docs/Monitor.xml.in

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
   3 "@DOCBOOK-43@" [
   4 <!ENTITY Methods SYSTEM "Methods.xml">
   5 ]>
   6
   7 <book>
   8   <bookinfo>
   9     <title>PlanetLab Administrative-Monitor API Documentation</title>
  10   </bookinfo>
  11
  12   <chapter id="Introduction">
  13     <title>Introduction</title>
  14
  15     <para>The PlanetLab Administrative-Monitor API (Admin-Mon) is the interface through
  16     which PLC administrators access the Admin-Mon API.  Some functions are
  17         also accessible to users with lower privileges. But, all users must have an account
  18         in the monitored PLC </para>
  19
  20     <section id="Authentication">
  21       <title>Authentication</title>
  22
  23           <para>Authentication for operations is based on the identity of the
  24           connecting user. The standard PLCAPI authetication is used here.</para>
  25
  26    </section>
  27     <section id="Connection">
  28       <title>Connection</title>
  29
  30           <para>The Admin-Mon XMLRPC server listens at http://PLC_MONITOR_HOST:8082/XMLRPC/</para>
  31           <para>The XMLRPC server can be accessed remotely using a standard Python XMLRPC shell.</para>
  32    </section>
  33     <section id="Example">
  34       <title>An Example using the PLC and Admin-Mon API</title>
  35
  36         <para>Access to the API is via standard XMLRPC.  A simple example is below.</para>
  37
  38       <programlisting>
  39 import xmlrpclib
  40 auth = {'Username'   : API_AUTH_USER,
  41         'AuthMethod' : 'password',
  42         'AuthString' : API_AUTH_PASSWORD}
  43 api  =  xmlrpclib.Server(API_SERVER, verbose=False, allow_none=True)
  44
  45 if api.upAndRunning():
  46     for i in api.getSiteStatus(auth):
  47         print i
  48 else:
  49     print "Admin-Mon API is not running."
  50       </programlisting>
  51
  52    </section>
  53
  54   </chapter>
  55
  56   <chapter id="Methods">
  57     <title>PlanetLab API Methods</title>
  58     <para></para>
  59
  60     &Methods;
  61   </chapter>
  62
  63 </book>
  64
  65 <!-- LocalWords:  PlanetLab API PLCAPI RPC HTTPS listMethods methodSignature
  66 -->
  67 <!-- LocalWords:  methodHelp multicall AuthMethod GetSession GnuPG Username GPG
  68 -->
  69 <!-- LocalWords:  AuthString AddPersonKey AddPeer UpdatePeer gpg
  70 -->