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 the slices access the Node API.</para>
  17
  18     <section id="Authentication">
  19       <title>Authentication</title>
  20
  21           <para>Authentication for operations is based on the identity of the
  22           connecting user. The standard PLCAPI authetication is used here.</para>
  23
  24    </section>
  25     <section id="Connection">
  26       <title>Connection</title>
  27
  28           <para>The Admin-Mon XMLRPC server listens at http://monitor.planet-lab.org:8082.</para>
  29           <para>The XMLRPC server can be accessed remotely using a standard Python XMLRPC shell.</para>
  30    </section>
  31     <section id="Example">
  32       <title>An Example using the PLC and Admin-Mon API</title>
  33
  34         <para>Access to the API is via standard XMLRPC.  A simple example is below.</para>
  35
  36       <programlisting>
  37 import xmlrpclib
  38 auth = {'Username'   : API_AUTH_USER,
  39         'AuthMethod' : 'password',
  40         'AuthString' : API_AUTH_PASSWORD}
  41 api  =  xmlrpclib.Server(API_SERVER, verbose=False, allow_none=True)
  42
  43 if api.upAndRunning():
  44     for i in api.getSiteStatus(auth):
  45         print i
  46       </programlisting>
  47
  48    </section>
  49
  50   </chapter>
  51
  52   <chapter id="Methods">
  53     <title>PlanetLab API Methods</title>
  54     <para></para>
  55
  56     &Methods;
  57   </chapter>
  58
  59 </book>
  60
  61 <!-- LocalWords:  PlanetLab API PLCAPI RPC HTTPS listMethods methodSignature
  62 -->
  63 <!-- LocalWords:  methodHelp multicall AuthMethod GetSession GnuPG Username GPG
  64 -->
  65 <!-- LocalWords:  AuthString AddPersonKey AddPeer UpdatePeer gpg
  66 -->