Gitiles
Code Review Sign In
gerrit.onosproject.org / OnosSystemTest / 0a0fdabf35940bcd98f83e9d9865b69e9cd05267 / . / TestON / Documentation / TestON_Document / TestON.drivers.common.clidriver.CLI-class.html
blob: 7cd1f12186475c1e9dd402e6e375f22535a8bb82 [file] [log] [blame]
adminbae64d82013-08-01 10:50:15 -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.clidriver.CLI</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 -0700[diff] [blame]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>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]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.clidriver-module.html">Module&nbsp;clidriver</a> ::
49 Class&nbsp;CLI
50 </span>
51 </td>
52 <td>
53 <table cellpadding="0" cellspacing="0">
54 <!-- hide/show private -->
55 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
56 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
57 <tr><td align="right"><span class="options"
58 >[<a href="frames.html" target="_top">frames</a
59 >]&nbsp;|&nbsp;<a href="TestON.drivers.common.clidriver.CLI-class.html"
60 target="_top">no&nbsp;frames</a>]</span></td></tr>
61 </table>
62 </td>
63 </tr>
64</table>
65<!-- ==================== CLASS DESCRIPTION ==================== -->
66<h1 class="epydoc">Class CLI</h1><p class="nomargin-top"><span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI">source&nbsp;code</a></span></p>
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]67<center>
68<center> <map id="class_hierarchy_for_cli_2" name="class_hierarchy_for_cli_2">
69<area shape="rect" id="node1" href="TestON.drivers.common.clidriver.CLI-class.html" title="CLI" alt="" coords="5,6,48,31"/>
70<area shape="rect" id="node2" href="javascript:void(0);" title="component.Component" alt="" coords="72,6,229,31"/>
71</map>
72 <img src="class_hierarchy_for_cli_2.gif" alt='' usemap="#class_hierarchy_for_cli_2" ismap="ismap" class="graph-without-title" />
73</center>
74</center>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]75<hr />
76<p>This will define common functions for CLI included.</p>
77
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.clidriver.CLI-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 -0700[diff] [blame]102 x.__init__(...) initializes x; see help(type(x)) for signature</td>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]103 <td align="right" valign="top">
104 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.__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.clidriver.CLI-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.clidriver-pysrc.html#CLI.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></td>
137 <td align="right" valign="top">
138 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.disconnect">source&nbsp;code</a></span>
139
140 </td>
141 </tr>
142 </table>
143
144 </td>
145 </tr>
146<tr>
147 <td width="15%" align="right" valign="top" class="summary">
148 <span class="summary-type">&nbsp;</span>
149 </td><td class="summary">
150 <table width="100%" cellpadding="0" cellspacing="0" border="0">
151 <tr>
152 <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>,
153 <span class="summary-sig-arg">**execparams</span>)</span><br />
154 It facilitates the command line execution of a given command.</td>
155 <td align="right" valign="top">
156 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.execute">source&nbsp;code</a></span>
157
158 </td>
159 </tr>
160 </table>
161
162 </td>
163 </tr>
164<tr>
165 <td width="15%" align="right" valign="top" class="summary">
166 <span class="summary-type">&nbsp;</span>
167 </td><td class="summary">
168 <table width="100%" cellpadding="0" cellspacing="0" border="0">
169 <tr>
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]170 <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>,
171 <span class="summary-sig-arg">response</span>)</span></td>
172 <td align="right" valign="top">
173 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.remove_contol_chars">source&nbsp;code</a></span>
174
175 </td>
176 </tr>
177 </table>
178
179 </td>
180 </tr>
181<tr>
182 <td width="15%" align="right" valign="top" class="summary">
183 <span class="summary-type">&nbsp;</span>
184 </td><td class="summary">
185 <table width="100%" cellpadding="0" cellspacing="0" border="0">
186 <tr>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]187 <td><span class="summary-sig"><a name="runAsSudoUser"></a><span class="summary-sig-name">runAsSudoUser</span>(<span class="summary-sig-arg">self</span>,
188 <span class="summary-sig-arg">handle</span>,
189 <span class="summary-sig-arg">pwd</span>,
190 <span class="summary-sig-arg">default</span>)</span></td>
191 <td align="right" valign="top">
192 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.runAsSudoUser">source&nbsp;code</a></span>
193
194 </td>
195 </tr>
196 </table>
197
198 </td>
199 </tr>
200<tr>
201 <td width="15%" align="right" valign="top" class="summary">
202 <span class="summary-type">&nbsp;</span>
203 </td><td class="summary">
204 <table width="100%" cellpadding="0" cellspacing="0" border="0">
205 <tr>
206 <td><span class="summary-sig"><a name="onfail"></a><span class="summary-sig-name">onfail</span>(<span class="summary-sig-arg">self</span>)</span></td>
207 <td align="right" valign="top">
208 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.onfail">source&nbsp;code</a></span>
209
210 </td>
211 </tr>
212 </table>
213
214 </td>
215 </tr>
216<tr>
217 <td width="15%" align="right" valign="top" class="summary">
218 <span class="summary-type">&nbsp;</span>
219 </td><td class="summary">
220 <table width="100%" cellpadding="0" cellspacing="0" border="0">
221 <tr>
222 <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>,
223 <span class="summary-sig-arg">user_name</span>,
224 <span class="summary-sig-arg">ip_address</span>,
225 <span class="summary-sig-arg">filepath</span>,
226 <span class="summary-sig-arg">pwd</span>,
227 <span class="summary-sig-arg">dst_path</span>)</span><br />
228 Connection will establish to the remote host using ssh.</td>
229 <td align="right" valign="top">
230 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.secureCopy">source&nbsp;code</a></span>
231
232 </td>
233 </tr>
234 </table>
235
236 </td>
237 </tr>
238 <tr>
239 <td colspan="2" class="summary">
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]240 <p class="indent-wrapped-lines"><b>Inherited from <code>component.Component</code></b>:
241 <code>__getattr__</code>,
242 <code>cleanup</code>,
243 <code>close_log_handles</code>,
244 <code>config</code>,
245 <code>experimentRun</code>,
246 <code>get_version</code>,
247 <code>log</code>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]248 </p>
249 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
250 <code>__delattr__</code>,
251 <code>__format__</code>,
252 <code>__getattribute__</code>,
253 <code>__hash__</code>,
254 <code>__new__</code>,
255 <code>__reduce__</code>,
256 <code>__reduce_ex__</code>,
257 <code>__repr__</code>,
258 <code>__setattr__</code>,
259 <code>__sizeof__</code>,
260 <code>__str__</code>,
261 <code>__subclasshook__</code>
262 </p>
263 </td>
264 </tr>
265</table>
266<!-- ==================== PROPERTIES ==================== -->
267<a name="section-Properties"></a>
268<table class="summary" border="1" cellpadding="3"
269 cellspacing="0" width="100%" bgcolor="white">
270<tr bgcolor="#70b0f0" class="table-header">
271 <td colspan="2" class="table-header">
272 <table border="0" cellpadding="0" cellspacing="0" width="100%">
273 <tr valign="top">
274 <td align="left"><span class="table-header">Properties</span></td>
275 <td align="right" valign="top"
276 ><span class="options">[<a href="#section-Properties"
277 class="privatelink" onclick="toggle_private();"
278 >hide private</a>]</span></td>
279 </tr>
280 </table>
281 </td>
282</tr>
283 <tr>
284 <td colspan="2" class="summary">
285 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
286 <code>__class__</code>
287 </p>
288 </td>
289 </tr>
290</table>
291<!-- ==================== METHOD DETAILS ==================== -->
292<a name="section-MethodDetails"></a>
293<table class="details" border="1" cellpadding="3"
294 cellspacing="0" width="100%" bgcolor="white">
295<tr bgcolor="#70b0f0" class="table-header">
296 <td colspan="2" class="table-header">
297 <table border="0" cellpadding="0" cellspacing="0" width="100%">
298 <tr valign="top">
299 <td align="left"><span class="table-header">Method Details</span></td>
300 <td align="right" valign="top"
301 ><span class="options">[<a href="#section-MethodDetails"
302 class="privatelink" onclick="toggle_private();"
303 >hide private</a>]</span></td>
304 </tr>
305 </table>
306 </td>
307</tr>
308</table>
309<a name="__init__"></a>
310<div>
311<table class="details" border="1" cellpadding="3"
312 cellspacing="0" width="100%" bgcolor="white">
313<tr><td>
314 <table width="100%" cellpadding="0" cellspacing="0" border="0">
315 <tr valign="top"><td>
316 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>)</span>
317 <br /><em class="fname">(Constructor)</em>
318 </h3>
319 </td><td align="right" valign="top"
320 ><span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.__init__">source&nbsp;code</a></span>&nbsp;
321 </td>
322 </tr></table>
323
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]324 <p>x.__init__(...) initializes x; see help(type(x)) for signature</p>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]325 <dl class="fields">
326 <dt>Overrides:
327 object.__init__
328 <dd><em class="note">(inherited documentation)</em></dd>
329 </dt>
330 </dl>
331</td></tr></table>
332</div>
333<a name="connect"></a>
334<div>
335<table class="details" border="1" cellpadding="3"
336 cellspacing="0" width="100%" bgcolor="white">
337<tr><td>
338 <table width="100%" cellpadding="0" cellspacing="0" border="0">
339 <tr valign="top"><td>
340 <h3 class="epydoc"><span class="sig"><span class="sig-name">connect</span>(<span class="sig-arg">self</span>,
341 <span class="sig-arg">**connectargs</span>)</span>
342 </h3>
343 </td><td align="right" valign="top"
344 ><span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.connect">source&nbsp;code</a></span>&nbsp;
345 </td>
346 </tr></table>
347
348 <p>Connection will establish to the remote host using ssh. It will take
349 user_name ,ip_address and password as arguments&lt;br&gt; and will return
350 the handle.</p>
351 <dl class="fields">
352 <dt>Overrides:
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]353 component.Component.connect
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]354 </dt>
355 </dl>
356</td></tr></table>
357</div>
358<a name="disconnect"></a>
359<div>
360<table class="details" border="1" cellpadding="3"
361 cellspacing="0" width="100%" bgcolor="white">
362<tr><td>
363 <table width="100%" cellpadding="0" cellspacing="0" border="0">
364 <tr valign="top"><td>
365 <h3 class="epydoc"><span class="sig"><span class="sig-name">disconnect</span>(<span class="sig-arg">self</span>)</span>
366 </h3>
367 </td><td align="right" valign="top"
368 ><span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.disconnect">source&nbsp;code</a></span>&nbsp;
369 </td>
370 </tr></table>
371
372
373 <dl class="fields">
374 <dt>Overrides:
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]375 component.Component.disconnect
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]376 </dt>
377 </dl>
378</td></tr></table>
379</div>
380<a name="execute"></a>
381<div>
382<table class="details" border="1" cellpadding="3"
383 cellspacing="0" width="100%" bgcolor="white">
384<tr><td>
385 <table width="100%" cellpadding="0" cellspacing="0" border="0">
386 <tr valign="top"><td>
387 <h3 class="epydoc"><span class="sig"><span class="sig-name">execute</span>(<span class="sig-arg">self</span>,
388 <span class="sig-arg">**execparams</span>)</span>
389 </h3>
390 </td><td align="right" valign="top"
391 ><span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.execute">source&nbsp;code</a></span>&nbsp;
392 </td>
393 </tr></table>
394
395 <p>It facilitates the command line execution of a given command. It has
396 arguments as : cmd =&gt; represents command to be executed, prompt =&gt;
397 represents expect command prompt or output, timeout =&gt; timeout for
398 command execution, more =&gt; to provide a key press if it is on.</p>
399 <p>It will return output of command exection.</p>
400 <dl class="fields">
401 <dt>Overrides:
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]402 component.Component.execute
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]403 </dt>
404 </dl>
405</td></tr></table>
406</div>
407<a name="secureCopy"></a>
408<div>
409<table class="details" border="1" cellpadding="3"
410 cellspacing="0" width="100%" bgcolor="white">
411<tr><td>
412 <table width="100%" cellpadding="0" cellspacing="0" border="0">
413 <tr valign="top"><td>
414 <h3 class="epydoc"><span class="sig"><span class="sig-name">secureCopy</span>(<span class="sig-arg">self</span>,
415 <span class="sig-arg">user_name</span>,
416 <span class="sig-arg">ip_address</span>,
417 <span class="sig-arg">filepath</span>,
418 <span class="sig-arg">pwd</span>,
419 <span class="sig-arg">dst_path</span>)</span>
420 </h3>
421 </td><td align="right" valign="top"
422 ><span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.secureCopy">source&nbsp;code</a></span>&nbsp;
423 </td>
424 </tr></table>
425
426 <p>Connection will establish to the remote host using ssh. It will take
427 user_name ,ip_address and password as arguments&lt;br&gt; and will return
428 the handle.</p>
429 <dl class="fields">
430 </dl>
431</td></tr></table>
432</div>
433<br />
434<!-- ==================== NAVIGATION BAR ==================== -->
435<table class="navbar" border="0" width="100%" cellpadding="0"
436 bgcolor="#a0c0ff" cellspacing="0">
437 <tr valign="middle">
438 <!-- Home link -->
439 <th>&nbsp;&nbsp;&nbsp;<a
440 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
441
442 <!-- Tree link -->
443 <th>&nbsp;&nbsp;&nbsp;<a
444 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
445
446 <!-- Index link -->
447 <th>&nbsp;&nbsp;&nbsp;<a
448 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
449
450 <!-- Help link -->
451 <th>&nbsp;&nbsp;&nbsp;<a
452 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
453
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]454 <!-- Project homepage -->
455 <th class="navbar" align="right" width="100%">
456 <table border="0" cellpadding="0" cellspacing="0">
457 <tr><th class="navbar" align="center"
458 >TestON</th>
459 </tr></table></th>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]460 </tr>
461</table>
462<table border="0" cellpadding="0" cellspacing="0" width="100%%">
463 <tr>
464 <td align="left" class="footer">
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]465 Generated by Epydoc 3.0.1 on Mon Aug 10 11:12:35 2015
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]466 </td>
467 <td align="right" class="footer">
468 <a target="mainFrame" href="http://epydoc.sourceforge.net"
469 >http://epydoc.sourceforge.net</a>
470 </td>
471 </tr>
472</table>
473
474<script type="text/javascript">
475 <!--
476 // Private objects are initially displayed (because if
477 // javascript is turned off then we want them to be
478 // visible); but by default, we want to hide them. So hide
479 // them unless we have a cookie that says to show them.
480 checkCookie();
481 // -->
482</script>
483</body>
484</html>