add unused driver method
[sfa.git] / docs / pythondoc-config.html
1 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
2 <html>
3 <head>
4 <meta http-equiv='Content-Type' content='text/html; charset=us-ascii' />
5 <title>The config Module</title>
6 </head>
7 <body>
8 <h1>The config Module</h1>
9 <p>Geniwrapper Configuration Info
10
11 This module holds configuration parameters for geniwrapper. There are two
12 main pieces of information that are used: the database connection and
13 the PLCAPI connection</p>
14 <dl>
15 <dt><a id='config.get_default_dbinfo-function' name='config.get_default_dbinfo-function'><b>get_default_dbinfo()</b></a> [<a href='#config.get_default_dbinfo-function'>#</a>]</dt>
16 <dd>
17 <p>Geniwrapper uses a MYSQL database to store records. This database may be
18 co-located with the PLC database, or it may be a separate database. The
19 following parameters define the connection to the database.
20
21 Note that Geniwrapper does not access any of the PLC databases directly via
22 a mysql connection; All PLC databases are accessed via PLCAPI.</p>
23 </dd>
24 <dt><a id='config.get_pl_auth-function' name='config.get_pl_auth-function'><b>get_pl_auth()</b></a> [<a href='#config.get_pl_auth-function'>#</a>]</dt>
25 <dd>
26 <p>Geniwrapper uses a PLCAPI connection to perform operations on the registry,
27 such as creating and deleting slices. This connection requires an account
28 on the PLC server with full administrator access.
29
30 The Url parameter controls whether the connection uses PLCAPI directly (i.e.
31 Geniwrapper is located on the same machine as PLC), or uses a XMLRPC connection
32 to the PLC machine. If you wish to use the API directly, then remove the Url
33 field from the dictionary.</p>
34 </dd>
35 </dl>
36 </body></html>