docs/pythondoc-component.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 component Module</title>
   6 </head>
   7 <body>
   8 <h1>The component Module</h1>
   9 <p>Geni Component Wrapper
  10
  11 This wrapper implements the Geni Component Interface</p>
  12 <dl>
  13 <dt><b>ComponentManager(ip, port, key_file, cert_file)</b> (class) [<a href='#component.ComponentManager-class'>#</a>]</dt>
  14 <dd>
  15 <p>ComponentManager is a GeniServer that serves component interface requests.</p>
  16 <p>For more information about this class, see <a href='#component.ComponentManager-class'><i>The ComponentManager Class</i></a>.</p>
  17 </dd>
  18 </dl>
  19 <h2><a id='component.ComponentManager-class' name='component.ComponentManager-class'>The ComponentManager Class</a></h2>
  20 <dl>
  21 <dt><b>ComponentManager(ip, port, key_file, cert_file)</b> (class) [<a href='#component.ComponentManager-class'>#</a>]</dt>
  22 <dd>
  23 <p>ComponentManager is a GeniServer that serves component interface requests.</p>
  24 </dd>
  25 <dt><a id='component.ComponentManager.decode_ticket-method' name='component.ComponentManager.decode_ticket-method'><b>decode_ticket(ticket_string)</b></a> [<a href='#component.ComponentManager.decode_ticket-method'>#</a>]</dt>
  26 <dd>
  27 <p>Examine the ticket that was provided by the caller, check that it is
  28 signed and verified correctly. Throw an exception if something is
  29 wrong with the ticket.
  30
  31 This is similar to geniserver.decode_authentication</p>
  32 <dl>
  33 <dt><i>ticket_string</i></dt>
  34 <dd>
  35 the string representation of the ticket</dd>
  36 </dl><br />
  37 </dd>
  38 <dt><a id='component.ComponentManager.delete_slice-method' name='component.ComponentManager.delete_slice-method'><b>delete_slice(cred_str)</b></a> [<a href='#component.ComponentManager.delete_slice-method'>#</a>]</dt>
  39 <dd>
  40 <p>Delete a slice.</p>
  41 <dl>
  42 <dt><i>cred</i></dt>
  43 <dd>
  44 a credential identifying the caller (callerGID) and the slice
  45     (objectGID)</dd>
  46 </dl><br />
  47 </dd>
  48 <dt><a id='component.ComponentManager.geni_ticket_to_plc_rec-method' name='component.ComponentManager.geni_ticket_to_plc_rec-method'><b>geni_ticket_to_plc_rec(ticket)</b></a> [<a href='#component.ComponentManager.geni_ticket_to_plc_rec-method'>#</a>]</dt>
  49 <dd>
  50 <p>Convert a geni ticket into a PLC record that can be submitted to the
  51 node manager. This involves some minor reformatting of the fields
  52 contained in the ticket.</p>
  53 <dl>
  54 <dt><i>ticket</i></dt>
  55 <dd>
  56 a ticket object</dd>
  57 <dt>Returns:</dt>
  58 <dd>
  59 a dictionary containing the PLC record info</dd>
  60 </dl><br />
  61 </dd>
  62 <dt><a id='component.ComponentManager.list_slices-method' name='component.ComponentManager.list_slices-method'><b>list_slices(cred_str)</b></a> [<a href='#component.ComponentManager.list_slices-method'>#</a>]</dt>
  63 <dd>
  64 <p>List the slices on a component.</p>
  65 <dl>
  66 <dt><i>cred_str</i></dt>
  67 <dd>
  68 string representation of a credential object that
  69     authorizes the caller</dd>
  70 <dt>Returns:</dt>
  71 <dd>
  72 a list of slice names</dd>
  73 </dl><br />
  74 </dd>
  75 <dt><a id='component.ComponentManager.reboot-method' name='component.ComponentManager.reboot-method'><b>reboot(cred_str)</b></a> [<a href='#component.ComponentManager.reboot-method'>#</a>]</dt>
  76 <dd>
  77 <p>Reboot the component.</p>
  78 <dl>
  79 <dt><i>cred_str</i></dt>
  80 <dd>
  81 string representation of a credential object that
  82     authorizes the caller</dd>
  83 </dl><br />
  84 </dd>
  85 <dt><a id='component.ComponentManager.redeem_ticket-method' name='component.ComponentManager.redeem_ticket-method'><b>redeem_ticket(ticket_str)</b></a> [<a href='#component.ComponentManager.redeem_ticket-method'>#</a>]</dt>
  86 <dd>
  87 <p>Redeem a ticket.
  88
  89 The ticket is submitted to the node manager, and the slice is instantiated
  90 or updated as appropriate.
  91
  92 TODO: This operation should return a sliver credential and indicate
  93 whether or not the component will accept only sliver credentials, or
  94 will accept both sliver and slice credentials.</p>
  95 <dl>
  96 <dt><i>ticket_str</i></dt>
  97 <dd>
  98 the string representation of a ticket object</dd>
  99 </dl><br />
 100 </dd>
 101 <dt><a id='component.ComponentManager.register_functions-method' name='component.ComponentManager.register_functions-method'><b>register_functions()</b></a> [<a href='#component.ComponentManager.register_functions-method'>#</a>]</dt>
 102 <dd>
 103 <p>Register the server RPCs for the component</p>
 104 </dd>
 105 <dt><a id='component.ComponentManager.reset_slice-method' name='component.ComponentManager.reset_slice-method'><b>reset_slice(cred_str)</b></a> [<a href='#component.ComponentManager.reset_slice-method'>#</a>]</dt>
 106 <dd>
 107 <p>Reset a slice.</p>
 108 <dl>
 109 <dt><i>cred</i></dt>
 110 <dd>
 111 a credential identifying the caller (callerGID) and the slice
 112     (objectGID)</dd>
 113 </dl><br />
 114 </dd>
 115 <dt><a id='component.ComponentManager.start_slice-method' name='component.ComponentManager.start_slice-method'><b>start_slice(cred_str)</b></a> [<a href='#component.ComponentManager.start_slice-method'>#</a>]</dt>
 116 <dd>
 117 <p>Start a slice.</p>
 118 <dl>
 119 <dt><i>cred</i></dt>
 120 <dd>
 121 a credential identifying the caller (callerGID) and the slice
 122     (objectGID)</dd>
 123 </dl><br />
 124 </dd>
 125 <dt><a id='component.ComponentManager.stop_slice-method' name='component.ComponentManager.stop_slice-method'><b>stop_slice(cred_str)</b></a> [<a href='#component.ComponentManager.stop_slice-method'>#</a>]</dt>
 126 <dd>
 127 <p>Stop a slice.</p>
 128 <dl>
 129 <dt><i>cred</i></dt>
 130 <dd>
 131 a credential identifying the caller (callerGID) and the slice
 132     (objectGID)</dd>
 133 </dl><br />
 134 </dd>
 135 </dl>
 136 </body></html>