add sphinx documentation
[nepi.git] / doc / sphinx / _build / html / _layout / nepi.resources.planetlab.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
4
5 <html xmlns="http://www.w3.org/1999/xhtml">
6   <head>
7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8     
9     <title>nepi.resources.planetlab package &mdash; NEPI 3.0 documentation</title>
10     
11     <link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
12     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
13     
14     <script type="text/javascript">
15       var DOCUMENTATION_OPTIONS = {
16         URL_ROOT:    '../',
17         VERSION:     '3.0',
18         COLLAPSE_INDEX: false,
19         FILE_SUFFIX: '.html',
20         HAS_SOURCE:  true
21       };
22     </script>
23     <script type="text/javascript" src="../_static/jquery.js"></script>
24     <script type="text/javascript" src="../_static/underscore.js"></script>
25     <script type="text/javascript" src="../_static/doctools.js"></script>
26     <link rel="top" title="NEPI 3.0 documentation" href="../index.html" /> 
27   </head>
28   <body>
29     <div class="related">
30       <h3>Navigation</h3>
31       <ul>
32         <li class="right" style="margin-right: 10px">
33           <a href="../genindex.html" title="General Index"
34              accesskey="I">index</a></li>
35         <li class="right" >
36           <a href="../py-modindex.html" title="Python Module Index"
37              >modules</a> |</li>
38         <li><a href="../index.html">NEPI 3.0 documentation</a> &raquo;</li> 
39       </ul>
40     </div>
41       <div class="sphinxsidebar">
42         <div class="sphinxsidebarwrapper">
43   <h3><a href="../index.html">Table Of Contents</a></h3>
44   <ul>
45 <li><a class="reference internal" href="#">nepi.resources.planetlab package</a><ul>
46 <li><a class="reference internal" href="#subpackages">Subpackages</a></li>
47 <li><a class="reference internal" href="#submodules">Submodules</a></li>
48 <li><a class="reference internal" href="#module-nepi.resources.planetlab.node">nepi.resources.planetlab.node module</a></li>
49 <li><a class="reference internal" href="#module-nepi.resources.planetlab.plcapi">nepi.resources.planetlab.plcapi module</a></li>
50 <li><a class="reference internal" href="#module-nepi.resources.planetlab.sfa_node">nepi.resources.planetlab.sfa_node module</a></li>
51 <li><a class="reference internal" href="#module-nepi.resources.planetlab.tap">nepi.resources.planetlab.tap module</a></li>
52 <li><a class="reference internal" href="#module-nepi.resources.planetlab.tun">nepi.resources.planetlab.tun module</a></li>
53 <li><a class="reference internal" href="#module-nepi.resources.planetlab.vroute">nepi.resources.planetlab.vroute module</a></li>
54 <li><a class="reference internal" href="#module-nepi.resources.planetlab">Module contents</a></li>
55 </ul>
56 </li>
57 </ul>
58
59   <h3>This Page</h3>
60   <ul class="this-page-menu">
61     <li><a href="../_sources/_layout/nepi.resources.planetlab.txt"
62            rel="nofollow">Show Source</a></li>
63   </ul>
64 <div id="searchbox" style="display: none">
65   <h3>Quick search</h3>
66     <form class="search" action="../search.html" method="get">
67       <input type="text" name="q" />
68       <input type="submit" value="Go" />
69       <input type="hidden" name="check_keywords" value="yes" />
70       <input type="hidden" name="area" value="default" />
71     </form>
72     <p class="searchtip" style="font-size: 90%">
73     Enter search terms or a module, class or function name.
74     </p>
75 </div>
76 <script type="text/javascript">$('#searchbox').show(0);</script>
77         </div>
78       </div>
79
80     <div class="document">
81       <div class="documentwrapper">
82         <div class="bodywrapper">
83           <div class="body">
84             
85   <div class="section" id="nepi-resources-planetlab-package">
86 <h1>nepi.resources.planetlab package<a class="headerlink" href="#nepi-resources-planetlab-package" title="Permalink to this headline">¶</a></h1>
87 <div class="section" id="subpackages">
88 <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
89 <div class="toctree-wrapper compound">
90 <ul>
91 <li class="toctree-l1"><a class="reference internal" href="nepi.resources.planetlab.ns3.html">nepi.resources.planetlab.ns3 package</a><ul>
92 <li class="toctree-l2"><a class="reference internal" href="nepi.resources.planetlab.ns3.html#submodules">Submodules</a></li>
93 <li class="toctree-l2"><a class="reference internal" href="nepi.resources.planetlab.ns3.html#module-nepi.resources.planetlab.ns3.fdudptunnel">nepi.resources.planetlab.ns3.fdudptunnel module</a></li>
94 <li class="toctree-l2"><a class="reference internal" href="nepi.resources.planetlab.ns3.html#module-nepi.resources.planetlab.ns3.tuntapfdlink">nepi.resources.planetlab.ns3.tuntapfdlink module</a></li>
95 <li class="toctree-l2"><a class="reference internal" href="nepi.resources.planetlab.ns3.html#module-nepi.resources.planetlab.ns3">Module contents</a></li>
96 </ul>
97 </li>
98 <li class="toctree-l1"><a class="reference internal" href="nepi.resources.planetlab.openvswitch.html">nepi.resources.planetlab.openvswitch package</a><ul>
99 <li class="toctree-l2"><a class="reference internal" href="nepi.resources.planetlab.openvswitch.html#submodules">Submodules</a></li>
100 <li class="toctree-l2"><a class="reference internal" href="nepi.resources.planetlab.openvswitch.html#module-nepi.resources.planetlab.openvswitch.ovs">nepi.resources.planetlab.openvswitch.ovs module</a></li>
101 <li class="toctree-l2"><a class="reference internal" href="nepi.resources.planetlab.openvswitch.html#module-nepi.resources.planetlab.openvswitch.ovsport">nepi.resources.planetlab.openvswitch.ovsport module</a></li>
102 <li class="toctree-l2"><a class="reference internal" href="nepi.resources.planetlab.openvswitch.html#module-nepi.resources.planetlab.openvswitch">Module contents</a></li>
103 </ul>
104 </li>
105 </ul>
106 </div>
107 </div>
108 <div class="section" id="submodules">
109 <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
110 </div>
111 <div class="section" id="module-nepi.resources.planetlab.node">
112 <span id="nepi-resources-planetlab-node-module"></span><h2>nepi.resources.planetlab.node module<a class="headerlink" href="#module-nepi.resources.planetlab.node" title="Permalink to this headline">¶</a></h2>
113 <dl class="class">
114 <dt id="nepi.resources.planetlab.node.PlanetlabNode">
115 <em class="property">class </em><tt class="descclassname">nepi.resources.planetlab.node.</tt><tt class="descname">PlanetlabNode</tt><big>(</big><em>ec</em>, <em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/node.html#PlanetlabNode"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.node.PlanetlabNode" title="Permalink to this definition">¶</a></dt>
116 <dd><p>Bases: <a class="reference internal" href="nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode" title="nepi.resources.linux.node.LinuxNode"><tt class="xref py py-class docutils literal"><span class="pre">nepi.resources.linux.node.LinuxNode</span></tt></a></p>
117 <dl class="method">
118 <dt id="nepi.resources.planetlab.node.PlanetlabNode.do_discover">
119 <tt class="descname">do_discover</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/node.html#PlanetlabNode.do_discover"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.node.PlanetlabNode.do_discover" title="Permalink to this definition">¶</a></dt>
120 <dd><p>Based on the attributes defined by the user, discover the suitable 
121 nodes for provision.</p>
122 </dd></dl>
123
124 <dl class="method">
125 <dt id="nepi.resources.planetlab.node.PlanetlabNode.do_provision">
126 <tt class="descname">do_provision</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/node.html#PlanetlabNode.do_provision"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.node.PlanetlabNode.do_provision" title="Permalink to this definition">¶</a></dt>
127 <dd><p>Add node to user&#8217;s slice after verifing that the node is functioning
128 correctly</p>
129 </dd></dl>
130
131 <dl class="method">
132 <dt id="nepi.resources.planetlab.node.PlanetlabNode.do_release">
133 <tt class="descname">do_release</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/node.html#PlanetlabNode.do_release"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.node.PlanetlabNode.do_release" title="Permalink to this definition">¶</a></dt>
134 <dd></dd></dl>
135
136 <dl class="method">
137 <dt id="nepi.resources.planetlab.node.PlanetlabNode.fail_discovery">
138 <tt class="descname">fail_discovery</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/node.html#PlanetlabNode.fail_discovery"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.node.PlanetlabNode.fail_discovery" title="Permalink to this definition">¶</a></dt>
139 <dd></dd></dl>
140
141 <dl class="method">
142 <dt id="nepi.resources.planetlab.node.PlanetlabNode.fail_node_not_alive">
143 <tt class="descname">fail_node_not_alive</tt><big>(</big><em>hostname=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/node.html#PlanetlabNode.fail_node_not_alive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.node.PlanetlabNode.fail_node_not_alive" title="Permalink to this definition">¶</a></dt>
144 <dd></dd></dl>
145
146 <dl class="method">
147 <dt id="nepi.resources.planetlab.node.PlanetlabNode.fail_node_not_available">
148 <tt class="descname">fail_node_not_available</tt><big>(</big><em>hostname</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/node.html#PlanetlabNode.fail_node_not_available"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.node.PlanetlabNode.fail_node_not_available" title="Permalink to this definition">¶</a></dt>
149 <dd></dd></dl>
150
151 <dl class="method">
152 <dt id="nepi.resources.planetlab.node.PlanetlabNode.fail_not_enough_nodes">
153 <tt class="descname">fail_not_enough_nodes</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/node.html#PlanetlabNode.fail_not_enough_nodes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.node.PlanetlabNode.fail_not_enough_nodes" title="Permalink to this definition">¶</a></dt>
154 <dd></dd></dl>
155
156 <dl class="method">
157 <dt id="nepi.resources.planetlab.node.PlanetlabNode.fail_plapi">
158 <tt class="descname">fail_plapi</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/node.html#PlanetlabNode.fail_plapi"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.node.PlanetlabNode.fail_plapi" title="Permalink to this definition">¶</a></dt>
159 <dd></dd></dl>
160
161 <dl class="attribute">
162 <dt id="nepi.resources.planetlab.node.PlanetlabNode.lock">
163 <tt class="descname">lock</tt><em class="property"> = &lt;thread.lock object at 0x7f028fc19a70&gt;</em><a class="headerlink" href="#nepi.resources.planetlab.node.PlanetlabNode.lock" title="Permalink to this definition">¶</a></dt>
164 <dd></dd></dl>
165
166 <dl class="attribute">
167 <dt id="nepi.resources.planetlab.node.PlanetlabNode.plapi">
168 <tt class="descname">plapi</tt><a class="reference internal" href="../_modules/nepi/resources/planetlab/node.html#PlanetlabNode.plapi"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.node.PlanetlabNode.plapi" title="Permalink to this definition">¶</a></dt>
169 <dd></dd></dl>
170
171 <dl class="method">
172 <dt id="nepi.resources.planetlab.node.PlanetlabNode.valid_connection">
173 <tt class="descname">valid_connection</tt><big>(</big><em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/node.html#PlanetlabNode.valid_connection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.node.PlanetlabNode.valid_connection" title="Permalink to this definition">¶</a></dt>
174 <dd></dd></dl>
175
176 </dd></dl>
177
178 </div>
179 <div class="section" id="module-nepi.resources.planetlab.plcapi">
180 <span id="nepi-resources-planetlab-plcapi-module"></span><h2>nepi.resources.planetlab.plcapi module<a class="headerlink" href="#module-nepi.resources.planetlab.plcapi" title="Permalink to this headline">¶</a></h2>
181 <dl class="class">
182 <dt id="nepi.resources.planetlab.plcapi.PLCAPI">
183 <em class="property">class </em><tt class="descclassname">nepi.resources.planetlab.plcapi.</tt><tt class="descname">PLCAPI</tt><big>(</big><em>username</em>, <em>password</em>, <em>hostname</em>, <em>urlpattern</em>, <em>ec</em>, <em>proxy</em>, <em>session_key=None</em>, <em>local_peer='PLE'</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/plcapi.html#PLCAPI"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.plcapi.PLCAPI" title="Permalink to this definition">¶</a></dt>
184 <dd><p>Bases: <a class="reference external" href="http://docs.python.org/library/functions.html#object" title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></a></p>
185 <dl class="method">
186 <dt id="nepi.resources.planetlab.plcapi.PLCAPI.add_slice_nodes">
187 <tt class="descname">add_slice_nodes</tt><big>(</big><em>slicename</em>, <em>nodes</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/plcapi.html#PLCAPI.add_slice_nodes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.plcapi.PLCAPI.add_slice_nodes" title="Permalink to this definition">¶</a></dt>
188 <dd></dd></dl>
189
190 <dl class="attribute">
191 <dt id="nepi.resources.planetlab.plcapi.PLCAPI.api">
192 <tt class="descname">api</tt><a class="reference internal" href="../_modules/nepi/resources/planetlab/plcapi.html#PLCAPI.api"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.plcapi.PLCAPI.api" title="Permalink to this definition">¶</a></dt>
193 <dd></dd></dl>
194
195 <dl class="method">
196 <dt id="nepi.resources.planetlab.plcapi.PLCAPI.blacklist_host">
197 <tt class="descname">blacklist_host</tt><big>(</big><em>node_id</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/plcapi.html#PLCAPI.blacklist_host"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.plcapi.PLCAPI.blacklist_host" title="Permalink to this definition">¶</a></dt>
198 <dd></dd></dl>
199
200 <dl class="method">
201 <dt id="nepi.resources.planetlab.plcapi.PLCAPI.blacklisted">
202 <tt class="descname">blacklisted</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/plcapi.html#PLCAPI.blacklisted"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.plcapi.PLCAPI.blacklisted" title="Permalink to this definition">¶</a></dt>
203 <dd></dd></dl>
204
205 <dl class="method">
206 <dt id="nepi.resources.planetlab.plcapi.PLCAPI.delete_slice_node">
207 <tt class="descname">delete_slice_node</tt><big>(</big><em>slice_id_or_name</em>, <em>node_id_or_hostname</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/plcapi.html#PLCAPI.delete_slice_node"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.plcapi.PLCAPI.delete_slice_node" title="Permalink to this definition">¶</a></dt>
208 <dd></dd></dl>
209
210 <dl class="method">
211 <dt id="nepi.resources.planetlab.plcapi.PLCAPI.finish_multicall">
212 <tt class="descname">finish_multicall</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/plcapi.html#PLCAPI.finish_multicall"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.plcapi.PLCAPI.finish_multicall" title="Permalink to this definition">¶</a></dt>
213 <dd></dd></dl>
214
215 <dl class="method">
216 <dt id="nepi.resources.planetlab.plcapi.PLCAPI.get_interfaces">
217 <tt class="descname">get_interfaces</tt><big>(</big><em>interface_id_or_ip=None</em>, <em>fields=None</em>, <em>**kw</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/plcapi.html#PLCAPI.get_interfaces"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.plcapi.PLCAPI.get_interfaces" title="Permalink to this definition">¶</a></dt>
218 <dd></dd></dl>
219
220 <dl class="method">
221 <dt id="nepi.resources.planetlab.plcapi.PLCAPI.get_node_flavour">
222 <tt class="descname">get_node_flavour</tt><big>(</big><em>node</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/plcapi.html#PLCAPI.get_node_flavour"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.plcapi.PLCAPI.get_node_flavour" title="Permalink to this definition">¶</a></dt>
223 <dd><p>Returns detailed information on a given node&#8217;s flavour,
224 i.e. its base installation.</p>
225 <p>This depends on the global PLC settings in the PLC_FLAVOUR area,
226 optionnally overridden by any of the following tags if set on that node:
227 &#8216;arch&#8217;, &#8216;pldistro&#8217;, &#8216;fcdistro&#8217;, &#8216;deployment&#8217;, &#8216;extensions&#8217;</p>
228 <p>Params:</p>
229 <blockquote>
230 <div><ul>
231 <li><dl class="first docutils">
232 <dt>node <span class="classifier-delimiter">:</span> <span class="classifier">int or string</span></dt>
233 <dd><ul class="first last simple">
234 <li>int, Node identifier</li>
235 <li>string, Fully qualified hostname</li>
236 </ul>
237 </dd>
238 </dl>
239 </li>
240 </ul>
241 </div></blockquote>
242 <p>Returns:</p>
243 <blockquote>
244 <div><dl class="docutils">
245 <dt>struct</dt>
246 <dd><ul class="first last simple">
247 <li>extensions : array of string, extensions to add to the base install</li>
248 <li>fcdistro : string, the fcdistro this node should be based upon</li>
249 <li>nodefamily : string, the nodefamily this node should be based upon</li>
250 <li>plain : boolean, use plain bootstrapfs image if set (for tests)</li>
251 </ul>
252 </dd>
253 </dl>
254 </div></blockquote>
255 </dd></dl>
256
257 <dl class="method">
258 <dt id="nepi.resources.planetlab.plcapi.PLCAPI.get_node_info">
259 <tt class="descname">get_node_info</tt><big>(</big><em>node_id</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/plcapi.html#PLCAPI.get_node_info"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.plcapi.PLCAPI.get_node_info" title="Permalink to this definition">¶</a></dt>
260 <dd></dd></dl>
261
262 <dl class="method">
263 <dt id="nepi.resources.planetlab.plcapi.PLCAPI.get_node_tags">
264 <tt class="descname">get_node_tags</tt><big>(</big><em>node_tag_id=None</em>, <em>fields=None</em>, <em>**kw</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/plcapi.html#PLCAPI.get_node_tags"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.plcapi.PLCAPI.get_node_tags" title="Permalink to this definition">¶</a></dt>
265 <dd></dd></dl>
266
267 <dl class="method">
268 <dt id="nepi.resources.planetlab.plcapi.PLCAPI.get_nodes">
269 <tt class="descname">get_nodes</tt><big>(</big><em>node_id_or_name=None</em>, <em>fields=None</em>, <em>**kw</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/plcapi.html#PLCAPI.get_nodes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.plcapi.PLCAPI.get_nodes" title="Permalink to this definition">¶</a></dt>
270 <dd><p>Returns an array of structs containing details about nodes. 
271 If node_id_or_name is specified and is an array of node identifiers
272 or hostnames,  or the filters keyword argument with struct of node
273 attributes, or node attributes by keyword argument,
274 only nodes matching the filter will be returned.</p>
275 <p>If fields is specified, only the specified details will be returned. 
276 NOTE that if fields is unspecified, the complete set of native fields are
277 returned, which DOES NOT include tags at this time.</p>
278 <p>Some fields may only be viewed by admins.</p>
279 <p>Special params:</p>
280 <blockquote>
281 <div><p>fields: an optional list of fields to retrieve. The default is all.</p>
282 <dl class="docutils">
283 <dt>filters: an optional mapping with custom filters, which is the only</dt>
284 <dd>way to support complex filters like negation and numeric comparisons.</dd>
285 <dt>peer: a string (or sequence of strings) with the name(s) of peers</dt>
286 <dd>to filter - or None for local nodes.</dd>
287 </dl>
288 </div></blockquote>
289 </dd></dl>
290
291 <dl class="method">
292 <dt id="nepi.resources.planetlab.plcapi.PLCAPI.get_slice_id">
293 <tt class="descname">get_slice_id</tt><big>(</big><em>slicename</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/plcapi.html#PLCAPI.get_slice_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.plcapi.PLCAPI.get_slice_id" title="Permalink to this definition">¶</a></dt>
294 <dd></dd></dl>
295
296 <dl class="method">
297 <dt id="nepi.resources.planetlab.plcapi.PLCAPI.get_slice_nodes">
298 <tt class="descname">get_slice_nodes</tt><big>(</big><em>slicename</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/plcapi.html#PLCAPI.get_slice_nodes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.plcapi.PLCAPI.get_slice_nodes" title="Permalink to this definition">¶</a></dt>
299 <dd></dd></dl>
300
301 <dl class="method">
302 <dt id="nepi.resources.planetlab.plcapi.PLCAPI.get_slice_tags">
303 <tt class="descname">get_slice_tags</tt><big>(</big><em>slice_tag_id=None</em>, <em>fields=None</em>, <em>**kw</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/plcapi.html#PLCAPI.get_slice_tags"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.plcapi.PLCAPI.get_slice_tags" title="Permalink to this definition">¶</a></dt>
304 <dd></dd></dl>
305
306 <dl class="method">
307 <dt id="nepi.resources.planetlab.plcapi.PLCAPI.get_slice_vnet_sys_tag">
308 <tt class="descname">get_slice_vnet_sys_tag</tt><big>(</big><em>slicename</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/plcapi.html#PLCAPI.get_slice_vnet_sys_tag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.plcapi.PLCAPI.get_slice_vnet_sys_tag" title="Permalink to this definition">¶</a></dt>
309 <dd></dd></dl>
310
311 <dl class="method">
312 <dt id="nepi.resources.planetlab.plcapi.PLCAPI.get_slices">
313 <tt class="descname">get_slices</tt><big>(</big><em>slice_id_or_name=None</em>, <em>fields=None</em>, <em>**kw</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/plcapi.html#PLCAPI.get_slices"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.plcapi.PLCAPI.get_slices" title="Permalink to this definition">¶</a></dt>
314 <dd></dd></dl>
315
316 <dl class="attribute">
317 <dt id="nepi.resources.planetlab.plcapi.PLCAPI.mcapi">
318 <tt class="descname">mcapi</tt><a class="reference internal" href="../_modules/nepi/resources/planetlab/plcapi.html#PLCAPI.mcapi"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.plcapi.PLCAPI.mcapi" title="Permalink to this definition">¶</a></dt>
319 <dd></dd></dl>
320
321 <dl class="attribute">
322 <dt id="nepi.resources.planetlab.plcapi.PLCAPI.network_types">
323 <tt class="descname">network_types</tt><a class="reference internal" href="../_modules/nepi/resources/planetlab/plcapi.html#PLCAPI.network_types"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.plcapi.PLCAPI.network_types" title="Permalink to this definition">¶</a></dt>
324 <dd></dd></dl>
325
326 <dl class="attribute">
327 <dt id="nepi.resources.planetlab.plcapi.PLCAPI.peer_map">
328 <tt class="descname">peer_map</tt><a class="reference internal" href="../_modules/nepi/resources/planetlab/plcapi.html#PLCAPI.peer_map"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.plcapi.PLCAPI.peer_map" title="Permalink to this definition">¶</a></dt>
329 <dd></dd></dl>
330
331 <dl class="method">
332 <dt id="nepi.resources.planetlab.plcapi.PLCAPI.release">
333 <tt class="descname">release</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/plcapi.html#PLCAPI.release"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.plcapi.PLCAPI.release" title="Permalink to this definition">¶</a></dt>
334 <dd></dd></dl>
335
336 <dl class="method">
337 <dt id="nepi.resources.planetlab.plcapi.PLCAPI.reserve_host">
338 <tt class="descname">reserve_host</tt><big>(</big><em>node_id</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/plcapi.html#PLCAPI.reserve_host"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.plcapi.PLCAPI.reserve_host" title="Permalink to this definition">¶</a></dt>
339 <dd></dd></dl>
340
341 <dl class="method">
342 <dt id="nepi.resources.planetlab.plcapi.PLCAPI.reserved">
343 <tt class="descname">reserved</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/plcapi.html#PLCAPI.reserved"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.plcapi.PLCAPI.reserved" title="Permalink to this definition">¶</a></dt>
344 <dd></dd></dl>
345
346 <dl class="method">
347 <dt id="nepi.resources.planetlab.plcapi.PLCAPI.start_multicall">
348 <tt class="descname">start_multicall</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/plcapi.html#PLCAPI.start_multicall"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.plcapi.PLCAPI.start_multicall" title="Permalink to this definition">¶</a></dt>
349 <dd></dd></dl>
350
351 <dl class="method">
352 <dt id="nepi.resources.planetlab.plcapi.PLCAPI.test">
353 <tt class="descname">test</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/plcapi.html#PLCAPI.test"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.plcapi.PLCAPI.test" title="Permalink to this definition">¶</a></dt>
354 <dd></dd></dl>
355
356 <dl class="method">
357 <dt id="nepi.resources.planetlab.plcapi.PLCAPI.unblacklist_host">
358 <tt class="descname">unblacklist_host</tt><big>(</big><em>node_id</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/plcapi.html#PLCAPI.unblacklist_host"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.plcapi.PLCAPI.unblacklist_host" title="Permalink to this definition">¶</a></dt>
359 <dd></dd></dl>
360
361 <dl class="method">
362 <dt id="nepi.resources.planetlab.plcapi.PLCAPI.unreserve_host">
363 <tt class="descname">unreserve_host</tt><big>(</big><em>node_id</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/plcapi.html#PLCAPI.unreserve_host"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.plcapi.PLCAPI.unreserve_host" title="Permalink to this definition">¶</a></dt>
364 <dd></dd></dl>
365
366 <dl class="method">
367 <dt id="nepi.resources.planetlab.plcapi.PLCAPI.update_slice">
368 <tt class="descname">update_slice</tt><big>(</big><em>slice_id_or_name</em>, <em>**kw</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/plcapi.html#PLCAPI.update_slice"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.plcapi.PLCAPI.update_slice" title="Permalink to this definition">¶</a></dt>
369 <dd></dd></dl>
370
371 </dd></dl>
372
373 <dl class="class">
374 <dt id="nepi.resources.planetlab.plcapi.PLCAPIFactory">
375 <em class="property">class </em><tt class="descclassname">nepi.resources.planetlab.plcapi.</tt><tt class="descname">PLCAPIFactory</tt><a class="reference internal" href="../_modules/nepi/resources/planetlab/plcapi.html#PLCAPIFactory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.plcapi.PLCAPIFactory" title="Permalink to this definition">¶</a></dt>
376 <dd><p>Bases: <a class="reference external" href="http://docs.python.org/library/functions.html#object" title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></a></p>
377 <div class="admonition note">
378 <p class="first admonition-title">Note</p>
379 <p class="last">It allows PlanetLab RMs sharing a same slice, to use a same plcapi instance,
380 and to sincronize blacklisted and reserved hosts.</p>
381 </div>
382 <dl class="classmethod">
383 <dt id="nepi.resources.planetlab.plcapi.PLCAPIFactory.create_api">
384 <em class="property">classmethod </em><tt class="descname">create_api</tt><big>(</big><em>pl_user</em>, <em>pl_pass</em>, <em>pl_host</em>, <em>pl_ptn</em>, <em>ec</em>, <em>proxy=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/plcapi.html#PLCAPIFactory.create_api"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.plcapi.PLCAPIFactory.create_api" title="Permalink to this definition">¶</a></dt>
385 <dd><p>Create an PLCAPI instance</p>
386 <table class="docutils field-list" frame="void" rules="none">
387 <col class="field-name" />
388 <col class="field-body" />
389 <tbody valign="top">
390 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
391 <li><strong>pl_user</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Planelab user name (used for web login)</li>
392 <li><strong>pl_pass</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Planetlab password (used for web login)</li>
393 <li><strong>pl_host</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Planetlab registry host (e.g. &#8220;www.planet-lab.eu&#8221;)</li>
394 <li><strong>pl_ptn</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; XMLRPC service pattern (e.g. <a class="reference external" href="https://%(hostname)s:443/PLCAPI/">https://%(hostname)s:443/PLCAPI/</a>)</li>
395 <li><strong>proxy</strong> &#8211; Proxy service url</li>
396 </ul>
397 </td>
398 </tr>
399 </tbody>
400 </table>
401 </dd></dl>
402
403 <dl class="classmethod">
404 <dt id="nepi.resources.planetlab.plcapi.PLCAPIFactory.get_api">
405 <em class="property">classmethod </em><tt class="descname">get_api</tt><big>(</big><em>pl_user</em>, <em>pl_pass</em>, <em>pl_host</em>, <em>pl_ptn</em>, <em>ec</em>, <em>proxy=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/plcapi.html#PLCAPIFactory.get_api"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.plcapi.PLCAPIFactory.get_api" title="Permalink to this definition">¶</a></dt>
406 <dd><p>Get existing PLCAPI instance</p>
407 <table class="docutils field-list" frame="void" rules="none">
408 <col class="field-name" />
409 <col class="field-body" />
410 <tbody valign="top">
411 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
412 <li><strong>pl_user</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Planelab user name (used for web login)</li>
413 <li><strong>pl_pass</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Planetlab password (used for web login)</li>
414 <li><strong>pl_host</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Planetlab registry host (e.g. &#8220;www.planet-lab.eu&#8221;)</li>
415 <li><strong>pl_ptn</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; XMLRPC service pattern (e.g. <a class="reference external" href="https://%(hostname)s:443/PLCAPI/">https://%(hostname)s:443/PLCAPI/</a>)</li>
416 <li><strong>proxy</strong> &#8211; Proxy service url</li>
417 </ul>
418 </td>
419 </tr>
420 </tbody>
421 </table>
422 </dd></dl>
423
424 </dd></dl>
425
426 </div>
427 <div class="section" id="module-nepi.resources.planetlab.sfa_node">
428 <span id="nepi-resources-planetlab-sfa-node-module"></span><h2>nepi.resources.planetlab.sfa_node module<a class="headerlink" href="#module-nepi.resources.planetlab.sfa_node" title="Permalink to this headline">¶</a></h2>
429 <dl class="class">
430 <dt id="nepi.resources.planetlab.sfa_node.PlanetlabSfaNode">
431 <em class="property">class </em><tt class="descclassname">nepi.resources.planetlab.sfa_node.</tt><tt class="descname">PlanetlabSfaNode</tt><big>(</big><em>ec</em>, <em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/sfa_node.html#PlanetlabSfaNode"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.sfa_node.PlanetlabSfaNode" title="Permalink to this definition">¶</a></dt>
432 <dd><p>Bases: <a class="reference internal" href="nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode" title="nepi.resources.linux.node.LinuxNode"><tt class="xref py py-class docutils literal"><span class="pre">nepi.resources.linux.node.LinuxNode</span></tt></a></p>
433 <dl class="method">
434 <dt id="nepi.resources.planetlab.sfa_node.PlanetlabSfaNode.do_discover">
435 <tt class="descname">do_discover</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/sfa_node.html#PlanetlabSfaNode.do_discover"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.sfa_node.PlanetlabSfaNode.do_discover" title="Permalink to this definition">¶</a></dt>
436 <dd><p>Based on the attributes defined by the user, discover the suitable 
437 nodes for provision.</p>
438 </dd></dl>
439
440 <dl class="method">
441 <dt id="nepi.resources.planetlab.sfa_node.PlanetlabSfaNode.do_provision">
442 <tt class="descname">do_provision</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/sfa_node.html#PlanetlabSfaNode.do_provision"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.sfa_node.PlanetlabSfaNode.do_provision" title="Permalink to this definition">¶</a></dt>
443 <dd><p>Add node to user&#8217;s slice and verifing that the node is functioning
444 correctly. Check ssh, file system.</p>
445 </dd></dl>
446
447 <dl class="method">
448 <dt id="nepi.resources.planetlab.sfa_node.PlanetlabSfaNode.do_release">
449 <tt class="descname">do_release</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/sfa_node.html#PlanetlabSfaNode.do_release"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.sfa_node.PlanetlabSfaNode.do_release" title="Permalink to this definition">¶</a></dt>
450 <dd></dd></dl>
451
452 <dl class="method">
453 <dt id="nepi.resources.planetlab.sfa_node.PlanetlabSfaNode.fail_discovery">
454 <tt class="descname">fail_discovery</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/sfa_node.html#PlanetlabSfaNode.fail_discovery"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.sfa_node.PlanetlabSfaNode.fail_discovery" title="Permalink to this definition">¶</a></dt>
455 <dd></dd></dl>
456
457 <dl class="method">
458 <dt id="nepi.resources.planetlab.sfa_node.PlanetlabSfaNode.fail_node_not_alive">
459 <tt class="descname">fail_node_not_alive</tt><big>(</big><em>hostname=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/sfa_node.html#PlanetlabSfaNode.fail_node_not_alive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.sfa_node.PlanetlabSfaNode.fail_node_not_alive" title="Permalink to this definition">¶</a></dt>
460 <dd></dd></dl>
461
462 <dl class="method">
463 <dt id="nepi.resources.planetlab.sfa_node.PlanetlabSfaNode.fail_node_not_available">
464 <tt class="descname">fail_node_not_available</tt><big>(</big><em>hostname</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/sfa_node.html#PlanetlabSfaNode.fail_node_not_available"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.sfa_node.PlanetlabSfaNode.fail_node_not_available" title="Permalink to this definition">¶</a></dt>
465 <dd></dd></dl>
466
467 <dl class="method">
468 <dt id="nepi.resources.planetlab.sfa_node.PlanetlabSfaNode.fail_not_enough_nodes">
469 <tt class="descname">fail_not_enough_nodes</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/sfa_node.html#PlanetlabSfaNode.fail_not_enough_nodes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.sfa_node.PlanetlabSfaNode.fail_not_enough_nodes" title="Permalink to this definition">¶</a></dt>
470 <dd></dd></dl>
471
472 <dl class="method">
473 <dt id="nepi.resources.planetlab.sfa_node.PlanetlabSfaNode.fail_sfaapi">
474 <tt class="descname">fail_sfaapi</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/sfa_node.html#PlanetlabSfaNode.fail_sfaapi"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.sfa_node.PlanetlabSfaNode.fail_sfaapi" title="Permalink to this definition">¶</a></dt>
475 <dd></dd></dl>
476
477 <dl class="attribute">
478 <dt id="nepi.resources.planetlab.sfa_node.PlanetlabSfaNode.sfaapi">
479 <tt class="descname">sfaapi</tt><a class="reference internal" href="../_modules/nepi/resources/planetlab/sfa_node.html#PlanetlabSfaNode.sfaapi"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.sfa_node.PlanetlabSfaNode.sfaapi" title="Permalink to this definition">¶</a></dt>
480 <dd><p>Property to instanciate the SFA API based in sfi client.
481 For each SFA method called this instance is used.</p>
482 </dd></dl>
483
484 <dl class="method">
485 <dt id="nepi.resources.planetlab.sfa_node.PlanetlabSfaNode.valid_connection">
486 <tt class="descname">valid_connection</tt><big>(</big><em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/sfa_node.html#PlanetlabSfaNode.valid_connection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.sfa_node.PlanetlabSfaNode.valid_connection" title="Permalink to this definition">¶</a></dt>
487 <dd></dd></dl>
488
489 </dd></dl>
490
491 </div>
492 <div class="section" id="module-nepi.resources.planetlab.tap">
493 <span id="nepi-resources-planetlab-tap-module"></span><h2>nepi.resources.planetlab.tap module<a class="headerlink" href="#module-nepi.resources.planetlab.tap" title="Permalink to this headline">¶</a></h2>
494 <dl class="class">
495 <dt id="nepi.resources.planetlab.tap.PlanetlabTap">
496 <em class="property">class </em><tt class="descclassname">nepi.resources.planetlab.tap.</tt><tt class="descname">PlanetlabTap</tt><big>(</big><em>ec</em>, <em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/tap.html#PlanetlabTap"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.tap.PlanetlabTap" title="Permalink to this definition">¶</a></dt>
497 <dd><p>Bases: <a class="reference internal" href="nepi.resources.linux.html#nepi.resources.linux.tap.LinuxTap" title="nepi.resources.linux.tap.LinuxTap"><tt class="xref py py-class docutils literal"><span class="pre">nepi.resources.linux.tap.LinuxTap</span></tt></a></p>
498 <dl class="method">
499 <dt id="nepi.resources.planetlab.tap.PlanetlabTap.gre_connect">
500 <tt class="descname">gre_connect</tt><big>(</big><em>remote_endpoint</em>, <em>connection_app_home</em>, <em>connection_run_home</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/tap.html#PlanetlabTap.gre_connect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.tap.PlanetlabTap.gre_connect" title="Permalink to this definition">¶</a></dt>
501 <dd></dd></dl>
502
503 <dl class="attribute">
504 <dt id="nepi.resources.planetlab.tap.PlanetlabTap.node">
505 <tt class="descname">node</tt><a class="reference internal" href="../_modules/nepi/resources/planetlab/tap.html#PlanetlabTap.node"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.tap.PlanetlabTap.node" title="Permalink to this definition">¶</a></dt>
506 <dd></dd></dl>
507
508 <dl class="method">
509 <dt id="nepi.resources.planetlab.tap.PlanetlabTap.upload_sources">
510 <tt class="descname">upload_sources</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/tap.html#PlanetlabTap.upload_sources"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.tap.PlanetlabTap.upload_sources" title="Permalink to this definition">¶</a></dt>
511 <dd></dd></dl>
512
513 <dl class="method">
514 <dt id="nepi.resources.planetlab.tap.PlanetlabTap.upload_start_command">
515 <tt class="descname">upload_start_command</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/tap.html#PlanetlabTap.upload_start_command"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.tap.PlanetlabTap.upload_start_command" title="Permalink to this definition">¶</a></dt>
516 <dd></dd></dl>
517
518 <dl class="method">
519 <dt id="nepi.resources.planetlab.tap.PlanetlabTap.valid_connection">
520 <tt class="descname">valid_connection</tt><big>(</big><em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/tap.html#PlanetlabTap.valid_connection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.tap.PlanetlabTap.valid_connection" title="Permalink to this definition">¶</a></dt>
521 <dd></dd></dl>
522
523 <dl class="attribute">
524 <dt id="nepi.resources.planetlab.tap.PlanetlabTap.vif_name_file">
525 <tt class="descname">vif_name_file</tt><a class="reference internal" href="../_modules/nepi/resources/planetlab/tap.html#PlanetlabTap.vif_name_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.tap.PlanetlabTap.vif_name_file" title="Permalink to this definition">¶</a></dt>
526 <dd></dd></dl>
527
528 <dl class="method">
529 <dt id="nepi.resources.planetlab.tap.PlanetlabTap.wait_vif_name">
530 <tt class="descname">wait_vif_name</tt><big>(</big><em>exec_run_home=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/tap.html#PlanetlabTap.wait_vif_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.tap.PlanetlabTap.wait_vif_name" title="Permalink to this definition">¶</a></dt>
531 <dd><p>Waits until the vif_name file for the command is generated, 
532 and returns the vif_name for the device</p>
533 </dd></dl>
534
535 </dd></dl>
536
537 </div>
538 <div class="section" id="module-nepi.resources.planetlab.tun">
539 <span id="nepi-resources-planetlab-tun-module"></span><h2>nepi.resources.planetlab.tun module<a class="headerlink" href="#module-nepi.resources.planetlab.tun" title="Permalink to this headline">¶</a></h2>
540 <dl class="class">
541 <dt id="nepi.resources.planetlab.tun.PlanetlabTun">
542 <em class="property">class </em><tt class="descclassname">nepi.resources.planetlab.tun.</tt><tt class="descname">PlanetlabTun</tt><big>(</big><em>ec</em>, <em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/tun.html#PlanetlabTun"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.tun.PlanetlabTun" title="Permalink to this definition">¶</a></dt>
543 <dd><p>Bases: <a class="reference internal" href="#nepi.resources.planetlab.tap.PlanetlabTap" title="nepi.resources.planetlab.tap.PlanetlabTap"><tt class="xref py py-class docutils literal"><span class="pre">nepi.resources.planetlab.tap.PlanetlabTap</span></tt></a></p>
544 </dd></dl>
545
546 </div>
547 <div class="section" id="module-nepi.resources.planetlab.vroute">
548 <span id="nepi-resources-planetlab-vroute-module"></span><h2>nepi.resources.planetlab.vroute module<a class="headerlink" href="#module-nepi.resources.planetlab.vroute" title="Permalink to this headline">¶</a></h2>
549 <dl class="class">
550 <dt id="nepi.resources.planetlab.vroute.PlanetlabVroute">
551 <em class="property">class </em><tt class="descclassname">nepi.resources.planetlab.vroute.</tt><tt class="descname">PlanetlabVroute</tt><big>(</big><em>ec</em>, <em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/vroute.html#PlanetlabVroute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.vroute.PlanetlabVroute" title="Permalink to this definition">¶</a></dt>
552 <dd><p>Bases: <a class="reference internal" href="nepi.resources.linux.html#nepi.resources.linux.application.LinuxApplication" title="nepi.resources.linux.application.LinuxApplication"><tt class="xref py py-class docutils literal"><span class="pre">nepi.resources.linux.application.LinuxApplication</span></tt></a></p>
553 <dl class="method">
554 <dt id="nepi.resources.planetlab.vroute.PlanetlabVroute.do_deploy">
555 <tt class="descname">do_deploy</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/vroute.html#PlanetlabVroute.do_deploy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.vroute.PlanetlabVroute.do_deploy" title="Permalink to this definition">¶</a></dt>
556 <dd></dd></dl>
557
558 <dl class="method">
559 <dt id="nepi.resources.planetlab.vroute.PlanetlabVroute.do_release">
560 <tt class="descname">do_release</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/vroute.html#PlanetlabVroute.do_release"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.vroute.PlanetlabVroute.do_release" title="Permalink to this definition">¶</a></dt>
561 <dd></dd></dl>
562
563 <dl class="method">
564 <dt id="nepi.resources.planetlab.vroute.PlanetlabVroute.do_start">
565 <tt class="descname">do_start</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/vroute.html#PlanetlabVroute.do_start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.vroute.PlanetlabVroute.do_start" title="Permalink to this definition">¶</a></dt>
566 <dd></dd></dl>
567
568 <dl class="method">
569 <dt id="nepi.resources.planetlab.vroute.PlanetlabVroute.do_stop">
570 <tt class="descname">do_stop</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/vroute.html#PlanetlabVroute.do_stop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.vroute.PlanetlabVroute.do_stop" title="Permalink to this definition">¶</a></dt>
571 <dd></dd></dl>
572
573 <dl class="attribute">
574 <dt id="nepi.resources.planetlab.vroute.PlanetlabVroute.node">
575 <tt class="descname">node</tt><a class="reference internal" href="../_modules/nepi/resources/planetlab/vroute.html#PlanetlabVroute.node"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.vroute.PlanetlabVroute.node" title="Permalink to this definition">¶</a></dt>
576 <dd></dd></dl>
577
578 <dl class="attribute">
579 <dt id="nepi.resources.planetlab.vroute.PlanetlabVroute.tap">
580 <tt class="descname">tap</tt><a class="reference internal" href="../_modules/nepi/resources/planetlab/vroute.html#PlanetlabVroute.tap"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.vroute.PlanetlabVroute.tap" title="Permalink to this definition">¶</a></dt>
581 <dd></dd></dl>
582
583 <dl class="method">
584 <dt id="nepi.resources.planetlab.vroute.PlanetlabVroute.upload_sources">
585 <tt class="descname">upload_sources</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/vroute.html#PlanetlabVroute.upload_sources"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.vroute.PlanetlabVroute.upload_sources" title="Permalink to this definition">¶</a></dt>
586 <dd></dd></dl>
587
588 <dl class="method">
589 <dt id="nepi.resources.planetlab.vroute.PlanetlabVroute.upload_start_command">
590 <tt class="descname">upload_start_command</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/vroute.html#PlanetlabVroute.upload_start_command"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.vroute.PlanetlabVroute.upload_start_command" title="Permalink to this definition">¶</a></dt>
591 <dd></dd></dl>
592
593 <dl class="method">
594 <dt id="nepi.resources.planetlab.vroute.PlanetlabVroute.valid_connection">
595 <tt class="descname">valid_connection</tt><big>(</big><em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/vroute.html#PlanetlabVroute.valid_connection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.vroute.PlanetlabVroute.valid_connection" title="Permalink to this definition">¶</a></dt>
596 <dd></dd></dl>
597
598 </dd></dl>
599
600 </div>
601 <div class="section" id="module-nepi.resources.planetlab">
602 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-nepi.resources.planetlab" title="Permalink to this headline">¶</a></h2>
603 </div>
604 </div>
605
606
607           </div>
608         </div>
609       </div>
610       <div class="clearer"></div>
611     </div>
612     <div class="related">
613       <h3>Navigation</h3>
614       <ul>
615         <li class="right" style="margin-right: 10px">
616           <a href="../genindex.html" title="General Index"
617              >index</a></li>
618         <li class="right" >
619           <a href="../py-modindex.html" title="Python Module Index"
620              >modules</a> |</li>
621         <li><a href="../index.html">NEPI 3.0 documentation</a> &raquo;</li> 
622       </ul>
623     </div>
624     <div class="footer">
625         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
626       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
627     </div>
628   </body>
629 </html>