Gitiles
Code Review Sign In
gerrit.onosproject.org / OnosSystemTest / 20038c49e88b65f4cb2710d270c00066915fcf8b / . / TestON / Documentation / TestON_Document / TestON.drivers.common.cli.emulator.remotemininetdriver.RemoteMininetDriver-class.html
blob: edabdd8e7b23c50cfb8da21f5c1f32ea64bb074a [file] [log] [blame]
Jon Halla1cdd892015-08-10 13:36:28 -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.remotemininetdriver.RemoteMininetDriver</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 <!-- 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>
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.emulator-module.html">Package&nbsp;emulator</a> ::
50 <a href="TestON.drivers.common.cli.emulator.remotemininetdriver-module.html">Module&nbsp;remotemininetdriver</a> ::
51 Class&nbsp;RemoteMininetDriver
52 </span>
53 </td>
54 <td>
55 <table cellpadding="0" cellspacing="0">
56 <!-- hide/show private -->
57 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
58 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
59 <tr><td align="right"><span class="options"
60 >[<a href="frames.html" target="_top">frames</a
61 >]&nbsp;|&nbsp;<a href="TestON.drivers.common.cli.emulator.remotemininetdriver.RemoteMininetDriver-class.html"
62 target="_top">no&nbsp;frames</a>]</span></td></tr>
63 </table>
64 </td>
65 </tr>
66</table>
67<!-- ==================== CLASS DESCRIPTION ==================== -->
68<h1 class="epydoc">Class RemoteMininetDriver</h1><p class="nomargin-top"><span class="codelink"><a href="TestON.drivers.common.cli.emulator.remotemininetdriver-pysrc.html#RemoteMininetDriver">source&nbsp;code</a></span></p>
69<center>
70<center> <map id="class_hierarchy_for_remotemini" name="class_hierarchy_for_remotemini">
71<area shape="rect" id="node1" href="TestON.drivers.common.cli.emulator.remotemininetdriver.RemoteMininetDriver-class.html" title="RemoteMininetDriver" alt="" coords="5,6,149,31"/>
72<area shape="rect" id="node2" href="TestON.drivers.common.cli.emulatordriver.Emulator-class.html" title="emulatordriver.Emulator" alt="" coords="175,6,333,31"/>
73<area shape="rect" id="node3" href="TestON.drivers.common.clidriver.CLI-class.html" title="clidriver.CLI" alt="" coords="359,6,451,31"/>
74<area shape="rect" id="node4" href="javascript:void(0);" title="component.Component" alt="" coords="476,6,633,31"/>
75</map>
76 <img src="class_hierarchy_for_remotemini.gif" alt='' usemap="#class_hierarchy_for_remotemini" ismap="ismap" class="graph-without-title" />
77</center>
78</center>
79<hr />
80<p>RemoteMininetCliDriver is the basic driver which will handle the
81 Mininet functions. The main different between this and the
82 MininetCliDriver is that this one does not build the mininet. It assumes
83 that there is already a mininet running on the target.</p>
84
85<!-- ==================== INSTANCE METHODS ==================== -->
86<a name="section-InstanceMethods"></a>
87<table class="summary" border="1" cellpadding="3"
88 cellspacing="0" width="100%" bgcolor="white">
89<tr bgcolor="#70b0f0" class="table-header">
90 <td colspan="2" class="table-header">
91 <table border="0" cellpadding="0" cellspacing="0" width="100%">
92 <tr valign="top">
93 <td align="left"><span class="table-header">Instance Methods</span></td>
94 <td align="right" valign="top"
95 ><span class="options">[<a href="#section-InstanceMethods"
96 class="privatelink" onclick="toggle_private();"
97 >hide private</a>]</span></td>
98 </tr>
99 </table>
100 </td>
101</tr>
102<tr>
103 <td width="15%" align="right" valign="top" class="summary">
104 <span class="summary-type">&nbsp;</span>
105 </td><td class="summary">
106 <table width="100%" cellpadding="0" cellspacing="0" border="0">
107 <tr>
108 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.remotemininetdriver.RemoteMininetDriver-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>)</span><br />
109 x.__init__(...) initializes x; see help(type(x)) for signature</td>
110 <td align="right" valign="top">
111 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.remotemininetdriver-pysrc.html#RemoteMininetDriver.__init__">source&nbsp;code</a></span>
112
113 </td>
114 </tr>
115 </table>
116
117 </td>
118 </tr>
119<tr>
120 <td width="15%" align="right" valign="top" class="summary">
121 <span class="summary-type">&nbsp;</span>
122 </td><td class="summary">
123 <table width="100%" cellpadding="0" cellspacing="0" border="0">
124 <tr>
125 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.remotemininetdriver.RemoteMininetDriver-class.html#connect" class="summary-sig-name">connect</a>(<span class="summary-sig-arg">self</span>,
126 <span class="summary-sig-arg">**connectargs</span>)</span><br />
127 ,user_name, ip_address, pwd,options ): Here the main is the TestON
128 instance after creating all the log handles.</td>
129 <td align="right" valign="top">
130 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.remotemininetdriver-pysrc.html#RemoteMininetDriver.connect">source&nbsp;code</a></span>
131
132 </td>
133 </tr>
134 </table>
135
136 </td>
137 </tr>
138<tr>
139 <td width="15%" align="right" valign="top" class="summary">
140 <span class="summary-type">&nbsp;</span>
141 </td><td class="summary">
142 <table width="100%" cellpadding="0" cellspacing="0" border="0">
143 <tr>
144 <td><span class="summary-sig"><a name="checkForLoss"></a><span class="summary-sig-name">checkForLoss</span>(<span class="summary-sig-arg">self</span>,
145 <span class="summary-sig-arg">pingList</span>)</span><br />
146 Returns main.FALSE for 0% packet loss and Returns main.ERROR if
147 &quot;found multiple mininet&quot; is found and Returns main.TRUE
148 else</td>
149 <td align="right" valign="top">
150 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.remotemininetdriver-pysrc.html#RemoteMininetDriver.checkForLoss">source&nbsp;code</a></span>
151
152 </td>
153 </tr>
154 </table>
155
156 </td>
157 </tr>
158<tr>
159 <td width="15%" align="right" valign="top" class="summary">
160 <span class="summary-type">&nbsp;</span>
161 </td><td class="summary">
162 <table width="100%" cellpadding="0" cellspacing="0" border="0">
163 <tr>
164 <td><span class="summary-sig"><a name="pingLong"></a><span class="summary-sig-name">pingLong</span>(<span class="summary-sig-arg">self</span>,
165 <span class="summary-sig-arg">**pingParams</span>)</span><br />
166 Starts a continuous ping on the mininet host outputting to a file in
167 the /tmp dir.</td>
168 <td align="right" valign="top">
169 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.remotemininetdriver-pysrc.html#RemoteMininetDriver.pingLong">source&nbsp;code</a></span>
170
171 </td>
172 </tr>
173 </table>
174
175 </td>
176 </tr>
177<tr>
178 <td width="15%" align="right" valign="top" class="summary">
179 <span class="summary-type">&nbsp;</span>
180 </td><td class="summary">
181 <table width="100%" cellpadding="0" cellspacing="0" border="0">
182 <tr>
183 <td><span class="summary-sig"><a name="pingstatus"></a><span class="summary-sig-name">pingstatus</span>(<span class="summary-sig-arg">self</span>,
184 <span class="summary-sig-arg">**pingParams</span>)</span><br />
185 Tails the respective ping output file and check that there is a
186 moving &quot;64 bytes&quot;</td>
187 <td align="right" valign="top">
188 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.remotemininetdriver-pysrc.html#RemoteMininetDriver.pingstatus">source&nbsp;code</a></span>
189
190 </td>
191 </tr>
192 </table>
193
194 </td>
195 </tr>
196<tr>
197 <td width="15%" align="right" valign="top" class="summary">
198 <span class="summary-type">&nbsp;</span>
199 </td><td class="summary">
200 <table width="100%" cellpadding="0" cellspacing="0" border="0">
201 <tr>
202 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.remotemininetdriver.RemoteMininetDriver-class.html#pingKill" class="summary-sig-name">pingKill</a>(<span class="summary-sig-arg">self</span>,
203 <span class="summary-sig-arg">testONUser</span>,
204 <span class="summary-sig-arg">testONIP</span>)</span><br />
205 Kills all continuous ping processes.</td>
206 <td align="right" valign="top">
207 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.remotemininetdriver-pysrc.html#RemoteMininetDriver.pingKill">source&nbsp;code</a></span>
208
209 </td>
210 </tr>
211 </table>
212
213 </td>
214 </tr>
215<tr>
216 <td width="15%" align="right" valign="top" class="summary">
217 <span class="summary-type">&nbsp;</span>
218 </td><td class="summary">
219 <table width="100%" cellpadding="0" cellspacing="0" border="0">
220 <tr>
221 <td><span class="summary-sig"><a name="pingLongKill"></a><span class="summary-sig-name">pingLongKill</span>(<span class="summary-sig-arg">self</span>)</span></td>
222 <td align="right" valign="top">
223 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.remotemininetdriver-pysrc.html#RemoteMininetDriver.pingLongKill">source&nbsp;code</a></span>
224
225 </td>
226 </tr>
227 </table>
228
229 </td>
230 </tr>
231<tr>
232 <td width="15%" align="right" valign="top" class="summary">
233 <span class="summary-type">&nbsp;</span>
234 </td><td class="summary">
235 <table width="100%" cellpadding="0" cellspacing="0" border="0">
236 <tr>
237 <td><span class="summary-sig"><a name="pingHostOptical"></a><span class="summary-sig-name">pingHostOptical</span>(<span class="summary-sig-arg">self</span>,
238 <span class="summary-sig-arg">**pingParams</span>)</span><br />
239 This function is only for Packet Optical related ping Use the next
240 pingHost() function for all normal scenarios ) Ping from one mininet
241 host to another Currently the only supported Params: SRC and TARGET</td>
242 <td align="right" valign="top">
243 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.remotemininetdriver-pysrc.html#RemoteMininetDriver.pingHostOptical">source&nbsp;code</a></span>
244
245 </td>
246 </tr>
247 </table>
248
249 </td>
250 </tr>
251<tr>
252 <td width="15%" align="right" valign="top" class="summary">
253 <span class="summary-type">&nbsp;</span>
254 </td><td class="summary">
255 <table width="100%" cellpadding="0" cellspacing="0" border="0">
256 <tr>
257 <td><span class="summary-sig"><a name="pingHost"></a><span class="summary-sig-name">pingHost</span>(<span class="summary-sig-arg">self</span>,
258 <span class="summary-sig-arg">**pingParams</span>)</span><br />
259 Pings between two hosts on remote mininet</td>
260 <td align="right" valign="top">
261 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.remotemininetdriver-pysrc.html#RemoteMininetDriver.pingHost">source&nbsp;code</a></span>
262
263 </td>
264 </tr>
265 </table>
266
267 </td>
268 </tr>
269<tr>
270 <td width="15%" align="right" valign="top" class="summary">
271 <span class="summary-type">&nbsp;</span>
272 </td><td class="summary">
273 <table width="100%" cellpadding="0" cellspacing="0" border="0">
274 <tr>
275 <td><span class="summary-sig"><a name="checknum"></a><span class="summary-sig-name">checknum</span>(<span class="summary-sig-arg">self</span>,
276 <span class="summary-sig-arg">num</span>)</span><br />
277 Verifies the correct number of switches are running</td>
278 <td align="right" valign="top">
279 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.remotemininetdriver-pysrc.html#RemoteMininetDriver.checknum">source&nbsp;code</a></span>
280
281 </td>
282 </tr>
283 </table>
284
285 </td>
286 </tr>
287<tr>
288 <td width="15%" align="right" valign="top" class="summary">
289 <span class="summary-type">&nbsp;</span>
290 </td><td class="summary">
291 <table width="100%" cellpadding="0" cellspacing="0" border="0">
292 <tr>
293 <td><span class="summary-sig"><a name="startTcpdump"></a><span class="summary-sig-name">startTcpdump</span>(<span class="summary-sig-arg">self</span>,
294 <span class="summary-sig-arg">filename</span>,
295 <span class="summary-sig-arg">intf</span>=<span class="summary-sig-default">&quot;eth0&quot;</span>,
296 <span class="summary-sig-arg">port</span>=<span class="summary-sig-default">&quot;port 6633&quot;</span>,
297 <span class="summary-sig-arg">user</span>=<span class="summary-sig-default">&quot;admin&quot;</span>)</span><br />
298 Runs tcpdump on an interface and saves the file intf can be
299 specified, or the default eth0 is used</td>
300 <td align="right" valign="top">
301 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.remotemininetdriver-pysrc.html#RemoteMininetDriver.startTcpdump">source&nbsp;code</a></span>
302
303 </td>
304 </tr>
305 </table>
306
307 </td>
308 </tr>
309<tr>
310 <td width="15%" align="right" valign="top" class="summary">
311 <span class="summary-type">&nbsp;</span>
312 </td><td class="summary">
313 <table width="100%" cellpadding="0" cellspacing="0" border="0">
314 <tr>
315 <td><span class="summary-sig"><a name="stopTcpdump"></a><span class="summary-sig-name">stopTcpdump</span>(<span class="summary-sig-arg">self</span>)</span><br />
316 pkills tcpdump</td>
317 <td align="right" valign="top">
318 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.remotemininetdriver-pysrc.html#RemoteMininetDriver.stopTcpdump">source&nbsp;code</a></span>
319
320 </td>
321 </tr>
322 </table>
323
324 </td>
325 </tr>
326<tr>
327 <td width="15%" align="right" valign="top" class="summary">
328 <span class="summary-type">&nbsp;</span>
329 </td><td class="summary">
330 <table width="100%" cellpadding="0" cellspacing="0" border="0">
331 <tr>
332 <td><span class="summary-sig"><a name="runOpticalMnScript"></a><span class="summary-sig-name">runOpticalMnScript</span>(<span class="summary-sig-arg">self</span>,
333 <span class="summary-sig-arg">name</span>=<span class="summary-sig-default">'onos'</span>,
334 <span class="summary-sig-arg">ctrllerIP</span>=<span class="summary-sig-default">None</span>)</span></td>
335 <td align="right" valign="top">
336 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.remotemininetdriver-pysrc.html#RemoteMininetDriver.runOpticalMnScript">source&nbsp;code</a></span>
337
338 </td>
339 </tr>
340 </table>
341
342 </td>
343 </tr>
344<tr>
345 <td width="15%" align="right" valign="top" class="summary">
346 <span class="summary-type">&nbsp;</span>
347 </td><td class="summary">
348 <table width="100%" cellpadding="0" cellspacing="0" border="0">
349 <tr>
350 <td><span class="summary-sig"><a name="attachLincOESession"></a><span class="summary-sig-name">attachLincOESession</span>(<span class="summary-sig-arg">self</span>)</span><br />
351 Since executing opticalTest.py will give you mininet prompt, you
352 would at some point require to get onto console of LincOE
353 ((linc@onosTestBench)1&gt;) to execute commands like bring a optical
354 port up or down on a ROADM You can attach to console of Linc-OE
355 session by a cmd: sudo ~/linc-oe/rel/linc/bin/linc attach</td>
356 <td align="right" valign="top">
357 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.remotemininetdriver-pysrc.html#RemoteMininetDriver.attachLincOESession">source&nbsp;code</a></span>
358
359 </td>
360 </tr>
361 </table>
362
363 </td>
364 </tr>
365<tr>
366 <td width="15%" align="right" valign="top" class="summary">
367 <span class="summary-type">&nbsp;</span>
368 </td><td class="summary">
369 <table width="100%" cellpadding="0" cellspacing="0" border="0">
370 <tr>
371 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.remotemininetdriver.RemoteMininetDriver-class.html#disconnect" class="summary-sig-name">disconnect</a>(<span class="summary-sig-arg">self</span>)</span><br />
372 Called at the end of the test to disconnect the handle.</td>
373 <td align="right" valign="top">
374 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.remotemininetdriver-pysrc.html#RemoteMininetDriver.disconnect">source&nbsp;code</a></span>
375
376 </td>
377 </tr>
378 </table>
379
380 </td>
381 </tr>
382<tr>
383 <td width="15%" align="right" valign="top" class="summary">
384 <span class="summary-type">&nbsp;</span>
385 </td><td class="summary">
386 <table width="100%" cellpadding="0" cellspacing="0" border="0">
387 <tr>
388 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.remotemininetdriver.RemoteMininetDriver-class.html#setIpTablesOUTPUT" class="summary-sig-name">setIpTablesOUTPUT</a>(<span class="summary-sig-arg">self</span>,
389 <span class="summary-sig-arg">dstIp</span>,
390 <span class="summary-sig-arg">dstPort</span>,
391 <span class="summary-sig-arg">action</span>=<span class="summary-sig-default">'add'</span>,
392 <span class="summary-sig-arg">packetType</span>=<span class="summary-sig-default">'tcp'</span>,
393 <span class="summary-sig-arg">rule</span>=<span class="summary-sig-default">'DROP'</span>)</span><br />
394 Description:
395 add or remove iptables rule to DROP ( default )
396 packets from specific IP and PORT
397Usage:
398* specify action ( 'add' or 'remove' )
399 when removing, pass in the same argument as you would add.</td>
400 <td align="right" valign="top">
401 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.remotemininetdriver-pysrc.html#RemoteMininetDriver.setIpTablesOUTPUT">source&nbsp;code</a></span>
402
403 </td>
404 </tr>
405 </table>
406
407 </td>
408 </tr>
409<tr>
410 <td width="15%" align="right" valign="top" class="summary">
411 <span class="summary-type">&nbsp;</span>
412 </td><td class="summary">
413 <table width="100%" cellpadding="0" cellspacing="0" border="0">
414 <tr>
415 <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>,
416 <span class="summary-sig-arg">**execparams</span>)</span><br />
417 It facilitates the command line execution of a given command.
418 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
419 <td align="right" valign="top">
420 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.execute">source&nbsp;code</a></span>
421
422 </td>
423 </tr>
424 </table>
425
426 </td>
427 </tr>
428<tr>
429 <td width="15%" align="right" valign="top" class="summary">
430 <span class="summary-type">&nbsp;</span>
431 </td><td class="summary">
432 <table width="100%" cellpadding="0" cellspacing="0" border="0">
433 <tr>
434 <td><span class="summary-sig"><a name="onfail"></a><span class="summary-sig-name">onfail</span>(<span class="summary-sig-arg">self</span>)</span>
435 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
436 <td align="right" valign="top">
437 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.onfail">source&nbsp;code</a></span>
438
439 </td>
440 </tr>
441 </table>
442
443 </td>
444 </tr>
445<tr>
446 <td width="15%" align="right" valign="top" class="summary">
447 <span class="summary-type">&nbsp;</span>
448 </td><td class="summary">
449 <table width="100%" cellpadding="0" cellspacing="0" border="0">
450 <tr>
451 <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>,
452 <span class="summary-sig-arg">response</span>)</span>
453 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
454 <td align="right" valign="top">
455 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.remove_contol_chars">source&nbsp;code</a></span>
456
457 </td>
458 </tr>
459 </table>
460
461 </td>
462 </tr>
463<tr>
464 <td width="15%" align="right" valign="top" class="summary">
465 <span class="summary-type">&nbsp;</span>
466 </td><td class="summary">
467 <table width="100%" cellpadding="0" cellspacing="0" border="0">
468 <tr>
469 <td><span class="summary-sig"><a name="runAsSudoUser"></a><span class="summary-sig-name">runAsSudoUser</span>(<span class="summary-sig-arg">self</span>,
470 <span class="summary-sig-arg">handle</span>,
471 <span class="summary-sig-arg">pwd</span>,
472 <span class="summary-sig-arg">default</span>)</span>
473 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
474 <td align="right" valign="top">
475 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.runAsSudoUser">source&nbsp;code</a></span>
476
477 </td>
478 </tr>
479 </table>
480
481 </td>
482 </tr>
483<tr>
484 <td width="15%" align="right" valign="top" class="summary">
485 <span class="summary-type">&nbsp;</span>
486 </td><td class="summary">
487 <table width="100%" cellpadding="0" cellspacing="0" border="0">
488 <tr>
489 <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>,
490 <span class="summary-sig-arg">user_name</span>,
491 <span class="summary-sig-arg">ip_address</span>,
492 <span class="summary-sig-arg">filepath</span>,
493 <span class="summary-sig-arg">pwd</span>,
494 <span class="summary-sig-arg">dst_path</span>)</span><br />
495 Connection will establish to the remote host using ssh.
496 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
497 <td align="right" valign="top">
498 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.secureCopy">source&nbsp;code</a></span>
499
500 </td>
501 </tr>
502 </table>
503
504 </td>
505 </tr>
506 <tr>
507 <td colspan="2" class="summary">
508 <p class="indent-wrapped-lines"><b>Inherited from <code>component.Component</code></b>:
509 <code>__getattr__</code>,
510 <code>cleanup</code>,
511 <code>close_log_handles</code>,
512 <code>config</code>,
513 <code>experimentRun</code>,
514 <code>get_version</code>,
515 <code>log</code>
516 </p>
517 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
518 <code>__delattr__</code>,
519 <code>__format__</code>,
520 <code>__getattribute__</code>,
521 <code>__hash__</code>,
522 <code>__new__</code>,
523 <code>__reduce__</code>,
524 <code>__reduce_ex__</code>,
525 <code>__repr__</code>,
526 <code>__setattr__</code>,
527 <code>__sizeof__</code>,
528 <code>__str__</code>,
529 <code>__subclasshook__</code>
530 </p>
531 </td>
532 </tr>
533</table>
534<!-- ==================== PROPERTIES ==================== -->
535<a name="section-Properties"></a>
536<table class="summary" border="1" cellpadding="3"
537 cellspacing="0" width="100%" bgcolor="white">
538<tr bgcolor="#70b0f0" class="table-header">
539 <td colspan="2" class="table-header">
540 <table border="0" cellpadding="0" cellspacing="0" width="100%">
541 <tr valign="top">
542 <td align="left"><span class="table-header">Properties</span></td>
543 <td align="right" valign="top"
544 ><span class="options">[<a href="#section-Properties"
545 class="privatelink" onclick="toggle_private();"
546 >hide private</a>]</span></td>
547 </tr>
548 </table>
549 </td>
550</tr>
551 <tr>
552 <td colspan="2" class="summary">
553 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
554 <code>__class__</code>
555 </p>
556 </td>
557 </tr>
558</table>
559<!-- ==================== METHOD DETAILS ==================== -->
560<a name="section-MethodDetails"></a>
561<table class="details" border="1" cellpadding="3"
562 cellspacing="0" width="100%" bgcolor="white">
563<tr bgcolor="#70b0f0" class="table-header">
564 <td colspan="2" class="table-header">
565 <table border="0" cellpadding="0" cellspacing="0" width="100%">
566 <tr valign="top">
567 <td align="left"><span class="table-header">Method Details</span></td>
568 <td align="right" valign="top"
569 ><span class="options">[<a href="#section-MethodDetails"
570 class="privatelink" onclick="toggle_private();"
571 >hide private</a>]</span></td>
572 </tr>
573 </table>
574 </td>
575</tr>
576</table>
577<a name="__init__"></a>
578<div>
579<table class="details" border="1" cellpadding="3"
580 cellspacing="0" width="100%" bgcolor="white">
581<tr><td>
582 <table width="100%" cellpadding="0" cellspacing="0" border="0">
583 <tr valign="top"><td>
584 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>)</span>
585 <br /><em class="fname">(Constructor)</em>
586 </h3>
587 </td><td align="right" valign="top"
588 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.remotemininetdriver-pysrc.html#RemoteMininetDriver.__init__">source&nbsp;code</a></span>&nbsp;
589 </td>
590 </tr></table>
591
592 <p>x.__init__(...) initializes x; see help(type(x)) for signature</p>
593 <dl class="fields">
594 <dt>Overrides:
595 object.__init__
596 <dd><em class="note">(inherited documentation)</em></dd>
597 </dt>
598 </dl>
599</td></tr></table>
600</div>
601<a name="connect"></a>
602<div>
603<table class="details" border="1" cellpadding="3"
604 cellspacing="0" width="100%" bgcolor="white">
605<tr><td>
606 <table width="100%" cellpadding="0" cellspacing="0" border="0">
607 <tr valign="top"><td>
608 <h3 class="epydoc"><span class="sig"><span class="sig-name">connect</span>(<span class="sig-arg">self</span>,
609 <span class="sig-arg">**connectargs</span>)</span>
610 </h3>
611 </td><td align="right" valign="top"
612 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.remotemininetdriver-pysrc.html#RemoteMininetDriver.connect">source&nbsp;code</a></span>&nbsp;
613 </td>
614 </tr></table>
615
616 <p>,user_name, ip_address, pwd,options ): Here the main is the TestON
617 instance after creating all the log handles.</p>
618 <dl class="fields">
619 <dt>Overrides:
620 component.Component.connect
621 </dt>
622 </dl>
623</td></tr></table>
624</div>
625<a name="pingKill"></a>
626<div>
627<table class="details" border="1" cellpadding="3"
628 cellspacing="0" width="100%" bgcolor="white">
629<tr><td>
630 <table width="100%" cellpadding="0" cellspacing="0" border="0">
631 <tr valign="top"><td>
632 <h3 class="epydoc"><span class="sig"><span class="sig-name">pingKill</span>(<span class="sig-arg">self</span>,
633 <span class="sig-arg">testONUser</span>,
634 <span class="sig-arg">testONIP</span>)</span>
635 </h3>
636 </td><td align="right" valign="top"
637 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.remotemininetdriver-pysrc.html#RemoteMininetDriver.pingKill">source&nbsp;code</a></span>&nbsp;
638 </td>
639 </tr></table>
640
641 <p>Kills all continuous ping processes. Then copies all the ping files to
642 the TestStation.</p>
643 <dl class="fields">
644 </dl>
645</td></tr></table>
646</div>
647<a name="disconnect"></a>
648<div>
649<table class="details" border="1" cellpadding="3"
650 cellspacing="0" width="100%" bgcolor="white">
651<tr><td>
652 <table width="100%" cellpadding="0" cellspacing="0" border="0">
653 <tr valign="top"><td>
654 <h3 class="epydoc"><span class="sig"><span class="sig-name">disconnect</span>(<span class="sig-arg">self</span>)</span>
655 </h3>
656 </td><td align="right" valign="top"
657 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.remotemininetdriver-pysrc.html#RemoteMininetDriver.disconnect">source&nbsp;code</a></span>&nbsp;
658 </td>
659 </tr></table>
660
661 <p>Called at the end of the test to disconnect the handle.</p>
662 <dl class="fields">
663 <dt>Overrides:
664 component.Component.disconnect
665 </dt>
666 </dl>
667</td></tr></table>
668</div>
669<a name="setIpTablesOUTPUT"></a>
670<div>
671<table class="details" border="1" cellpadding="3"
672 cellspacing="0" width="100%" bgcolor="white">
673<tr><td>
674 <table width="100%" cellpadding="0" cellspacing="0" border="0">
675 <tr valign="top"><td>
676 <h3 class="epydoc"><span class="sig"><span class="sig-name">setIpTablesOUTPUT</span>(<span class="sig-arg">self</span>,
677 <span class="sig-arg">dstIp</span>,
678 <span class="sig-arg">dstPort</span>,
679 <span class="sig-arg">action</span>=<span class="sig-default">'add'</span>,
680 <span class="sig-arg">packetType</span>=<span class="sig-default">'tcp'</span>,
681 <span class="sig-arg">rule</span>=<span class="sig-default">'DROP'</span>)</span>
682 </h3>
683 </td><td align="right" valign="top"
684 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.remotemininetdriver-pysrc.html#RemoteMininetDriver.setIpTablesOUTPUT">source&nbsp;code</a></span>&nbsp;
685 </td>
686 </tr></table>
687
688 <pre class="literalblock">
689
690Description:
691 add or remove iptables rule to DROP ( default )
692 packets from specific IP and PORT
693Usage:
694* specify action ( 'add' or 'remove' )
695 when removing, pass in the same argument as you would add. It will
696 delete that specific rule.
697* specify the destination ip to block with dstIp
698* specify destination port to block to dstPort
699* optional packet type to block ( default tcp )
700* optional iptables rule ( default DROP )
701WARNING:
702* This function uses root privilege iptables command which may result
703in unwanted network errors. USE WITH CAUTION
704
705</pre>
706 <dl class="fields">
707 </dl>
708</td></tr></table>
709</div>
710<br />
711<!-- ==================== NAVIGATION BAR ==================== -->
712<table class="navbar" border="0" width="100%" cellpadding="0"
713 bgcolor="#a0c0ff" cellspacing="0">
714 <tr valign="middle">
715 <!-- Home link -->
716 <th>&nbsp;&nbsp;&nbsp;<a
717 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
718
719 <!-- Tree link -->
720 <th>&nbsp;&nbsp;&nbsp;<a
721 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
722
723 <!-- Index link -->
724 <th>&nbsp;&nbsp;&nbsp;<a
725 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
726
727 <!-- Help link -->
728 <th>&nbsp;&nbsp;&nbsp;<a
729 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
730
731 <!-- Project homepage -->
732 <th class="navbar" align="right" width="100%">
733 <table border="0" cellpadding="0" cellspacing="0">
734 <tr><th class="navbar" align="center"
735 >TestON</th>
736 </tr></table></th>
737 </tr>
738</table>
739<table border="0" cellpadding="0" cellspacing="0" width="100%%">
740 <tr>
741 <td align="left" class="footer">
742 Generated by Epydoc 3.0.1 on Mon Aug 10 11:12:35 2015
743 </td>
744 <td align="right" class="footer">
745 <a target="mainFrame" href="http://epydoc.sourceforge.net"
746 >http://epydoc.sourceforge.net</a>
747 </td>
748 </tr>
749</table>
750
751<script type="text/javascript">
752 <!--
753 // Private objects are initially displayed (because if
754 // javascript is turned off then we want them to be
755 // visible); but by default, we want to hide them. So hide
756 // them unless we have a cookie that says to show them.
757 checkCookie();
758 // -->
759</script>
760</body>
761</html>