Gitiles
Code Review Sign In
gerrit.onosproject.org / OnosSystemTest / a1cdd89614292d9758aeb97acf8b9ae1cf4526a3 / . / TestON / Documentation / TestON_Document / TestON.drivers.common.cli.remotetestbed.remotepoxdriver.RemotePoxDriver-class.html
blob: c55e2ab56149b34f37527861ee351c26bdfb143b [file] [log] [blame]
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame^]1<?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.remotetestbed.remotepoxdriver.RemotePoxDriver</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
33 <!-- 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>
39 </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.remotetestbed-module.html">Package&nbsp;remotetestbed</a> ::
50 <a href="TestON.drivers.common.cli.remotetestbed.remotepoxdriver-module.html">Module&nbsp;remotepoxdriver</a> ::
51 Class&nbsp;RemotePoxDriver
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.remotetestbed.remotepoxdriver.RemotePoxDriver-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 RemotePoxDriver</h1><p class="nomargin-top"><span class="codelink"><a href="TestON.drivers.common.cli.remotetestbed.remotepoxdriver-pysrc.html#RemotePoxDriver">source&nbsp;code</a></span></p>
69<center>
70<center> <map id="class_hierarchy_for_remotepoxd" name="class_hierarchy_for_remotepoxd">
71<area shape="rect" id="node1" href="TestON.drivers.common.cli.remotetestbed.remotepoxdriver.RemotePoxDriver-class.html" title="RemotePoxDriver" alt="" coords="5,6,131,31"/>
72<area shape="rect" id="node2" href="TestON.drivers.common.cli.remotetestbeddriver.RemoteTestBedDriver-class.html" title="remotetestbeddriver.RemoteTestBedDriver" alt="" coords="155,6,425,31"/>
73<area shape="rect" id="node3" href="TestON.drivers.common.clidriver.CLI-class.html" title="clidriver.CLI" alt="" coords="450,6,541,31"/>
74<area shape="rect" id="node4" href="javascript:void(0);" title="component.Component" alt="" coords="567,6,724,31"/>
75</map>
76 <img src="class_hierarchy_for_remotepoxd.gif" alt='' usemap="#class_hierarchy_for_remotepoxd" ismap="ismap" class="graph-without-title" />
77</center>
78</center>
79<hr />
80<p>RemoteVMDriver is the basic driver which will handle the Mininet
81 functions</p>
82
83<!-- ==================== INSTANCE METHODS ==================== -->
84<a name="section-InstanceMethods"></a>
85<table class="summary" border="1" cellpadding="3"
86 cellspacing="0" width="100%" bgcolor="white">
87<tr bgcolor="#70b0f0" class="table-header">
88 <td colspan="2" class="table-header">
89 <table border="0" cellpadding="0" cellspacing="0" width="100%">
90 <tr valign="top">
91 <td align="left"><span class="table-header">Instance Methods</span></td>
92 <td align="right" valign="top"
93 ><span class="options">[<a href="#section-InstanceMethods"
94 class="privatelink" onclick="toggle_private();"
95 >hide private</a>]</span></td>
96 </tr>
97 </table>
98 </td>
99</tr>
100<tr>
101 <td width="15%" align="right" valign="top" class="summary">
102 <span class="summary-type">&nbsp;</span>
103 </td><td class="summary">
104 <table width="100%" cellpadding="0" cellspacing="0" border="0">
105 <tr>
106 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.remotetestbed.remotepoxdriver.RemotePoxDriver-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>)</span><br />
107 x.__init__(...) initializes x; see help(type(x)) for signature</td>
108 <td align="right" valign="top">
109 <span class="codelink"><a href="TestON.drivers.common.cli.remotetestbed.remotepoxdriver-pysrc.html#RemotePoxDriver.__init__">source&nbsp;code</a></span>
110
111 </td>
112 </tr>
113 </table>
114
115 </td>
116 </tr>
117<tr>
118 <td width="15%" align="right" valign="top" class="summary">
119 <span class="summary-type">&nbsp;</span>
120 </td><td class="summary">
121 <table width="100%" cellpadding="0" cellspacing="0" border="0">
122 <tr>
123 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.remotetestbed.remotepoxdriver.RemotePoxDriver-class.html#connect" class="summary-sig-name">connect</a>(<span class="summary-sig-arg">self</span>,
124 <span class="summary-sig-arg">**connectargs</span>)</span><br />
125 Connection will establish to the remote host using ssh.</td>
126 <td align="right" valign="top">
127 <span class="codelink"><a href="TestON.drivers.common.cli.remotetestbed.remotepoxdriver-pysrc.html#RemotePoxDriver.connect">source&nbsp;code</a></span>
128
129 </td>
130 </tr>
131 </table>
132
133 </td>
134 </tr>
135<tr>
136 <td width="15%" align="right" valign="top" class="summary">
137 <span class="summary-type">&nbsp;</span>
138 </td><td class="summary">
139 <table width="100%" cellpadding="0" cellspacing="0" border="0">
140 <tr>
141 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.remotetestbed.remotepoxdriver.RemotePoxDriver-class.html#disconnect" class="summary-sig-name">disconnect</a>(<span class="summary-sig-arg">self</span>,
142 <span class="summary-sig-arg">handle</span>)</span></td>
143 <td align="right" valign="top">
144 <span class="codelink"><a href="TestON.drivers.common.cli.remotetestbed.remotepoxdriver-pysrc.html#RemotePoxDriver.disconnect">source&nbsp;code</a></span>
145
146 </td>
147 </tr>
148 </table>
149
150 </td>
151 </tr>
152<tr>
153 <td width="15%" align="right" valign="top" class="summary">
154 <span class="summary-type">&nbsp;</span>
155 </td><td class="summary">
156 <table width="100%" cellpadding="0" cellspacing="0" border="0">
157 <tr>
158 <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>,
159 <span class="summary-sig-arg">**execparams</span>)</span><br />
160 It facilitates the command line execution of a given command.
161 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
162 <td align="right" valign="top">
163 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.execute">source&nbsp;code</a></span>
164
165 </td>
166 </tr>
167 </table>
168
169 </td>
170 </tr>
171<tr>
172 <td width="15%" align="right" valign="top" class="summary">
173 <span class="summary-type">&nbsp;</span>
174 </td><td class="summary">
175 <table width="100%" cellpadding="0" cellspacing="0" border="0">
176 <tr>
177 <td><span class="summary-sig"><a name="onfail"></a><span class="summary-sig-name">onfail</span>(<span class="summary-sig-arg">self</span>)</span>
178 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
179 <td align="right" valign="top">
180 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.onfail">source&nbsp;code</a></span>
181
182 </td>
183 </tr>
184 </table>
185
186 </td>
187 </tr>
188<tr>
189 <td width="15%" align="right" valign="top" class="summary">
190 <span class="summary-type">&nbsp;</span>
191 </td><td class="summary">
192 <table width="100%" cellpadding="0" cellspacing="0" border="0">
193 <tr>
194 <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>,
195 <span class="summary-sig-arg">response</span>)</span>
196 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
197 <td align="right" valign="top">
198 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.remove_contol_chars">source&nbsp;code</a></span>
199
200 </td>
201 </tr>
202 </table>
203
204 </td>
205 </tr>
206<tr>
207 <td width="15%" align="right" valign="top" class="summary">
208 <span class="summary-type">&nbsp;</span>
209 </td><td class="summary">
210 <table width="100%" cellpadding="0" cellspacing="0" border="0">
211 <tr>
212 <td><span class="summary-sig"><a name="runAsSudoUser"></a><span class="summary-sig-name">runAsSudoUser</span>(<span class="summary-sig-arg">self</span>,
213 <span class="summary-sig-arg">handle</span>,
214 <span class="summary-sig-arg">pwd</span>,
215 <span class="summary-sig-arg">default</span>)</span>
216 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
217 <td align="right" valign="top">
218 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.runAsSudoUser">source&nbsp;code</a></span>
219
220 </td>
221 </tr>
222 </table>
223
224 </td>
225 </tr>
226<tr>
227 <td width="15%" align="right" valign="top" class="summary">
228 <span class="summary-type">&nbsp;</span>
229 </td><td class="summary">
230 <table width="100%" cellpadding="0" cellspacing="0" border="0">
231 <tr>
232 <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>,
233 <span class="summary-sig-arg">user_name</span>,
234 <span class="summary-sig-arg">ip_address</span>,
235 <span class="summary-sig-arg">filepath</span>,
236 <span class="summary-sig-arg">pwd</span>,
237 <span class="summary-sig-arg">dst_path</span>)</span><br />
238 Connection will establish to the remote host using ssh.
239 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
240 <td align="right" valign="top">
241 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.secureCopy">source&nbsp;code</a></span>
242
243 </td>
244 </tr>
245 </table>
246
247 </td>
248 </tr>
249 <tr>
250 <td colspan="2" class="summary">
251 <p class="indent-wrapped-lines"><b>Inherited from <code>component.Component</code></b>:
252 <code>__getattr__</code>,
253 <code>cleanup</code>,
254 <code>close_log_handles</code>,
255 <code>config</code>,
256 <code>experimentRun</code>,
257 <code>get_version</code>,
258 <code>log</code>
259 </p>
260 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
261 <code>__delattr__</code>,
262 <code>__format__</code>,
263 <code>__getattribute__</code>,
264 <code>__hash__</code>,
265 <code>__new__</code>,
266 <code>__reduce__</code>,
267 <code>__reduce_ex__</code>,
268 <code>__repr__</code>,
269 <code>__setattr__</code>,
270 <code>__sizeof__</code>,
271 <code>__str__</code>,
272 <code>__subclasshook__</code>
273 </p>
274 </td>
275 </tr>
276</table>
277<!-- ==================== PROPERTIES ==================== -->
278<a name="section-Properties"></a>
279<table class="summary" border="1" cellpadding="3"
280 cellspacing="0" width="100%" bgcolor="white">
281<tr bgcolor="#70b0f0" class="table-header">
282 <td colspan="2" class="table-header">
283 <table border="0" cellpadding="0" cellspacing="0" width="100%">
284 <tr valign="top">
285 <td align="left"><span class="table-header">Properties</span></td>
286 <td align="right" valign="top"
287 ><span class="options">[<a href="#section-Properties"
288 class="privatelink" onclick="toggle_private();"
289 >hide private</a>]</span></td>
290 </tr>
291 </table>
292 </td>
293</tr>
294 <tr>
295 <td colspan="2" class="summary">
296 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
297 <code>__class__</code>
298 </p>
299 </td>
300 </tr>
301</table>
302<!-- ==================== METHOD DETAILS ==================== -->
303<a name="section-MethodDetails"></a>
304<table class="details" border="1" cellpadding="3"
305 cellspacing="0" width="100%" bgcolor="white">
306<tr bgcolor="#70b0f0" class="table-header">
307 <td colspan="2" class="table-header">
308 <table border="0" cellpadding="0" cellspacing="0" width="100%">
309 <tr valign="top">
310 <td align="left"><span class="table-header">Method Details</span></td>
311 <td align="right" valign="top"
312 ><span class="options">[<a href="#section-MethodDetails"
313 class="privatelink" onclick="toggle_private();"
314 >hide private</a>]</span></td>
315 </tr>
316 </table>
317 </td>
318</tr>
319</table>
320<a name="__init__"></a>
321<div>
322<table class="details" border="1" cellpadding="3"
323 cellspacing="0" width="100%" bgcolor="white">
324<tr><td>
325 <table width="100%" cellpadding="0" cellspacing="0" border="0">
326 <tr valign="top"><td>
327 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>)</span>
328 <br /><em class="fname">(Constructor)</em>
329 </h3>
330 </td><td align="right" valign="top"
331 ><span class="codelink"><a href="TestON.drivers.common.cli.remotetestbed.remotepoxdriver-pysrc.html#RemotePoxDriver.__init__">source&nbsp;code</a></span>&nbsp;
332 </td>
333 </tr></table>
334
335 <p>x.__init__(...) initializes x; see help(type(x)) for signature</p>
336 <dl class="fields">
337 <dt>Overrides:
338 object.__init__
339 <dd><em class="note">(inherited documentation)</em></dd>
340 </dt>
341 </dl>
342</td></tr></table>
343</div>
344<a name="connect"></a>
345<div>
346<table class="details" border="1" cellpadding="3"
347 cellspacing="0" width="100%" bgcolor="white">
348<tr><td>
349 <table width="100%" cellpadding="0" cellspacing="0" border="0">
350 <tr valign="top"><td>
351 <h3 class="epydoc"><span class="sig"><span class="sig-name">connect</span>(<span class="sig-arg">self</span>,
352 <span class="sig-arg">**connectargs</span>)</span>
353 </h3>
354 </td><td align="right" valign="top"
355 ><span class="codelink"><a href="TestON.drivers.common.cli.remotetestbed.remotepoxdriver-pysrc.html#RemotePoxDriver.connect">source&nbsp;code</a></span>&nbsp;
356 </td>
357 </tr></table>
358
359 <p>Connection will establish to the remote host using ssh. It will take
360 user_name ,ip_address and password as arguments&lt;br&gt; and will return
361 the handle.</p>
362 <dl class="fields">
363 <dt>Overrides:
364 component.Component.connect
365 </dt>
366 </dl>
367</td></tr></table>
368</div>
369<a name="disconnect"></a>
370<div>
371<table class="details" border="1" cellpadding="3"
372 cellspacing="0" width="100%" bgcolor="white">
373<tr><td>
374 <table width="100%" cellpadding="0" cellspacing="0" border="0">
375 <tr valign="top"><td>
376 <h3 class="epydoc"><span class="sig"><span class="sig-name">disconnect</span>(<span class="sig-arg">self</span>,
377 <span class="sig-arg">handle</span>)</span>
378 </h3>
379 </td><td align="right" valign="top"
380 ><span class="codelink"><a href="TestON.drivers.common.cli.remotetestbed.remotepoxdriver-pysrc.html#RemotePoxDriver.disconnect">source&nbsp;code</a></span>&nbsp;
381 </td>
382 </tr></table>
383
384
385 <dl class="fields">
386 <dt>Overrides:
387 component.Component.disconnect
388 </dt>
389 </dl>
390</td></tr></table>
391</div>
392<br />
393<!-- ==================== NAVIGATION BAR ==================== -->
394<table class="navbar" border="0" width="100%" cellpadding="0"
395 bgcolor="#a0c0ff" cellspacing="0">
396 <tr valign="middle">
397 <!-- Home link -->
398 <th>&nbsp;&nbsp;&nbsp;<a
399 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
400
401 <!-- Tree link -->
402 <th>&nbsp;&nbsp;&nbsp;<a
403 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
404
405 <!-- Index link -->
406 <th>&nbsp;&nbsp;&nbsp;<a
407 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
408
409 <!-- Help link -->
410 <th>&nbsp;&nbsp;&nbsp;<a
411 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
412
413 <!-- Project homepage -->
414 <th class="navbar" align="right" width="100%">
415 <table border="0" cellpadding="0" cellspacing="0">
416 <tr><th class="navbar" align="center"
417 >TestON</th>
418 </tr></table></th>
419 </tr>
420</table>
421<table border="0" cellpadding="0" cellspacing="0" width="100%%">
422 <tr>
423 <td align="left" class="footer">
424 Generated by Epydoc 3.0.1 on Mon Aug 10 11:12:35 2015
425 </td>
426 <td align="right" class="footer">
427 <a target="mainFrame" href="http://epydoc.sourceforge.net"
428 >http://epydoc.sourceforge.net</a>
429 </td>
430 </tr>
431</table>
432
433<script type="text/javascript">
434 <!--
435 // Private objects are initially displayed (because if
436 // javascript is turned off then we want them to be
437 // visible); but by default, we want to hide them. So hide
438 // them unless we have a cookie that says to show them.
439 checkCookie();
440 // -->
441</script>
442</body>
443</html>