Gitiles
Code Review Sign In
gerrit.onosproject.org / OnosSystemTest / 7b1dacd2c668a6b19fd19f8749841e1a26e15cf1 / . / TestON / Documentation / TestON_Document / TestON.drivers.common.cli.remotetestbed.remotevmdriver.RemoteVMDriver-class.html
blob: 023dfca354633877971387425f5b7ea4932d78ca [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.remotevmdriver.RemoteVMDriver</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.remotevmdriver-module.html">Module&nbsp;remotevmdriver</a> ::
51 Class&nbsp;RemoteVMDriver
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.remotevmdriver.RemoteVMDriver-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 RemoteVMDriver</h1><p class="nomargin-top"><span class="codelink"><a href="TestON.drivers.common.cli.remotetestbed.remotevmdriver-pysrc.html#RemoteVMDriver">source&nbsp;code</a></span></p>
69<center>
70<center> <map id="class_hierarchy_for_remotevmdr" name="class_hierarchy_for_remotevmdr">
71<area shape="rect" id="node1" href="TestON.drivers.common.cli.remotetestbed.remotevmdriver.RemoteVMDriver-class.html" title="RemoteVMDriver" alt="" coords="5,6,128,31"/>
72<area shape="rect" id="node2" href="TestON.drivers.common.cli.remotetestbeddriver.RemoteTestBedDriver-class.html" title="remotetestbeddriver.RemoteTestBedDriver" alt="" coords="153,6,423,31"/>
73<area shape="rect" id="node3" href="TestON.drivers.common.clidriver.CLI-class.html" title="clidriver.CLI" alt="" coords="447,6,539,31"/>
74<area shape="rect" id="node4" href="javascript:void(0);" title="component.Component" alt="" coords="564,6,721,31"/>
75</map>
76 <img src="class_hierarchy_for_remotevmdr.gif" alt='' usemap="#class_hierarchy_for_remotevmdr" 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.remotevmdriver.RemoteVMDriver-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.remotevmdriver-pysrc.html#RemoteVMDriver.__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.remotevmdriver.RemoteVMDriver-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.remotevmdriver-pysrc.html#RemoteVMDriver.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 name="SSH"></a><span class="summary-sig-name">SSH</span>(<span class="summary-sig-arg">self</span>,
142 <span class="summary-sig-arg">**connectargs</span>)</span></td>
143 <td align="right" valign="top">
144 <span class="codelink"><a href="TestON.drivers.common.cli.remotetestbed.remotevmdriver-pysrc.html#RemoteVMDriver.SSH">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#disconnect" class="summary-sig-name">disconnect</a>(<span class="summary-sig-arg">self</span>)</span>
159 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
160 <td align="right" valign="top">
161 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.disconnect">source&nbsp;code</a></span>
162
163 </td>
164 </tr>
165 </table>
166
167 </td>
168 </tr>
169<tr>
170 <td width="15%" align="right" valign="top" class="summary">
171 <span class="summary-type">&nbsp;</span>
172 </td><td class="summary">
173 <table width="100%" cellpadding="0" cellspacing="0" border="0">
174 <tr>
175 <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>,
176 <span class="summary-sig-arg">**execparams</span>)</span><br />
177 It facilitates the command line execution of a given command.
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.execute">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="onfail"></a><span class="summary-sig-name">onfail</span>(<span class="summary-sig-arg">self</span>)</span>
195 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
196 <td align="right" valign="top">
197 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.onfail">source&nbsp;code</a></span>
198
199 </td>
200 </tr>
201 </table>
202
203 </td>
204 </tr>
205<tr>
206 <td width="15%" align="right" valign="top" class="summary">
207 <span class="summary-type">&nbsp;</span>
208 </td><td class="summary">
209 <table width="100%" cellpadding="0" cellspacing="0" border="0">
210 <tr>
211 <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>,
212 <span class="summary-sig-arg">response</span>)</span>
213 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
214 <td align="right" valign="top">
215 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.remove_contol_chars">source&nbsp;code</a></span>
216
217 </td>
218 </tr>
219 </table>
220
221 </td>
222 </tr>
223<tr>
224 <td width="15%" align="right" valign="top" class="summary">
225 <span class="summary-type">&nbsp;</span>
226 </td><td class="summary">
227 <table width="100%" cellpadding="0" cellspacing="0" border="0">
228 <tr>
229 <td><span class="summary-sig"><a name="runAsSudoUser"></a><span class="summary-sig-name">runAsSudoUser</span>(<span class="summary-sig-arg">self</span>,
230 <span class="summary-sig-arg">handle</span>,
231 <span class="summary-sig-arg">pwd</span>,
232 <span class="summary-sig-arg">default</span>)</span>
233 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
234 <td align="right" valign="top">
235 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.runAsSudoUser">source&nbsp;code</a></span>
236
237 </td>
238 </tr>
239 </table>
240
241 </td>
242 </tr>
243<tr>
244 <td width="15%" align="right" valign="top" class="summary">
245 <span class="summary-type">&nbsp;</span>
246 </td><td class="summary">
247 <table width="100%" cellpadding="0" cellspacing="0" border="0">
248 <tr>
249 <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>,
250 <span class="summary-sig-arg">user_name</span>,
251 <span class="summary-sig-arg">ip_address</span>,
252 <span class="summary-sig-arg">filepath</span>,
253 <span class="summary-sig-arg">pwd</span>,
254 <span class="summary-sig-arg">dst_path</span>)</span><br />
255 Connection will establish to the remote host using ssh.
256 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
257 <td align="right" valign="top">
258 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.secureCopy">source&nbsp;code</a></span>
259
260 </td>
261 </tr>
262 </table>
263
264 </td>
265 </tr>
266 <tr>
267 <td colspan="2" class="summary">
268 <p class="indent-wrapped-lines"><b>Inherited from <code>component.Component</code></b>:
269 <code>__getattr__</code>,
270 <code>cleanup</code>,
271 <code>close_log_handles</code>,
272 <code>config</code>,
273 <code>experimentRun</code>,
274 <code>get_version</code>,
275 <code>log</code>
276 </p>
277 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
278 <code>__delattr__</code>,
279 <code>__format__</code>,
280 <code>__getattribute__</code>,
281 <code>__hash__</code>,
282 <code>__new__</code>,
283 <code>__reduce__</code>,
284 <code>__reduce_ex__</code>,
285 <code>__repr__</code>,
286 <code>__setattr__</code>,
287 <code>__sizeof__</code>,
288 <code>__str__</code>,
289 <code>__subclasshook__</code>
290 </p>
291 </td>
292 </tr>
293</table>
294<!-- ==================== PROPERTIES ==================== -->
295<a name="section-Properties"></a>
296<table class="summary" border="1" cellpadding="3"
297 cellspacing="0" width="100%" bgcolor="white">
298<tr bgcolor="#70b0f0" class="table-header">
299 <td colspan="2" class="table-header">
300 <table border="0" cellpadding="0" cellspacing="0" width="100%">
301 <tr valign="top">
302 <td align="left"><span class="table-header">Properties</span></td>
303 <td align="right" valign="top"
304 ><span class="options">[<a href="#section-Properties"
305 class="privatelink" onclick="toggle_private();"
306 >hide private</a>]</span></td>
307 </tr>
308 </table>
309 </td>
310</tr>
311 <tr>
312 <td colspan="2" class="summary">
313 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
314 <code>__class__</code>
315 </p>
316 </td>
317 </tr>
318</table>
319<!-- ==================== METHOD DETAILS ==================== -->
320<a name="section-MethodDetails"></a>
321<table class="details" border="1" cellpadding="3"
322 cellspacing="0" width="100%" bgcolor="white">
323<tr bgcolor="#70b0f0" class="table-header">
324 <td colspan="2" class="table-header">
325 <table border="0" cellpadding="0" cellspacing="0" width="100%">
326 <tr valign="top">
327 <td align="left"><span class="table-header">Method Details</span></td>
328 <td align="right" valign="top"
329 ><span class="options">[<a href="#section-MethodDetails"
330 class="privatelink" onclick="toggle_private();"
331 >hide private</a>]</span></td>
332 </tr>
333 </table>
334 </td>
335</tr>
336</table>
337<a name="__init__"></a>
338<div>
339<table class="details" border="1" cellpadding="3"
340 cellspacing="0" width="100%" bgcolor="white">
341<tr><td>
342 <table width="100%" cellpadding="0" cellspacing="0" border="0">
343 <tr valign="top"><td>
344 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>)</span>
345 <br /><em class="fname">(Constructor)</em>
346 </h3>
347 </td><td align="right" valign="top"
348 ><span class="codelink"><a href="TestON.drivers.common.cli.remotetestbed.remotevmdriver-pysrc.html#RemoteVMDriver.__init__">source&nbsp;code</a></span>&nbsp;
349 </td>
350 </tr></table>
351
352 <p>x.__init__(...) initializes x; see help(type(x)) for signature</p>
353 <dl class="fields">
354 <dt>Overrides:
355 object.__init__
356 <dd><em class="note">(inherited documentation)</em></dd>
357 </dt>
358 </dl>
359</td></tr></table>
360</div>
361<a name="connect"></a>
362<div>
363<table class="details" border="1" cellpadding="3"
364 cellspacing="0" width="100%" bgcolor="white">
365<tr><td>
366 <table width="100%" cellpadding="0" cellspacing="0" border="0">
367 <tr valign="top"><td>
368 <h3 class="epydoc"><span class="sig"><span class="sig-name">connect</span>(<span class="sig-arg">self</span>,
369 <span class="sig-arg">**connectargs</span>)</span>
370 </h3>
371 </td><td align="right" valign="top"
372 ><span class="codelink"><a href="TestON.drivers.common.cli.remotetestbed.remotevmdriver-pysrc.html#RemoteVMDriver.connect">source&nbsp;code</a></span>&nbsp;
373 </td>
374 </tr></table>
375
376 <p>Connection will establish to the remote host using ssh. It will take
377 user_name ,ip_address and password as arguments&lt;br&gt; and will return
378 the handle.</p>
379 <dl class="fields">
380 <dt>Overrides:
381 component.Component.connect
382 </dt>
383 </dl>
384</td></tr></table>
385</div>
386<br />
387<!-- ==================== NAVIGATION BAR ==================== -->
388<table class="navbar" border="0" width="100%" cellpadding="0"
389 bgcolor="#a0c0ff" cellspacing="0">
390 <tr valign="middle">
391 <!-- Home link -->
392 <th>&nbsp;&nbsp;&nbsp;<a
393 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
394
395 <!-- Tree link -->
396 <th>&nbsp;&nbsp;&nbsp;<a
397 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
398
399 <!-- Index link -->
400 <th>&nbsp;&nbsp;&nbsp;<a
401 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
402
403 <!-- Help link -->
404 <th>&nbsp;&nbsp;&nbsp;<a
405 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
406
407 <!-- Project homepage -->
408 <th class="navbar" align="right" width="100%">
409 <table border="0" cellpadding="0" cellspacing="0">
410 <tr><th class="navbar" align="center"
411 >TestON</th>
412 </tr></table></th>
413 </tr>
414</table>
415<table border="0" cellpadding="0" cellspacing="0" width="100%%">
416 <tr>
417 <td align="left" class="footer">
418 Generated by Epydoc 3.0.1 on Mon Aug 10 11:12:35 2015
419 </td>
420 <td align="right" class="footer">
421 <a target="mainFrame" href="http://epydoc.sourceforge.net"
422 >http://epydoc.sourceforge.net</a>
423 </td>
424 </tr>
425</table>
426
427<script type="text/javascript">
428 <!--
429 // Private objects are initially displayed (because if
430 // javascript is turned off then we want them to be
431 // visible); but by default, we want to hide them. So hide
432 // them unless we have a cookie that says to show them.
433 checkCookie();
434 // -->
435</script>
436</body>
437</html>