Gitiles
Code Review Sign In
gerrit.onosproject.org / OnosSystemTest / a1cdd89614292d9758aeb97acf8b9ae1cf4526a3 / . / TestON / Documentation / TestON_Document / TestON.drivers.common.cli.toolsdriver.Tools-class.html
blob: 6a302696f77467c9f398c94139f6d0e55d082ccf [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.cli.toolsdriver.Tools</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.cli-module.html">Package&nbsp;cli</a> ::
49 <a href="TestON.drivers.common.cli.toolsdriver-module.html">Module&nbsp;toolsdriver</a> ::
50 Class&nbsp;Tools
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.toolsdriver.Tools-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 Tools</h1><p class="nomargin-top"><span class="codelink"><a href="TestON.drivers.common.cli.toolsdriver-pysrc.html#Tools">source&nbsp;code</a></span></p>
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame^]68<center>
69<center> <map id="class_hierarchy_for_tools" name="class_hierarchy_for_tools">
70<area shape="rect" id="node1" href="TestON.drivers.common.cli.toolsdriver.Tools-class.html" title="Tools" alt="" coords="5,6,59,31"/>
71<area shape="rect" id="node2" href="TestON.drivers.common.clidriver.CLI-class.html" title="clidriver.CLI" alt="" coords="83,6,175,31"/>
72<area shape="rect" id="node3" href="javascript:void(0);" title="component.Component" alt="" coords="200,6,357,31"/>
73</map>
74 <img src="class_hierarchy_for_tools.gif" alt='' usemap="#class_hierarchy_for_tools" ismap="ismap" class="graph-without-title" />
75</center>
76</center>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]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.toolsdriver.Tools-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.cli.toolsdriver-pysrc.html#Tools.__init__">source&nbsp;code</a></span>
105
106 </td>
107 </tr>
108 </table>
109
110 </td>
111 </tr>
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame^]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.
121 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
122 <td align="right" valign="top">
123 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.connect">source&nbsp;code</a></span>
124
125 </td>
126 </tr>
127 </table>
128
129 </td>
130 </tr>
131<tr>
132 <td width="15%" align="right" valign="top" class="summary">
133 <span class="summary-type">&nbsp;</span>
134 </td><td class="summary">
135 <table width="100%" cellpadding="0" cellspacing="0" border="0">
136 <tr>
137 <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>
138 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
139 <td align="right" valign="top">
140 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.disconnect">source&nbsp;code</a></span>
141
142 </td>
143 </tr>
144 </table>
145
146 </td>
147 </tr>
148<tr>
149 <td width="15%" align="right" valign="top" class="summary">
150 <span class="summary-type">&nbsp;</span>
151 </td><td class="summary">
152 <table width="100%" cellpadding="0" cellspacing="0" border="0">
153 <tr>
154 <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>,
155 <span class="summary-sig-arg">**execparams</span>)</span><br />
156 It facilitates the command line execution of a given command.
157 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
158 <td align="right" valign="top">
159 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.execute">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="onfail"></a><span class="summary-sig-name">onfail</span>(<span class="summary-sig-arg">self</span>)</span>
174 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
175 <td align="right" valign="top">
176 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.onfail">source&nbsp;code</a></span>
177
178 </td>
179 </tr>
180 </table>
181
182 </td>
183 </tr>
184<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 name="remove_contol_chars"></a><span class="summary-sig-name">remove_contol_chars</span>(<span class="summary-sig-arg">self</span>,
191 <span class="summary-sig-arg">response</span>)</span>
192 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
193 <td align="right" valign="top">
194 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.remove_contol_chars">source&nbsp;code</a></span>
195
196 </td>
197 </tr>
198 </table>
199
200 </td>
201 </tr>
202<tr>
203 <td width="15%" align="right" valign="top" class="summary">
204 <span class="summary-type">&nbsp;</span>
205 </td><td class="summary">
206 <table width="100%" cellpadding="0" cellspacing="0" border="0">
207 <tr>
208 <td><span class="summary-sig"><a name="runAsSudoUser"></a><span class="summary-sig-name">runAsSudoUser</span>(<span class="summary-sig-arg">self</span>,
209 <span class="summary-sig-arg">handle</span>,
210 <span class="summary-sig-arg">pwd</span>,
211 <span class="summary-sig-arg">default</span>)</span>
212 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
213 <td align="right" valign="top">
214 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.runAsSudoUser">source&nbsp;code</a></span>
215
216 </td>
217 </tr>
218 </table>
219
220 </td>
221 </tr>
222<tr>
223 <td width="15%" align="right" valign="top" class="summary">
224 <span class="summary-type">&nbsp;</span>
225 </td><td class="summary">
226 <table width="100%" cellpadding="0" cellspacing="0" border="0">
227 <tr>
228 <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>,
229 <span class="summary-sig-arg">user_name</span>,
230 <span class="summary-sig-arg">ip_address</span>,
231 <span class="summary-sig-arg">filepath</span>,
232 <span class="summary-sig-arg">pwd</span>,
233 <span class="summary-sig-arg">dst_path</span>)</span><br />
234 Connection will establish to the remote host using ssh.
235 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
236 <td align="right" valign="top">
237 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.secureCopy">source&nbsp;code</a></span>
238
239 </td>
240 </tr>
241 </table>
242
243 </td>
244 </tr>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]245 <tr>
246 <td colspan="2" class="summary">
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame^]247 <p class="indent-wrapped-lines"><b>Inherited from <code>component.Component</code></b>:
248 <code>__getattr__</code>,
249 <code>cleanup</code>,
250 <code>close_log_handles</code>,
251 <code>config</code>,
252 <code>experimentRun</code>,
253 <code>get_version</code>,
254 <code>log</code>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]255 </p>
256 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
257 <code>__delattr__</code>,
258 <code>__format__</code>,
259 <code>__getattribute__</code>,
260 <code>__hash__</code>,
261 <code>__new__</code>,
262 <code>__reduce__</code>,
263 <code>__reduce_ex__</code>,
264 <code>__repr__</code>,
265 <code>__setattr__</code>,
266 <code>__sizeof__</code>,
267 <code>__str__</code>,
268 <code>__subclasshook__</code>
269 </p>
270 </td>
271 </tr>
272</table>
273<!-- ==================== PROPERTIES ==================== -->
274<a name="section-Properties"></a>
275<table class="summary" border="1" cellpadding="3"
276 cellspacing="0" width="100%" bgcolor="white">
277<tr bgcolor="#70b0f0" class="table-header">
278 <td colspan="2" class="table-header">
279 <table border="0" cellpadding="0" cellspacing="0" width="100%">
280 <tr valign="top">
281 <td align="left"><span class="table-header">Properties</span></td>
282 <td align="right" valign="top"
283 ><span class="options">[<a href="#section-Properties"
284 class="privatelink" onclick="toggle_private();"
285 >hide private</a>]</span></td>
286 </tr>
287 </table>
288 </td>
289</tr>
290 <tr>
291 <td colspan="2" class="summary">
292 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
293 <code>__class__</code>
294 </p>
295 </td>
296 </tr>
297</table>
298<!-- ==================== METHOD DETAILS ==================== -->
299<a name="section-MethodDetails"></a>
300<table class="details" border="1" cellpadding="3"
301 cellspacing="0" width="100%" bgcolor="white">
302<tr bgcolor="#70b0f0" class="table-header">
303 <td colspan="2" class="table-header">
304 <table border="0" cellpadding="0" cellspacing="0" width="100%">
305 <tr valign="top">
306 <td align="left"><span class="table-header">Method Details</span></td>
307 <td align="right" valign="top"
308 ><span class="options">[<a href="#section-MethodDetails"
309 class="privatelink" onclick="toggle_private();"
310 >hide private</a>]</span></td>
311 </tr>
312 </table>
313 </td>
314</tr>
315</table>
316<a name="__init__"></a>
317<div>
318<table class="details" border="1" cellpadding="3"
319 cellspacing="0" width="100%" bgcolor="white">
320<tr><td>
321 <table width="100%" cellpadding="0" cellspacing="0" border="0">
322 <tr valign="top"><td>
323 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>)</span>
324 <br /><em class="fname">(Constructor)</em>
325 </h3>
326 </td><td align="right" valign="top"
327 ><span class="codelink"><a href="TestON.drivers.common.cli.toolsdriver-pysrc.html#Tools.__init__">source&nbsp;code</a></span>&nbsp;
328 </td>
329 </tr></table>
330
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame^]331 <p>x.__init__(...) initializes x; see help(type(x)) for signature</p>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]332 <dl class="fields">
333 <dt>Overrides:
334 object.__init__
335 <dd><em class="note">(inherited documentation)</em></dd>
336 </dt>
337 </dl>
338</td></tr></table>
339</div>
340<br />
341<!-- ==================== NAVIGATION BAR ==================== -->
342<table class="navbar" border="0" width="100%" cellpadding="0"
343 bgcolor="#a0c0ff" cellspacing="0">
344 <tr valign="middle">
345 <!-- Home link -->
346 <th>&nbsp;&nbsp;&nbsp;<a
347 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
348
349 <!-- Tree link -->
350 <th>&nbsp;&nbsp;&nbsp;<a
351 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
352
353 <!-- Index link -->
354 <th>&nbsp;&nbsp;&nbsp;<a
355 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
356
357 <!-- Help link -->
358 <th>&nbsp;&nbsp;&nbsp;<a
359 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
360
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame^]361 <!-- Project homepage -->
362 <th class="navbar" align="right" width="100%">
363 <table border="0" cellpadding="0" cellspacing="0">
364 <tr><th class="navbar" align="center"
365 >TestON</th>
366 </tr></table></th>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]367 </tr>
368</table>
369<table border="0" cellpadding="0" cellspacing="0" width="100%%">
370 <tr>
371 <td align="left" class="footer">
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame^]372 Generated by Epydoc 3.0.1 on Mon Aug 10 11:12:35 2015
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]373 </td>
374 <td align="right" class="footer">
375 <a target="mainFrame" href="http://epydoc.sourceforge.net"
376 >http://epydoc.sourceforge.net</a>
377 </td>
378 </tr>
379</table>
380
381<script type="text/javascript">
382 <!--
383 // Private objects are initially displayed (because if
384 // javascript is turned off then we want them to be
385 // visible); but by default, we want to hide them. So hide
386 // them unless we have a cookie that says to show them.
387 checkCookie();
388 // -->
389</script>
390</body>
391</html>