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