Gitiles
Code Review Sign In
gerrit.onosproject.org / OnosSystemTest / d7b9c204b570f34ec51f43a0e3bc7475337a094a / . / TestON / Documentation / TestON_Document / TestON.drivers.common.cli.emulator.poxclidriver.PoxCliDriver-class.html
blob: 673e8a0a07dc47aec89a2367dd5f4774b7ecf7d9 [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.emulator.poxclidriver.PoxCliDriver</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.emulator-module.html">Package&nbsp;emulator</a> ::
45 <a href="TestON.drivers.common.cli.emulator.poxclidriver-module.html">Module&nbsp;poxclidriver</a> ::
46 Class&nbsp;PoxCliDriver
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.emulator.poxclidriver.PoxCliDriver-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 PoxCliDriver</h1><p class="nomargin-top"><span class="codelink"><a href="TestON.drivers.common.cli.emulator.poxclidriver-pysrc.html#PoxCliDriver">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 <a href="TestON.drivers.common.cli.emulatordriver.Emulator-class.html">emulatordriver.Emulator</a> --+
72 |
73 <strong class="uidshort">PoxCliDriver</strong>
74</pre>
75
76<hr />
77<p>PoxCliDriver driver provides the basic functions of POX controller</p>
78
79<!-- ==================== INSTANCE METHODS ==================== -->
80<a name="section-InstanceMethods"></a>
81<table class="summary" border="1" cellpadding="3"
82 cellspacing="0" width="100%" bgcolor="white">
83<tr bgcolor="#70b0f0" class="table-header">
84 <td colspan="2" class="table-header">
85 <table border="0" cellpadding="0" cellspacing="0" width="100%">
86 <tr valign="top">
87 <td align="left"><span class="table-header">Instance Methods</span></td>
88 <td align="right" valign="top"
89 ><span class="options">[<a href="#section-InstanceMethods"
90 class="privatelink" onclick="toggle_private();"
91 >hide private</a>]</span></td>
92 </tr>
93 </table>
94 </td>
95</tr>
96<tr>
97 <td width="15%" align="right" valign="top" class="summary">
98 <span class="summary-type">&nbsp;</span>
99 </td><td class="summary">
100 <table width="100%" cellpadding="0" cellspacing="0" border="0">
101 <tr>
102 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.poxclidriver.PoxCliDriver-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>)</span><br />
103 x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
104 <td align="right" valign="top">
105 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.poxclidriver-pysrc.html#PoxCliDriver.__init__">source&nbsp;code</a></span>
106
107 </td>
108 </tr>
109 </table>
110
111 </td>
112 </tr>
113<tr>
114 <td width="15%" align="right" valign="top" class="summary">
115 <span class="summary-type">&nbsp;</span>
116 </td><td class="summary">
117 <table width="100%" cellpadding="0" cellspacing="0" border="0">
118 <tr>
119 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.poxclidriver.PoxCliDriver-class.html#connect" class="summary-sig-name">connect</a>(<span class="summary-sig-arg">self</span>,
120 <span class="summary-sig-arg">**connectargs</span>)</span><br />
121 this subroutine is to launch pox controller .</td>
122 <td align="right" valign="top">
123 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.poxclidriver-pysrc.html#PoxCliDriver.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.cli.emulator.poxclidriver.PoxCliDriver-class.html#disconnect" class="summary-sig-name">disconnect</a>(<span class="summary-sig-arg">self</span>,
138 <span class="summary-sig-arg">handle</span>)</span></td>
139 <td align="right" valign="top">
140 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.poxclidriver-pysrc.html#PoxCliDriver.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.cli.emulator.poxclidriver.PoxCliDriver-class.html#get_version" class="summary-sig-name">get_version</a>(<span class="summary-sig-arg">self</span>)</span></td>
155 <td align="right" valign="top">
156 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.poxclidriver-pysrc.html#PoxCliDriver.get_version">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>
170 <td><span class="summary-sig"><a name="getcmd"></a><span class="summary-sig-name">getcmd</span>(<span class="summary-sig-arg">self</span>,
171 <span class="summary-sig-arg">options</span>)</span></td>
172 <td align="right" valign="top">
173 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.poxclidriver-pysrc.html#PoxCliDriver.getcmd">source&nbsp;code</a></span>
174
175 </td>
176 </tr>
177 </table>
178
179 </td>
180 </tr>
181 <tr>
182 <td colspan="2" class="summary">
183 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="TestON.drivers.common.clidriver.CLI-class.html">clidriver.CLI</a></code></b>:
184 <code><a href="TestON.drivers.common.clidriver.CLI-class.html#execute">execute</a></code>,
185 <code><a href="TestON.drivers.common.clidriver.CLI-class.html#onfail">onfail</a></code>,
186 <code><a href="TestON.drivers.common.clidriver.CLI-class.html#runAsSudoUser">runAsSudoUser</a></code>,
187 <code><a href="TestON.drivers.common.clidriver.CLI-class.html#secureCopy">secureCopy</a></code>
188 </p>
189 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="TestON.drivers.component.Component-class.html">component.Component</a></code></b>:
190 <code><a href="TestON.drivers.component.Component-class.html#__getattr__">__getattr__</a></code>,
191 <code><a href="TestON.drivers.component.Component-class.html#cleanup">cleanup</a></code>,
192 <code><a href="TestON.drivers.component.Component-class.html#close_log_handles">close_log_handles</a></code>,
193 <code><a href="TestON.drivers.component.Component-class.html#config">config</a></code>,
194 <code><a href="TestON.drivers.component.Component-class.html#experimentRun">experimentRun</a></code>,
195 <code><a href="TestON.drivers.component.Component-class.html#log">log</a></code>
196 </p>
197 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
198 <code>__delattr__</code>,
199 <code>__format__</code>,
200 <code>__getattribute__</code>,
201 <code>__hash__</code>,
202 <code>__new__</code>,
203 <code>__reduce__</code>,
204 <code>__reduce_ex__</code>,
205 <code>__repr__</code>,
206 <code>__setattr__</code>,
207 <code>__sizeof__</code>,
208 <code>__str__</code>,
209 <code>__subclasshook__</code>
210 </p>
211 </td>
212 </tr>
213</table>
214<!-- ==================== PROPERTIES ==================== -->
215<a name="section-Properties"></a>
216<table class="summary" border="1" cellpadding="3"
217 cellspacing="0" width="100%" bgcolor="white">
218<tr bgcolor="#70b0f0" class="table-header">
219 <td colspan="2" class="table-header">
220 <table border="0" cellpadding="0" cellspacing="0" width="100%">
221 <tr valign="top">
222 <td align="left"><span class="table-header">Properties</span></td>
223 <td align="right" valign="top"
224 ><span class="options">[<a href="#section-Properties"
225 class="privatelink" onclick="toggle_private();"
226 >hide private</a>]</span></td>
227 </tr>
228 </table>
229 </td>
230</tr>
231 <tr>
232 <td colspan="2" class="summary">
233 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
234 <code>__class__</code>
235 </p>
236 </td>
237 </tr>
238</table>
239<!-- ==================== METHOD DETAILS ==================== -->
240<a name="section-MethodDetails"></a>
241<table class="details" border="1" cellpadding="3"
242 cellspacing="0" width="100%" bgcolor="white">
243<tr bgcolor="#70b0f0" class="table-header">
244 <td colspan="2" class="table-header">
245 <table border="0" cellpadding="0" cellspacing="0" width="100%">
246 <tr valign="top">
247 <td align="left"><span class="table-header">Method Details</span></td>
248 <td align="right" valign="top"
249 ><span class="options">[<a href="#section-MethodDetails"
250 class="privatelink" onclick="toggle_private();"
251 >hide private</a>]</span></td>
252 </tr>
253 </table>
254 </td>
255</tr>
256</table>
257<a name="__init__"></a>
258<div>
259<table class="details" border="1" cellpadding="3"
260 cellspacing="0" width="100%" bgcolor="white">
261<tr><td>
262 <table width="100%" cellpadding="0" cellspacing="0" border="0">
263 <tr valign="top"><td>
264 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>)</span>
265 <br /><em class="fname">(Constructor)</em>
266 </h3>
267 </td><td align="right" valign="top"
268 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.poxclidriver-pysrc.html#PoxCliDriver.__init__">source&nbsp;code</a></span>&nbsp;
269 </td>
270 </tr></table>
271
272 <p>x.__init__(...) initializes x; see x.__class__.__doc__ for
273 signature</p>
274 <dl class="fields">
275 <dt>Overrides:
276 object.__init__
277 <dd><em class="note">(inherited documentation)</em></dd>
278 </dt>
279 </dl>
280</td></tr></table>
281</div>
282<a name="connect"></a>
283<div>
284<table class="details" border="1" cellpadding="3"
285 cellspacing="0" width="100%" bgcolor="white">
286<tr><td>
287 <table width="100%" cellpadding="0" cellspacing="0" border="0">
288 <tr valign="top"><td>
289 <h3 class="epydoc"><span class="sig"><span class="sig-name">connect</span>(<span class="sig-arg">self</span>,
290 <span class="sig-arg">**connectargs</span>)</span>
291 </h3>
292 </td><td align="right" valign="top"
293 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.poxclidriver-pysrc.html#PoxCliDriver.connect">source&nbsp;code</a></span>&nbsp;
294 </td>
295 </tr></table>
296
297 <p>this subroutine is to launch pox controller . It must have arguments
298 as : user_name = host name , ip_address = ip address of the host , pwd =
299 password of host , options = it is a topology hash which will consists
300 the component's details for the test run</p>
301 <p>*** host is here a virtual mahine or system where pox framework
302 hierarchy exists</p>
303 <dl class="fields">
304 <dt>Overrides:
305 <a href="TestON.drivers.component.Component-class.html#connect">component.Component.connect</a>
306 </dt>
307 </dl>
308</td></tr></table>
309</div>
310<a name="disconnect"></a>
311<div>
312<table class="details" border="1" cellpadding="3"
313 cellspacing="0" width="100%" bgcolor="white">
314<tr><td>
315 <table width="100%" cellpadding="0" cellspacing="0" border="0">
316 <tr valign="top"><td>
317 <h3 class="epydoc"><span class="sig"><span class="sig-name">disconnect</span>(<span class="sig-arg">self</span>,
318 <span class="sig-arg">handle</span>)</span>
319 </h3>
320 </td><td align="right" valign="top"
321 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.poxclidriver-pysrc.html#PoxCliDriver.disconnect">source&nbsp;code</a></span>&nbsp;
322 </td>
323 </tr></table>
324
325
326 <dl class="fields">
327 <dt>Overrides:
328 <a href="TestON.drivers.component.Component-class.html#disconnect">component.Component.disconnect</a>
329 </dt>
330 </dl>
331</td></tr></table>
332</div>
333<a name="get_version"></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">get_version</span>(<span class="sig-arg">self</span>)</span>
341 </h3>
342 </td><td align="right" valign="top"
343 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.poxclidriver-pysrc.html#PoxCliDriver.get_version">source&nbsp;code</a></span>&nbsp;
344 </td>
345 </tr></table>
346
347
348 <dl class="fields">
349 <dt>Overrides:
350 <a href="TestON.drivers.component.Component-class.html#get_version">component.Component.get_version</a>
351 </dt>
352 </dl>
353</td></tr></table>
354</div>
355<br />
356<!-- ==================== NAVIGATION BAR ==================== -->
357<table class="navbar" border="0" width="100%" cellpadding="0"
358 bgcolor="#a0c0ff" cellspacing="0">
359 <tr valign="middle">
360 <!-- Home link -->
361 <th>&nbsp;&nbsp;&nbsp;<a
362 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
363
364 <!-- Tree link -->
365 <th>&nbsp;&nbsp;&nbsp;<a
366 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
367
368 <!-- Index link -->
369 <th>&nbsp;&nbsp;&nbsp;<a
370 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
371
372 <!-- Help link -->
373 <th>&nbsp;&nbsp;&nbsp;<a
374 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
375
376 <th class="navbar" width="100%"></th>
377 </tr>
378</table>
379<table border="0" cellpadding="0" cellspacing="0" width="100%%">
380 <tr>
381 <td align="left" class="footer">
382 Generated by Epydoc 3.0.1 on Mon Mar 11 12:56:26 2013
383 </td>
384 <td align="right" class="footer">
385 <a target="mainFrame" href="http://epydoc.sourceforge.net"
386 >http://epydoc.sourceforge.net</a>
387 </td>
388 </tr>
389</table>
390
391<script type="text/javascript">
392 <!--
393 // Private objects are initially displayed (because if
394 // javascript is turned off then we want them to be
395 // visible); but by default, we want to hide them. So hide
396 // them unless we have a cookie that says to show them.
397 checkCookie();
398 // -->
399</script>
400</body>
401</html>