adding docbook definitions for NodeManager. Currently, 'DocBook.py' is a copy
[nodemanager.git] / doc / NMAPI.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
3     "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
4 <!ENTITY Methods SYSTEM "Methods.xml">
5 ]>
6
7 <book>
8   <bookinfo>
9     <title>PlanetLab Node Manager API Documentation</title>
10   </bookinfo>
11
12   <chapter id="Introduction">
13     <title>Introduction</title>
14
15     <para>The PlanetLab Node Manager API (NMAPI) 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 NM operations is based on the identity of the
22           connecting slice.  For slices whose roles are defined as
23           'nm-controller', the target slice must be listed delegated and as
24           controlled by the calling slice.</para>
25
26    </section>
27     <section id="Connection">
28       <title>Connection</title>
29
30           <para>The NM XMLRPC server listens locally on every PlanetLab node at http://localhost:812.</para>
31    </section>
32
33   </chapter>
34
35   <chapter id="Methods">
36     <title>PlanetLab API Methods</title>
37     <para></para>
38
39     &Methods;
40   </chapter>
41
42 </book>
43
44 <!-- LocalWords:  PlanetLab API PLCAPI RPC HTTPS listMethods methodSignature
45 -->
46 <!-- LocalWords:  methodHelp multicall AuthMethod GetSession GnuPG Username GPG
47 -->
48 <!-- LocalWords:  AuthString AddPersonKey AddPeer UpdatePeer gpg
49 -->