Gitiles
Code Review Sign In
gerrit.onosproject.org / OnosSystemTest / 317ed671753cb73809ce6b6691d881157878fe97 / . / TestON / Documentation / TestON_Document / TestON.drivers.common.cli.remotesysdriver.RemoteSysDriver-class.html
blob: 0e6b32b2afa31a38f28c8dc848659b14b1199f61 [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.remotesysdriver.RemoteSysDriver</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 <th class="navbar" width="100%"></th>
34 </tr>
35</table>
36<table width="100%" cellpadding="0" cellspacing="0">
37 <tr valign="top">
38 <td width="100%">
39 <span class="breadcrumbs">
40 <a href="TestON-module.html">Package&nbsp;TestON</a> ::
41 <a href="TestON.drivers-module.html">Package&nbsp;drivers</a> ::
42 <a href="TestON.drivers.common-module.html">Package&nbsp;common</a> ::
43 <a href="TestON.drivers.common.cli-module.html">Package&nbsp;cli</a> ::
44 <a href="TestON.drivers.common.cli.remotesysdriver-module.html">Module&nbsp;remotesysdriver</a> ::
45 Class&nbsp;RemoteSysDriver
46 </span>
47 </td>
48 <td>
49 <table cellpadding="0" cellspacing="0">
50 <!-- hide/show private -->
51 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
52 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
53 <tr><td align="right"><span class="options"
54 >[<a href="frames.html" target="_top">frames</a
55 >]&nbsp;|&nbsp;<a href="TestON.drivers.common.cli.remotesysdriver.RemoteSysDriver-class.html"
56 target="_top">no&nbsp;frames</a>]</span></td></tr>
57 </table>
58 </td>
59 </tr>
60</table>
61<!-- ==================== CLASS DESCRIPTION ==================== -->
62<h1 class="epydoc">Class RemoteSysDriver</h1><p class="nomargin-top"><span class="codelink"><a href="TestON.drivers.common.cli.remotesysdriver-pysrc.html#RemoteSysDriver">source&nbsp;code</a></span></p>
63<pre class="base-tree">
64 object --+
65 |
66<a href="TestON.drivers.component.Component-class.html">component.Component</a> --+
67 |
68 <a href="TestON.drivers.common.clidriver.CLI-class.html">clidriver.CLI</a> --+
69 |
70 <strong class="uidshort">RemoteSysDriver</strong>
71</pre>
72
73<hr />
74<!-- ==================== INSTANCE METHODS ==================== -->
75<a name="section-InstanceMethods"></a>
76<table class="summary" border="1" cellpadding="3"
77 cellspacing="0" width="100%" bgcolor="white">
78<tr bgcolor="#70b0f0" class="table-header">
79 <td colspan="2" class="table-header">
80 <table border="0" cellpadding="0" cellspacing="0" width="100%">
81 <tr valign="top">
82 <td align="left"><span class="table-header">Instance Methods</span></td>
83 <td align="right" valign="top"
84 ><span class="options">[<a href="#section-InstanceMethods"
85 class="privatelink" onclick="toggle_private();"
86 >hide private</a>]</span></td>
87 </tr>
88 </table>
89 </td>
90</tr>
91<tr>
92 <td width="15%" align="right" valign="top" class="summary">
93 <span class="summary-type">&nbsp;</span>
94 </td><td class="summary">
95 <table width="100%" cellpadding="0" cellspacing="0" border="0">
96 <tr>
97 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.remotesysdriver.RemoteSysDriver-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>)</span><br />
98 x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
99 <td align="right" valign="top">
100 <span class="codelink"><a href="TestON.drivers.common.cli.remotesysdriver-pysrc.html#RemoteSysDriver.__init__">source&nbsp;code</a></span>
101
102 </td>
103 </tr>
104 </table>
105
106 </td>
107 </tr>
108<tr>
109 <td width="15%" align="right" valign="top" class="summary">
110 <span class="summary-type">&nbsp;</span>
111 </td><td class="summary">
112 <table width="100%" cellpadding="0" cellspacing="0" border="0">
113 <tr>
114 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.remotesysdriver.RemoteSysDriver-class.html#connect" class="summary-sig-name">connect</a>(<span class="summary-sig-arg">self</span>,
115 <span class="summary-sig-arg">**connectargs</span>)</span><br />
116 Connection will establish to the remote host using ssh.</td>
117 <td align="right" valign="top">
118 <span class="codelink"><a href="TestON.drivers.common.cli.remotesysdriver-pysrc.html#RemoteSysDriver.connect">source&nbsp;code</a></span>
119
120 </td>
121 </tr>
122 </table>
123
124 </td>
125 </tr>
126 <tr>
127 <td colspan="2" class="summary">
128 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="TestON.drivers.common.clidriver.CLI-class.html">clidriver.CLI</a></code></b>:
129 <code><a href="TestON.drivers.common.clidriver.CLI-class.html#disconnect">disconnect</a></code>,
130 <code><a href="TestON.drivers.common.clidriver.CLI-class.html#execute">execute</a></code>,
131 <code><a href="TestON.drivers.common.clidriver.CLI-class.html#onfail">onfail</a></code>,
132 <code><a href="TestON.drivers.common.clidriver.CLI-class.html#runAsSudoUser">runAsSudoUser</a></code>,
133 <code><a href="TestON.drivers.common.clidriver.CLI-class.html#secureCopy">secureCopy</a></code>
134 </p>
135 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="TestON.drivers.component.Component-class.html">component.Component</a></code></b>:
136 <code><a href="TestON.drivers.component.Component-class.html#__getattr__">__getattr__</a></code>,
137 <code><a href="TestON.drivers.component.Component-class.html#cleanup">cleanup</a></code>,
138 <code><a href="TestON.drivers.component.Component-class.html#close_log_handles">close_log_handles</a></code>,
139 <code><a href="TestON.drivers.component.Component-class.html#config">config</a></code>,
140 <code><a href="TestON.drivers.component.Component-class.html#experimentRun">experimentRun</a></code>,
141 <code><a href="TestON.drivers.component.Component-class.html#get_version">get_version</a></code>,
142 <code><a href="TestON.drivers.component.Component-class.html#log">log</a></code>
143 </p>
144 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
145 <code>__delattr__</code>,
146 <code>__format__</code>,
147 <code>__getattribute__</code>,
148 <code>__hash__</code>,
149 <code>__new__</code>,
150 <code>__reduce__</code>,
151 <code>__reduce_ex__</code>,
152 <code>__repr__</code>,
153 <code>__setattr__</code>,
154 <code>__sizeof__</code>,
155 <code>__str__</code>,
156 <code>__subclasshook__</code>
157 </p>
158 </td>
159 </tr>
160</table>
161<!-- ==================== PROPERTIES ==================== -->
162<a name="section-Properties"></a>
163<table class="summary" border="1" cellpadding="3"
164 cellspacing="0" width="100%" bgcolor="white">
165<tr bgcolor="#70b0f0" class="table-header">
166 <td colspan="2" class="table-header">
167 <table border="0" cellpadding="0" cellspacing="0" width="100%">
168 <tr valign="top">
169 <td align="left"><span class="table-header">Properties</span></td>
170 <td align="right" valign="top"
171 ><span class="options">[<a href="#section-Properties"
172 class="privatelink" onclick="toggle_private();"
173 >hide private</a>]</span></td>
174 </tr>
175 </table>
176 </td>
177</tr>
178 <tr>
179 <td colspan="2" class="summary">
180 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
181 <code>__class__</code>
182 </p>
183 </td>
184 </tr>
185</table>
186<!-- ==================== METHOD DETAILS ==================== -->
187<a name="section-MethodDetails"></a>
188<table class="details" border="1" cellpadding="3"
189 cellspacing="0" width="100%" bgcolor="white">
190<tr bgcolor="#70b0f0" class="table-header">
191 <td colspan="2" class="table-header">
192 <table border="0" cellpadding="0" cellspacing="0" width="100%">
193 <tr valign="top">
194 <td align="left"><span class="table-header">Method Details</span></td>
195 <td align="right" valign="top"
196 ><span class="options">[<a href="#section-MethodDetails"
197 class="privatelink" onclick="toggle_private();"
198 >hide private</a>]</span></td>
199 </tr>
200 </table>
201 </td>
202</tr>
203</table>
204<a name="__init__"></a>
205<div>
206<table class="details" border="1" cellpadding="3"
207 cellspacing="0" width="100%" bgcolor="white">
208<tr><td>
209 <table width="100%" cellpadding="0" cellspacing="0" border="0">
210 <tr valign="top"><td>
211 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>)</span>
212 <br /><em class="fname">(Constructor)</em>
213 </h3>
214 </td><td align="right" valign="top"
215 ><span class="codelink"><a href="TestON.drivers.common.cli.remotesysdriver-pysrc.html#RemoteSysDriver.__init__">source&nbsp;code</a></span>&nbsp;
216 </td>
217 </tr></table>
218
219 <p>x.__init__(...) initializes x; see x.__class__.__doc__ for
220 signature</p>
221 <dl class="fields">
222 <dt>Overrides:
223 object.__init__
224 <dd><em class="note">(inherited documentation)</em></dd>
225 </dt>
226 </dl>
227</td></tr></table>
228</div>
229<a name="connect"></a>
230<div>
231<table class="details" border="1" cellpadding="3"
232 cellspacing="0" width="100%" bgcolor="white">
233<tr><td>
234 <table width="100%" cellpadding="0" cellspacing="0" border="0">
235 <tr valign="top"><td>
236 <h3 class="epydoc"><span class="sig"><span class="sig-name">connect</span>(<span class="sig-arg">self</span>,
237 <span class="sig-arg">**connectargs</span>)</span>
238 </h3>
239 </td><td align="right" valign="top"
240 ><span class="codelink"><a href="TestON.drivers.common.cli.remotesysdriver-pysrc.html#RemoteSysDriver.connect">source&nbsp;code</a></span>&nbsp;
241 </td>
242 </tr></table>
243
244 <p>Connection will establish to the remote host using ssh. It will take
245 user_name ,ip_address and password as arguments&lt;br&gt; and will return
246 the handle.</p>
247 <dl class="fields">
248 <dt>Overrides:
249 <a href="TestON.drivers.component.Component-class.html#connect">component.Component.connect</a>
250 </dt>
251 </dl>
252</td></tr></table>
253</div>
254<br />
255<!-- ==================== NAVIGATION BAR ==================== -->
256<table class="navbar" border="0" width="100%" cellpadding="0"
257 bgcolor="#a0c0ff" cellspacing="0">
258 <tr valign="middle">
259 <!-- Home link -->
260 <th>&nbsp;&nbsp;&nbsp;<a
261 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
262
263 <!-- Tree link -->
264 <th>&nbsp;&nbsp;&nbsp;<a
265 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
266
267 <!-- Index link -->
268 <th>&nbsp;&nbsp;&nbsp;<a
269 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
270
271 <!-- Help link -->
272 <th>&nbsp;&nbsp;&nbsp;<a
273 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
274
275 <th class="navbar" width="100%"></th>
276 </tr>
277</table>
278<table border="0" cellpadding="0" cellspacing="0" width="100%%">
279 <tr>
280 <td align="left" class="footer">
281 Generated by Epydoc 3.0.1 on Mon Mar 11 12:56:26 2013
282 </td>
283 <td align="right" class="footer">
284 <a target="mainFrame" href="http://epydoc.sourceforge.net"
285 >http://epydoc.sourceforge.net</a>
286 </td>
287 </tr>
288</table>
289
290<script type="text/javascript">
291 <!--
292 // Private objects are initially displayed (because if
293 // javascript is turned off then we want them to be
294 // visible); but by default, we want to hide them. So hide
295 // them unless we have a cookie that says to show them.
296 checkCookie();
297 // -->
298</script>
299</body>
300</html>