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