1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5 <html xmlns="http://www.w3.org/1999/xhtml">
7 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9 <title>nepi.resources.planetlab.openvswitch package — NEPI 3.0 documentation</title>
11 <link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
12 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
14 <script type="text/javascript">
15 var DOCUMENTATION_OPTIONS = {
18 COLLAPSE_INDEX: false,
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" />
32 <li class="right" style="margin-right: 10px">
33 <a href="../genindex.html" title="General Index"
34 accesskey="I">index</a></li>
36 <a href="../py-modindex.html" title="Python Module Index"
38 <li><a href="../index.html">NEPI 3.0 documentation</a> »</li>
41 <div class="sphinxsidebar">
42 <div class="sphinxsidebarwrapper">
43 <h3><a href="../index.html">Table Of Contents</a></h3>
45 <li><a class="reference internal" href="#">nepi.resources.planetlab.openvswitch package</a><ul>
46 <li><a class="reference internal" href="#submodules">Submodules</a></li>
47 <li><a class="reference internal" href="#module-nepi.resources.planetlab.openvswitch.ovs">nepi.resources.planetlab.openvswitch.ovs module</a></li>
48 <li><a class="reference internal" href="#module-nepi.resources.planetlab.openvswitch.ovsport">nepi.resources.planetlab.openvswitch.ovsport module</a></li>
49 <li><a class="reference internal" href="#module-nepi.resources.planetlab.openvswitch">Module contents</a></li>
55 <ul class="this-page-menu">
56 <li><a href="../_sources/_layout/nepi.resources.planetlab.openvswitch.txt"
57 rel="nofollow">Show Source</a></li>
59 <div id="searchbox" style="display: none">
61 <form class="search" action="../search.html" method="get">
62 <input type="text" name="q" />
63 <input type="submit" value="Go" />
64 <input type="hidden" name="check_keywords" value="yes" />
65 <input type="hidden" name="area" value="default" />
67 <p class="searchtip" style="font-size: 90%">
68 Enter search terms or a module, class or function name.
71 <script type="text/javascript">$('#searchbox').show(0);</script>
75 <div class="document">
76 <div class="documentwrapper">
77 <div class="bodywrapper">
80 <div class="section" id="nepi-resources-planetlab-openvswitch-package">
81 <h1>nepi.resources.planetlab.openvswitch package<a class="headerlink" href="#nepi-resources-planetlab-openvswitch-package" title="Permalink to this headline">¶</a></h1>
82 <div class="section" id="submodules">
83 <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
85 <div class="section" id="module-nepi.resources.planetlab.openvswitch.ovs">
86 <span id="nepi-resources-planetlab-openvswitch-ovs-module"></span><h2>nepi.resources.planetlab.openvswitch.ovs module<a class="headerlink" href="#module-nepi.resources.planetlab.openvswitch.ovs" title="Permalink to this headline">¶</a></h2>
88 <dt id="nepi.resources.planetlab.openvswitch.ovs.PlanetlabOVSSwitch">
89 <em class="property">class </em><tt class="descclassname">nepi.resources.planetlab.openvswitch.ovs.</tt><tt class="descname">PlanetlabOVSSwitch</tt><big>(</big><em>ec</em>, <em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/openvswitch/ovs.html#PlanetlabOVSSwitch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.openvswitch.ovs.PlanetlabOVSSwitch" title="Permalink to this definition">¶</a></dt>
90 <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>
93 <tt class="descname">Class Args :</tt></dt>
94 <dd><table class="docutils field-list" frame="void" rules="none">
95 <col class="field-name" />
96 <col class="field-body" />
98 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
99 <li><strong>ec</strong> (<em>ExperimentController</em>) – The Experiment controller</li>
100 <li><strong>guid</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – guid of the RM</li>
109 <dt id="nepi.resources.planetlab.openvswitch.ovs.PlanetlabOVSSwitch.assign_controller">
110 <tt class="descname">assign_controller</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/openvswitch/ovs.html#PlanetlabOVSSwitch.assign_controller"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.openvswitch.ovs.PlanetlabOVSSwitch.assign_controller" title="Permalink to this definition">¶</a></dt>
111 <dd><p>Set the controller IP</p>
115 <dt id="nepi.resources.planetlab.openvswitch.ovs.PlanetlabOVSSwitch.check_sliver_ovs">
116 <tt class="descname">check_sliver_ovs</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/openvswitch/ovs.html#PlanetlabOVSSwitch.check_sliver_ovs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.openvswitch.ovs.PlanetlabOVSSwitch.check_sliver_ovs" title="Permalink to this definition">¶</a></dt>
117 <dd><p>Check if sliver-ovs exists. If it does not exist, the execution is stopped</p>
121 <dt id="nepi.resources.planetlab.openvswitch.ovs.PlanetlabOVSSwitch.create_bridge">
122 <tt class="descname">create_bridge</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/openvswitch/ovs.html#PlanetlabOVSSwitch.create_bridge"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.openvswitch.ovs.PlanetlabOVSSwitch.create_bridge" title="Permalink to this definition">¶</a></dt>
123 <dd><p>Create the bridge/switch and check error during SSH connection</p>
127 <dt id="nepi.resources.planetlab.openvswitch.ovs.PlanetlabOVSSwitch.do_deploy">
128 <tt class="descname">do_deploy</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/openvswitch/ovs.html#PlanetlabOVSSwitch.do_deploy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.openvswitch.ovs.PlanetlabOVSSwitch.do_deploy" title="Permalink to this definition">¶</a></dt>
129 <dd><p>Deploy the OVS Switch : Turn on the server, create the bridges
130 and assign the controller</p>
134 <dt id="nepi.resources.planetlab.openvswitch.ovs.PlanetlabOVSSwitch.do_provision">
135 <tt class="descname">do_provision</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/openvswitch/ovs.html#PlanetlabOVSSwitch.do_provision"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.openvswitch.ovs.PlanetlabOVSSwitch.do_provision" title="Permalink to this definition">¶</a></dt>
139 <dt id="nepi.resources.planetlab.openvswitch.ovs.PlanetlabOVSSwitch.do_release">
140 <tt class="descname">do_release</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/openvswitch/ovs.html#PlanetlabOVSSwitch.do_release"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.openvswitch.ovs.PlanetlabOVSSwitch.do_release" title="Permalink to this definition">¶</a></dt>
141 <dd><p>Delete the bridge and close the server.</p>
143 <div></div></blockquote>
144 <p>to be released before releasing itself</p>
147 <dl class="attribute">
148 <dt id="nepi.resources.planetlab.openvswitch.ovs.PlanetlabOVSSwitch.node">
149 <tt class="descname">node</tt><a class="reference internal" href="../_modules/nepi/resources/planetlab/openvswitch/ovs.html#PlanetlabOVSSwitch.node"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.openvswitch.ovs.PlanetlabOVSSwitch.node" title="Permalink to this definition">¶</a></dt>
150 <dd><p>Node wthat run the switch</p>
154 <dt id="nepi.resources.planetlab.openvswitch.ovs.PlanetlabOVSSwitch.ovs_status">
155 <tt class="descname">ovs_status</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/openvswitch/ovs.html#PlanetlabOVSSwitch.ovs_status"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.openvswitch.ovs.PlanetlabOVSSwitch.ovs_status" title="Permalink to this definition">¶</a></dt>
156 <dd><p>Print the status of the bridge</p>
160 <dt id="nepi.resources.planetlab.openvswitch.ovs.PlanetlabOVSSwitch.servers_on">
161 <tt class="descname">servers_on</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/openvswitch/ovs.html#PlanetlabOVSSwitch.servers_on"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.openvswitch.ovs.PlanetlabOVSSwitch.servers_on" title="Permalink to this definition">¶</a></dt>
162 <dd><p>Start the openvswitch servers and check it</p>
166 <dt id="nepi.resources.planetlab.openvswitch.ovs.PlanetlabOVSSwitch.valid_connection">
167 <tt class="descname">valid_connection</tt><big>(</big><em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/openvswitch/ovs.html#PlanetlabOVSSwitch.valid_connection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.openvswitch.ovs.PlanetlabOVSSwitch.valid_connection" title="Permalink to this definition">¶</a></dt>
168 <dd><p>Check if the connection with the guid in parameter is possible. Only meaningful connections are allowed.</p>
169 <table class="docutils field-list" frame="void" rules="none">
170 <col class="field-name" />
171 <col class="field-body" />
173 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>guid</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – Guid of the current RM</td>
175 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">Boolean</td>
184 <div class="section" id="module-nepi.resources.planetlab.openvswitch.ovsport">
185 <span id="nepi-resources-planetlab-openvswitch-ovsport-module"></span><h2>nepi.resources.planetlab.openvswitch.ovsport module<a class="headerlink" href="#module-nepi.resources.planetlab.openvswitch.ovsport" title="Permalink to this headline">¶</a></h2>
187 <dt id="nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort">
188 <em class="property">class </em><tt class="descclassname">nepi.resources.planetlab.openvswitch.ovsport.</tt><tt class="descname">PlanetlabOVSPort</tt><big>(</big><em>ec</em>, <em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/openvswitch/ovsport.html#PlanetlabOVSPort"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort" title="Permalink to this definition">¶</a></dt>
189 <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>
192 <tt class="descname">Class Args :</tt></dt>
193 <dd><table class="docutils field-list" frame="void" rules="none">
194 <col class="field-name" />
195 <col class="field-body" />
197 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
198 <li><strong>ec</strong> (<em>ExperimentController</em>) – The Experiment controller</li>
199 <li><strong>guid</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – guid of the RM</li>
208 <dt id="nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.check_status">
209 <tt class="descname">check_status</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/openvswitch/ovsport.html#PlanetlabOVSPort.check_status"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.check_status" title="Permalink to this definition">¶</a></dt>
213 <dt id="nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.create_port">
214 <tt class="descname">create_port</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/openvswitch/ovsport.html#PlanetlabOVSPort.create_port"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.create_port" title="Permalink to this definition">¶</a></dt>
215 <dd><p>Create the desired port</p>
219 <dt id="nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.do_deploy">
220 <tt class="descname">do_deploy</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/openvswitch/ovsport.html#PlanetlabOVSPort.do_deploy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.do_deploy" title="Permalink to this definition">¶</a></dt>
221 <dd><p>Deploy the OVS port after the OVS Switch</p>
225 <dt id="nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.do_provision">
226 <tt class="descname">do_provision</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/openvswitch/ovsport.html#PlanetlabOVSPort.do_provision"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.do_provision" title="Permalink to this definition">¶</a></dt>
230 <dt id="nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.do_release">
231 <tt class="descname">do_release</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/openvswitch/ovsport.html#PlanetlabOVSPort.do_release"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.do_release" title="Permalink to this definition">¶</a></dt>
232 <dd><p>Delete the port on the OVSwitch. It needs to wait for the tunnel
237 <dt id="nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.establish_udp_connection">
238 <tt class="descname">establish_udp_connection</tt><big>(</big><em>remote_endpoint</em>, <em>connection_app_home</em>, <em>connection_run_home</em>, <em>port</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/openvswitch/ovsport.html#PlanetlabOVSPort.establish_udp_connection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.establish_udp_connection" title="Permalink to this definition">¶</a></dt>
242 <dt id="nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.initiate_udp_connection">
243 <tt class="descname">initiate_udp_connection</tt><big>(</big><em>remote_endpoint</em>, <em>connection_app_home</em>, <em>connection_run_home</em>, <em>cipher</em>, <em>cipher_key</em>, <em>bwlimit</em>, <em>txqueuelen</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/openvswitch/ovsport.html#PlanetlabOVSPort.initiate_udp_connection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.initiate_udp_connection" title="Permalink to this definition">¶</a></dt>
244 <dd><p>Get the local_endpoint of the port</p>
247 <dl class="attribute">
248 <dt id="nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.node">
249 <tt class="descname">node</tt><a class="reference internal" href="../_modules/nepi/resources/planetlab/openvswitch/ovsport.html#PlanetlabOVSPort.node"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.node" title="Permalink to this definition">¶</a></dt>
250 <dd><p>Node that run the switch and the ports</p>
253 <dl class="attribute">
254 <dt id="nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.ovsswitch">
255 <tt class="descname">ovsswitch</tt><a class="reference internal" href="../_modules/nepi/resources/planetlab/openvswitch/ovsport.html#PlanetlabOVSPort.ovsswitch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.ovsswitch" title="Permalink to this definition">¶</a></dt>
256 <dd><p>Switch where the port is created</p>
259 <dl class="attribute">
260 <dt id="nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.port_number">
261 <tt class="descname">port_number</tt><a class="reference internal" href="../_modules/nepi/resources/planetlab/openvswitch/ovsport.html#PlanetlabOVSPort.port_number"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.port_number" title="Permalink to this definition">¶</a></dt>
265 <dt id="nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.terminate_connection">
266 <tt class="descname">terminate_connection</tt><big>(</big><em>endpoint</em>, <em>connection_app_home</em>, <em>connection_run_home</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/openvswitch/ovsport.html#PlanetlabOVSPort.terminate_connection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.terminate_connection" title="Permalink to this definition">¶</a></dt>
270 <dt id="nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.valid_connection">
271 <tt class="descname">valid_connection</tt><big>(</big><em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/openvswitch/ovsport.html#PlanetlabOVSPort.valid_connection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.valid_connection" title="Permalink to this definition">¶</a></dt>
272 <dd><p>Check if the connection is available.</p>
273 <table class="docutils field-list" frame="void" rules="none">
274 <col class="field-name" />
275 <col class="field-body" />
277 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>guid</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – Guid of the current RM</td>
279 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">Boolean</td>
286 <dt id="nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.verify_connection">
287 <tt class="descname">verify_connection</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/openvswitch/ovsport.html#PlanetlabOVSPort.verify_connection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.verify_connection" title="Permalink to this definition">¶</a></dt>
293 <div class="section" id="module-nepi.resources.planetlab.openvswitch">
294 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-nepi.resources.planetlab.openvswitch" title="Permalink to this headline">¶</a></h2>
302 <div class="clearer"></div>
304 <div class="related">
307 <li class="right" style="margin-right: 10px">
308 <a href="../genindex.html" title="General Index"
311 <a href="../py-modindex.html" title="Python Module Index"
313 <li><a href="../index.html">NEPI 3.0 documentation</a> »</li>
317 © Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
318 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.