blob: 3a1086ee2cb08e88113e95a75f6ff2268665597a [file] [log] [blame]
adminbae64d82013-08-01 10:50:15 -07001<?xml version="1.0" encoding="ascii"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6 <title>TestON.drivers.common.cli.emulator.poxclidriver.PoxCliDriver</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
9</head>
10
11<body bgcolor="white" text="black" link="blue" vlink="#204080"
12 alink="#204080">
13<!-- ==================== NAVIGATION BAR ==================== -->
14<table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
16 <tr valign="middle">
17 <!-- Home link -->
18 <th>&nbsp;&nbsp;&nbsp;<a
19 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
20
21 <!-- Tree link -->
22 <th>&nbsp;&nbsp;&nbsp;<a
23 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
24
25 <!-- Index link -->
26 <th>&nbsp;&nbsp;&nbsp;<a
27 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28
29 <!-- Help link -->
30 <th>&nbsp;&nbsp;&nbsp;<a
31 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
32
Jon Halla1cdd892015-08-10 13:36:28 -070033 <!-- Project homepage -->
34 <th class="navbar" align="right" width="100%">
35 <table border="0" cellpadding="0" cellspacing="0">
36 <tr><th class="navbar" align="center"
37 >TestON</th>
38 </tr></table></th>
adminbae64d82013-08-01 10:50:15 -070039 </tr>
40</table>
41<table width="100%" cellpadding="0" cellspacing="0">
42 <tr valign="top">
43 <td width="100%">
44 <span class="breadcrumbs">
45 <a href="TestON-module.html">Package&nbsp;TestON</a> ::
46 <a href="TestON.drivers-module.html">Package&nbsp;drivers</a> ::
47 <a href="TestON.drivers.common-module.html">Package&nbsp;common</a> ::
48 <a href="TestON.drivers.common.cli-module.html">Package&nbsp;cli</a> ::
49 <a href="TestON.drivers.common.cli.emulator-module.html">Package&nbsp;emulator</a> ::
50 <a href="TestON.drivers.common.cli.emulator.poxclidriver-module.html">Module&nbsp;poxclidriver</a> ::
51 Class&nbsp;PoxCliDriver
52 </span>
53 </td>
54 <td>
55 <table cellpadding="0" cellspacing="0">
56 <!-- hide/show private -->
57 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
58 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
59 <tr><td align="right"><span class="options"
60 >[<a href="frames.html" target="_top">frames</a
61 >]&nbsp;|&nbsp;<a href="TestON.drivers.common.cli.emulator.poxclidriver.PoxCliDriver-class.html"
62 target="_top">no&nbsp;frames</a>]</span></td></tr>
63 </table>
64 </td>
65 </tr>
66</table>
67<!-- ==================== CLASS DESCRIPTION ==================== -->
68<h1 class="epydoc">Class PoxCliDriver</h1><p class="nomargin-top"><span class="codelink"><a href="TestON.drivers.common.cli.emulator.poxclidriver-pysrc.html#PoxCliDriver">source&nbsp;code</a></span></p>
Jon Halla1cdd892015-08-10 13:36:28 -070069<center>
70<center> <map id="class_hierarchy_for_poxclidriv" name="class_hierarchy_for_poxclidriv">
71<area shape="rect" id="node1" href="TestON.drivers.common.cli.emulator.poxclidriver.PoxCliDriver-class.html" title="PoxCliDriver" alt="" coords="5,6,101,31"/>
72<area shape="rect" id="node2" href="TestON.drivers.common.cli.emulatordriver.Emulator-class.html" title="emulatordriver.Emulator" alt="" coords="125,6,284,31"/>
73<area shape="rect" id="node3" href="TestON.drivers.common.clidriver.CLI-class.html" title="clidriver.CLI" alt="" coords="310,6,401,31"/>
74<area shape="rect" id="node4" href="javascript:void(0);" title="component.Component" alt="" coords="427,6,584,31"/>
75</map>
76 <img src="class_hierarchy_for_poxclidriv.gif" alt='' usemap="#class_hierarchy_for_poxclidriv" ismap="ismap" class="graph-without-title" />
77</center>
78</center>
adminbae64d82013-08-01 10:50:15 -070079<hr />
80<p>PoxCliDriver driver provides the basic functions of POX controller</p>
81
82<!-- ==================== INSTANCE METHODS ==================== -->
83<a name="section-InstanceMethods"></a>
84<table class="summary" border="1" cellpadding="3"
85 cellspacing="0" width="100%" bgcolor="white">
86<tr bgcolor="#70b0f0" class="table-header">
87 <td colspan="2" class="table-header">
88 <table border="0" cellpadding="0" cellspacing="0" width="100%">
89 <tr valign="top">
90 <td align="left"><span class="table-header">Instance Methods</span></td>
91 <td align="right" valign="top"
92 ><span class="options">[<a href="#section-InstanceMethods"
93 class="privatelink" onclick="toggle_private();"
94 >hide private</a>]</span></td>
95 </tr>
96 </table>
97 </td>
98</tr>
99<tr>
100 <td width="15%" align="right" valign="top" class="summary">
101 <span class="summary-type">&nbsp;</span>
102 </td><td class="summary">
103 <table width="100%" cellpadding="0" cellspacing="0" border="0">
104 <tr>
105 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.poxclidriver.PoxCliDriver-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>)</span><br />
Jon Halla1cdd892015-08-10 13:36:28 -0700106 x.__init__(...) initializes x; see help(type(x)) for signature</td>
adminbae64d82013-08-01 10:50:15 -0700107 <td align="right" valign="top">
108 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.poxclidriver-pysrc.html#PoxCliDriver.__init__">source&nbsp;code</a></span>
109
110 </td>
111 </tr>
112 </table>
113
114 </td>
115 </tr>
116<tr>
117 <td width="15%" align="right" valign="top" class="summary">
118 <span class="summary-type">&nbsp;</span>
119 </td><td class="summary">
120 <table width="100%" cellpadding="0" cellspacing="0" border="0">
121 <tr>
122 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.poxclidriver.PoxCliDriver-class.html#connect" class="summary-sig-name">connect</a>(<span class="summary-sig-arg">self</span>,
123 <span class="summary-sig-arg">**connectargs</span>)</span><br />
124 this subroutine is to launch pox controller .</td>
125 <td align="right" valign="top">
126 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.poxclidriver-pysrc.html#PoxCliDriver.connect">source&nbsp;code</a></span>
127
128 </td>
129 </tr>
130 </table>
131
132 </td>
133 </tr>
134<tr>
135 <td width="15%" align="right" valign="top" class="summary">
136 <span class="summary-type">&nbsp;</span>
137 </td><td class="summary">
138 <table width="100%" cellpadding="0" cellspacing="0" border="0">
139 <tr>
140 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.poxclidriver.PoxCliDriver-class.html#disconnect" class="summary-sig-name">disconnect</a>(<span class="summary-sig-arg">self</span>,
141 <span class="summary-sig-arg">handle</span>)</span></td>
142 <td align="right" valign="top">
143 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.poxclidriver-pysrc.html#PoxCliDriver.disconnect">source&nbsp;code</a></span>
144
145 </td>
146 </tr>
147 </table>
148
149 </td>
150 </tr>
151<tr>
152 <td width="15%" align="right" valign="top" class="summary">
153 <span class="summary-type">&nbsp;</span>
154 </td><td class="summary">
155 <table width="100%" cellpadding="0" cellspacing="0" border="0">
156 <tr>
157 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.poxclidriver.PoxCliDriver-class.html#get_version" class="summary-sig-name">get_version</a>(<span class="summary-sig-arg">self</span>)</span></td>
158 <td align="right" valign="top">
159 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.poxclidriver-pysrc.html#PoxCliDriver.get_version">source&nbsp;code</a></span>
160
161 </td>
162 </tr>
163 </table>
164
165 </td>
166 </tr>
167<tr>
168 <td width="15%" align="right" valign="top" class="summary">
169 <span class="summary-type">&nbsp;</span>
170 </td><td class="summary">
171 <table width="100%" cellpadding="0" cellspacing="0" border="0">
172 <tr>
173 <td><span class="summary-sig"><a name="getcmd"></a><span class="summary-sig-name">getcmd</span>(<span class="summary-sig-arg">self</span>,
174 <span class="summary-sig-arg">options</span>)</span></td>
175 <td align="right" valign="top">
176 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.poxclidriver-pysrc.html#PoxCliDriver.getcmd">source&nbsp;code</a></span>
177
178 </td>
179 </tr>
180 </table>
181
182 </td>
183 </tr>
Jon Halla1cdd892015-08-10 13:36:28 -0700184<tr>
185 <td width="15%" align="right" valign="top" class="summary">
186 <span class="summary-type">&nbsp;</span>
187 </td><td class="summary">
188 <table width="100%" cellpadding="0" cellspacing="0" border="0">
189 <tr>
190 <td><span class="summary-sig"><a href="TestON.drivers.common.clidriver.CLI-class.html#execute" class="summary-sig-name">execute</a>(<span class="summary-sig-arg">self</span>,
191 <span class="summary-sig-arg">**execparams</span>)</span><br />
192 It facilitates the command line execution of a given command.
193 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
194 <td align="right" valign="top">
195 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.execute">source&nbsp;code</a></span>
196
197 </td>
198 </tr>
199 </table>
200
201 </td>
202 </tr>
203<tr>
204 <td width="15%" align="right" valign="top" class="summary">
205 <span class="summary-type">&nbsp;</span>
206 </td><td class="summary">
207 <table width="100%" cellpadding="0" cellspacing="0" border="0">
208 <tr>
209 <td><span class="summary-sig"><a name="onfail"></a><span class="summary-sig-name">onfail</span>(<span class="summary-sig-arg">self</span>)</span>
210 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
211 <td align="right" valign="top">
212 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.onfail">source&nbsp;code</a></span>
213
214 </td>
215 </tr>
216 </table>
217
218 </td>
219 </tr>
220<tr>
221 <td width="15%" align="right" valign="top" class="summary">
222 <span class="summary-type">&nbsp;</span>
223 </td><td class="summary">
224 <table width="100%" cellpadding="0" cellspacing="0" border="0">
225 <tr>
226 <td><span class="summary-sig"><a name="remove_contol_chars"></a><span class="summary-sig-name">remove_contol_chars</span>(<span class="summary-sig-arg">self</span>,
227 <span class="summary-sig-arg">response</span>)</span>
228 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
229 <td align="right" valign="top">
230 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.remove_contol_chars">source&nbsp;code</a></span>
231
232 </td>
233 </tr>
234 </table>
235
236 </td>
237 </tr>
238<tr>
239 <td width="15%" align="right" valign="top" class="summary">
240 <span class="summary-type">&nbsp;</span>
241 </td><td class="summary">
242 <table width="100%" cellpadding="0" cellspacing="0" border="0">
243 <tr>
244 <td><span class="summary-sig"><a name="runAsSudoUser"></a><span class="summary-sig-name">runAsSudoUser</span>(<span class="summary-sig-arg">self</span>,
245 <span class="summary-sig-arg">handle</span>,
246 <span class="summary-sig-arg">pwd</span>,
247 <span class="summary-sig-arg">default</span>)</span>
248 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
249 <td align="right" valign="top">
250 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.runAsSudoUser">source&nbsp;code</a></span>
251
252 </td>
253 </tr>
254 </table>
255
256 </td>
257 </tr>
258<tr>
259 <td width="15%" align="right" valign="top" class="summary">
260 <span class="summary-type">&nbsp;</span>
261 </td><td class="summary">
262 <table width="100%" cellpadding="0" cellspacing="0" border="0">
263 <tr>
264 <td><span class="summary-sig"><a href="TestON.drivers.common.clidriver.CLI-class.html#secureCopy" class="summary-sig-name">secureCopy</a>(<span class="summary-sig-arg">self</span>,
265 <span class="summary-sig-arg">user_name</span>,
266 <span class="summary-sig-arg">ip_address</span>,
267 <span class="summary-sig-arg">filepath</span>,
268 <span class="summary-sig-arg">pwd</span>,
269 <span class="summary-sig-arg">dst_path</span>)</span><br />
270 Connection will establish to the remote host using ssh.
271 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
272 <td align="right" valign="top">
273 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.secureCopy">source&nbsp;code</a></span>
274
275 </td>
276 </tr>
277 </table>
278
279 </td>
280 </tr>
adminbae64d82013-08-01 10:50:15 -0700281 <tr>
282 <td colspan="2" class="summary">
Jon Halla1cdd892015-08-10 13:36:28 -0700283 <p class="indent-wrapped-lines"><b>Inherited from <code>component.Component</code></b>:
284 <code>__getattr__</code>,
285 <code>cleanup</code>,
286 <code>close_log_handles</code>,
287 <code>config</code>,
288 <code>experimentRun</code>,
289 <code>log</code>
adminbae64d82013-08-01 10:50:15 -0700290 </p>
291 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
292 <code>__delattr__</code>,
293 <code>__format__</code>,
294 <code>__getattribute__</code>,
295 <code>__hash__</code>,
296 <code>__new__</code>,
297 <code>__reduce__</code>,
298 <code>__reduce_ex__</code>,
299 <code>__repr__</code>,
300 <code>__setattr__</code>,
301 <code>__sizeof__</code>,
302 <code>__str__</code>,
303 <code>__subclasshook__</code>
304 </p>
305 </td>
306 </tr>
307</table>
308<!-- ==================== PROPERTIES ==================== -->
309<a name="section-Properties"></a>
310<table class="summary" border="1" cellpadding="3"
311 cellspacing="0" width="100%" bgcolor="white">
312<tr bgcolor="#70b0f0" class="table-header">
313 <td colspan="2" class="table-header">
314 <table border="0" cellpadding="0" cellspacing="0" width="100%">
315 <tr valign="top">
316 <td align="left"><span class="table-header">Properties</span></td>
317 <td align="right" valign="top"
318 ><span class="options">[<a href="#section-Properties"
319 class="privatelink" onclick="toggle_private();"
320 >hide private</a>]</span></td>
321 </tr>
322 </table>
323 </td>
324</tr>
325 <tr>
326 <td colspan="2" class="summary">
327 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
328 <code>__class__</code>
329 </p>
330 </td>
331 </tr>
332</table>
333<!-- ==================== METHOD DETAILS ==================== -->
334<a name="section-MethodDetails"></a>
335<table class="details" border="1" cellpadding="3"
336 cellspacing="0" width="100%" bgcolor="white">
337<tr bgcolor="#70b0f0" class="table-header">
338 <td colspan="2" class="table-header">
339 <table border="0" cellpadding="0" cellspacing="0" width="100%">
340 <tr valign="top">
341 <td align="left"><span class="table-header">Method Details</span></td>
342 <td align="right" valign="top"
343 ><span class="options">[<a href="#section-MethodDetails"
344 class="privatelink" onclick="toggle_private();"
345 >hide private</a>]</span></td>
346 </tr>
347 </table>
348 </td>
349</tr>
350</table>
351<a name="__init__"></a>
352<div>
353<table class="details" border="1" cellpadding="3"
354 cellspacing="0" width="100%" bgcolor="white">
355<tr><td>
356 <table width="100%" cellpadding="0" cellspacing="0" border="0">
357 <tr valign="top"><td>
358 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>)</span>
359 <br /><em class="fname">(Constructor)</em>
360 </h3>
361 </td><td align="right" valign="top"
362 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.poxclidriver-pysrc.html#PoxCliDriver.__init__">source&nbsp;code</a></span>&nbsp;
363 </td>
364 </tr></table>
365
Jon Halla1cdd892015-08-10 13:36:28 -0700366 <p>x.__init__(...) initializes x; see help(type(x)) for signature</p>
adminbae64d82013-08-01 10:50:15 -0700367 <dl class="fields">
368 <dt>Overrides:
369 object.__init__
370 <dd><em class="note">(inherited documentation)</em></dd>
371 </dt>
372 </dl>
373</td></tr></table>
374</div>
375<a name="connect"></a>
376<div>
377<table class="details" border="1" cellpadding="3"
378 cellspacing="0" width="100%" bgcolor="white">
379<tr><td>
380 <table width="100%" cellpadding="0" cellspacing="0" border="0">
381 <tr valign="top"><td>
382 <h3 class="epydoc"><span class="sig"><span class="sig-name">connect</span>(<span class="sig-arg">self</span>,
383 <span class="sig-arg">**connectargs</span>)</span>
384 </h3>
385 </td><td align="right" valign="top"
386 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.poxclidriver-pysrc.html#PoxCliDriver.connect">source&nbsp;code</a></span>&nbsp;
387 </td>
388 </tr></table>
389
390 <p>this subroutine is to launch pox controller . It must have arguments
391 as : user_name = host name , ip_address = ip address of the host , pwd =
392 password of host , options = it is a topology hash which will consists
393 the component's details for the test run</p>
394 <p>*** host is here a virtual mahine or system where pox framework
395 hierarchy exists</p>
396 <dl class="fields">
397 <dt>Overrides:
Jon Halla1cdd892015-08-10 13:36:28 -0700398 component.Component.connect
adminbae64d82013-08-01 10:50:15 -0700399 </dt>
400 </dl>
401</td></tr></table>
402</div>
403<a name="disconnect"></a>
404<div>
405<table class="details" border="1" cellpadding="3"
406 cellspacing="0" width="100%" bgcolor="white">
407<tr><td>
408 <table width="100%" cellpadding="0" cellspacing="0" border="0">
409 <tr valign="top"><td>
410 <h3 class="epydoc"><span class="sig"><span class="sig-name">disconnect</span>(<span class="sig-arg">self</span>,
411 <span class="sig-arg">handle</span>)</span>
412 </h3>
413 </td><td align="right" valign="top"
414 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.poxclidriver-pysrc.html#PoxCliDriver.disconnect">source&nbsp;code</a></span>&nbsp;
415 </td>
416 </tr></table>
417
418
419 <dl class="fields">
420 <dt>Overrides:
Jon Halla1cdd892015-08-10 13:36:28 -0700421 component.Component.disconnect
adminbae64d82013-08-01 10:50:15 -0700422 </dt>
423 </dl>
424</td></tr></table>
425</div>
426<a name="get_version"></a>
427<div>
428<table class="details" border="1" cellpadding="3"
429 cellspacing="0" width="100%" bgcolor="white">
430<tr><td>
431 <table width="100%" cellpadding="0" cellspacing="0" border="0">
432 <tr valign="top"><td>
433 <h3 class="epydoc"><span class="sig"><span class="sig-name">get_version</span>(<span class="sig-arg">self</span>)</span>
434 </h3>
435 </td><td align="right" valign="top"
436 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.poxclidriver-pysrc.html#PoxCliDriver.get_version">source&nbsp;code</a></span>&nbsp;
437 </td>
438 </tr></table>
439
440
441 <dl class="fields">
442 <dt>Overrides:
Jon Halla1cdd892015-08-10 13:36:28 -0700443 component.Component.get_version
adminbae64d82013-08-01 10:50:15 -0700444 </dt>
445 </dl>
446</td></tr></table>
447</div>
448<br />
449<!-- ==================== NAVIGATION BAR ==================== -->
450<table class="navbar" border="0" width="100%" cellpadding="0"
451 bgcolor="#a0c0ff" cellspacing="0">
452 <tr valign="middle">
453 <!-- Home link -->
454 <th>&nbsp;&nbsp;&nbsp;<a
455 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
456
457 <!-- Tree link -->
458 <th>&nbsp;&nbsp;&nbsp;<a
459 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
460
461 <!-- Index link -->
462 <th>&nbsp;&nbsp;&nbsp;<a
463 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
464
465 <!-- Help link -->
466 <th>&nbsp;&nbsp;&nbsp;<a
467 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
468
Jon Halla1cdd892015-08-10 13:36:28 -0700469 <!-- Project homepage -->
470 <th class="navbar" align="right" width="100%">
471 <table border="0" cellpadding="0" cellspacing="0">
472 <tr><th class="navbar" align="center"
473 >TestON</th>
474 </tr></table></th>
adminbae64d82013-08-01 10:50:15 -0700475 </tr>
476</table>
477<table border="0" cellpadding="0" cellspacing="0" width="100%%">
478 <tr>
479 <td align="left" class="footer">
Jon Halla1cdd892015-08-10 13:36:28 -0700480 Generated by Epydoc 3.0.1 on Mon Aug 10 11:12:35 2015
adminbae64d82013-08-01 10:50:15 -0700481 </td>
482 <td align="right" class="footer">
483 <a target="mainFrame" href="http://epydoc.sourceforge.net"
484 >http://epydoc.sourceforge.net</a>
485 </td>
486 </tr>
487</table>
488
489<script type="text/javascript">
490 <!--
491 // Private objects are initially displayed (because if
492 // javascript is turned off then we want them to be
493 // visible); but by default, we want to hide them. So hide
494 // them unless we have a cookie that says to show them.
495 checkCookie();
496 // -->
497</script>
498</body>
499</html>