Gitiles
Code Review Sign In
gerrit.onosproject.org / OnosSystemTest / 095730ab5095824c4e78a32881d54b09c961788a / . / TestON / Documentation / TestON_Document / TestON.drivers.common.cli.emulator.mininetclidriver.MininetCliDriver-class.html
blob: 9b083093fd54381c7894e984ec274a3fd93ab477 [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.mininetclidriver.MininetCliDriver</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.emulator-module.html">Package&nbsp;emulator</a> ::
50 <a href="TestON.drivers.common.cli.emulator.mininetclidriver-module.html">Module&nbsp;mininetclidriver</a> ::
51 Class&nbsp;MininetCliDriver
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.mininetclidriver.MininetCliDriver-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 MininetCliDriver</h1><p class="nomargin-top"><span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver">source&nbsp;code</a></span></p>
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]69<center>
70<center> <map id="class_hierarchy_for_mininetcli" name="class_hierarchy_for_mininetcli">
71<area shape="rect" id="node1" href="TestON.drivers.common.cli.emulator.mininetclidriver.MininetCliDriver-class.html" title="MininetCliDriver" alt="" coords="5,6,120,31"/>
72<area shape="rect" id="node2" href="TestON.drivers.common.cli.emulatordriver.Emulator-class.html" title="emulatordriver.Emulator" alt="" coords="144,6,303,31"/>
73<area shape="rect" id="node3" href="TestON.drivers.common.clidriver.CLI-class.html" title="clidriver.CLI" alt="" coords="329,6,420,31"/>
74<area shape="rect" id="node4" href="javascript:void(0);" title="component.Component" alt="" coords="445,6,603,31"/>
75</map>
76 <img src="class_hierarchy_for_mininetcli.gif" alt='' usemap="#class_hierarchy_for_mininetcli" ismap="ismap" class="graph-without-title" />
77</center>
78</center>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]79<hr />
80<p>MininetCliDriver is the basic driver which will handle the Mininet
81 functions</p>
82
83<!-- ==================== INSTANCE METHODS ==================== -->
84<a name="section-InstanceMethods"></a>
85<table class="summary" border="1" cellpadding="3"
86 cellspacing="0" width="100%" bgcolor="white">
87<tr bgcolor="#70b0f0" class="table-header">
88 <td colspan="2" class="table-header">
89 <table border="0" cellpadding="0" cellspacing="0" width="100%">
90 <tr valign="top">
91 <td align="left"><span class="table-header">Instance Methods</span></td>
92 <td align="right" valign="top"
93 ><span class="options">[<a href="#section-InstanceMethods"
94 class="privatelink" onclick="toggle_private();"
95 >hide private</a>]</span></td>
96 </tr>
97 </table>
98 </td>
99</tr>
100<tr>
101 <td width="15%" align="right" valign="top" class="summary">
102 <span class="summary-type">&nbsp;</span>
103 </td><td class="summary">
104 <table width="100%" cellpadding="0" cellspacing="0" border="0">
105 <tr>
106 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.mininetclidriver.MininetCliDriver-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]107 x.__init__(...) initializes x; see help(type(x)) for signature</td>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]108 <td align="right" valign="top">
109 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.__init__">source&nbsp;code</a></span>
110
111 </td>
112 </tr>
113 </table>
114
115 </td>
116 </tr>
117<tr>
118 <td width="15%" align="right" valign="top" class="summary">
119 <span class="summary-type">&nbsp;</span>
120 </td><td class="summary">
121 <table width="100%" cellpadding="0" cellspacing="0" border="0">
122 <tr>
123 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.mininetclidriver.MininetCliDriver-class.html#connect" class="summary-sig-name">connect</a>(<span class="summary-sig-arg">self</span>,
124 <span class="summary-sig-arg">**connectargs</span>)</span><br />
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]125 Here the main is the TestON instance after creating all the log
126 handles.</td>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]127 <td align="right" valign="top">
128 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.connect">source&nbsp;code</a></span>
129
130 </td>
131 </tr>
132 </table>
133
134 </td>
135 </tr>
136<tr>
137 <td width="15%" align="right" valign="top" class="summary">
138 <span class="summary-type">&nbsp;</span>
139 </td><td class="summary">
140 <table width="100%" cellpadding="0" cellspacing="0" border="0">
141 <tr>
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]142 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.mininetclidriver.MininetCliDriver-class.html#startNet" class="summary-sig-name">startNet</a>(<span class="summary-sig-arg">self</span>,
143 <span class="summary-sig-arg">topoFile</span>=<span class="summary-sig-default">''</span>,
144 <span class="summary-sig-arg">args</span>=<span class="summary-sig-default">''</span>,
145 <span class="summary-sig-arg">mnCmd</span>=<span class="summary-sig-default">''</span>,
146 <span class="summary-sig-arg">timeout</span>=<span class="summary-sig-default">120</span>)</span><br />
147 Description:
148 Starts Mininet accepts a topology(.py) file and/or an optional
149 argument, to start the mininet, as a parameter.</td>
150 <td align="right" valign="top">
151 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.startNet">source&nbsp;code</a></span>
152
153 </td>
154 </tr>
155 </table>
156
157 </td>
158 </tr>
159<tr>
160 <td width="15%" align="right" valign="top" class="summary">
161 <span class="summary-type">&nbsp;</span>
162 </td><td class="summary">
163 <table width="100%" cellpadding="0" cellspacing="0" border="0">
164 <tr>
165 <td><span class="summary-sig"><a name="numSwitchesNlinks"></a><span class="summary-sig-name">numSwitchesNlinks</span>(<span class="summary-sig-arg">self</span>,
166 <span class="summary-sig-arg">topoType</span>,
167 <span class="summary-sig-arg">depth</span>,
168 <span class="summary-sig-arg">fanout</span>)</span></td>
169 <td align="right" valign="top">
170 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.numSwitchesNlinks">source&nbsp;code</a></span>
171
172 </td>
173 </tr>
174 </table>
175
176 </td>
177 </tr>
178<tr>
179 <td width="15%" align="right" valign="top" class="summary">
180 <span class="summary-type">&nbsp;</span>
181 </td><td class="summary">
182 <table width="100%" cellpadding="0" cellspacing="0" border="0">
183 <tr>
184 <td><span class="summary-sig"><a name="calculateSwAndLinks"></a><span class="summary-sig-name">calculateSwAndLinks</span>(<span class="summary-sig-arg">self</span>)</span><br />
185 Calculate the number of switches and links in a topo.</td>
186 <td align="right" valign="top">
187 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.calculateSwAndLinks">source&nbsp;code</a></span>
188
189 </td>
190 </tr>
191 </table>
192
193 </td>
194 </tr>
195<tr>
196 <td width="15%" align="right" valign="top" class="summary">
197 <span class="summary-type">&nbsp;</span>
198 </td><td class="summary">
199 <table width="100%" cellpadding="0" cellspacing="0" border="0">
200 <tr>
201 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.mininetclidriver.MininetCliDriver-class.html#pingall" class="summary-sig-name">pingall</a>(<span class="summary-sig-arg">self</span>,
202 <span class="summary-sig-arg">timeout</span>=<span class="summary-sig-default">300</span>,
203 <span class="summary-sig-arg">shortCircuit</span>=<span class="summary-sig-default">False</span>,
204 <span class="summary-sig-arg">acceptableFailed</span>=<span class="summary-sig-default">0</span>)</span><br />
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]205 Verifies the reachability of the hosts using pingall command.</td>
206 <td align="right" valign="top">
207 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.pingall">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>
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]221 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.mininetclidriver.MininetCliDriver-class.html#fpingHost" class="summary-sig-name">fpingHost</a>(<span class="summary-sig-arg">self</span>,
222 <span class="summary-sig-arg">**pingParams</span>)</span><br />
223 Uses the fping package for faster pinging...</td>
224 <td align="right" valign="top">
225 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.fpingHost">source&nbsp;code</a></span>
226
227 </td>
228 </tr>
229 </table>
230
231 </td>
232 </tr>
233<tr>
234 <td width="15%" align="right" valign="top" class="summary">
235 <span class="summary-type">&nbsp;</span>
236 </td><td class="summary">
237 <table width="100%" cellpadding="0" cellspacing="0" border="0">
238 <tr>
239 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.mininetclidriver.MininetCliDriver-class.html#pingallHosts" class="summary-sig-name">pingallHosts</a>(<span class="summary-sig-arg">self</span>,
240 <span class="summary-sig-arg">hostList</span>)</span><br />
241 Ping all specified IPv4 hosts</td>
242 <td align="right" valign="top">
243 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.pingallHosts">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 href="TestON.drivers.common.cli.emulator.mininetclidriver.MininetCliDriver-class.html#pingIpv6Hosts" class="summary-sig-name">pingIpv6Hosts</a>(<span class="summary-sig-arg">self</span>,
258 <span class="summary-sig-arg">hostList</span>,
259 <span class="summary-sig-arg">prefix</span>=<span class="summary-sig-default">'1000::'</span>)</span><br />
260 IPv6 ping all hosts in hostList.</td>
261 <td align="right" valign="top">
262 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.pingIpv6Hosts">source&nbsp;code</a></span>
263
264 </td>
265 </tr>
266 </table>
267
268 </td>
269 </tr>
270<tr>
271 <td width="15%" align="right" valign="top" class="summary">
272 <span class="summary-type">&nbsp;</span>
273 </td><td class="summary">
274 <table width="100%" cellpadding="0" cellspacing="0" border="0">
275 <tr>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]276 <td><span class="summary-sig"><a name="pingHost"></a><span class="summary-sig-name">pingHost</span>(<span class="summary-sig-arg">self</span>,
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]277 <span class="summary-sig-arg">**pingParams</span>)</span><br />
278 Ping from one mininet host to another Currently the only supported
279 Params: SRC and TARGET</td>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]280 <td align="right" valign="top">
281 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.pingHost">source&nbsp;code</a></span>
282
283 </td>
284 </tr>
285 </table>
286
287 </td>
288 </tr>
289<tr>
290 <td width="15%" align="right" valign="top" class="summary">
291 <span class="summary-type">&nbsp;</span>
292 </td><td class="summary">
293 <table width="100%" cellpadding="0" cellspacing="0" border="0">
294 <tr>
295 <td><span class="summary-sig"><a name="checkIP"></a><span class="summary-sig-name">checkIP</span>(<span class="summary-sig-arg">self</span>,
296 <span class="summary-sig-arg">host</span>)</span><br />
297 Verifies the host's ip configured or not.</td>
298 <td align="right" valign="top">
299 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.checkIP">source&nbsp;code</a></span>
300
301 </td>
302 </tr>
303 </table>
304
305 </td>
306 </tr>
307<tr>
308 <td width="15%" align="right" valign="top" class="summary">
309 <span class="summary-type">&nbsp;</span>
310 </td><td class="summary">
311 <table width="100%" cellpadding="0" cellspacing="0" border="0">
312 <tr>
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]313 <td><span class="summary-sig"><a name="verifySSH"></a><span class="summary-sig-name">verifySSH</span>(<span class="summary-sig-arg">self</span>,
314 <span class="summary-sig-arg">**connectargs</span>)</span></td>
315 <td align="right" valign="top">
316 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.verifySSH">source&nbsp;code</a></span>
317
318 </td>
319 </tr>
320 </table>
321
322 </td>
323 </tr>
324<tr>
325 <td width="15%" align="right" valign="top" class="summary">
326 <span class="summary-type">&nbsp;</span>
327 </td><td class="summary">
328 <table width="100%" cellpadding="0" cellspacing="0" border="0">
329 <tr>
330 <td><span class="summary-sig"><a name="moveHost"></a><span class="summary-sig-name">moveHost</span>(<span class="summary-sig-arg">self</span>,
331 <span class="summary-sig-arg">host</span>,
332 <span class="summary-sig-arg">oldSw</span>,
333 <span class="summary-sig-arg">newSw</span>)</span><br />
334 Moves a host from one switch to another on the fly
335Note: The intf between host and oldSw when detached
336 using detach(), will still show up in the 'net'
337 cmd, because switch.detach() doesn't affect switch.intfs[]
338 ( which is correct behavior since the interfaces
339 haven't moved ).</td>
340 <td align="right" valign="top">
341 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.moveHost">source&nbsp;code</a></span>
342
343 </td>
344 </tr>
345 </table>
346
347 </td>
348 </tr>
349<tr>
350 <td width="15%" align="right" valign="top" class="summary">
351 <span class="summary-type">&nbsp;</span>
352 </td><td class="summary">
353 <table width="100%" cellpadding="0" cellspacing="0" border="0">
354 <tr>
355 <td><span class="summary-sig"><a name="changeIP"></a><span class="summary-sig-name">changeIP</span>(<span class="summary-sig-arg">self</span>,
356 <span class="summary-sig-arg">host</span>,
357 <span class="summary-sig-arg">intf</span>,
358 <span class="summary-sig-arg">newIP</span>,
359 <span class="summary-sig-arg">newNetmask</span>)</span><br />
360 Changes the ip address of a host on the fly Ex: h2 ifconfig h2-eth0
361 10.0.1.2 netmask 255.255.255.0</td>
362 <td align="right" valign="top">
363 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.changeIP">source&nbsp;code</a></span>
364
365 </td>
366 </tr>
367 </table>
368
369 </td>
370 </tr>
371<tr>
372 <td width="15%" align="right" valign="top" class="summary">
373 <span class="summary-type">&nbsp;</span>
374 </td><td class="summary">
375 <table width="100%" cellpadding="0" cellspacing="0" border="0">
376 <tr>
377 <td><span class="summary-sig"><a name="changeDefaultGateway"></a><span class="summary-sig-name">changeDefaultGateway</span>(<span class="summary-sig-arg">self</span>,
378 <span class="summary-sig-arg">host</span>,
379 <span class="summary-sig-arg">newGW</span>)</span><br />
380 Changes the default gateway of a host Ex: h1 route add default gw
381 10.0.1.2</td>
382 <td align="right" valign="top">
383 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.changeDefaultGateway">source&nbsp;code</a></span>
384
385 </td>
386 </tr>
387 </table>
388
389 </td>
390 </tr>
391<tr>
392 <td width="15%" align="right" valign="top" class="summary">
393 <span class="summary-type">&nbsp;</span>
394 </td><td class="summary">
395 <table width="100%" cellpadding="0" cellspacing="0" border="0">
396 <tr>
397 <td><span class="summary-sig"><a name="addStaticMACAddress"></a><span class="summary-sig-name">addStaticMACAddress</span>(<span class="summary-sig-arg">self</span>,
398 <span class="summary-sig-arg">host</span>,
399 <span class="summary-sig-arg">GW</span>,
400 <span class="summary-sig-arg">macaddr</span>)</span><br />
401 Changes the mac address of a gateway host</td>
402 <td align="right" valign="top">
403 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.addStaticMACAddress">source&nbsp;code</a></span>
404
405 </td>
406 </tr>
407 </table>
408
409 </td>
410 </tr>
411<tr>
412 <td width="15%" align="right" valign="top" class="summary">
413 <span class="summary-type">&nbsp;</span>
414 </td><td class="summary">
415 <table width="100%" cellpadding="0" cellspacing="0" border="0">
416 <tr>
417 <td><span class="summary-sig"><a name="verifyStaticGWandMAC"></a><span class="summary-sig-name">verifyStaticGWandMAC</span>(<span class="summary-sig-arg">self</span>,
418 <span class="summary-sig-arg">host</span>)</span><br />
419 Verify if the static gateway and mac address assignment</td>
420 <td align="right" valign="top">
421 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.verifyStaticGWandMAC">source&nbsp;code</a></span>
422
423 </td>
424 </tr>
425 </table>
426
427 </td>
428 </tr>
429<tr>
430 <td width="15%" align="right" valign="top" class="summary">
431 <span class="summary-type">&nbsp;</span>
432 </td><td class="summary">
433 <table width="100%" cellpadding="0" cellspacing="0" border="0">
434 <tr>
435 <td><span class="summary-sig"><a name="getMacAddress"></a><span class="summary-sig-name">getMacAddress</span>(<span class="summary-sig-arg">self</span>,
436 <span class="summary-sig-arg">host</span>)</span><br />
437 Verifies the host's ip configured or not.</td>
438 <td align="right" valign="top">
439 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.getMacAddress">source&nbsp;code</a></span>
440
441 </td>
442 </tr>
443 </table>
444
445 </td>
446 </tr>
447<tr>
448 <td width="15%" align="right" valign="top" class="summary">
449 <span class="summary-type">&nbsp;</span>
450 </td><td class="summary">
451 <table width="100%" cellpadding="0" cellspacing="0" border="0">
452 <tr>
453 <td><span class="summary-sig"><a name="getInterfaceMACAddress"></a><span class="summary-sig-name">getInterfaceMACAddress</span>(<span class="summary-sig-arg">self</span>,
454 <span class="summary-sig-arg">host</span>,
455 <span class="summary-sig-arg">interface</span>)</span><br />
456 Return the IP address of the interface on the given host</td>
457 <td align="right" valign="top">
458 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.getInterfaceMACAddress">source&nbsp;code</a></span>
459
460 </td>
461 </tr>
462 </table>
463
464 </td>
465 </tr>
466<tr>
467 <td width="15%" align="right" valign="top" class="summary">
468 <span class="summary-type">&nbsp;</span>
469 </td><td class="summary">
470 <table width="100%" cellpadding="0" cellspacing="0" border="0">
471 <tr>
472 <td><span class="summary-sig"><a name="getIPAddress"></a><span class="summary-sig-name">getIPAddress</span>(<span class="summary-sig-arg">self</span>,
473 <span class="summary-sig-arg">host</span>)</span><br />
474 Verifies the host's ip configured or not.</td>
475 <td align="right" valign="top">
476 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.getIPAddress">source&nbsp;code</a></span>
477
478 </td>
479 </tr>
480 </table>
481
482 </td>
483 </tr>
484<tr>
485 <td width="15%" align="right" valign="top" class="summary">
486 <span class="summary-type">&nbsp;</span>
487 </td><td class="summary">
488 <table width="100%" cellpadding="0" cellspacing="0" border="0">
489 <tr>
490 <td><span class="summary-sig"><a name="getSwitchDPID"></a><span class="summary-sig-name">getSwitchDPID</span>(<span class="summary-sig-arg">self</span>,
491 <span class="summary-sig-arg">switch</span>)</span><br />
492 return the datapath ID of the switch</td>
493 <td align="right" valign="top">
494 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.getSwitchDPID">source&nbsp;code</a></span>
495
496 </td>
497 </tr>
498 </table>
499
500 </td>
501 </tr>
502<tr>
503 <td width="15%" align="right" valign="top" class="summary">
504 <span class="summary-type">&nbsp;</span>
505 </td><td class="summary">
506 <table width="100%" cellpadding="0" cellspacing="0" border="0">
507 <tr>
508 <td><span class="summary-sig"><a name="getDPID"></a><span class="summary-sig-name">getDPID</span>(<span class="summary-sig-arg">self</span>,
509 <span class="summary-sig-arg">switch</span>)</span></td>
510 <td align="right" valign="top">
511 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.getDPID">source&nbsp;code</a></span>
512
513 </td>
514 </tr>
515 </table>
516
517 </td>
518 </tr>
519<tr>
520 <td width="15%" align="right" valign="top" class="summary">
521 <span class="summary-type">&nbsp;</span>
522 </td><td class="summary">
523 <table width="100%" cellpadding="0" cellspacing="0" border="0">
524 <tr>
525 <td><span class="summary-sig"><a name="getInterfaces"></a><span class="summary-sig-name">getInterfaces</span>(<span class="summary-sig-arg">self</span>,
526 <span class="summary-sig-arg">node</span>)</span><br />
527 return information dict about interfaces connected to the node</td>
528 <td align="right" valign="top">
529 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.getInterfaces">source&nbsp;code</a></span>
530
531 </td>
532 </tr>
533 </table>
534
535 </td>
536 </tr>
537<tr>
538 <td width="15%" align="right" valign="top" class="summary">
539 <span class="summary-type">&nbsp;</span>
540 </td><td class="summary">
541 <table width="100%" cellpadding="0" cellspacing="0" border="0">
542 <tr>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]543 <td><span class="summary-sig"><a name="dump"></a><span class="summary-sig-name">dump</span>(<span class="summary-sig-arg">self</span>)</span></td>
544 <td align="right" valign="top">
545 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.dump">source&nbsp;code</a></span>
546
547 </td>
548 </tr>
549 </table>
550
551 </td>
552 </tr>
553<tr>
554 <td width="15%" align="right" valign="top" class="summary">
555 <span class="summary-type">&nbsp;</span>
556 </td><td class="summary">
557 <table width="100%" cellpadding="0" cellspacing="0" border="0">
558 <tr>
559 <td><span class="summary-sig"><a name="intfs"></a><span class="summary-sig-name">intfs</span>(<span class="summary-sig-arg">self</span>)</span></td>
560 <td align="right" valign="top">
561 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.intfs">source&nbsp;code</a></span>
562
563 </td>
564 </tr>
565 </table>
566
567 </td>
568 </tr>
569<tr>
570 <td width="15%" align="right" valign="top" class="summary">
571 <span class="summary-type">&nbsp;</span>
572 </td><td class="summary">
573 <table width="100%" cellpadding="0" cellspacing="0" border="0">
574 <tr>
575 <td><span class="summary-sig"><a name="net"></a><span class="summary-sig-name">net</span>(<span class="summary-sig-arg">self</span>)</span></td>
576 <td align="right" valign="top">
577 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.net">source&nbsp;code</a></span>
578
579 </td>
580 </tr>
581 </table>
582
583 </td>
584 </tr>
585<tr>
586 <td width="15%" align="right" valign="top" class="summary">
587 <span class="summary-type">&nbsp;</span>
588 </td><td class="summary">
589 <table width="100%" cellpadding="0" cellspacing="0" border="0">
590 <tr>
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]591 <td><span class="summary-sig"><a name="links"></a><span class="summary-sig-name">links</span>(<span class="summary-sig-arg">self</span>)</span></td>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]592 <td align="right" valign="top">
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]593 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.links">source&nbsp;code</a></span>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]594
595 </td>
596 </tr>
597 </table>
598
599 </td>
600 </tr>
601<tr>
602 <td width="15%" align="right" valign="top" class="summary">
603 <span class="summary-type">&nbsp;</span>
604 </td><td class="summary">
605 <table width="100%" cellpadding="0" cellspacing="0" border="0">
606 <tr>
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]607 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.mininetclidriver.MininetCliDriver-class.html#iperftcpAll" class="summary-sig-name">iperftcpAll</a>(<span class="summary-sig-arg">self</span>,
608 <span class="summary-sig-arg">hosts</span>,
609 <span class="summary-sig-arg">timeout</span>=<span class="summary-sig-default">6</span>)</span><br />
610 Runs the iperftcp function with a given set of hosts and specified timeout.</td>
611 <td align="right" valign="top">
612 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.iperftcpAll">source&nbsp;code</a></span>
613
614 </td>
615 </tr>
616 </table>
617
618 </td>
619 </tr>
620<tr>
621 <td width="15%" align="right" valign="top" class="summary">
622 <span class="summary-type">&nbsp;</span>
623 </td><td class="summary">
624 <table width="100%" cellpadding="0" cellspacing="0" border="0">
625 <tr>
626 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.mininetclidriver.MininetCliDriver-class.html#iperftcp" class="summary-sig-name">iperftcp</a>(<span class="summary-sig-arg">self</span>,
627 <span class="summary-sig-arg">host1</span>=<span class="summary-sig-default">&quot;h1&quot;</span>,
628 <span class="summary-sig-arg">host2</span>=<span class="summary-sig-default">&quot;h2&quot;</span>,
629 <span class="summary-sig-arg">timeout</span>=<span class="summary-sig-default">6</span>)</span><br />
630 Creates an iperf TCP test between two hosts.</td>
631 <td align="right" valign="top">
632 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.iperftcp">source&nbsp;code</a></span>
633
634 </td>
635 </tr>
636 </table>
637
638 </td>
639 </tr>
640<tr>
641 <td width="15%" align="right" valign="top" class="summary">
642 <span class="summary-type">&nbsp;</span>
643 </td><td class="summary">
644 <table width="100%" cellpadding="0" cellspacing="0" border="0">
645 <tr>
646 <td><span class="summary-sig"><a name="iperfudpAll"></a><span class="summary-sig-name">iperfudpAll</span>(<span class="summary-sig-arg">self</span>,
647 <span class="summary-sig-arg">hosts</span>,
648 <span class="summary-sig-arg">bandwidth</span>=<span class="summary-sig-default">&quot;10M&quot;</span>)</span><br />
649 Runs the iperfudp function with a given set of hosts and specified
650 bandwidth</td>
651 <td align="right" valign="top">
652 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.iperfudpAll">source&nbsp;code</a></span>
653
654 </td>
655 </tr>
656 </table>
657
658 </td>
659 </tr>
660<tr>
661 <td width="15%" align="right" valign="top" class="summary">
662 <span class="summary-type">&nbsp;</span>
663 </td><td class="summary">
664 <table width="100%" cellpadding="0" cellspacing="0" border="0">
665 <tr>
666 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.mininetclidriver.MininetCliDriver-class.html#iperfudp" class="summary-sig-name">iperfudp</a>(<span class="summary-sig-arg">self</span>,
667 <span class="summary-sig-arg">bandwidth</span>=<span class="summary-sig-default">&quot;10M&quot;</span>,
668 <span class="summary-sig-arg">host1</span>=<span class="summary-sig-default">&quot;h1&quot;</span>,
669 <span class="summary-sig-arg">host2</span>=<span class="summary-sig-default">&quot;h2&quot;</span>)</span><br />
670 Creates an iperf UDP test with a specific bandwidth.</td>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]671 <td align="right" valign="top">
672 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.iperfudp">source&nbsp;code</a></span>
673
674 </td>
675 </tr>
676 </table>
677
678 </td>
679 </tr>
680<tr>
681 <td width="15%" align="right" valign="top" class="summary">
682 <span class="summary-type">&nbsp;</span>
683 </td><td class="summary">
684 <table width="100%" cellpadding="0" cellspacing="0" border="0">
685 <tr>
686 <td><span class="summary-sig"><a name="nodes"></a><span class="summary-sig-name">nodes</span>(<span class="summary-sig-arg">self</span>)</span></td>
687 <td align="right" valign="top">
688 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.nodes">source&nbsp;code</a></span>
689
690 </td>
691 </tr>
692 </table>
693
694 </td>
695 </tr>
696<tr>
697 <td width="15%" align="right" valign="top" class="summary">
698 <span class="summary-type">&nbsp;</span>
699 </td><td class="summary">
700 <table width="100%" cellpadding="0" cellspacing="0" border="0">
701 <tr>
702 <td><span class="summary-sig"><a name="pingpair"></a><span class="summary-sig-name">pingpair</span>(<span class="summary-sig-arg">self</span>)</span></td>
703 <td align="right" valign="top">
704 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.pingpair">source&nbsp;code</a></span>
705
706 </td>
707 </tr>
708 </table>
709
710 </td>
711 </tr>
712<tr>
713 <td width="15%" align="right" valign="top" class="summary">
714 <span class="summary-type">&nbsp;</span>
715 </td><td class="summary">
716 <table width="100%" cellpadding="0" cellspacing="0" border="0">
717 <tr>
718 <td><span class="summary-sig"><a name="link"></a><span class="summary-sig-name">link</span>(<span class="summary-sig-arg">self</span>,
719 <span class="summary-sig-arg">**linkargs</span>)</span><br />
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]720 Bring link( s ) between two nodes up or down</td>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]721 <td align="right" valign="top">
722 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.link">source&nbsp;code</a></span>
723
724 </td>
725 </tr>
726 </table>
727
728 </td>
729 </tr>
730<tr>
731 <td width="15%" align="right" valign="top" class="summary">
732 <span class="summary-type">&nbsp;</span>
733 </td><td class="summary">
734 <table width="100%" cellpadding="0" cellspacing="0" border="0">
735 <tr>
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]736 <td><span class="summary-sig"><a name="yank"></a><span class="summary-sig-name">yank</span>(<span class="summary-sig-arg">self</span>,
737 <span class="summary-sig-arg">**yankargs</span>)</span><br />
738 yank a mininet switch interface to a host</td>
739 <td align="right" valign="top">
740 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.yank">source&nbsp;code</a></span>
741
742 </td>
743 </tr>
744 </table>
745
746 </td>
747 </tr>
748<tr>
749 <td width="15%" align="right" valign="top" class="summary">
750 <span class="summary-type">&nbsp;</span>
751 </td><td class="summary">
752 <table width="100%" cellpadding="0" cellspacing="0" border="0">
753 <tr>
754 <td><span class="summary-sig"><a name="plug"></a><span class="summary-sig-name">plug</span>(<span class="summary-sig-arg">self</span>,
755 <span class="summary-sig-arg">**plugargs</span>)</span><br />
756 plug the yanked mininet switch interface to a switch</td>
757 <td align="right" valign="top">
758 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.plug">source&nbsp;code</a></span>
759
760 </td>
761 </tr>
762 </table>
763
764 </td>
765 </tr>
766<tr>
767 <td width="15%" align="right" valign="top" class="summary">
768 <span class="summary-type">&nbsp;</span>
769 </td><td class="summary">
770 <table width="100%" cellpadding="0" cellspacing="0" border="0">
771 <tr>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]772 <td><span class="summary-sig"><a name="dpctl"></a><span class="summary-sig-name">dpctl</span>(<span class="summary-sig-arg">self</span>,
773 <span class="summary-sig-arg">**dpctlargs</span>)</span><br />
774 Run dpctl command on all switches.</td>
775 <td align="right" valign="top">
776 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.dpctl">source&nbsp;code</a></span>
777
778 </td>
779 </tr>
780 </table>
781
782 </td>
783 </tr>
784<tr>
785 <td width="15%" align="right" valign="top" class="summary">
786 <span class="summary-type">&nbsp;</span>
787 </td><td class="summary">
788 <table width="100%" cellpadding="0" cellspacing="0" border="0">
789 <tr>
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]790 <td><span class="summary-sig"><a name="getVersion"></a><span class="summary-sig-name">getVersion</span>(<span class="summary-sig-arg">self</span>)</span></td>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]791 <td align="right" valign="top">
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]792 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.getVersion">source&nbsp;code</a></span>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]793
794 </td>
795 </tr>
796 </table>
797
798 </td>
799 </tr>
800<tr>
801 <td width="15%" align="right" valign="top" class="summary">
802 <span class="summary-type">&nbsp;</span>
803 </td><td class="summary">
804 <table width="100%" cellpadding="0" cellspacing="0" border="0">
805 <tr>
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]806 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.mininetclidriver.MininetCliDriver-class.html#getSwController" class="summary-sig-name">getSwController</a>(<span class="summary-sig-arg">self</span>,
807 <span class="summary-sig-arg">sw</span>)</span><br />
808 Parameters:
809 sw: The name of an OVS switch.</td>
810 <td align="right" valign="top">
811 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.getSwController">source&nbsp;code</a></span>
812
813 </td>
814 </tr>
815 </table>
816
817 </td>
818 </tr>
819<tr>
820 <td width="15%" align="right" valign="top" class="summary">
821 <span class="summary-type">&nbsp;</span>
822 </td><td class="summary">
823 <table width="100%" cellpadding="0" cellspacing="0" border="0">
824 <tr>
825 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.mininetclidriver.MininetCliDriver-class.html#assignSwController" class="summary-sig-name">assignSwController</a>(<span class="summary-sig-arg">self</span>,
826 <span class="summary-sig-arg">sw</span>,
827 <span class="summary-sig-arg">ip</span>,
828 <span class="summary-sig-arg">port</span>=<span class="summary-sig-default">&quot;6633&quot;</span>,
829 <span class="summary-sig-arg">ptcp</span>=<span class="summary-sig-default">&quot;&quot;</span>)</span><br />
830 Description:
831 Assign switches to the controllers ( for ovs use only )
832Required:
833 sw - Name of the switch.</td>
834 <td align="right" valign="top">
835 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.assignSwController">source&nbsp;code</a></span>
836
837 </td>
838 </tr>
839 </table>
840
841 </td>
842 </tr>
843<tr>
844 <td width="15%" align="right" valign="top" class="summary">
845 <span class="summary-type">&nbsp;</span>
846 </td><td class="summary">
847 <table width="100%" cellpadding="0" cellspacing="0" border="0">
848 <tr>
849 <td><span class="summary-sig"><a name="deleteSwController"></a><span class="summary-sig-name">deleteSwController</span>(<span class="summary-sig-arg">self</span>,
850 <span class="summary-sig-arg">sw</span>)</span><br />
851 Removes the controller target from sw</td>
852 <td align="right" valign="top">
853 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.deleteSwController">source&nbsp;code</a></span>
854
855 </td>
856 </tr>
857 </table>
858
859 </td>
860 </tr>
861<tr>
862 <td width="15%" align="right" valign="top" class="summary">
863 <span class="summary-type">&nbsp;</span>
864 </td><td class="summary">
865 <table width="100%" cellpadding="0" cellspacing="0" border="0">
866 <tr>
867 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.mininetclidriver.MininetCliDriver-class.html#addSwitch" class="summary-sig-name">addSwitch</a>(<span class="summary-sig-arg">self</span>,
868 <span class="summary-sig-arg">sw</span>,
869 <span class="summary-sig-arg">**kwargs</span>)</span><br />
870 adds a switch to the mininet topology
871NOTE: This uses a custom mn function.</td>
872 <td align="right" valign="top">
873 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.addSwitch">source&nbsp;code</a></span>
874
875 </td>
876 </tr>
877 </table>
878
879 </td>
880 </tr>
881<tr>
882 <td width="15%" align="right" valign="top" class="summary">
883 <span class="summary-type">&nbsp;</span>
884 </td><td class="summary">
885 <table width="100%" cellpadding="0" cellspacing="0" border="0">
886 <tr>
887 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.mininetclidriver.MininetCliDriver-class.html#delSwitch" class="summary-sig-name">delSwitch</a>(<span class="summary-sig-arg">self</span>,
888 <span class="summary-sig-arg">sw</span>)</span><br />
889 delete a switch from the mininet topology
890NOTE: This uses a custom mn function.</td>
891 <td align="right" valign="top">
892 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.delSwitch">source&nbsp;code</a></span>
893
894 </td>
895 </tr>
896 </table>
897
898 </td>
899 </tr>
900<tr>
901 <td width="15%" align="right" valign="top" class="summary">
902 <span class="summary-type">&nbsp;</span>
903 </td><td class="summary">
904 <table width="100%" cellpadding="0" cellspacing="0" border="0">
905 <tr>
906 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.mininetclidriver.MininetCliDriver-class.html#addLink" class="summary-sig-name">addLink</a>(<span class="summary-sig-arg">self</span>,
907 <span class="summary-sig-arg">node1</span>,
908 <span class="summary-sig-arg">node2</span>)</span><br />
909 add a link to the mininet topology
910NOTE: This uses a custom mn function.</td>
911 <td align="right" valign="top">
912 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.addLink">source&nbsp;code</a></span>
913
914 </td>
915 </tr>
916 </table>
917
918 </td>
919 </tr>
920<tr>
921 <td width="15%" align="right" valign="top" class="summary">
922 <span class="summary-type">&nbsp;</span>
923 </td><td class="summary">
924 <table width="100%" cellpadding="0" cellspacing="0" border="0">
925 <tr>
926 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.mininetclidriver.MininetCliDriver-class.html#delLink" class="summary-sig-name">delLink</a>(<span class="summary-sig-arg">self</span>,
927 <span class="summary-sig-arg">node1</span>,
928 <span class="summary-sig-arg">node2</span>)</span><br />
929 delete a link from the mininet topology
930NOTE: This uses a custom mn function.</td>
931 <td align="right" valign="top">
932 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.delLink">source&nbsp;code</a></span>
933
934 </td>
935 </tr>
936 </table>
937
938 </td>
939 </tr>
940<tr>
941 <td width="15%" align="right" valign="top" class="summary">
942 <span class="summary-type">&nbsp;</span>
943 </td><td class="summary">
944 <table width="100%" cellpadding="0" cellspacing="0" border="0">
945 <tr>
946 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.mininetclidriver.MininetCliDriver-class.html#addHost" class="summary-sig-name">addHost</a>(<span class="summary-sig-arg">self</span>,
947 <span class="summary-sig-arg">hostname</span>,
948 <span class="summary-sig-arg">**kwargs</span>)</span><br />
949 Add a host to the mininet topology
950NOTE: This uses a custom mn function.</td>
951 <td align="right" valign="top">
952 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.addHost">source&nbsp;code</a></span>
953
954 </td>
955 </tr>
956 </table>
957
958 </td>
959 </tr>
960<tr>
961 <td width="15%" align="right" valign="top" class="summary">
962 <span class="summary-type">&nbsp;</span>
963 </td><td class="summary">
964 <table width="100%" cellpadding="0" cellspacing="0" border="0">
965 <tr>
966 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.mininetclidriver.MininetCliDriver-class.html#delHost" class="summary-sig-name">delHost</a>(<span class="summary-sig-arg">self</span>,
967 <span class="summary-sig-arg">hostname</span>)</span><br />
968 delete a host from the mininet topology
969NOTE: This uses a custom mn function.</td>
970 <td align="right" valign="top">
971 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.delHost">source&nbsp;code</a></span>
972
973 </td>
974 </tr>
975 </table>
976
977 </td>
978 </tr>
979<tr>
980 <td width="15%" align="right" valign="top" class="summary">
981 <span class="summary-type">&nbsp;</span>
982 </td><td class="summary">
983 <table width="100%" cellpadding="0" cellspacing="0" border="0">
984 <tr>
985 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.mininetclidriver.MininetCliDriver-class.html#disconnect" class="summary-sig-name">disconnect</a>(<span class="summary-sig-arg">self</span>)</span><br />
986 Called at the end of the test to stop the mininet and disconnect the
987 handle.</td>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]988 <td align="right" valign="top">
989 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.disconnect">source&nbsp;code</a></span>
990
991 </td>
992 </tr>
993 </table>
994
995 </td>
996 </tr>
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]997<tr>
998 <td width="15%" align="right" valign="top" class="summary">
999 <span class="summary-type">&nbsp;</span>
1000 </td><td class="summary">
1001 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1002 <tr>
1003 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.mininetclidriver.MininetCliDriver-class.html#stopNet" class="summary-sig-name">stopNet</a>(<span class="summary-sig-arg">self</span>,
1004 <span class="summary-sig-arg">fileName</span>=<span class="summary-sig-default">&quot;&quot;</span>,
1005 <span class="summary-sig-arg">timeout</span>=<span class="summary-sig-default">5</span>)</span><br />
1006 Stops mininet.</td>
1007 <td align="right" valign="top">
1008 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.stopNet">source&nbsp;code</a></span>
1009
1010 </td>
1011 </tr>
1012 </table>
1013
1014 </td>
1015 </tr>
1016<tr>
1017 <td width="15%" align="right" valign="top" class="summary">
1018 <span class="summary-type">&nbsp;</span>
1019 </td><td class="summary">
1020 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1021 <tr>
1022 <td><span class="summary-sig"><a name="arping"></a><span class="summary-sig-name">arping</span>(<span class="summary-sig-arg">self</span>,
1023 <span class="summary-sig-arg">host</span>=<span class="summary-sig-default">&quot;&quot;</span>,
1024 <span class="summary-sig-arg">ip</span>=<span class="summary-sig-default">&quot;10.128.20.211&quot;</span>,
1025 <span class="summary-sig-arg">ethDevice</span>=<span class="summary-sig-default">&quot;&quot;</span>)</span><br />
1026 Description:
1027 Sends arp message from mininet host for hosts discovery
1028Required:
1029 host - hosts name
1030Optional:
1031 ip - ip address that does not exist in the network so there would
1032 be no reply.</td>
1033 <td align="right" valign="top">
1034 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.arping">source&nbsp;code</a></span>
1035
1036 </td>
1037 </tr>
1038 </table>
1039
1040 </td>
1041 </tr>
1042<tr>
1043 <td width="15%" align="right" valign="top" class="summary">
1044 <span class="summary-type">&nbsp;</span>
1045 </td><td class="summary">
1046 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1047 <tr>
1048 <td><span class="summary-sig"><a name="decToHex"></a><span class="summary-sig-name">decToHex</span>(<span class="summary-sig-arg">self</span>,
1049 <span class="summary-sig-arg">num</span>)</span></td>
1050 <td align="right" valign="top">
1051 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.decToHex">source&nbsp;code</a></span>
1052
1053 </td>
1054 </tr>
1055 </table>
1056
1057 </td>
1058 </tr>
1059<tr>
1060 <td width="15%" align="right" valign="top" class="summary">
1061 <span class="summary-type">&nbsp;</span>
1062 </td><td class="summary">
1063 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1064 <tr>
1065 <td><span class="summary-sig"><a name="getSwitchFlowCount"></a><span class="summary-sig-name">getSwitchFlowCount</span>(<span class="summary-sig-arg">self</span>,
1066 <span class="summary-sig-arg">switch</span>)</span><br />
1067 return the Flow Count of the switch</td>
1068 <td align="right" valign="top">
1069 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.getSwitchFlowCount">source&nbsp;code</a></span>
1070
1071 </td>
1072 </tr>
1073 </table>
1074
1075 </td>
1076 </tr>
1077<tr>
1078 <td width="15%" align="right" valign="top" class="summary">
1079 <span class="summary-type">&nbsp;</span>
1080 </td><td class="summary">
1081 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1082 <tr>
1083 <td><span class="summary-sig"><a name="checkFlows"></a><span class="summary-sig-name">checkFlows</span>(<span class="summary-sig-arg">self</span>,
1084 <span class="summary-sig-arg">sw</span>,
1085 <span class="summary-sig-arg">dumpFormat</span>=<span class="summary-sig-default">None</span>)</span></td>
1086 <td align="right" valign="top">
1087 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.checkFlows">source&nbsp;code</a></span>
1088
1089 </td>
1090 </tr>
1091 </table>
1092
1093 </td>
1094 </tr>
1095<tr>
1096 <td width="15%" align="right" valign="top" class="summary">
1097 <span class="summary-type">&nbsp;</span>
1098 </td><td class="summary">
1099 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1100 <tr>
1101 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.mininetclidriver.MininetCliDriver-class.html#getFlowTable" class="summary-sig-name">getFlowTable</a>(<span class="summary-sig-arg">self</span>,
1102 <span class="summary-sig-arg">protoVersion</span>,
1103 <span class="summary-sig-arg">sw</span>)</span><br />
1104 Returns certain fields of an OVS flow table.</td>
1105 <td align="right" valign="top">
1106 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.getFlowTable">source&nbsp;code</a></span>
1107
1108 </td>
1109 </tr>
1110 </table>
1111
1112 </td>
1113 </tr>
1114<tr>
1115 <td width="15%" align="right" valign="top" class="summary">
1116 <span class="summary-type">&nbsp;</span>
1117 </td><td class="summary">
1118 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1119 <tr>
1120 <td><span class="summary-sig"><a name="flowComp"></a><span class="summary-sig-name">flowComp</span>(<span class="summary-sig-arg">self</span>,
1121 <span class="summary-sig-arg">flow1</span>,
1122 <span class="summary-sig-arg">flow2</span>)</span></td>
1123 <td align="right" valign="top">
1124 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.flowComp">source&nbsp;code</a></span>
1125
1126 </td>
1127 </tr>
1128 </table>
1129
1130 </td>
1131 </tr>
1132<tr>
1133 <td width="15%" align="right" valign="top" class="summary">
1134 <span class="summary-type">&nbsp;</span>
1135 </td><td class="summary">
1136 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1137 <tr>
1138 <td><span class="summary-sig"><a name="startTcpdump"></a><span class="summary-sig-name">startTcpdump</span>(<span class="summary-sig-arg">self</span>,
1139 <span class="summary-sig-arg">filename</span>,
1140 <span class="summary-sig-arg">intf</span>=<span class="summary-sig-default">&quot;eth0&quot;</span>,
1141 <span class="summary-sig-arg">port</span>=<span class="summary-sig-default">&quot;port 6633&quot;</span>)</span><br />
1142 Runs tpdump on an interface and saves the file intf can be specified,
1143 or the default eth0 is used</td>
1144 <td align="right" valign="top">
1145 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.startTcpdump">source&nbsp;code</a></span>
1146
1147 </td>
1148 </tr>
1149 </table>
1150
1151 </td>
1152 </tr>
1153<tr>
1154 <td width="15%" align="right" valign="top" class="summary">
1155 <span class="summary-type">&nbsp;</span>
1156 </td><td class="summary">
1157 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1158 <tr>
1159 <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 />
1160 pkills tcpdump</td>
1161 <td align="right" valign="top">
1162 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.stopTcpdump">source&nbsp;code</a></span>
1163
1164 </td>
1165 </tr>
1166 </table>
1167
1168 </td>
1169 </tr>
1170<tr>
1171 <td width="15%" align="right" valign="top" class="summary">
1172 <span class="summary-type">&nbsp;</span>
1173 </td><td class="summary">
1174 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1175 <tr>
1176 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.mininetclidriver.MininetCliDriver-class.html#getPorts" class="summary-sig-name">getPorts</a>(<span class="summary-sig-arg">self</span>,
1177 <span class="summary-sig-arg">nodeName</span>,
1178 <span class="summary-sig-arg">verbose</span>=<span class="summary-sig-default">False</span>)</span><br />
1179 Read ports from a Mininet switch.</td>
1180 <td align="right" valign="top">
1181 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.getPorts">source&nbsp;code</a></span>
1182
1183 </td>
1184 </tr>
1185 </table>
1186
1187 </td>
1188 </tr>
1189<tr>
1190 <td width="15%" align="right" valign="top" class="summary">
1191 <span class="summary-type">&nbsp;</span>
1192 </td><td class="summary">
1193 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1194 <tr>
1195 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.mininetclidriver.MininetCliDriver-class.html#getSwitches" class="summary-sig-name">getSwitches</a>(<span class="summary-sig-arg">self</span>,
1196 <span class="summary-sig-arg">verbose</span>=<span class="summary-sig-default">False</span>)</span><br />
1197 Read switches from Mininet.</td>
1198 <td align="right" valign="top">
1199 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.getSwitches">source&nbsp;code</a></span>
1200
1201 </td>
1202 </tr>
1203 </table>
1204
1205 </td>
1206 </tr>
1207<tr>
1208 <td width="15%" align="right" valign="top" class="summary">
1209 <span class="summary-type">&nbsp;</span>
1210 </td><td class="summary">
1211 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1212 <tr>
1213 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.mininetclidriver.MininetCliDriver-class.html#getHosts" class="summary-sig-name">getHosts</a>(<span class="summary-sig-arg">self</span>,
1214 <span class="summary-sig-arg">verbose</span>=<span class="summary-sig-default">False</span>)</span><br />
1215 Read hosts from Mininet.</td>
1216 <td align="right" valign="top">
1217 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.getHosts">source&nbsp;code</a></span>
1218
1219 </td>
1220 </tr>
1221 </table>
1222
1223 </td>
1224 </tr>
1225<tr>
1226 <td width="15%" align="right" valign="top" class="summary">
1227 <span class="summary-type">&nbsp;</span>
1228 </td><td class="summary">
1229 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1230 <tr>
1231 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.mininetclidriver.MininetCliDriver-class.html#getLinks" class="summary-sig-name">getLinks</a>(<span class="summary-sig-arg">self</span>)</span><br />
1232 Gathers information about current Mininet links.</td>
1233 <td align="right" valign="top">
1234 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.getLinks">source&nbsp;code</a></span>
1235
1236 </td>
1237 </tr>
1238 </table>
1239
1240 </td>
1241 </tr>
1242<tr>
1243 <td width="15%" align="right" valign="top" class="summary">
1244 <span class="summary-type">&nbsp;</span>
1245 </td><td class="summary">
1246 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1247 <tr>
1248 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.mininetclidriver.MininetCliDriver-class.html#compareSwitches" class="summary-sig-name">compareSwitches</a>(<span class="summary-sig-arg">self</span>,
1249 <span class="summary-sig-arg">switches</span>,
1250 <span class="summary-sig-arg">switchesJson</span>,
1251 <span class="summary-sig-arg">portsJson</span>)</span><br />
1252 Compare mn and onos switches
1253 switchesJson: parsed json object from the onos devices api</td>
1254 <td align="right" valign="top">
1255 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.compareSwitches">source&nbsp;code</a></span>
1256
1257 </td>
1258 </tr>
1259 </table>
1260
1261 </td>
1262 </tr>
1263<tr>
1264 <td width="15%" align="right" valign="top" class="summary">
1265 <span class="summary-type">&nbsp;</span>
1266 </td><td class="summary">
1267 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1268 <tr>
1269 <td><span class="summary-sig"><a name="compareLinks"></a><span class="summary-sig-name">compareLinks</span>(<span class="summary-sig-arg">self</span>,
1270 <span class="summary-sig-arg">switches</span>,
1271 <span class="summary-sig-arg">links</span>,
1272 <span class="summary-sig-arg">linksJson</span>)</span><br />
1273 Compare mn and onos links linksJson: parsed json object from the onos
1274 links api</td>
1275 <td align="right" valign="top">
1276 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.compareLinks">source&nbsp;code</a></span>
1277
1278 </td>
1279 </tr>
1280 </table>
1281
1282 </td>
1283 </tr>
1284<tr>
1285 <td width="15%" align="right" valign="top" class="summary">
1286 <span class="summary-type">&nbsp;</span>
1287 </td><td class="summary">
1288 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1289 <tr>
1290 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.mininetclidriver.MininetCliDriver-class.html#compareHosts" class="summary-sig-name">compareHosts</a>(<span class="summary-sig-arg">self</span>,
1291 <span class="summary-sig-arg">hosts</span>,
1292 <span class="summary-sig-arg">hostsJson</span>)</span><br />
1293 Compare mn and onos Hosts.</td>
1294 <td align="right" valign="top">
1295 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.compareHosts">source&nbsp;code</a></span>
1296
1297 </td>
1298 </tr>
1299 </table>
1300
1301 </td>
1302 </tr>
1303<tr>
1304 <td width="15%" align="right" valign="top" class="summary">
1305 <span class="summary-type">&nbsp;</span>
1306 </td><td class="summary">
1307 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1308 <tr>
1309 <td><span class="summary-sig"><a name="getHostsOld"></a><span class="summary-sig-name">getHostsOld</span>(<span class="summary-sig-arg">self</span>)</span><br />
1310 Returns a list of all hosts Don't ask questions just use it</td>
1311 <td align="right" valign="top">
1312 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.getHostsOld">source&nbsp;code</a></span>
1313
1314 </td>
1315 </tr>
1316 </table>
1317
1318 </td>
1319 </tr>
1320<tr>
1321 <td width="15%" align="right" valign="top" class="summary">
1322 <span class="summary-type">&nbsp;</span>
1323 </td><td class="summary">
1324 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1325 <tr>
1326 <td><span class="summary-sig"><a name="getSwitch"></a><span class="summary-sig-name">getSwitch</span>(<span class="summary-sig-arg">self</span>)</span><br />
1327 Returns a list of all switches Again, don't ask question just use
1328 it...</td>
1329 <td align="right" valign="top">
1330 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.getSwitch">source&nbsp;code</a></span>
1331
1332 </td>
1333 </tr>
1334 </table>
1335
1336 </td>
1337 </tr>
1338<tr>
1339 <td width="15%" align="right" valign="top" class="summary">
1340 <span class="summary-type">&nbsp;</span>
1341 </td><td class="summary">
1342 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1343 <tr>
1344 <td><span class="summary-sig"><a name="update"></a><span class="summary-sig-name">update</span>(<span class="summary-sig-arg">self</span>)</span><br />
1345 updates the port address and status information for each port in mn</td>
1346 <td align="right" valign="top">
1347 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.update">source&nbsp;code</a></span>
1348
1349 </td>
1350 </tr>
1351 </table>
1352
1353 </td>
1354 </tr>
1355<tr>
1356 <td width="15%" align="right" valign="top" class="summary">
1357 <span class="summary-type">&nbsp;</span>
1358 </td><td class="summary">
1359 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1360 <tr>
1361 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.mininetclidriver.MininetCliDriver-class.html#assignVLAN" class="summary-sig-name">assignVLAN</a>(<span class="summary-sig-arg">self</span>,
1362 <span class="summary-sig-arg">host</span>,
1363 <span class="summary-sig-arg">intf</span>,
1364 <span class="summary-sig-arg">vlan</span>)</span><br />
1365 Add vlan tag to a host.</td>
1366 <td align="right" valign="top">
1367 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.assignVLAN">source&nbsp;code</a></span>
1368
1369 </td>
1370 </tr>
1371 </table>
1372
1373 </td>
1374 </tr>
1375<tr>
1376 <td width="15%" align="right" valign="top" class="summary">
1377 <span class="summary-type">&nbsp;</span>
1378 </td><td class="summary">
1379 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1380 <tr>
1381 <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>,
1382 <span class="summary-sig-arg">**execparams</span>)</span><br />
1383 It facilitates the command line execution of a given command.
1384 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
1385 <td align="right" valign="top">
1386 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.execute">source&nbsp;code</a></span>
1387
1388 </td>
1389 </tr>
1390 </table>
1391
1392 </td>
1393 </tr>
1394<tr>
1395 <td width="15%" align="right" valign="top" class="summary">
1396 <span class="summary-type">&nbsp;</span>
1397 </td><td class="summary">
1398 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1399 <tr>
1400 <td><span class="summary-sig"><a name="onfail"></a><span class="summary-sig-name">onfail</span>(<span class="summary-sig-arg">self</span>)</span>
1401 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
1402 <td align="right" valign="top">
1403 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.onfail">source&nbsp;code</a></span>
1404
1405 </td>
1406 </tr>
1407 </table>
1408
1409 </td>
1410 </tr>
1411<tr>
1412 <td width="15%" align="right" valign="top" class="summary">
1413 <span class="summary-type">&nbsp;</span>
1414 </td><td class="summary">
1415 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1416 <tr>
1417 <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>,
1418 <span class="summary-sig-arg">response</span>)</span>
1419 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
1420 <td align="right" valign="top">
1421 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.remove_contol_chars">source&nbsp;code</a></span>
1422
1423 </td>
1424 </tr>
1425 </table>
1426
1427 </td>
1428 </tr>
1429<tr>
1430 <td width="15%" align="right" valign="top" class="summary">
1431 <span class="summary-type">&nbsp;</span>
1432 </td><td class="summary">
1433 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1434 <tr>
1435 <td><span class="summary-sig"><a name="runAsSudoUser"></a><span class="summary-sig-name">runAsSudoUser</span>(<span class="summary-sig-arg">self</span>,
1436 <span class="summary-sig-arg">handle</span>,
1437 <span class="summary-sig-arg">pwd</span>,
1438 <span class="summary-sig-arg">default</span>)</span>
1439 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
1440 <td align="right" valign="top">
1441 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.runAsSudoUser">source&nbsp;code</a></span>
1442
1443 </td>
1444 </tr>
1445 </table>
1446
1447 </td>
1448 </tr>
1449<tr>
1450 <td width="15%" align="right" valign="top" class="summary">
1451 <span class="summary-type">&nbsp;</span>
1452 </td><td class="summary">
1453 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1454 <tr>
1455 <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>,
1456 <span class="summary-sig-arg">user_name</span>,
1457 <span class="summary-sig-arg">ip_address</span>,
1458 <span class="summary-sig-arg">filepath</span>,
1459 <span class="summary-sig-arg">pwd</span>,
1460 <span class="summary-sig-arg">dst_path</span>)</span><br />
1461 Connection will establish to the remote host using ssh.
1462 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
1463 <td align="right" valign="top">
1464 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.secureCopy">source&nbsp;code</a></span>
1465
1466 </td>
1467 </tr>
1468 </table>
1469
1470 </td>
1471 </tr>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]1472 <tr>
1473 <td colspan="2" class="summary">
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]1474 <p class="indent-wrapped-lines"><b>Inherited from <code>component.Component</code></b>:
1475 <code>__getattr__</code>,
1476 <code>cleanup</code>,
1477 <code>close_log_handles</code>,
1478 <code>config</code>,
1479 <code>experimentRun</code>,
1480 <code>get_version</code>,
1481 <code>log</code>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]1482 </p>
1483 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
1484 <code>__delattr__</code>,
1485 <code>__format__</code>,
1486 <code>__getattribute__</code>,
1487 <code>__hash__</code>,
1488 <code>__new__</code>,
1489 <code>__reduce__</code>,
1490 <code>__reduce_ex__</code>,
1491 <code>__repr__</code>,
1492 <code>__setattr__</code>,
1493 <code>__sizeof__</code>,
1494 <code>__str__</code>,
1495 <code>__subclasshook__</code>
1496 </p>
1497 </td>
1498 </tr>
1499</table>
1500<!-- ==================== PROPERTIES ==================== -->
1501<a name="section-Properties"></a>
1502<table class="summary" border="1" cellpadding="3"
1503 cellspacing="0" width="100%" bgcolor="white">
1504<tr bgcolor="#70b0f0" class="table-header">
1505 <td colspan="2" class="table-header">
1506 <table border="0" cellpadding="0" cellspacing="0" width="100%">
1507 <tr valign="top">
1508 <td align="left"><span class="table-header">Properties</span></td>
1509 <td align="right" valign="top"
1510 ><span class="options">[<a href="#section-Properties"
1511 class="privatelink" onclick="toggle_private();"
1512 >hide private</a>]</span></td>
1513 </tr>
1514 </table>
1515 </td>
1516</tr>
1517 <tr>
1518 <td colspan="2" class="summary">
1519 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
1520 <code>__class__</code>
1521 </p>
1522 </td>
1523 </tr>
1524</table>
1525<!-- ==================== METHOD DETAILS ==================== -->
1526<a name="section-MethodDetails"></a>
1527<table class="details" border="1" cellpadding="3"
1528 cellspacing="0" width="100%" bgcolor="white">
1529<tr bgcolor="#70b0f0" class="table-header">
1530 <td colspan="2" class="table-header">
1531 <table border="0" cellpadding="0" cellspacing="0" width="100%">
1532 <tr valign="top">
1533 <td align="left"><span class="table-header">Method Details</span></td>
1534 <td align="right" valign="top"
1535 ><span class="options">[<a href="#section-MethodDetails"
1536 class="privatelink" onclick="toggle_private();"
1537 >hide private</a>]</span></td>
1538 </tr>
1539 </table>
1540 </td>
1541</tr>
1542</table>
1543<a name="__init__"></a>
1544<div>
1545<table class="details" border="1" cellpadding="3"
1546 cellspacing="0" width="100%" bgcolor="white">
1547<tr><td>
1548 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1549 <tr valign="top"><td>
1550 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>)</span>
1551 <br /><em class="fname">(Constructor)</em>
1552 </h3>
1553 </td><td align="right" valign="top"
1554 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.__init__">source&nbsp;code</a></span>&nbsp;
1555 </td>
1556 </tr></table>
1557
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]1558 <p>x.__init__(...) initializes x; see help(type(x)) for signature</p>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]1559 <dl class="fields">
1560 <dt>Overrides:
1561 object.__init__
1562 <dd><em class="note">(inherited documentation)</em></dd>
1563 </dt>
1564 </dl>
1565</td></tr></table>
1566</div>
1567<a name="connect"></a>
1568<div>
1569<table class="details" border="1" cellpadding="3"
1570 cellspacing="0" width="100%" bgcolor="white">
1571<tr><td>
1572 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1573 <tr valign="top"><td>
1574 <h3 class="epydoc"><span class="sig"><span class="sig-name">connect</span>(<span class="sig-arg">self</span>,
1575 <span class="sig-arg">**connectargs</span>)</span>
1576 </h3>
1577 </td><td align="right" valign="top"
1578 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.connect">source&nbsp;code</a></span>&nbsp;
1579 </td>
1580 </tr></table>
1581
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]1582 <p>Here the main is the TestON instance after creating all the log
1583 handles.</p>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]1584 <dl class="fields">
1585 <dt>Overrides:
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]1586 component.Component.connect
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]1587 </dt>
1588 </dl>
1589</td></tr></table>
1590</div>
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]1591<a name="startNet"></a>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]1592<div>
1593<table class="details" border="1" cellpadding="3"
1594 cellspacing="0" width="100%" bgcolor="white">
1595<tr><td>
1596 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1597 <tr valign="top"><td>
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]1598 <h3 class="epydoc"><span class="sig"><span class="sig-name">startNet</span>(<span class="sig-arg">self</span>,
1599 <span class="sig-arg">topoFile</span>=<span class="sig-default">''</span>,
1600 <span class="sig-arg">args</span>=<span class="sig-default">''</span>,
1601 <span class="sig-arg">mnCmd</span>=<span class="sig-default">''</span>,
1602 <span class="sig-arg">timeout</span>=<span class="sig-default">120</span>)</span>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]1603 </h3>
1604 </td><td align="right" valign="top"
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]1605 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.startNet">source&nbsp;code</a></span>&nbsp;
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]1606 </td>
1607 </tr></table>
1608
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]1609 <pre class="literalblock">
1610
1611Description:
1612 Starts Mininet accepts a topology(.py) file and/or an optional
1613 argument, to start the mininet, as a parameter.
1614 Can also send regular mininet command to load up desired topology.
1615 Eg. Pass in a string 'sudo mn --topo=tree,3,3' to mnCmd
1616Options:
1617 topoFile = file path for topology file (.py)
1618 args = extra option added when starting the topology from the file
1619 mnCmd = Mininet command use to start topology
1620Returns:
1621 main.TRUE if the mininet starts successfully, main.FALSE
1622 otherwise
1623
1624</pre>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]1625 <dl class="fields">
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]1626 </dl>
1627</td></tr></table>
1628</div>
1629<a name="pingall"></a>
1630<div>
1631<table class="details" border="1" cellpadding="3"
1632 cellspacing="0" width="100%" bgcolor="white">
1633<tr><td>
1634 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1635 <tr valign="top"><td>
1636 <h3 class="epydoc"><span class="sig"><span class="sig-name">pingall</span>(<span class="sig-arg">self</span>,
1637 <span class="sig-arg">timeout</span>=<span class="sig-default">300</span>,
1638 <span class="sig-arg">shortCircuit</span>=<span class="sig-default">False</span>,
1639 <span class="sig-arg">acceptableFailed</span>=<span class="sig-default">0</span>)</span>
1640 </h3>
1641 </td><td align="right" valign="top"
1642 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.pingall">source&nbsp;code</a></span>&nbsp;
1643 </td>
1644 </tr></table>
1645
1646 <pre class="literalblock">
1647
1648Verifies the reachability of the hosts using pingall command.
1649Optional parameter timeout allows you to specify how long to
1650wait for pingall to complete
1651Optional:
1652timeout( seconds ) - How long to wait before breaking the pingall
1653shortCircuit - Break the pingall based on the number of failed hosts
1654 ping
1655acceptableFailed - Set the number of acceptable failed pings for the
1656 function to still return main.TRUE
1657Returns:
1658main.TRUE if pingall completes with no pings dropped
1659otherwise main.FALSE
1660
1661</pre>
1662 <dl class="fields">
1663 </dl>
1664</td></tr></table>
1665</div>
1666<a name="fpingHost"></a>
1667<div>
1668<table class="details" border="1" cellpadding="3"
1669 cellspacing="0" width="100%" bgcolor="white">
1670<tr><td>
1671 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1672 <tr valign="top"><td>
1673 <h3 class="epydoc"><span class="sig"><span class="sig-name">fpingHost</span>(<span class="sig-arg">self</span>,
1674 <span class="sig-arg">**pingParams</span>)</span>
1675 </h3>
1676 </td><td align="right" valign="top"
1677 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.fpingHost">source&nbsp;code</a></span>&nbsp;
1678 </td>
1679 </tr></table>
1680
1681 <p>Uses the fping package for faster pinging... *requires fping to be
1682 installed on machine running mininet</p>
1683 <dl class="fields">
1684 </dl>
1685</td></tr></table>
1686</div>
1687<a name="pingallHosts"></a>
1688<div>
1689<table class="details" border="1" cellpadding="3"
1690 cellspacing="0" width="100%" bgcolor="white">
1691<tr><td>
1692 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1693 <tr valign="top"><td>
1694 <h3 class="epydoc"><span class="sig"><span class="sig-name">pingallHosts</span>(<span class="sig-arg">self</span>,
1695 <span class="sig-arg">hostList</span>)</span>
1696 </h3>
1697 </td><td align="right" valign="top"
1698 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.pingallHosts">source&nbsp;code</a></span>&nbsp;
1699 </td>
1700 </tr></table>
1701
1702 <p>Ping all specified IPv4 hosts</p>
1703 <p>Acceptable hostList:</p>
1704 <ul>
1705 <li>
1706 [ 'h1','h2','h3','h4' ]
1707 </li>
1708 </ul>
1709 <p>Returns main.TRUE if all hosts specified can reach each other</p>
1710 <p>Returns main.FALSE if one or more of hosts specified cannot reach each
1711 other</p>
1712 <dl class="fields">
1713 </dl>
1714</td></tr></table>
1715</div>
1716<a name="pingIpv6Hosts"></a>
1717<div>
1718<table class="details" border="1" cellpadding="3"
1719 cellspacing="0" width="100%" bgcolor="white">
1720<tr><td>
1721 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1722 <tr valign="top"><td>
1723 <h3 class="epydoc"><span class="sig"><span class="sig-name">pingIpv6Hosts</span>(<span class="sig-arg">self</span>,
1724 <span class="sig-arg">hostList</span>,
1725 <span class="sig-arg">prefix</span>=<span class="sig-default">'1000::'</span>)</span>
1726 </h3>
1727 </td><td align="right" valign="top"
1728 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.pingIpv6Hosts">source&nbsp;code</a></span>&nbsp;
1729 </td>
1730 </tr></table>
1731
1732 <p>IPv6 ping all hosts in hostList. If no prefix passed this will use
1733 default prefix of 1000:</p>
1734<pre class="literalblock">
1735
1736</pre>
1737 <p>Returns main.TRUE if all hosts specified can reach each other</p>
1738 <p>Returns main.FALSE if one or more of hosts specified cannot reach each
1739 other</p>
1740 <dl class="fields">
1741 </dl>
1742</td></tr></table>
1743</div>
1744<a name="iperftcpAll"></a>
1745<div>
1746<table class="details" border="1" cellpadding="3"
1747 cellspacing="0" width="100%" bgcolor="white">
1748<tr><td>
1749 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1750 <tr valign="top"><td>
1751 <h3 class="epydoc"><span class="sig"><span class="sig-name">iperftcpAll</span>(<span class="sig-arg">self</span>,
1752 <span class="sig-arg">hosts</span>,
1753 <span class="sig-arg">timeout</span>=<span class="sig-default">6</span>)</span>
1754 </h3>
1755 </td><td align="right" valign="top"
1756 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.iperftcpAll">source&nbsp;code</a></span>&nbsp;
1757 </td>
1758 </tr></table>
1759
1760 <pre class="literalblock">
1761
1762Runs the iperftcp function with a given set of hosts and specified timeout.
1763
1764@parm:
1765 timeout: The defualt timeout is 6 sec to allow enough time for a successful test to complete,
1766 and short enough to stop an unsuccessful test from quiting and cleaning up mininet.
1767
1768</pre>
1769 <dl class="fields">
1770 </dl>
1771</td></tr></table>
1772</div>
1773<a name="iperftcp"></a>
1774<div>
1775<table class="details" border="1" cellpadding="3"
1776 cellspacing="0" width="100%" bgcolor="white">
1777<tr><td>
1778 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1779 <tr valign="top"><td>
1780 <h3 class="epydoc"><span class="sig"><span class="sig-name">iperftcp</span>(<span class="sig-arg">self</span>,
1781 <span class="sig-arg">host1</span>=<span class="sig-default">&quot;h1&quot;</span>,
1782 <span class="sig-arg">host2</span>=<span class="sig-default">&quot;h2&quot;</span>,
1783 <span class="sig-arg">timeout</span>=<span class="sig-default">6</span>)</span>
1784 </h3>
1785 </td><td align="right" valign="top"
1786 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.iperftcp">source&nbsp;code</a></span>&nbsp;
1787 </td>
1788 </tr></table>
1789
1790 <pre class="literalblock">
1791
1792Creates an iperf TCP test between two hosts. Returns main.TRUE if test results
1793are valid.
1794
1795@parm:
1796 timeout: The defualt timeout is 6 sec to allow enough time for a successful test to complete,
1797 and short enough to stop an unsuccessful test from quiting and cleaning up mininet.
1798
1799</pre>
1800 <dl class="fields">
1801 </dl>
1802</td></tr></table>
1803</div>
1804<a name="iperfudp"></a>
1805<div>
1806<table class="details" border="1" cellpadding="3"
1807 cellspacing="0" width="100%" bgcolor="white">
1808<tr><td>
1809 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1810 <tr valign="top"><td>
1811 <h3 class="epydoc"><span class="sig"><span class="sig-name">iperfudp</span>(<span class="sig-arg">self</span>,
1812 <span class="sig-arg">bandwidth</span>=<span class="sig-default">&quot;10M&quot;</span>,
1813 <span class="sig-arg">host1</span>=<span class="sig-default">&quot;h1&quot;</span>,
1814 <span class="sig-arg">host2</span>=<span class="sig-default">&quot;h2&quot;</span>)</span>
1815 </h3>
1816 </td><td align="right" valign="top"
1817 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.iperfudp">source&nbsp;code</a></span>&nbsp;
1818 </td>
1819 </tr></table>
1820
1821 <p>Creates an iperf UDP test with a specific bandwidth. Returns true if
1822 results are valid.</p>
1823 <dl class="fields">
1824 </dl>
1825</td></tr></table>
1826</div>
1827<a name="getSwController"></a>
1828<div>
1829<table class="details" border="1" cellpadding="3"
1830 cellspacing="0" width="100%" bgcolor="white">
1831<tr><td>
1832 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1833 <tr valign="top"><td>
1834 <h3 class="epydoc"><span class="sig"><span class="sig-name">getSwController</span>(<span class="sig-arg">self</span>,
1835 <span class="sig-arg">sw</span>)</span>
1836 </h3>
1837 </td><td align="right" valign="top"
1838 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.getSwController">source&nbsp;code</a></span>&nbsp;
1839 </td>
1840 </tr></table>
1841
1842 <pre class="literalblock">
1843
1844Parameters:
1845 sw: The name of an OVS switch. Example &quot;s1&quot;
1846Return:
1847 The output of the command from the mininet cli
1848 or main.FALSE on timeout
1849
1850</pre>
1851 <dl class="fields">
1852 </dl>
1853</td></tr></table>
1854</div>
1855<a name="assignSwController"></a>
1856<div>
1857<table class="details" border="1" cellpadding="3"
1858 cellspacing="0" width="100%" bgcolor="white">
1859<tr><td>
1860 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1861 <tr valign="top"><td>
1862 <h3 class="epydoc"><span class="sig"><span class="sig-name">assignSwController</span>(<span class="sig-arg">self</span>,
1863 <span class="sig-arg">sw</span>,
1864 <span class="sig-arg">ip</span>,
1865 <span class="sig-arg">port</span>=<span class="sig-default">&quot;6633&quot;</span>,
1866 <span class="sig-arg">ptcp</span>=<span class="sig-default">&quot;&quot;</span>)</span>
1867 </h3>
1868 </td><td align="right" valign="top"
1869 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.assignSwController">source&nbsp;code</a></span>&nbsp;
1870 </td>
1871 </tr></table>
1872
1873 <pre class="literalblock">
1874
1875Description:
1876 Assign switches to the controllers ( for ovs use only )
1877Required:
1878 sw - Name of the switch. This can be a list or a string.
1879 ip - Ip addresses of controllers. This can be a list or a string.
1880Optional:
1881 port - ONOS use port 6633, if no list of ports is passed, then
1882 the all the controller will use 6633 as their port number
1883 ptcp - ptcp number, This can be a string or a list that has
1884 the same length as switch. This is optional and not required
1885 when using ovs switches.
1886NOTE: If switches and ptcp are given in a list type they should have the
1887 same length and should be in the same order, Eg. sw=[ 's1' ... n ]
1888 ptcp=[ '6637' ... n ], s1 has ptcp number 6637 and so on.
1889
1890Return:
1891 Returns main.TRUE if mininet correctly assigned switches to
1892 controllers, otherwise it will return main.FALSE or an appropriate
1893 exception(s)
1894
1895</pre>
1896 <dl class="fields">
1897 </dl>
1898</td></tr></table>
1899</div>
1900<a name="addSwitch"></a>
1901<div>
1902<table class="details" border="1" cellpadding="3"
1903 cellspacing="0" width="100%" bgcolor="white">
1904<tr><td>
1905 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1906 <tr valign="top"><td>
1907 <h3 class="epydoc"><span class="sig"><span class="sig-name">addSwitch</span>(<span class="sig-arg">self</span>,
1908 <span class="sig-arg">sw</span>,
1909 <span class="sig-arg">**kwargs</span>)</span>
1910 </h3>
1911 </td><td align="right" valign="top"
1912 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.addSwitch">source&nbsp;code</a></span>&nbsp;
1913 </td>
1914 </tr></table>
1915
1916 <pre class="literalblock">
1917
1918adds a switch to the mininet topology
1919NOTE: This uses a custom mn function. MN repo should be on
1920 dynamic_topo branch
1921NOTE: cannot currently specify what type of switch
1922required params:
1923 sw = name of the new switch as a string
1924optional keywords:
1925 dpid = &quot;dpid&quot;
1926returns: main.FALSE on an error, else main.TRUE
1927
1928</pre>
1929 <dl class="fields">
1930 </dl>
1931</td></tr></table>
1932</div>
1933<a name="delSwitch"></a>
1934<div>
1935<table class="details" border="1" cellpadding="3"
1936 cellspacing="0" width="100%" bgcolor="white">
1937<tr><td>
1938 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1939 <tr valign="top"><td>
1940 <h3 class="epydoc"><span class="sig"><span class="sig-name">delSwitch</span>(<span class="sig-arg">self</span>,
1941 <span class="sig-arg">sw</span>)</span>
1942 </h3>
1943 </td><td align="right" valign="top"
1944 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.delSwitch">source&nbsp;code</a></span>&nbsp;
1945 </td>
1946 </tr></table>
1947
1948 <pre class="literalblock">
1949
1950delete a switch from the mininet topology
1951NOTE: This uses a custom mn function. MN repo should be on
1952 dynamic_topo branch
1953required params:
1954 sw = name of the switch as a string
1955returns: main.FALSE on an error, else main.TRUE
1956
1957</pre>
1958 <dl class="fields">
1959 </dl>
1960</td></tr></table>
1961</div>
1962<a name="addLink"></a>
1963<div>
1964<table class="details" border="1" cellpadding="3"
1965 cellspacing="0" width="100%" bgcolor="white">
1966<tr><td>
1967 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1968 <tr valign="top"><td>
1969 <h3 class="epydoc"><span class="sig"><span class="sig-name">addLink</span>(<span class="sig-arg">self</span>,
1970 <span class="sig-arg">node1</span>,
1971 <span class="sig-arg">node2</span>)</span>
1972 </h3>
1973 </td><td align="right" valign="top"
1974 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.addLink">source&nbsp;code</a></span>&nbsp;
1975 </td>
1976 </tr></table>
1977
1978 <pre class="literalblock">
1979
1980add a link to the mininet topology
1981NOTE: This uses a custom mn function. MN repo should be on
1982 dynamic_topo branch
1983NOTE: cannot currently specify what type of link
1984required params:
1985node1 = the string node name of the first endpoint of the link
1986node2 = the string node name of the second endpoint of the link
1987returns: main.FALSE on an error, else main.TRUE
1988
1989</pre>
1990 <dl class="fields">
1991 </dl>
1992</td></tr></table>
1993</div>
1994<a name="delLink"></a>
1995<div>
1996<table class="details" border="1" cellpadding="3"
1997 cellspacing="0" width="100%" bgcolor="white">
1998<tr><td>
1999 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2000 <tr valign="top"><td>
2001 <h3 class="epydoc"><span class="sig"><span class="sig-name">delLink</span>(<span class="sig-arg">self</span>,
2002 <span class="sig-arg">node1</span>,
2003 <span class="sig-arg">node2</span>)</span>
2004 </h3>
2005 </td><td align="right" valign="top"
2006 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.delLink">source&nbsp;code</a></span>&nbsp;
2007 </td>
2008 </tr></table>
2009
2010 <pre class="literalblock">
2011
2012delete a link from the mininet topology
2013NOTE: This uses a custom mn function. MN repo should be on
2014 dynamic_topo branch
2015required params:
2016node1 = the string node name of the first endpoint of the link
2017node2 = the string node name of the second endpoint of the link
2018returns: main.FALSE on an error, else main.TRUE
2019
2020</pre>
2021 <dl class="fields">
2022 </dl>
2023</td></tr></table>
2024</div>
2025<a name="addHost"></a>
2026<div>
2027<table class="details" border="1" cellpadding="3"
2028 cellspacing="0" width="100%" bgcolor="white">
2029<tr><td>
2030 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2031 <tr valign="top"><td>
2032 <h3 class="epydoc"><span class="sig"><span class="sig-name">addHost</span>(<span class="sig-arg">self</span>,
2033 <span class="sig-arg">hostname</span>,
2034 <span class="sig-arg">**kwargs</span>)</span>
2035 </h3>
2036 </td><td align="right" valign="top"
2037 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.addHost">source&nbsp;code</a></span>&nbsp;
2038 </td>
2039 </tr></table>
2040
2041 <pre class="literalblock">
2042
2043Add a host to the mininet topology
2044NOTE: This uses a custom mn function. MN repo should be on
2045 dynamic_topo branch
2046NOTE: cannot currently specify what type of host
2047required params:
2048 hostname = the string hostname
2049optional key-value params
2050 switch = &quot;switch name&quot;
2051 returns: main.FALSE on an error, else main.TRUE
2052
2053</pre>
2054 <dl class="fields">
2055 </dl>
2056</td></tr></table>
2057</div>
2058<a name="delHost"></a>
2059<div>
2060<table class="details" border="1" cellpadding="3"
2061 cellspacing="0" width="100%" bgcolor="white">
2062<tr><td>
2063 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2064 <tr valign="top"><td>
2065 <h3 class="epydoc"><span class="sig"><span class="sig-name">delHost</span>(<span class="sig-arg">self</span>,
2066 <span class="sig-arg">hostname</span>)</span>
2067 </h3>
2068 </td><td align="right" valign="top"
2069 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.delHost">source&nbsp;code</a></span>&nbsp;
2070 </td>
2071 </tr></table>
2072
2073 <pre class="literalblock">
2074
2075delete a host from the mininet topology
2076NOTE: This uses a custom mn function. MN repo should be on
2077 dynamic_topo branch
2078NOTE: this uses a custom mn function
2079required params:
2080hostname = the string hostname
2081returns: main.FALSE on an error, else main.TRUE
2082
2083</pre>
2084 <dl class="fields">
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]2085 </dl>
2086</td></tr></table>
2087</div>
2088<a name="disconnect"></a>
2089<div>
2090<table class="details" border="1" cellpadding="3"
2091 cellspacing="0" width="100%" bgcolor="white">
2092<tr><td>
2093 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2094 <tr valign="top"><td>
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]2095 <h3 class="epydoc"><span class="sig"><span class="sig-name">disconnect</span>(<span class="sig-arg">self</span>)</span>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]2096 </h3>
2097 </td><td align="right" valign="top"
2098 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.disconnect">source&nbsp;code</a></span>&nbsp;
2099 </td>
2100 </tr></table>
2101
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]2102 <p>Called at the end of the test to stop the mininet and disconnect the
2103 handle.</p>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]2104 <dl class="fields">
2105 <dt>Overrides:
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]2106 component.Component.disconnect
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]2107 </dt>
2108 </dl>
2109</td></tr></table>
2110</div>
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]2111<a name="stopNet"></a>
2112<div>
2113<table class="details" border="1" cellpadding="3"
2114 cellspacing="0" width="100%" bgcolor="white">
2115<tr><td>
2116 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2117 <tr valign="top"><td>
2118 <h3 class="epydoc"><span class="sig"><span class="sig-name">stopNet</span>(<span class="sig-arg">self</span>,
2119 <span class="sig-arg">fileName</span>=<span class="sig-default">&quot;&quot;</span>,
2120 <span class="sig-arg">timeout</span>=<span class="sig-default">5</span>)</span>
2121 </h3>
2122 </td><td align="right" valign="top"
2123 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.stopNet">source&nbsp;code</a></span>&nbsp;
2124 </td>
2125 </tr></table>
2126
2127 <pre class="literalblock">
2128
2129Stops mininet.
2130Returns main.TRUE if the mininet successfully stops and
2131 main.FALSE if the pexpect handle does not exist.
2132
2133Will cleanup and exit the test if mininet fails to stop
2134
2135</pre>
2136 <dl class="fields">
2137 </dl>
2138</td></tr></table>
2139</div>
2140<a name="getFlowTable"></a>
2141<div>
2142<table class="details" border="1" cellpadding="3"
2143 cellspacing="0" width="100%" bgcolor="white">
2144<tr><td>
2145 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2146 <tr valign="top"><td>
2147 <h3 class="epydoc"><span class="sig"><span class="sig-name">getFlowTable</span>(<span class="sig-arg">self</span>,
2148 <span class="sig-arg">protoVersion</span>,
2149 <span class="sig-arg">sw</span>)</span>
2150 </h3>
2151 </td><td align="right" valign="top"
2152 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.getFlowTable">source&nbsp;code</a></span>&nbsp;
2153 </td>
2154 </tr></table>
2155
2156 <pre class="literalblock">
2157
2158Returns certain fields of an OVS flow table. Will force output to
2159either OF 1.0 or 1.3 format for consistency.
2160
2161TODO add option to look at cookies. ignoring them for now
2162
2163 NOTE: Use format to force consistent flow table output across
2164 versions
2165
2166</pre>
2167 <dl class="fields">
2168 </dl>
2169</td></tr></table>
2170</div>
2171<a name="getPorts"></a>
2172<div>
2173<table class="details" border="1" cellpadding="3"
2174 cellspacing="0" width="100%" bgcolor="white">
2175<tr><td>
2176 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2177 <tr valign="top"><td>
2178 <h3 class="epydoc"><span class="sig"><span class="sig-name">getPorts</span>(<span class="sig-arg">self</span>,
2179 <span class="sig-arg">nodeName</span>,
2180 <span class="sig-arg">verbose</span>=<span class="sig-default">False</span>)</span>
2181 </h3>
2182 </td><td align="right" valign="top"
2183 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.getPorts">source&nbsp;code</a></span>&nbsp;
2184 </td>
2185 </tr></table>
2186
2187 <p>Read ports from a Mininet switch.</p>
2188 <p>Returns a json structure containing information about the ports of the
2189 given switch.</p>
2190 <dl class="fields">
2191 </dl>
2192</td></tr></table>
2193</div>
2194<a name="getSwitches"></a>
2195<div>
2196<table class="details" border="1" cellpadding="3"
2197 cellspacing="0" width="100%" bgcolor="white">
2198<tr><td>
2199 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2200 <tr valign="top"><td>
2201 <h3 class="epydoc"><span class="sig"><span class="sig-name">getSwitches</span>(<span class="sig-arg">self</span>,
2202 <span class="sig-arg">verbose</span>=<span class="sig-default">False</span>)</span>
2203 </h3>
2204 </td><td align="right" valign="top"
2205 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.getSwitches">source&nbsp;code</a></span>&nbsp;
2206 </td>
2207 </tr></table>
2208
2209 <p>Read switches from Mininet.</p>
2210 <p>Returns a dictionary whose keys are the switch names and the value is
2211 a dictionary containing information about the switch.</p>
2212 <dl class="fields">
2213 </dl>
2214</td></tr></table>
2215</div>
2216<a name="getHosts"></a>
2217<div>
2218<table class="details" border="1" cellpadding="3"
2219 cellspacing="0" width="100%" bgcolor="white">
2220<tr><td>
2221 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2222 <tr valign="top"><td>
2223 <h3 class="epydoc"><span class="sig"><span class="sig-name">getHosts</span>(<span class="sig-arg">self</span>,
2224 <span class="sig-arg">verbose</span>=<span class="sig-default">False</span>)</span>
2225 </h3>
2226 </td><td align="right" valign="top"
2227 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.getHosts">source&nbsp;code</a></span>&nbsp;
2228 </td>
2229 </tr></table>
2230
2231 <p>Read hosts from Mininet.</p>
2232 <p>Returns a dictionary whose keys are the host names and the value is a
2233 dictionary containing information about the host.</p>
2234 <dl class="fields">
2235 </dl>
2236</td></tr></table>
2237</div>
2238<a name="getLinks"></a>
2239<div>
2240<table class="details" border="1" cellpadding="3"
2241 cellspacing="0" width="100%" bgcolor="white">
2242<tr><td>
2243 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2244 <tr valign="top"><td>
2245 <h3 class="epydoc"><span class="sig"><span class="sig-name">getLinks</span>(<span class="sig-arg">self</span>)</span>
2246 </h3>
2247 </td><td align="right" valign="top"
2248 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.getLinks">source&nbsp;code</a></span>&nbsp;
2249 </td>
2250 </tr></table>
2251
2252 <pre class="literalblock">
2253
2254Gathers information about current Mininet links. These links may not
2255be up if one of the ports is down.
2256
2257Returns a list of dictionaries with link endpoints.
2258
2259The dictionary structure is:
2260 { 'node1': str( node1 name )
2261 'node2': str( node2 name )
2262 'port1': str( port1 of_port )
2263 'port2': str( port2 of_port ) }
2264Note: The port number returned is the eth#, not necessarily the of_port
2265 number. In Mininet, for OVS switch, these should be the same. For
2266 hosts, this is just the eth#.
2267
2268</pre>
2269 <dl class="fields">
2270 </dl>
2271</td></tr></table>
2272</div>
2273<a name="compareSwitches"></a>
2274<div>
2275<table class="details" border="1" cellpadding="3"
2276 cellspacing="0" width="100%" bgcolor="white">
2277<tr><td>
2278 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2279 <tr valign="top"><td>
2280 <h3 class="epydoc"><span class="sig"><span class="sig-name">compareSwitches</span>(<span class="sig-arg">self</span>,
2281 <span class="sig-arg">switches</span>,
2282 <span class="sig-arg">switchesJson</span>,
2283 <span class="sig-arg">portsJson</span>)</span>
2284 </h3>
2285 </td><td align="right" valign="top"
2286 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.compareSwitches">source&nbsp;code</a></span>&nbsp;
2287 </td>
2288 </tr></table>
2289
2290 <pre class="literalblock">
2291
2292 Compare mn and onos switches
2293 switchesJson: parsed json object from the onos devices api
2294
2295Dependencies:
2296 1. numpy - &quot;sudo pip install numpy&quot;
2297
2298</pre>
2299 <dl class="fields">
2300 </dl>
2301</td></tr></table>
2302</div>
2303<a name="compareHosts"></a>
2304<div>
2305<table class="details" border="1" cellpadding="3"
2306 cellspacing="0" width="100%" bgcolor="white">
2307<tr><td>
2308 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2309 <tr valign="top"><td>
2310 <h3 class="epydoc"><span class="sig"><span class="sig-name">compareHosts</span>(<span class="sig-arg">self</span>,
2311 <span class="sig-arg">hosts</span>,
2312 <span class="sig-arg">hostsJson</span>)</span>
2313 </h3>
2314 </td><td align="right" valign="top"
2315 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.compareHosts">source&nbsp;code</a></span>&nbsp;
2316 </td>
2317 </tr></table>
2318
2319 <pre class="literalblock">
2320
2321Compare mn and onos Hosts.
2322Since Mininet hosts are quiet, ONOS will only know of them when they
2323speak. For this reason, we will only check that the hosts in ONOS
2324stores are in Mininet, and not vice versa.
2325
2326Arguments:
2327 hostsJson: parsed json object from the onos hosts api
2328Returns:
2329
2330</pre>
2331 <dl class="fields">
2332 </dl>
2333</td></tr></table>
2334</div>
2335<a name="assignVLAN"></a>
2336<div>
2337<table class="details" border="1" cellpadding="3"
2338 cellspacing="0" width="100%" bgcolor="white">
2339<tr><td>
2340 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2341 <tr valign="top"><td>
2342 <h3 class="epydoc"><span class="sig"><span class="sig-name">assignVLAN</span>(<span class="sig-arg">self</span>,
2343 <span class="sig-arg">host</span>,
2344 <span class="sig-arg">intf</span>,
2345 <span class="sig-arg">vlan</span>)</span>
2346 </h3>
2347 </td><td align="right" valign="top"
2348 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.mininetclidriver-pysrc.html#MininetCliDriver.assignVLAN">source&nbsp;code</a></span>&nbsp;
2349 </td>
2350 </tr></table>
2351
2352 <pre class="literalblock">
2353
2354Add vlan tag to a host.
2355Dependencies:
2356 This class depends on the &quot;vlan&quot; package
2357 $ sudo apt-get install vlan
2358Configuration:
2359 Load the 8021q module into the kernel
2360 $sudo modprobe 8021q
2361
2362 To make this setup permanent:
2363 $ sudo su -c 'echo &quot;8021q&quot; &gt;&gt; /etc/modules'
2364
2365</pre>
2366 <dl class="fields">
2367 </dl>
2368</td></tr></table>
2369</div>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]2370<br />
2371<!-- ==================== NAVIGATION BAR ==================== -->
2372<table class="navbar" border="0" width="100%" cellpadding="0"
2373 bgcolor="#a0c0ff" cellspacing="0">
2374 <tr valign="middle">
2375 <!-- Home link -->
2376 <th>&nbsp;&nbsp;&nbsp;<a
2377 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
2378
2379 <!-- Tree link -->
2380 <th>&nbsp;&nbsp;&nbsp;<a
2381 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
2382
2383 <!-- Index link -->
2384 <th>&nbsp;&nbsp;&nbsp;<a
2385 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
2386
2387 <!-- Help link -->
2388 <th>&nbsp;&nbsp;&nbsp;<a
2389 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
2390
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]2391 <!-- Project homepage -->
2392 <th class="navbar" align="right" width="100%">
2393 <table border="0" cellpadding="0" cellspacing="0">
2394 <tr><th class="navbar" align="center"
2395 >TestON</th>
2396 </tr></table></th>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]2397 </tr>
2398</table>
2399<table border="0" cellpadding="0" cellspacing="0" width="100%%">
2400 <tr>
2401 <td align="left" class="footer">
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]2402 Generated by Epydoc 3.0.1 on Mon Aug 10 11:12:35 2015
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]2403 </td>
2404 <td align="right" class="footer">
2405 <a target="mainFrame" href="http://epydoc.sourceforge.net"
2406 >http://epydoc.sourceforge.net</a>
2407 </td>
2408 </tr>
2409</table>
2410
2411<script type="text/javascript">
2412 <!--
2413 // Private objects are initially displayed (because if
2414 // javascript is turned off then we want them to be
2415 // visible); but by default, we want to hide them. So hide
2416 // them unless we have a cookie that says to show them.
2417 checkCookie();
2418 // -->
2419</script>
2420</body>
2421</html>