Gitiles
Code Review Sign In
gerrit.onosproject.org / OnosSystemTest / fa65fce68ffebfa96cf26d63043f07bb6aae3152 / . / TestON / Documentation / TestON_Document / TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html
blob: 0c710a12731a1ccdbe0708ae88fdec0b537df2bc [file] [log] [blame]
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]1<?xml version="1.0" encoding="ascii"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6 <title>TestON.drivers.common.cli.onosclidriver.OnosCliDriver</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
9</head>
10
11<body bgcolor="white" text="black" link="blue" vlink="#204080"
12 alink="#204080">
13<!-- ==================== NAVIGATION BAR ==================== -->
14<table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
16 <tr valign="middle">
17 <!-- Home link -->
18 <th>&nbsp;&nbsp;&nbsp;<a
19 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
20
21 <!-- Tree link -->
22 <th>&nbsp;&nbsp;&nbsp;<a
23 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
24
25 <!-- Index link -->
26 <th>&nbsp;&nbsp;&nbsp;<a
27 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28
29 <!-- Help link -->
30 <th>&nbsp;&nbsp;&nbsp;<a
31 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
32
33 <!-- Project homepage -->
34 <th class="navbar" align="right" width="100%">
35 <table border="0" cellpadding="0" cellspacing="0">
36 <tr><th class="navbar" align="center"
37 >TestON</th>
38 </tr></table></th>
39 </tr>
40</table>
41<table width="100%" cellpadding="0" cellspacing="0">
42 <tr valign="top">
43 <td width="100%">
44 <span class="breadcrumbs">
45 <a href="TestON-module.html">Package&nbsp;TestON</a> ::
46 <a href="TestON.drivers-module.html">Package&nbsp;drivers</a> ::
47 <a href="TestON.drivers.common-module.html">Package&nbsp;common</a> ::
48 <a href="TestON.drivers.common.cli-module.html">Package&nbsp;cli</a> ::
49 <a href="TestON.drivers.common.cli.onosclidriver-module.html">Module&nbsp;onosclidriver</a> ::
50 Class&nbsp;OnosCliDriver
51 </span>
52 </td>
53 <td>
54 <table cellpadding="0" cellspacing="0">
55 <!-- hide/show private -->
56 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
57 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
58 <tr><td align="right"><span class="options"
59 >[<a href="frames.html" target="_top">frames</a
60 >]&nbsp;|&nbsp;<a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html"
61 target="_top">no&nbsp;frames</a>]</span></td></tr>
62 </table>
63 </td>
64 </tr>
65</table>
66<!-- ==================== CLASS DESCRIPTION ==================== -->
67<h1 class="epydoc">Class OnosCliDriver</h1><p class="nomargin-top"><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver">source&nbsp;code</a></span></p>
68<center>
69<center> <map id="class_hierarchy_for_onosclidri" name="class_hierarchy_for_onosclidri">
70<area shape="rect" id="node1" href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html" title="OnosCliDriver" alt="" coords="5,6,109,31"/>
71<area shape="rect" id="node2" href="TestON.drivers.common.clidriver.CLI-class.html" title="clidriver.CLI" alt="" coords="134,6,225,31"/>
72<area shape="rect" id="node3" href="javascript:void(0);" title="component.Component" alt="" coords="251,6,408,31"/>
73</map>
74 <img src="class_hierarchy_for_onosclidri.gif" alt='' usemap="#class_hierarchy_for_onosclidri" ismap="ismap" class="graph-without-title" />
75</center>
76</center>
77<hr />
78<!-- ==================== INSTANCE METHODS ==================== -->
79<a name="section-InstanceMethods"></a>
80<table class="summary" border="1" cellpadding="3"
81 cellspacing="0" width="100%" bgcolor="white">
82<tr bgcolor="#70b0f0" class="table-header">
83 <td colspan="2" class="table-header">
84 <table border="0" cellpadding="0" cellspacing="0" width="100%">
85 <tr valign="top">
86 <td align="left"><span class="table-header">Instance Methods</span></td>
87 <td align="right" valign="top"
88 ><span class="options">[<a href="#section-InstanceMethods"
89 class="privatelink" onclick="toggle_private();"
90 >hide private</a>]</span></td>
91 </tr>
92 </table>
93 </td>
94</tr>
95<tr>
96 <td width="15%" align="right" valign="top" class="summary">
97 <span class="summary-type">&nbsp;</span>
98 </td><td class="summary">
99 <table width="100%" cellpadding="0" cellspacing="0" border="0">
100 <tr>
101 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>)</span><br />
102 Initialize client</td>
103 <td align="right" valign="top">
104 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.__init__">source&nbsp;code</a></span>
105
106 </td>
107 </tr>
108 </table>
109
110 </td>
111 </tr>
112<tr>
113 <td width="15%" align="right" valign="top" class="summary">
114 <span class="summary-type">&nbsp;</span>
115 </td><td class="summary">
116 <table width="100%" cellpadding="0" cellspacing="0" border="0">
117 <tr>
118 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#connect" class="summary-sig-name">connect</a>(<span class="summary-sig-arg">self</span>,
119 <span class="summary-sig-arg">**connectargs</span>)</span><br />
120 Creates ssh handle for ONOS cli.</td>
121 <td align="right" valign="top">
122 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.connect">source&nbsp;code</a></span>
123
124 </td>
125 </tr>
126 </table>
127
128 </td>
129 </tr>
130<tr>
131 <td width="15%" align="right" valign="top" class="summary">
132 <span class="summary-type">&nbsp;</span>
133 </td><td class="summary">
134 <table width="100%" cellpadding="0" cellspacing="0" border="0">
135 <tr>
136 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#disconnect" class="summary-sig-name">disconnect</a>(<span class="summary-sig-arg">self</span>)</span><br />
137 Called when Test is complete to disconnect the ONOS handle.</td>
138 <td align="right" valign="top">
139 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.disconnect">source&nbsp;code</a></span>
140
141 </td>
142 </tr>
143 </table>
144
145 </td>
146 </tr>
147<tr>
148 <td width="15%" align="right" valign="top" class="summary">
149 <span class="summary-type">&nbsp;</span>
150 </td><td class="summary">
151 <table width="100%" cellpadding="0" cellspacing="0" border="0">
152 <tr>
153 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#logout" class="summary-sig-name">logout</a>(<span class="summary-sig-arg">self</span>)</span><br />
154 Sends 'logout' command to ONOS cli...</td>
155 <td align="right" valign="top">
156 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.logout">source&nbsp;code</a></span>
157
158 </td>
159 </tr>
160 </table>
161
162 </td>
163 </tr>
164<tr>
165 <td width="15%" align="right" valign="top" class="summary">
166 <span class="summary-type">&nbsp;</span>
167 </td><td class="summary">
168 <table width="100%" cellpadding="0" cellspacing="0" border="0">
169 <tr>
170 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#setCell" class="summary-sig-name">setCell</a>(<span class="summary-sig-arg">self</span>,
171 <span class="summary-sig-arg">cellname</span>)</span><br />
172 Calls 'cell &lt;name&gt;' to set the environment variables on
173 ONOSbench</td>
174 <td align="right" valign="top">
175 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.setCell">source&nbsp;code</a></span>
176
177 </td>
178 </tr>
179 </table>
180
181 </td>
182 </tr>
183<tr>
184 <td width="15%" align="right" valign="top" class="summary">
185 <span class="summary-type">&nbsp;</span>
186 </td><td class="summary">
187 <table width="100%" cellpadding="0" cellspacing="0" border="0">
188 <tr>
189 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#startOnosCli" class="summary-sig-name">startOnosCli</a>(<span class="summary-sig-arg">self</span>,
190 <span class="summary-sig-arg">ONOSIp</span>,
191 <span class="summary-sig-arg">karafTimeout</span>=<span class="summary-sig-default">&quot;&quot;</span>,
192 <span class="summary-sig-arg">commandlineTimeout</span>=<span class="summary-sig-default">10</span>,
193 <span class="summary-sig-arg">onosStartTimeout</span>=<span class="summary-sig-default">60</span>)</span><br />
194 karafTimeout is an optional argument.</td>
195 <td align="right" valign="top">
196 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.startOnosCli">source&nbsp;code</a></span>
197
198 </td>
199 </tr>
200 </table>
201
202 </td>
203 </tr>
204<tr>
205 <td width="15%" align="right" valign="top" class="summary">
206 <span class="summary-type">&nbsp;</span>
207 </td><td class="summary">
208 <table width="100%" cellpadding="0" cellspacing="0" border="0">
209 <tr>
210 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#log" class="summary-sig-name">log</a>(<span class="summary-sig-arg">self</span>,
211 <span class="summary-sig-arg">cmdStr</span>,
212 <span class="summary-sig-arg">level</span>=<span class="summary-sig-default">&quot;&quot;</span>)</span><br />
213 log the commands in the onos CLI.</td>
214 <td align="right" valign="top">
215 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.log">source&nbsp;code</a></span>
216
217 </td>
218 </tr>
219 </table>
220
221 </td>
222 </tr>
223<tr>
224 <td width="15%" align="right" valign="top" class="summary">
225 <span class="summary-type">&nbsp;</span>
226 </td><td class="summary">
227 <table width="100%" cellpadding="0" cellspacing="0" border="0">
228 <tr>
229 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#sendline" class="summary-sig-name">sendline</a>(<span class="summary-sig-arg">self</span>,
230 <span class="summary-sig-arg">cmdStr</span>,
231 <span class="summary-sig-arg">debug</span>=<span class="summary-sig-default">False</span>)</span><br />
232 Send a completely user specified string to the onos&gt; prompt.</td>
233 <td align="right" valign="top">
234 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.sendline">source&nbsp;code</a></span>
235
236 </td>
237 </tr>
238 </table>
239
240 </td>
241 </tr>
242<tr>
243 <td width="15%" align="right" valign="top" class="summary">
244 <span class="summary-type">&nbsp;</span>
245 </td><td class="summary">
246 <table width="100%" cellpadding="0" cellspacing="0" border="0">
247 <tr>
248 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#addNode" class="summary-sig-name">addNode</a>(<span class="summary-sig-arg">self</span>,
249 <span class="summary-sig-arg">nodeId</span>,
250 <span class="summary-sig-arg">ONOSIp</span>,
251 <span class="summary-sig-arg">tcpPort</span>=<span class="summary-sig-default">&quot;&quot;</span>)</span><br />
252 Adds a new cluster node by ID and address information.</td>
253 <td align="right" valign="top">
254 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.addNode">source&nbsp;code</a></span>
255
256 </td>
257 </tr>
258 </table>
259
260 </td>
261 </tr>
262<tr>
263 <td width="15%" align="right" valign="top" class="summary">
264 <span class="summary-type">&nbsp;</span>
265 </td><td class="summary">
266 <table width="100%" cellpadding="0" cellspacing="0" border="0">
267 <tr>
268 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#removeNode" class="summary-sig-name">removeNode</a>(<span class="summary-sig-arg">self</span>,
269 <span class="summary-sig-arg">nodeId</span>)</span><br />
270 Removes a cluster by ID...</td>
271 <td align="right" valign="top">
272 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.removeNode">source&nbsp;code</a></span>
273
274 </td>
275 </tr>
276 </table>
277
278 </td>
279 </tr>
280<tr>
281 <td width="15%" align="right" valign="top" class="summary">
282 <span class="summary-type">&nbsp;</span>
283 </td><td class="summary">
284 <table width="100%" cellpadding="0" cellspacing="0" border="0">
285 <tr>
286 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#nodes" class="summary-sig-name">nodes</a>(<span class="summary-sig-arg">self</span>,
287 <span class="summary-sig-arg">jsonFormat</span>=<span class="summary-sig-default">True</span>)</span><br />
288 List the nodes currently visible...</td>
289 <td align="right" valign="top">
290 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.nodes">source&nbsp;code</a></span>
291
292 </td>
293 </tr>
294 </table>
295
296 </td>
297 </tr>
298<tr>
299 <td width="15%" align="right" valign="top" class="summary">
300 <span class="summary-type">&nbsp;</span>
301 </td><td class="summary">
302 <table width="100%" cellpadding="0" cellspacing="0" border="0">
303 <tr>
304 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#topology" class="summary-sig-name">topology</a>(<span class="summary-sig-arg">self</span>)</span><br />
305 Definition:
306 Returns the output of topology command.</td>
307 <td align="right" valign="top">
308 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.topology">source&nbsp;code</a></span>
309
310 </td>
311 </tr>
312 </table>
313
314 </td>
315 </tr>
316<tr>
317 <td width="15%" align="right" valign="top" class="summary">
318 <span class="summary-type">&nbsp;</span>
319 </td><td class="summary">
320 <table width="100%" cellpadding="0" cellspacing="0" border="0">
321 <tr>
322 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#featureInstall" class="summary-sig-name">featureInstall</a>(<span class="summary-sig-arg">self</span>,
323 <span class="summary-sig-arg">featureStr</span>)</span><br />
324 Installs a specified feature by issuing command:...</td>
325 <td align="right" valign="top">
326 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.featureInstall">source&nbsp;code</a></span>
327
328 </td>
329 </tr>
330 </table>
331
332 </td>
333 </tr>
334<tr>
335 <td width="15%" align="right" valign="top" class="summary">
336 <span class="summary-type">&nbsp;</span>
337 </td><td class="summary">
338 <table width="100%" cellpadding="0" cellspacing="0" border="0">
339 <tr>
340 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#featureUninstall" class="summary-sig-name">featureUninstall</a>(<span class="summary-sig-arg">self</span>,
341 <span class="summary-sig-arg">featureStr</span>)</span><br />
342 Uninstalls a specified feature by issuing command:...</td>
343 <td align="right" valign="top">
344 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.featureUninstall">source&nbsp;code</a></span>
345
346 </td>
347 </tr>
348 </table>
349
350 </td>
351 </tr>
352<tr>
353 <td width="15%" align="right" valign="top" class="summary">
354 <span class="summary-type">&nbsp;</span>
355 </td><td class="summary">
356 <table width="100%" cellpadding="0" cellspacing="0" border="0">
357 <tr>
358 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#deviceRemove" class="summary-sig-name">deviceRemove</a>(<span class="summary-sig-arg">self</span>,
359 <span class="summary-sig-arg">deviceId</span>)</span><br />
360 Removes particular device from storage</td>
361 <td align="right" valign="top">
362 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.deviceRemove">source&nbsp;code</a></span>
363
364 </td>
365 </tr>
366 </table>
367
368 </td>
369 </tr>
370<tr>
371 <td width="15%" align="right" valign="top" class="summary">
372 <span class="summary-type">&nbsp;</span>
373 </td><td class="summary">
374 <table width="100%" cellpadding="0" cellspacing="0" border="0">
375 <tr>
376 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#devices" class="summary-sig-name">devices</a>(<span class="summary-sig-arg">self</span>,
377 <span class="summary-sig-arg">jsonFormat</span>=<span class="summary-sig-default">True</span>)</span><br />
378 Lists all infrastructure devices or switches...</td>
379 <td align="right" valign="top">
380 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.devices">source&nbsp;code</a></span>
381
382 </td>
383 </tr>
384 </table>
385
386 </td>
387 </tr>
388<tr>
389 <td width="15%" align="right" valign="top" class="summary">
390 <span class="summary-type">&nbsp;</span>
391 </td><td class="summary">
392 <table width="100%" cellpadding="0" cellspacing="0" border="0">
393 <tr>
394 <td><span class="summary-sig"><a name="balanceMasters"></a><span class="summary-sig-name">balanceMasters</span>(<span class="summary-sig-arg">self</span>)</span><br />
395 This balances the devices across all controllers by issuing command:
396 'onos&gt; onos:balance-masters' If required this could be extended to
397 return devices balanced output.</td>
398 <td align="right" valign="top">
399 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.balanceMasters">source&nbsp;code</a></span>
400
401 </td>
402 </tr>
403 </table>
404
405 </td>
406 </tr>
407<tr>
408 <td width="15%" align="right" valign="top" class="summary">
409 <span class="summary-type">&nbsp;</span>
410 </td><td class="summary">
411 <table width="100%" cellpadding="0" cellspacing="0" border="0">
412 <tr>
413 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#checkMasters" class="summary-sig-name">checkMasters</a>(<span class="summary-sig-arg">self</span>,
414 <span class="summary-sig-arg">jsonFormat</span>=<span class="summary-sig-default">True</span>)</span><br />
415 Returns the output of the masters command.</td>
416 <td align="right" valign="top">
417 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.checkMasters">source&nbsp;code</a></span>
418
419 </td>
420 </tr>
421 </table>
422
423 </td>
424 </tr>
425<tr>
426 <td width="15%" align="right" valign="top" class="summary">
427 <span class="summary-type">&nbsp;</span>
428 </td><td class="summary">
429 <table width="100%" cellpadding="0" cellspacing="0" border="0">
430 <tr>
431 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#checkBalanceMasters" class="summary-sig-name">checkBalanceMasters</a>(<span class="summary-sig-arg">self</span>,
432 <span class="summary-sig-arg">jsonFormat</span>=<span class="summary-sig-default">True</span>)</span><br />
433 Uses the master command to check that the devices' leadership is
434 evenly divided</td>
435 <td align="right" valign="top">
436 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.checkBalanceMasters">source&nbsp;code</a></span>
437
438 </td>
439 </tr>
440 </table>
441
442 </td>
443 </tr>
444<tr>
445 <td width="15%" align="right" valign="top" class="summary">
446 <span class="summary-type">&nbsp;</span>
447 </td><td class="summary">
448 <table width="100%" cellpadding="0" cellspacing="0" border="0">
449 <tr>
450 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#links" class="summary-sig-name">links</a>(<span class="summary-sig-arg">self</span>,
451 <span class="summary-sig-arg">jsonFormat</span>=<span class="summary-sig-default">True</span>)</span><br />
452 Lists all core links...</td>
453 <td align="right" valign="top">
454 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.links">source&nbsp;code</a></span>
455
456 </td>
457 </tr>
458 </table>
459
460 </td>
461 </tr>
462<tr>
463 <td width="15%" align="right" valign="top" class="summary">
464 <span class="summary-type">&nbsp;</span>
465 </td><td class="summary">
466 <table width="100%" cellpadding="0" cellspacing="0" border="0">
467 <tr>
468 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#ports" class="summary-sig-name">ports</a>(<span class="summary-sig-arg">self</span>,
469 <span class="summary-sig-arg">jsonFormat</span>=<span class="summary-sig-default">True</span>)</span><br />
470 Lists all ports...</td>
471 <td align="right" valign="top">
472 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.ports">source&nbsp;code</a></span>
473
474 </td>
475 </tr>
476 </table>
477
478 </td>
479 </tr>
480<tr>
481 <td width="15%" align="right" valign="top" class="summary">
482 <span class="summary-type">&nbsp;</span>
483 </td><td class="summary">
484 <table width="100%" cellpadding="0" cellspacing="0" border="0">
485 <tr>
486 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#roles" class="summary-sig-name">roles</a>(<span class="summary-sig-arg">self</span>,
487 <span class="summary-sig-arg">jsonFormat</span>=<span class="summary-sig-default">True</span>)</span><br />
488 Lists all devices and the controllers with roles assigned to them...</td>
489 <td align="right" valign="top">
490 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.roles">source&nbsp;code</a></span>
491
492 </td>
493 </tr>
494 </table>
495
496 </td>
497 </tr>
498<tr>
499 <td width="15%" align="right" valign="top" class="summary">
500 <span class="summary-type">&nbsp;</span>
501 </td><td class="summary">
502 <table width="100%" cellpadding="0" cellspacing="0" border="0">
503 <tr>
504 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#getRole" class="summary-sig-name">getRole</a>(<span class="summary-sig-arg">self</span>,
505 <span class="summary-sig-arg">deviceId</span>)</span><br />
506 Given the a string containing the json representation of the
507 &quot;roles&quot; cli command and a partial or whole device id,
508 returns a json object containing the roles output for the first
509 device whose id contains &quot;device_id&quot;</td>
510 <td align="right" valign="top">
511 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.getRole">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 href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#rolesNotNull" class="summary-sig-name">rolesNotNull</a>(<span class="summary-sig-arg">self</span>)</span><br />
526 Iterates through each device and checks if there is a master assigned...</td>
527 <td align="right" valign="top">
528 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.rolesNotNull">source&nbsp;code</a></span>
529
530 </td>
531 </tr>
532 </table>
533
534 </td>
535 </tr>
536<tr>
537 <td width="15%" align="right" valign="top" class="summary">
538 <span class="summary-type">&nbsp;</span>
539 </td><td class="summary">
540 <table width="100%" cellpadding="0" cellspacing="0" border="0">
541 <tr>
542 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#paths" class="summary-sig-name">paths</a>(<span class="summary-sig-arg">self</span>,
543 <span class="summary-sig-arg">srcId</span>,
544 <span class="summary-sig-arg">dstId</span>)</span><br />
545 Returns string of paths, and the cost.</td>
546 <td align="right" valign="top">
547 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.paths">source&nbsp;code</a></span>
548
549 </td>
550 </tr>
551 </table>
552
553 </td>
554 </tr>
555<tr>
556 <td width="15%" align="right" valign="top" class="summary">
557 <span class="summary-type">&nbsp;</span>
558 </td><td class="summary">
559 <table width="100%" cellpadding="0" cellspacing="0" border="0">
560 <tr>
561 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#hosts" class="summary-sig-name">hosts</a>(<span class="summary-sig-arg">self</span>,
562 <span class="summary-sig-arg">jsonFormat</span>=<span class="summary-sig-default">True</span>)</span><br />
563 Lists all discovered hosts...</td>
564 <td align="right" valign="top">
565 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.hosts">source&nbsp;code</a></span>
566
567 </td>
568 </tr>
569 </table>
570
571 </td>
572 </tr>
573<tr>
574 <td width="15%" align="right" valign="top" class="summary">
575 <span class="summary-type">&nbsp;</span>
576 </td><td class="summary">
577 <table width="100%" cellpadding="0" cellspacing="0" border="0">
578 <tr>
579 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#getHost" class="summary-sig-name">getHost</a>(<span class="summary-sig-arg">self</span>,
580 <span class="summary-sig-arg">mac</span>)</span><br />
581 Return the first host from the hosts api whose 'id' contains 'mac'</td>
582 <td align="right" valign="top">
583 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.getHost">source&nbsp;code</a></span>
584
585 </td>
586 </tr>
587 </table>
588
589 </td>
590 </tr>
591<tr>
592 <td width="15%" align="right" valign="top" class="summary">
593 <span class="summary-type">&nbsp;</span>
594 </td><td class="summary">
595 <table width="100%" cellpadding="0" cellspacing="0" border="0">
596 <tr>
597 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#getHostsId" class="summary-sig-name">getHostsId</a>(<span class="summary-sig-arg">self</span>,
598 <span class="summary-sig-arg">hostList</span>)</span><br />
599 Obtain list of hosts
600Issues command: 'onos&gt; hosts'</td>
601 <td align="right" valign="top">
602 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.getHostsId">source&nbsp;code</a></span>
603
604 </td>
605 </tr>
606 </table>
607
608 </td>
609 </tr>
610<tr>
611 <td width="15%" align="right" valign="top" class="summary">
612 <span class="summary-type">&nbsp;</span>
613 </td><td class="summary">
614 <table width="100%" cellpadding="0" cellspacing="0" border="0">
615 <tr>
616 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#addHostIntent" class="summary-sig-name">addHostIntent</a>(<span class="summary-sig-arg">self</span>,
617 <span class="summary-sig-arg">hostIdOne</span>,
618 <span class="summary-sig-arg">hostIdTwo</span>)</span><br />
619 Required:
620 * hostIdOne: ONOS host id for host1
621 * hostIdTwo: ONOS host id for host2
622Description:
623 Adds a host-to-host intent ( bidirectional ) by
624 specifying the two hosts.</td>
625 <td align="right" valign="top">
626 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.addHostIntent">source&nbsp;code</a></span>
627
628 </td>
629 </tr>
630 </table>
631
632 </td>
633 </tr>
634<tr>
635 <td width="15%" align="right" valign="top" class="summary">
636 <span class="summary-type">&nbsp;</span>
637 </td><td class="summary">
638 <table width="100%" cellpadding="0" cellspacing="0" border="0">
639 <tr>
640 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#addOpticalIntent" class="summary-sig-name">addOpticalIntent</a>(<span class="summary-sig-arg">self</span>,
641 <span class="summary-sig-arg">ingressDevice</span>,
642 <span class="summary-sig-arg">egressDevice</span>)</span><br />
643 Required:...</td>
644 <td align="right" valign="top">
645 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.addOpticalIntent">source&nbsp;code</a></span>
646
647 </td>
648 </tr>
649 </table>
650
651 </td>
652 </tr>
653<tr>
654 <td width="15%" align="right" valign="top" class="summary">
655 <span class="summary-type">&nbsp;</span>
656 </td><td class="summary">
657 <table width="100%" cellpadding="0" cellspacing="0" border="0">
658 <tr>
659 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#addPointIntent" class="summary-sig-name">addPointIntent</a>(<span class="summary-sig-arg">self</span>,
660 <span class="summary-sig-arg">ingressDevice</span>,
661 <span class="summary-sig-arg">egressDevice</span>,
662 <span class="summary-sig-arg">portIngress</span>=<span class="summary-sig-default">&quot;&quot;</span>,
663 <span class="summary-sig-arg">portEgress</span>=<span class="summary-sig-default">&quot;&quot;</span>,
664 <span class="summary-sig-arg">ethType</span>=<span class="summary-sig-default">&quot;&quot;</span>,
665 <span class="summary-sig-arg">ethSrc</span>=<span class="summary-sig-default">&quot;&quot;</span>,
666 <span class="summary-sig-arg">ethDst</span>=<span class="summary-sig-default">&quot;&quot;</span>,
667 <span class="summary-sig-arg">bandwidth</span>=<span class="summary-sig-default">&quot;&quot;</span>,
668 <span class="summary-sig-arg">lambdaAlloc</span>=<span class="summary-sig-default">False</span>,
669 <span class="summary-sig-arg">ipProto</span>=<span class="summary-sig-default">&quot;&quot;</span>,
670 <span class="summary-sig-arg">ipSrc</span>=<span class="summary-sig-default">&quot;&quot;</span>,
671 <span class="summary-sig-arg">ipDst</span>=<span class="summary-sig-default">&quot;&quot;</span>,
672 <span class="summary-sig-arg">tcpSrc</span>=<span class="summary-sig-default">&quot;&quot;</span>,
673 <span class="summary-sig-arg">tcpDst</span>=<span class="summary-sig-default">&quot;&quot;</span>)</span><br />
674 Required:
675 * ingressDevice: device id of ingress device
676 * egressDevice: device id of egress device
677Optional:
678 * ethType: specify ethType
679 * ethSrc: specify ethSrc ( i.e.</td>
680 <td align="right" valign="top">
681 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.addPointIntent">source&nbsp;code</a></span>
682
683 </td>
684 </tr>
685 </table>
686
687 </td>
688 </tr>
689<tr>
690 <td width="15%" align="right" valign="top" class="summary">
691 <span class="summary-type">&nbsp;</span>
692 </td><td class="summary">
693 <table width="100%" cellpadding="0" cellspacing="0" border="0">
694 <tr>
695 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#addMultipointToSinglepointIntent" class="summary-sig-name">addMultipointToSinglepointIntent</a>(<span class="summary-sig-arg">self</span>,
696 <span class="summary-sig-arg">ingressDeviceList</span>,
697 <span class="summary-sig-arg">egressDevice</span>,
698 <span class="summary-sig-arg">portIngressList</span>=<span class="summary-sig-default">None</span>,
699 <span class="summary-sig-arg">portEgress</span>=<span class="summary-sig-default">&quot;&quot;</span>,
700 <span class="summary-sig-arg">ethType</span>=<span class="summary-sig-default">&quot;&quot;</span>,
701 <span class="summary-sig-arg">ethSrc</span>=<span class="summary-sig-default">&quot;&quot;</span>,
702 <span class="summary-sig-arg">ethDst</span>=<span class="summary-sig-default">&quot;&quot;</span>,
703 <span class="summary-sig-arg">bandwidth</span>=<span class="summary-sig-default">&quot;&quot;</span>,
704 <span class="summary-sig-arg">lambdaAlloc</span>=<span class="summary-sig-default">False</span>,
705 <span class="summary-sig-arg">ipProto</span>=<span class="summary-sig-default">&quot;&quot;</span>,
706 <span class="summary-sig-arg">ipSrc</span>=<span class="summary-sig-default">&quot;&quot;</span>,
707 <span class="summary-sig-arg">ipDst</span>=<span class="summary-sig-default">&quot;&quot;</span>,
708 <span class="summary-sig-arg">tcpSrc</span>=<span class="summary-sig-default">&quot;&quot;</span>,
709 <span class="summary-sig-arg">tcpDst</span>=<span class="summary-sig-default">&quot;&quot;</span>,
710 <span class="summary-sig-arg">setEthSrc</span>=<span class="summary-sig-default">&quot;&quot;</span>,
711 <span class="summary-sig-arg">setEthDst</span>=<span class="summary-sig-default">&quot;&quot;</span>)</span><br />
712 Note:
713 This function assumes the format of all ingress devices
714 is same.</td>
715 <td align="right" valign="top">
716 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.addMultipointToSinglepointIntent">source&nbsp;code</a></span>
717
718 </td>
719 </tr>
720 </table>
721
722 </td>
723 </tr>
724<tr>
725 <td width="15%" align="right" valign="top" class="summary">
726 <span class="summary-type">&nbsp;</span>
727 </td><td class="summary">
728 <table width="100%" cellpadding="0" cellspacing="0" border="0">
729 <tr>
730 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#addSinglepointToMultipointIntent" class="summary-sig-name">addSinglepointToMultipointIntent</a>(<span class="summary-sig-arg">self</span>,
731 <span class="summary-sig-arg">ingressDevice</span>,
732 <span class="summary-sig-arg">egressDeviceList</span>,
733 <span class="summary-sig-arg">portIngress</span>=<span class="summary-sig-default">&quot;&quot;</span>,
734 <span class="summary-sig-arg">portEgressList</span>=<span class="summary-sig-default">None</span>,
735 <span class="summary-sig-arg">ethType</span>=<span class="summary-sig-default">&quot;&quot;</span>,
736 <span class="summary-sig-arg">ethSrc</span>=<span class="summary-sig-default">&quot;&quot;</span>,
737 <span class="summary-sig-arg">ethDst</span>=<span class="summary-sig-default">&quot;&quot;</span>,
738 <span class="summary-sig-arg">bandwidth</span>=<span class="summary-sig-default">&quot;&quot;</span>,
739 <span class="summary-sig-arg">lambdaAlloc</span>=<span class="summary-sig-default">False</span>,
740 <span class="summary-sig-arg">ipProto</span>=<span class="summary-sig-default">&quot;&quot;</span>,
741 <span class="summary-sig-arg">ipSrc</span>=<span class="summary-sig-default">&quot;&quot;</span>,
742 <span class="summary-sig-arg">ipDst</span>=<span class="summary-sig-default">&quot;&quot;</span>,
743 <span class="summary-sig-arg">tcpSrc</span>=<span class="summary-sig-default">&quot;&quot;</span>,
744 <span class="summary-sig-arg">tcpDst</span>=<span class="summary-sig-default">&quot;&quot;</span>,
745 <span class="summary-sig-arg">setEthSrc</span>=<span class="summary-sig-default">&quot;&quot;</span>,
746 <span class="summary-sig-arg">setEthDst</span>=<span class="summary-sig-default">&quot;&quot;</span>)</span><br />
747 Note:
748 This function assumes the format of all egress devices
749 is same.</td>
750 <td align="right" valign="top">
751 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.addSinglepointToMultipointIntent">source&nbsp;code</a></span>
752
753 </td>
754 </tr>
755 </table>
756
757 </td>
758 </tr>
759<tr>
760 <td width="15%" align="right" valign="top" class="summary">
761 <span class="summary-type">&nbsp;</span>
762 </td><td class="summary">
763 <table width="100%" cellpadding="0" cellspacing="0" border="0">
764 <tr>
765 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#addMplsIntent" class="summary-sig-name">addMplsIntent</a>(<span class="summary-sig-arg">self</span>,
766 <span class="summary-sig-arg">ingressDevice</span>,
767 <span class="summary-sig-arg">egressDevice</span>,
768 <span class="summary-sig-arg">ingressPort</span>=<span class="summary-sig-default">&quot;&quot;</span>,
769 <span class="summary-sig-arg">egressPort</span>=<span class="summary-sig-default">&quot;&quot;</span>,
770 <span class="summary-sig-arg">ethType</span>=<span class="summary-sig-default">&quot;&quot;</span>,
771 <span class="summary-sig-arg">ethSrc</span>=<span class="summary-sig-default">&quot;&quot;</span>,
772 <span class="summary-sig-arg">ethDst</span>=<span class="summary-sig-default">&quot;&quot;</span>,
773 <span class="summary-sig-arg">bandwidth</span>=<span class="summary-sig-default">&quot;&quot;</span>,
774 <span class="summary-sig-arg">lambdaAlloc</span>=<span class="summary-sig-default">False</span>,
775 <span class="summary-sig-arg">ipProto</span>=<span class="summary-sig-default">&quot;&quot;</span>,
776 <span class="summary-sig-arg">ipSrc</span>=<span class="summary-sig-default">&quot;&quot;</span>,
777 <span class="summary-sig-arg">ipDst</span>=<span class="summary-sig-default">&quot;&quot;</span>,
778 <span class="summary-sig-arg">tcpSrc</span>=<span class="summary-sig-default">&quot;&quot;</span>,
779 <span class="summary-sig-arg">tcpDst</span>=<span class="summary-sig-default">&quot;&quot;</span>,
780 <span class="summary-sig-arg">ingressLabel</span>=<span class="summary-sig-default">&quot;&quot;</span>,
781 <span class="summary-sig-arg">egressLabel</span>=<span class="summary-sig-default">&quot;&quot;</span>,
782 <span class="summary-sig-arg">priority</span>=<span class="summary-sig-default">&quot;&quot;</span>)</span><br />
783 Required:
784 * ingressDevice: device id of ingress device
785 * egressDevice: device id of egress device
786Optional:
787 * ethType: specify ethType
788 * ethSrc: specify ethSrc ( i.e.</td>
789 <td align="right" valign="top">
790 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.addMplsIntent">source&nbsp;code</a></span>
791
792 </td>
793 </tr>
794 </table>
795
796 </td>
797 </tr>
798<tr>
799 <td width="15%" align="right" valign="top" class="summary">
800 <span class="summary-type">&nbsp;</span>
801 </td><td class="summary">
802 <table width="100%" cellpadding="0" cellspacing="0" border="0">
803 <tr>
804 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#removeIntent" class="summary-sig-name">removeIntent</a>(<span class="summary-sig-arg">self</span>,
805 <span class="summary-sig-arg">intentId</span>,
806 <span class="summary-sig-arg">app</span>=<span class="summary-sig-default">'org.onosproject.cli'</span>,
807 <span class="summary-sig-arg">purge</span>=<span class="summary-sig-default">False</span>,
808 <span class="summary-sig-arg">sync</span>=<span class="summary-sig-default">False</span>)</span><br />
809 Remove intent for specified application id and intent id
810Optional args:-
811-s or --sync: Waits for the removal before returning
812-p or --purge: Purge the intent from the store after removal</td>
813 <td align="right" valign="top">
814 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.removeIntent">source&nbsp;code</a></span>
815
816 </td>
817 </tr>
818 </table>
819
820 </td>
821 </tr>
822<tr>
823 <td width="15%" align="right" valign="top" class="summary">
824 <span class="summary-type">&nbsp;</span>
825 </td><td class="summary">
826 <table width="100%" cellpadding="0" cellspacing="0" border="0">
827 <tr>
828 <td><span class="summary-sig"><a name="purgeWithdrawnIntents"></a><span class="summary-sig-name">purgeWithdrawnIntents</span>(<span class="summary-sig-arg">self</span>)</span><br />
829 Purges all WITHDRAWN Intents</td>
830 <td align="right" valign="top">
831 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.purgeWithdrawnIntents">source&nbsp;code</a></span>
832
833 </td>
834 </tr>
835 </table>
836
837 </td>
838 </tr>
839<tr>
840 <td width="15%" align="right" valign="top" class="summary">
841 <span class="summary-type">&nbsp;</span>
842 </td><td class="summary">
843 <table width="100%" cellpadding="0" cellspacing="0" border="0">
844 <tr>
845 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#routes" class="summary-sig-name">routes</a>(<span class="summary-sig-arg">self</span>,
846 <span class="summary-sig-arg">jsonFormat</span>=<span class="summary-sig-default">False</span>)</span><br />
847 NOTE: This method should be used after installing application:...</td>
848 <td align="right" valign="top">
849 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.routes">source&nbsp;code</a></span>
850
851 </td>
852 </tr>
853 </table>
854
855 </td>
856 </tr>
857<tr>
858 <td width="15%" align="right" valign="top" class="summary">
859 <span class="summary-type">&nbsp;</span>
860 </td><td class="summary">
861 <table width="100%" cellpadding="0" cellspacing="0" border="0">
862 <tr>
863 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#intents" class="summary-sig-name">intents</a>(<span class="summary-sig-arg">self</span>,
864 <span class="summary-sig-arg">jsonFormat</span>=<span class="summary-sig-default">True</span>)</span><br />
865 Optional:...</td>
866 <td align="right" valign="top">
867 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.intents">source&nbsp;code</a></span>
868
869 </td>
870 </tr>
871 </table>
872
873 </td>
874 </tr>
875<tr>
876 <td width="15%" align="right" valign="top" class="summary">
877 <span class="summary-type">&nbsp;</span>
878 </td><td class="summary">
879 <table width="100%" cellpadding="0" cellspacing="0" border="0">
880 <tr>
881 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#getIntentState" class="summary-sig-name">getIntentState</a>(<span class="summary-sig-arg">self</span>,
882 <span class="summary-sig-arg">intentsId</span>,
883 <span class="summary-sig-arg">intentsJson</span>=<span class="summary-sig-default">None</span>)</span><br />
884 Check intent state.</td>
885 <td align="right" valign="top">
886 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.getIntentState">source&nbsp;code</a></span>
887
888 </td>
889 </tr>
890 </table>
891
892 </td>
893 </tr>
894<tr>
895 <td width="15%" align="right" valign="top" class="summary">
896 <span class="summary-type">&nbsp;</span>
897 </td><td class="summary">
898 <table width="100%" cellpadding="0" cellspacing="0" border="0">
899 <tr>
900 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#checkIntentState" class="summary-sig-name">checkIntentState</a>(<span class="summary-sig-arg">self</span>,
901 <span class="summary-sig-arg">intentsId</span>,
902 <span class="summary-sig-arg">expectedState</span>=<span class="summary-sig-default">'INSTALLED'</span>)</span><br />
903 Description:
904 Check intents state
905Required:
906 intentsId - List of intents ID to be checked
907Optional:
908 expectedState - Check the expected state(s) of each intents
909 state in the list.</td>
910 <td align="right" valign="top">
911 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.checkIntentState">source&nbsp;code</a></span>
912
913 </td>
914 </tr>
915 </table>
916
917 </td>
918 </tr>
919<tr>
920 <td width="15%" align="right" valign="top" class="summary">
921 <span class="summary-type">&nbsp;</span>
922 </td><td class="summary">
923 <table width="100%" cellpadding="0" cellspacing="0" border="0">
924 <tr>
925 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#flows" class="summary-sig-name">flows</a>(<span class="summary-sig-arg">self</span>,
926 <span class="summary-sig-arg">jsonFormat</span>=<span class="summary-sig-default">True</span>)</span><br />
927 Optional:...</td>
928 <td align="right" valign="top">
929 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.flows">source&nbsp;code</a></span>
930
931 </td>
932 </tr>
933 </table>
934
935 </td>
936 </tr>
937<tr>
938 <td width="15%" align="right" valign="top" class="summary">
939 <span class="summary-type">&nbsp;</span>
940 </td><td class="summary">
941 <table width="100%" cellpadding="0" cellspacing="0" border="0">
942 <tr>
943 <td><span class="summary-sig"><a name="checkFlowsState"></a><span class="summary-sig-name">checkFlowsState</span>(<span class="summary-sig-arg">self</span>)</span><br />
944 Description:
945 Check the if all the current flows are in ADDED state or
946 PENDING_ADD state
947Return:
948 returnValue - Returns main.TRUE only if all flows are in
949 ADDED state or PENDING_ADD, return main.FALSE
950 otherwise.</td>
951 <td align="right" valign="top">
952 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.checkFlowsState">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.onosclidriver.OnosCliDriver-class.html#pushTestIntents" class="summary-sig-name">pushTestIntents</a>(<span class="summary-sig-arg">self</span>,
967 <span class="summary-sig-arg">dpidSrc</span>,
968 <span class="summary-sig-arg">dpidDst</span>,
969 <span class="summary-sig-arg">numIntents</span>,
970 <span class="summary-sig-arg">numMult</span>=<span class="summary-sig-default">&quot;&quot;</span>,
971 <span class="summary-sig-arg">appId</span>=<span class="summary-sig-default">&quot;&quot;</span>,
972 <span class="summary-sig-arg">report</span>=<span class="summary-sig-default">True</span>)</span><br />
973 Description:...</td>
974 <td align="right" valign="top">
975 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.pushTestIntents">source&nbsp;code</a></span>
976
977 </td>
978 </tr>
979 </table>
980
981 </td>
982 </tr>
983<tr>
984 <td width="15%" align="right" valign="top" class="summary">
985 <span class="summary-type">&nbsp;</span>
986 </td><td class="summary">
987 <table width="100%" cellpadding="0" cellspacing="0" border="0">
988 <tr>
989 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#intentsEventsMetrics" class="summary-sig-name">intentsEventsMetrics</a>(<span class="summary-sig-arg">self</span>,
990 <span class="summary-sig-arg">jsonFormat</span>=<span class="summary-sig-default">True</span>)</span><br />
991 Description:Returns topology metrics...</td>
992 <td align="right" valign="top">
993 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.intentsEventsMetrics">source&nbsp;code</a></span>
994
995 </td>
996 </tr>
997 </table>
998
999 </td>
1000 </tr>
1001<tr>
1002 <td width="15%" align="right" valign="top" class="summary">
1003 <span class="summary-type">&nbsp;</span>
1004 </td><td class="summary">
1005 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1006 <tr>
1007 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#topologyEventsMetrics" class="summary-sig-name">topologyEventsMetrics</a>(<span class="summary-sig-arg">self</span>,
1008 <span class="summary-sig-arg">jsonFormat</span>=<span class="summary-sig-default">True</span>)</span><br />
1009 Description:Returns topology metrics...</td>
1010 <td align="right" valign="top">
1011 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.topologyEventsMetrics">source&nbsp;code</a></span>
1012
1013 </td>
1014 </tr>
1015 </table>
1016
1017 </td>
1018 </tr>
1019<tr>
1020 <td width="15%" align="right" valign="top" class="summary">
1021 <span class="summary-type">&nbsp;</span>
1022 </td><td class="summary">
1023 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1024 <tr>
1025 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#getAllIntentsId" class="summary-sig-name">getAllIntentsId</a>(<span class="summary-sig-arg">self</span>)</span><br />
1026 Description:...</td>
1027 <td align="right" valign="top">
1028 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.getAllIntentsId">source&nbsp;code</a></span>
1029
1030 </td>
1031 </tr>
1032 </table>
1033
1034 </td>
1035 </tr>
1036<tr>
1037 <td width="15%" align="right" valign="top" class="summary">
1038 <span class="summary-type">&nbsp;</span>
1039 </td><td class="summary">
1040 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1041 <tr>
1042 <td><span class="summary-sig"><a name="FlowAddedCount"></a><span class="summary-sig-name">FlowAddedCount</span>(<span class="summary-sig-arg">self</span>,
1043 <span class="summary-sig-arg">deviceId</span>)</span><br />
1044 Determine the number of flow rules for the given device id that are
1045 in the added state</td>
1046 <td align="right" valign="top">
1047 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.FlowAddedCount">source&nbsp;code</a></span>
1048
1049 </td>
1050 </tr>
1051 </table>
1052
1053 </td>
1054 </tr>
1055<tr>
1056 <td width="15%" align="right" valign="top" class="summary">
1057 <span class="summary-type">&nbsp;</span>
1058 </td><td class="summary">
1059 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1060 <tr>
1061 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#getAllDevicesId" class="summary-sig-name">getAllDevicesId</a>(<span class="summary-sig-arg">self</span>)</span><br />
1062 Use 'devices' function to obtain list of all devices and parse the
1063 result to obtain a list of all device id's.</td>
1064 <td align="right" valign="top">
1065 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.getAllDevicesId">source&nbsp;code</a></span>
1066
1067 </td>
1068 </tr>
1069 </table>
1070
1071 </td>
1072 </tr>
1073<tr>
1074 <td width="15%" align="right" valign="top" class="summary">
1075 <span class="summary-type">&nbsp;</span>
1076 </td><td class="summary">
1077 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1078 <tr>
1079 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#getAllNodesId" class="summary-sig-name">getAllNodesId</a>(<span class="summary-sig-arg">self</span>)</span><br />
1080 Uses 'nodes' function to obtain list of all nodes
1081and parse the result of nodes to obtain just the
1082node id's.</td>
1083 <td align="right" valign="top">
1084 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.getAllNodesId">source&nbsp;code</a></span>
1085
1086 </td>
1087 </tr>
1088 </table>
1089
1090 </td>
1091 </tr>
1092<tr>
1093 <td width="15%" align="right" valign="top" class="summary">
1094 <span class="summary-type">&nbsp;</span>
1095 </td><td class="summary">
1096 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1097 <tr>
1098 <td><span class="summary-sig"><a name="getDevice"></a><span class="summary-sig-name">getDevice</span>(<span class="summary-sig-arg">self</span>,
1099 <span class="summary-sig-arg">dpid</span>=<span class="summary-sig-default">None</span>)</span><br />
1100 Return the first device from the devices api whose 'id' contains
1101 'dpid' Return None if there is no match</td>
1102 <td align="right" valign="top">
1103 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.getDevice">source&nbsp;code</a></span>
1104
1105 </td>
1106 </tr>
1107 </table>
1108
1109 </td>
1110 </tr>
1111<tr>
1112 <td width="15%" align="right" valign="top" class="summary">
1113 <span class="summary-type">&nbsp;</span>
1114 </td><td class="summary">
1115 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1116 <tr>
1117 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#checkStatus" class="summary-sig-name">checkStatus</a>(<span class="summary-sig-arg">self</span>,
1118 <span class="summary-sig-arg">ip</span>,
1119 <span class="summary-sig-arg">numoswitch</span>,
1120 <span class="summary-sig-arg">numolink</span>,
1121 <span class="summary-sig-arg">logLevel</span>=<span class="summary-sig-default">&quot;info&quot;</span>)</span><br />
1122 Checks the number of switches &amp; links that ONOS sees against the
1123supplied values.</td>
1124 <td align="right" valign="top">
1125 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.checkStatus">source&nbsp;code</a></span>
1126
1127 </td>
1128 </tr>
1129 </table>
1130
1131 </td>
1132 </tr>
1133<tr>
1134 <td width="15%" align="right" valign="top" class="summary">
1135 <span class="summary-type">&nbsp;</span>
1136 </td><td class="summary">
1137 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1138 <tr>
1139 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#deviceRole" class="summary-sig-name">deviceRole</a>(<span class="summary-sig-arg">self</span>,
1140 <span class="summary-sig-arg">deviceId</span>,
1141 <span class="summary-sig-arg">onosNode</span>,
1142 <span class="summary-sig-arg">role</span>=<span class="summary-sig-default">&quot;master&quot;</span>)</span><br />
1143 Calls the device-role cli command.</td>
1144 <td align="right" valign="top">
1145 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.deviceRole">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 href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#clusters" class="summary-sig-name">clusters</a>(<span class="summary-sig-arg">self</span>,
1160 <span class="summary-sig-arg">jsonFormat</span>=<span class="summary-sig-default">True</span>)</span><br />
1161 Lists all clusters...</td>
1162 <td align="right" valign="top">
1163 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.clusters">source&nbsp;code</a></span>
1164
1165 </td>
1166 </tr>
1167 </table>
1168
1169 </td>
1170 </tr>
1171<tr>
1172 <td width="15%" align="right" valign="top" class="summary">
1173 <span class="summary-type">&nbsp;</span>
1174 </td><td class="summary">
1175 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1176 <tr>
1177 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#electionTestLeader" class="summary-sig-name">electionTestLeader</a>(<span class="summary-sig-arg">self</span>)</span><br />
1178 CLI command to get the current leader for the Election test application...</td>
1179 <td align="right" valign="top">
1180 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.electionTestLeader">source&nbsp;code</a></span>
1181
1182 </td>
1183 </tr>
1184 </table>
1185
1186 </td>
1187 </tr>
1188<tr>
1189 <td width="15%" align="right" valign="top" class="summary">
1190 <span class="summary-type">&nbsp;</span>
1191 </td><td class="summary">
1192 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1193 <tr>
1194 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#electionTestRun" class="summary-sig-name">electionTestRun</a>(<span class="summary-sig-arg">self</span>)</span><br />
1195 CLI command to run for leadership of the Election test application.</td>
1196 <td align="right" valign="top">
1197 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.electionTestRun">source&nbsp;code</a></span>
1198
1199 </td>
1200 </tr>
1201 </table>
1202
1203 </td>
1204 </tr>
1205<tr>
1206 <td width="15%" align="right" valign="top" class="summary">
1207 <span class="summary-type">&nbsp;</span>
1208 </td><td class="summary">
1209 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1210 <tr>
1211 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#electionTestWithdraw" class="summary-sig-name">electionTestWithdraw</a>(<span class="summary-sig-arg">self</span>)</span><br />
1212 * CLI command to withdraw the local node from leadership election for
1213* the Election test application.</td>
1214 <td align="right" valign="top">
1215 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.electionTestWithdraw">source&nbsp;code</a></span>
1216
1217 </td>
1218 </tr>
1219 </table>
1220
1221 </td>
1222 </tr>
1223<tr>
1224 <td width="15%" align="right" valign="top" class="summary">
1225 <span class="summary-type">&nbsp;</span>
1226 </td><td class="summary">
1227 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1228 <tr>
1229 <td><span class="summary-sig"><a name="getDevicePortsEnabledCount"></a><span class="summary-sig-name">getDevicePortsEnabledCount</span>(<span class="summary-sig-arg">self</span>,
1230 <span class="summary-sig-arg">dpid</span>)</span><br />
1231 Get the count of all enabled ports on a particular device/switch</td>
1232 <td align="right" valign="top">
1233 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.getDevicePortsEnabledCount">source&nbsp;code</a></span>
1234
1235 </td>
1236 </tr>
1237 </table>
1238
1239 </td>
1240 </tr>
1241<tr>
1242 <td width="15%" align="right" valign="top" class="summary">
1243 <span class="summary-type">&nbsp;</span>
1244 </td><td class="summary">
1245 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1246 <tr>
1247 <td><span class="summary-sig"><a name="getDeviceLinksActiveCount"></a><span class="summary-sig-name">getDeviceLinksActiveCount</span>(<span class="summary-sig-arg">self</span>,
1248 <span class="summary-sig-arg">dpid</span>)</span><br />
1249 Get the count of all enabled ports on a particular device/switch</td>
1250 <td align="right" valign="top">
1251 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.getDeviceLinksActiveCount">source&nbsp;code</a></span>
1252
1253 </td>
1254 </tr>
1255 </table>
1256
1257 </td>
1258 </tr>
1259<tr>
1260 <td width="15%" align="right" valign="top" class="summary">
1261 <span class="summary-type">&nbsp;</span>
1262 </td><td class="summary">
1263 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1264 <tr>
1265 <td><span class="summary-sig"><a name="getAllIntentIds"></a><span class="summary-sig-name">getAllIntentIds</span>(<span class="summary-sig-arg">self</span>)</span><br />
1266 Return a list of all Intent IDs</td>
1267 <td align="right" valign="top">
1268 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.getAllIntentIds">source&nbsp;code</a></span>
1269
1270 </td>
1271 </tr>
1272 </table>
1273
1274 </td>
1275 </tr>
1276<tr>
1277 <td width="15%" align="right" valign="top" class="summary">
1278 <span class="summary-type">&nbsp;</span>
1279 </td><td class="summary">
1280 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1281 <tr>
1282 <td><span class="summary-sig"><a name="intentSummary"></a><span class="summary-sig-name">intentSummary</span>(<span class="summary-sig-arg">self</span>)</span><br />
1283 Returns a dictionary containing the current intent states and the
1284 count</td>
1285 <td align="right" valign="top">
1286 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.intentSummary">source&nbsp;code</a></span>
1287
1288 </td>
1289 </tr>
1290 </table>
1291
1292 </td>
1293 </tr>
1294<tr>
1295 <td width="15%" align="right" valign="top" class="summary">
1296 <span class="summary-type">&nbsp;</span>
1297 </td><td class="summary">
1298 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1299 <tr>
1300 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#leaders" class="summary-sig-name">leaders</a>(<span class="summary-sig-arg">self</span>,
1301 <span class="summary-sig-arg">jsonFormat</span>=<span class="summary-sig-default">True</span>)</span><br />
1302 Returns the output of the leaders command.</td>
1303 <td align="right" valign="top">
1304 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.leaders">source&nbsp;code</a></span>
1305
1306 </td>
1307 </tr>
1308 </table>
1309
1310 </td>
1311 </tr>
1312<tr>
1313 <td width="15%" align="right" valign="top" class="summary">
1314 <span class="summary-type">&nbsp;</span>
1315 </td><td class="summary">
1316 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1317 <tr>
1318 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#leaderCandidates" class="summary-sig-name">leaderCandidates</a>(<span class="summary-sig-arg">self</span>,
1319 <span class="summary-sig-arg">jsonFormat</span>=<span class="summary-sig-default">True</span>)</span><br />
1320 Returns the output of the leaders -c command.</td>
1321 <td align="right" valign="top">
1322 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.leaderCandidates">source&nbsp;code</a></span>
1323
1324 </td>
1325 </tr>
1326 </table>
1327
1328 </td>
1329 </tr>
1330<tr>
1331 <td width="15%" align="right" valign="top" class="summary">
1332 <span class="summary-type">&nbsp;</span>
1333 </td><td class="summary">
1334 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1335 <tr>
1336 <td><span class="summary-sig"><a name="specificLeaderCandidate"></a><span class="summary-sig-name">specificLeaderCandidate</span>(<span class="summary-sig-arg">self</span>,
1337 <span class="summary-sig-arg">topic</span>)</span><br />
1338 Returns a list in format [leader,candidate1,candidate2,...] for a
1339 given topic parameter and an empty list if the topic doesn't exist If
1340 no leader is elected leader in the returned list will be
1341 &quot;none&quot; Returns None if there is a type error processing the
1342 json object</td>
1343 <td align="right" valign="top">
1344 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.specificLeaderCandidate">source&nbsp;code</a></span>
1345
1346 </td>
1347 </tr>
1348 </table>
1349
1350 </td>
1351 </tr>
1352<tr>
1353 <td width="15%" align="right" valign="top" class="summary">
1354 <span class="summary-type">&nbsp;</span>
1355 </td><td class="summary">
1356 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1357 <tr>
1358 <td><span class="summary-sig"><a name="pendingMap"></a><span class="summary-sig-name">pendingMap</span>(<span class="summary-sig-arg">self</span>,
1359 <span class="summary-sig-arg">jsonFormat</span>=<span class="summary-sig-default">True</span>)</span><br />
1360 Returns the output of the intent Pending map.</td>
1361 <td align="right" valign="top">
1362 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.pendingMap">source&nbsp;code</a></span>
1363
1364 </td>
1365 </tr>
1366 </table>
1367
1368 </td>
1369 </tr>
1370<tr>
1371 <td width="15%" align="right" valign="top" class="summary">
1372 <span class="summary-type">&nbsp;</span>
1373 </td><td class="summary">
1374 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1375 <tr>
1376 <td><span class="summary-sig"><a name="partitions"></a><span class="summary-sig-name">partitions</span>(<span class="summary-sig-arg">self</span>,
1377 <span class="summary-sig-arg">jsonFormat</span>=<span class="summary-sig-default">True</span>)</span><br />
1378 Returns the output of the raft partitions command for ONOS.</td>
1379 <td align="right" valign="top">
1380 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.partitions">source&nbsp;code</a></span>
1381
1382 </td>
1383 </tr>
1384 </table>
1385
1386 </td>
1387 </tr>
1388<tr>
1389 <td width="15%" align="right" valign="top" class="summary">
1390 <span class="summary-type">&nbsp;</span>
1391 </td><td class="summary">
1392 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1393 <tr>
1394 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#apps" class="summary-sig-name">apps</a>(<span class="summary-sig-arg">self</span>,
1395 <span class="summary-sig-arg">jsonFormat</span>=<span class="summary-sig-default">True</span>)</span><br />
1396 Returns the output of the apps command for ONOS.</td>
1397 <td align="right" valign="top">
1398 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.apps">source&nbsp;code</a></span>
1399
1400 </td>
1401 </tr>
1402 </table>
1403
1404 </td>
1405 </tr>
1406<tr>
1407 <td width="15%" align="right" valign="top" class="summary">
1408 <span class="summary-type">&nbsp;</span>
1409 </td><td class="summary">
1410 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1411 <tr>
1412 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#appStatus" class="summary-sig-name">appStatus</a>(<span class="summary-sig-arg">self</span>,
1413 <span class="summary-sig-arg">appName</span>)</span><br />
1414 Uses the onos:apps cli command to return the status of an application.</td>
1415 <td align="right" valign="top">
1416 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.appStatus">source&nbsp;code</a></span>
1417
1418 </td>
1419 </tr>
1420 </table>
1421
1422 </td>
1423 </tr>
1424<tr>
1425 <td width="15%" align="right" valign="top" class="summary">
1426 <span class="summary-type">&nbsp;</span>
1427 </td><td class="summary">
1428 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1429 <tr>
1430 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#app" class="summary-sig-name">app</a>(<span class="summary-sig-arg">self</span>,
1431 <span class="summary-sig-arg">appName</span>,
1432 <span class="summary-sig-arg">option</span>)</span><br />
1433 Interacts with the app command for ONOS.</td>
1434 <td align="right" valign="top">
1435 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.app">source&nbsp;code</a></span>
1436
1437 </td>
1438 </tr>
1439 </table>
1440
1441 </td>
1442 </tr>
1443<tr>
1444 <td width="15%" align="right" valign="top" class="summary">
1445 <span class="summary-type">&nbsp;</span>
1446 </td><td class="summary">
1447 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1448 <tr>
1449 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#activateApp" class="summary-sig-name">activateApp</a>(<span class="summary-sig-arg">self</span>,
1450 <span class="summary-sig-arg">appName</span>,
1451 <span class="summary-sig-arg">check</span>=<span class="summary-sig-default">True</span>)</span><br />
1452 Activate an app that is already installed in ONOS...</td>
1453 <td align="right" valign="top">
1454 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.activateApp">source&nbsp;code</a></span>
1455
1456 </td>
1457 </tr>
1458 </table>
1459
1460 </td>
1461 </tr>
1462<tr>
1463 <td width="15%" align="right" valign="top" class="summary">
1464 <span class="summary-type">&nbsp;</span>
1465 </td><td class="summary">
1466 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1467 <tr>
1468 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#deactivateApp" class="summary-sig-name">deactivateApp</a>(<span class="summary-sig-arg">self</span>,
1469 <span class="summary-sig-arg">appName</span>,
1470 <span class="summary-sig-arg">check</span>=<span class="summary-sig-default">True</span>)</span><br />
1471 Deactivate an app that is already activated in ONOS...</td>
1472 <td align="right" valign="top">
1473 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.deactivateApp">source&nbsp;code</a></span>
1474
1475 </td>
1476 </tr>
1477 </table>
1478
1479 </td>
1480 </tr>
1481<tr>
1482 <td width="15%" align="right" valign="top" class="summary">
1483 <span class="summary-type">&nbsp;</span>
1484 </td><td class="summary">
1485 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1486 <tr>
1487 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#uninstallApp" class="summary-sig-name">uninstallApp</a>(<span class="summary-sig-arg">self</span>,
1488 <span class="summary-sig-arg">appName</span>,
1489 <span class="summary-sig-arg">check</span>=<span class="summary-sig-default">True</span>)</span><br />
1490 Uninstall an app that is already installed in ONOS...</td>
1491 <td align="right" valign="top">
1492 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.uninstallApp">source&nbsp;code</a></span>
1493
1494 </td>
1495 </tr>
1496 </table>
1497
1498 </td>
1499 </tr>
1500<tr>
1501 <td width="15%" align="right" valign="top" class="summary">
1502 <span class="summary-type">&nbsp;</span>
1503 </td><td class="summary">
1504 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1505 <tr>
1506 <td><span class="summary-sig"><a name="appIDs"></a><span class="summary-sig-name">appIDs</span>(<span class="summary-sig-arg">self</span>,
1507 <span class="summary-sig-arg">jsonFormat</span>=<span class="summary-sig-default">True</span>)</span><br />
1508 Show the mappings between app id and app names given by the 'app-ids'
1509 cli command</td>
1510 <td align="right" valign="top">
1511 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.appIDs">source&nbsp;code</a></span>
1512
1513 </td>
1514 </tr>
1515 </table>
1516
1517 </td>
1518 </tr>
1519<tr>
1520 <td width="15%" align="right" valign="top" class="summary">
1521 <span class="summary-type">&nbsp;</span>
1522 </td><td class="summary">
1523 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1524 <tr>
1525 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#appToIDCheck" class="summary-sig-name">appToIDCheck</a>(<span class="summary-sig-arg">self</span>)</span><br />
1526 This method will check that each application's ID listed in 'apps' is
1527the same as the ID listed in 'app-ids'.</td>
1528 <td align="right" valign="top">
1529 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.appToIDCheck">source&nbsp;code</a></span>
1530
1531 </td>
1532 </tr>
1533 </table>
1534
1535 </td>
1536 </tr>
1537<tr>
1538 <td width="15%" align="right" valign="top" class="summary">
1539 <span class="summary-type">&nbsp;</span>
1540 </td><td class="summary">
1541 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1542 <tr>
1543 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#getCfg" class="summary-sig-name">getCfg</a>(<span class="summary-sig-arg">self</span>,
1544 <span class="summary-sig-arg">component</span>=<span class="summary-sig-default">None</span>,
1545 <span class="summary-sig-arg">propName</span>=<span class="summary-sig-default">None</span>,
1546 <span class="summary-sig-arg">short</span>=<span class="summary-sig-default">False</span>,
1547 <span class="summary-sig-arg">jsonFormat</span>=<span class="summary-sig-default">True</span>)</span><br />
1548 Get configuration settings from onos cli
1549Optional arguments:
1550 component - Optionally only list configurations for a specific
1551 component.</td>
1552 <td align="right" valign="top">
1553 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.getCfg">source&nbsp;code</a></span>
1554
1555 </td>
1556 </tr>
1557 </table>
1558
1559 </td>
1560 </tr>
1561<tr>
1562 <td width="15%" align="right" valign="top" class="summary">
1563 <span class="summary-type">&nbsp;</span>
1564 </td><td class="summary">
1565 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1566 <tr>
1567 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#setCfg" class="summary-sig-name">setCfg</a>(<span class="summary-sig-arg">self</span>,
1568 <span class="summary-sig-arg">component</span>,
1569 <span class="summary-sig-arg">propName</span>,
1570 <span class="summary-sig-arg">value</span>=<span class="summary-sig-default">None</span>,
1571 <span class="summary-sig-arg">check</span>=<span class="summary-sig-default">True</span>)</span><br />
1572 Set/Unset configuration settings from ONOS cli
1573Required arguments:
1574 component - The case sensitive name of the component whose
1575 property is to be set
1576 propName - The case sensitive name of the property to be set/unset
1577Optional arguments:
1578 value - The value to set the property to.</td>
1579 <td align="right" valign="top">
1580 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.setCfg">source&nbsp;code</a></span>
1581
1582 </td>
1583 </tr>
1584 </table>
1585
1586 </td>
1587 </tr>
1588<tr>
1589 <td width="15%" align="right" valign="top" class="summary">
1590 <span class="summary-type">&nbsp;</span>
1591 </td><td class="summary">
1592 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1593 <tr>
1594 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#setTestAdd" class="summary-sig-name">setTestAdd</a>(<span class="summary-sig-arg">self</span>,
1595 <span class="summary-sig-arg">setName</span>,
1596 <span class="summary-sig-arg">values</span>)</span><br />
1597 CLI command to add elements to a distributed set.</td>
1598 <td align="right" valign="top">
1599 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.setTestAdd">source&nbsp;code</a></span>
1600
1601 </td>
1602 </tr>
1603 </table>
1604
1605 </td>
1606 </tr>
1607<tr>
1608 <td width="15%" align="right" valign="top" class="summary">
1609 <span class="summary-type">&nbsp;</span>
1610 </td><td class="summary">
1611 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1612 <tr>
1613 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#setTestRemove" class="summary-sig-name">setTestRemove</a>(<span class="summary-sig-arg">self</span>,
1614 <span class="summary-sig-arg">setName</span>,
1615 <span class="summary-sig-arg">values</span>,
1616 <span class="summary-sig-arg">clear</span>=<span class="summary-sig-default">False</span>,
1617 <span class="summary-sig-arg">retain</span>=<span class="summary-sig-default">False</span>)</span><br />
1618 CLI command to remove elements from a distributed set.</td>
1619 <td align="right" valign="top">
1620 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.setTestRemove">source&nbsp;code</a></span>
1621
1622 </td>
1623 </tr>
1624 </table>
1625
1626 </td>
1627 </tr>
1628<tr>
1629 <td width="15%" align="right" valign="top" class="summary">
1630 <span class="summary-type">&nbsp;</span>
1631 </td><td class="summary">
1632 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1633 <tr>
1634 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#setTestGet" class="summary-sig-name">setTestGet</a>(<span class="summary-sig-arg">self</span>,
1635 <span class="summary-sig-arg">setName</span>,
1636 <span class="summary-sig-arg">values</span>=<span class="summary-sig-default">&quot;&quot;</span>)</span><br />
1637 CLI command to get the elements in a distributed set.</td>
1638 <td align="right" valign="top">
1639 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.setTestGet">source&nbsp;code</a></span>
1640
1641 </td>
1642 </tr>
1643 </table>
1644
1645 </td>
1646 </tr>
1647<tr>
1648 <td width="15%" align="right" valign="top" class="summary">
1649 <span class="summary-type">&nbsp;</span>
1650 </td><td class="summary">
1651 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1652 <tr>
1653 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#setTestSize" class="summary-sig-name">setTestSize</a>(<span class="summary-sig-arg">self</span>,
1654 <span class="summary-sig-arg">setName</span>)</span><br />
1655 CLI command to get the elements in a distributed set.</td>
1656 <td align="right" valign="top">
1657 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.setTestSize">source&nbsp;code</a></span>
1658
1659 </td>
1660 </tr>
1661 </table>
1662
1663 </td>
1664 </tr>
1665<tr>
1666 <td width="15%" align="right" valign="top" class="summary">
1667 <span class="summary-type">&nbsp;</span>
1668 </td><td class="summary">
1669 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1670 <tr>
1671 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#counters" class="summary-sig-name">counters</a>(<span class="summary-sig-arg">self</span>,
1672 <span class="summary-sig-arg">jsonFormat</span>=<span class="summary-sig-default">True</span>)</span><br />
1673 Command to list the various counters in the system.</td>
1674 <td align="right" valign="top">
1675 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.counters">source&nbsp;code</a></span>
1676
1677 </td>
1678 </tr>
1679 </table>
1680
1681 </td>
1682 </tr>
1683<tr>
1684 <td width="15%" align="right" valign="top" class="summary">
1685 <span class="summary-type">&nbsp;</span>
1686 </td><td class="summary">
1687 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1688 <tr>
1689 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#counterTestAddAndGet" class="summary-sig-name">counterTestAddAndGet</a>(<span class="summary-sig-arg">self</span>,
1690 <span class="summary-sig-arg">counter</span>,
1691 <span class="summary-sig-arg">delta</span>=<span class="summary-sig-default">1</span>,
1692 <span class="summary-sig-arg">inMemory</span>=<span class="summary-sig-default">False</span>)</span><br />
1693 CLI command to add a delta to then get a distributed counter.</td>
1694 <td align="right" valign="top">
1695 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.counterTestAddAndGet">source&nbsp;code</a></span>
1696
1697 </td>
1698 </tr>
1699 </table>
1700
1701 </td>
1702 </tr>
1703<tr>
1704 <td width="15%" align="right" valign="top" class="summary">
1705 <span class="summary-type">&nbsp;</span>
1706 </td><td class="summary">
1707 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1708 <tr>
1709 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.onosclidriver.OnosCliDriver-class.html#counterTestGetAndAdd" class="summary-sig-name">counterTestGetAndAdd</a>(<span class="summary-sig-arg">self</span>,
1710 <span class="summary-sig-arg">counter</span>,
1711 <span class="summary-sig-arg">delta</span>=<span class="summary-sig-default">1</span>,
1712 <span class="summary-sig-arg">inMemory</span>=<span class="summary-sig-default">False</span>)</span><br />
1713 CLI command to get a distributed counter then add a delta to it.</td>
1714 <td align="right" valign="top">
1715 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.counterTestGetAndAdd">source&nbsp;code</a></span>
1716
1717 </td>
1718 </tr>
1719 </table>
1720
1721 </td>
1722 </tr>
1723<tr>
1724 <td width="15%" align="right" valign="top" class="summary">
1725 <span class="summary-type">&nbsp;</span>
1726 </td><td class="summary">
1727 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1728 <tr>
1729 <td><span class="summary-sig"><a name="summary"></a><span class="summary-sig-name">summary</span>(<span class="summary-sig-arg">self</span>,
1730 <span class="summary-sig-arg">jsonFormat</span>=<span class="summary-sig-default">True</span>)</span><br />
1731 Description: Execute summary command in onos Returns: json object (
1732 summary -j ), returns main.FALSE if there is no output</td>
1733 <td align="right" valign="top">
1734 <span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.summary">source&nbsp;code</a></span>
1735
1736 </td>
1737 </tr>
1738 </table>
1739
1740 </td>
1741 </tr>
1742<tr>
1743 <td width="15%" align="right" valign="top" class="summary">
1744 <span class="summary-type">&nbsp;</span>
1745 </td><td class="summary">
1746 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1747 <tr>
1748 <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>,
1749 <span class="summary-sig-arg">**execparams</span>)</span><br />
1750 It facilitates the command line execution of a given command.
1751 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
1752 <td align="right" valign="top">
1753 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.execute">source&nbsp;code</a></span>
1754
1755 </td>
1756 </tr>
1757 </table>
1758
1759 </td>
1760 </tr>
1761<tr>
1762 <td width="15%" align="right" valign="top" class="summary">
1763 <span class="summary-type">&nbsp;</span>
1764 </td><td class="summary">
1765 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1766 <tr>
1767 <td><span class="summary-sig"><a name="onfail"></a><span class="summary-sig-name">onfail</span>(<span class="summary-sig-arg">self</span>)</span>
1768 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
1769 <td align="right" valign="top">
1770 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.onfail">source&nbsp;code</a></span>
1771
1772 </td>
1773 </tr>
1774 </table>
1775
1776 </td>
1777 </tr>
1778<tr>
1779 <td width="15%" align="right" valign="top" class="summary">
1780 <span class="summary-type">&nbsp;</span>
1781 </td><td class="summary">
1782 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1783 <tr>
1784 <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>,
1785 <span class="summary-sig-arg">response</span>)</span>
1786 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
1787 <td align="right" valign="top">
1788 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.remove_contol_chars">source&nbsp;code</a></span>
1789
1790 </td>
1791 </tr>
1792 </table>
1793
1794 </td>
1795 </tr>
1796<tr>
1797 <td width="15%" align="right" valign="top" class="summary">
1798 <span class="summary-type">&nbsp;</span>
1799 </td><td class="summary">
1800 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1801 <tr>
1802 <td><span class="summary-sig"><a name="runAsSudoUser"></a><span class="summary-sig-name">runAsSudoUser</span>(<span class="summary-sig-arg">self</span>,
1803 <span class="summary-sig-arg">handle</span>,
1804 <span class="summary-sig-arg">pwd</span>,
1805 <span class="summary-sig-arg">default</span>)</span>
1806 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
1807 <td align="right" valign="top">
1808 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.runAsSudoUser">source&nbsp;code</a></span>
1809
1810 </td>
1811 </tr>
1812 </table>
1813
1814 </td>
1815 </tr>
1816<tr>
1817 <td width="15%" align="right" valign="top" class="summary">
1818 <span class="summary-type">&nbsp;</span>
1819 </td><td class="summary">
1820 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1821 <tr>
1822 <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>,
1823 <span class="summary-sig-arg">user_name</span>,
1824 <span class="summary-sig-arg">ip_address</span>,
1825 <span class="summary-sig-arg">filepath</span>,
1826 <span class="summary-sig-arg">pwd</span>,
1827 <span class="summary-sig-arg">dst_path</span>)</span><br />
1828 Connection will establish to the remote host using ssh.
1829 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
1830 <td align="right" valign="top">
1831 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.secureCopy">source&nbsp;code</a></span>
1832
1833 </td>
1834 </tr>
1835 </table>
1836
1837 </td>
1838 </tr>
1839 <tr>
1840 <td colspan="2" class="summary">
1841 <p class="indent-wrapped-lines"><b>Inherited from <code>component.Component</code></b>:
1842 <code>__getattr__</code>,
1843 <code>cleanup</code>,
1844 <code>close_log_handles</code>,
1845 <code>config</code>,
1846 <code>experimentRun</code>,
1847 <code>get_version</code>
1848 </p>
1849 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
1850 <code>__delattr__</code>,
1851 <code>__format__</code>,
1852 <code>__getattribute__</code>,
1853 <code>__hash__</code>,
1854 <code>__new__</code>,
1855 <code>__reduce__</code>,
1856 <code>__reduce_ex__</code>,
1857 <code>__repr__</code>,
1858 <code>__setattr__</code>,
1859 <code>__sizeof__</code>,
1860 <code>__str__</code>,
1861 <code>__subclasshook__</code>
1862 </p>
1863 </td>
1864 </tr>
1865</table>
1866<!-- ==================== PROPERTIES ==================== -->
1867<a name="section-Properties"></a>
1868<table class="summary" border="1" cellpadding="3"
1869 cellspacing="0" width="100%" bgcolor="white">
1870<tr bgcolor="#70b0f0" class="table-header">
1871 <td colspan="2" class="table-header">
1872 <table border="0" cellpadding="0" cellspacing="0" width="100%">
1873 <tr valign="top">
1874 <td align="left"><span class="table-header">Properties</span></td>
1875 <td align="right" valign="top"
1876 ><span class="options">[<a href="#section-Properties"
1877 class="privatelink" onclick="toggle_private();"
1878 >hide private</a>]</span></td>
1879 </tr>
1880 </table>
1881 </td>
1882</tr>
1883 <tr>
1884 <td colspan="2" class="summary">
1885 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
1886 <code>__class__</code>
1887 </p>
1888 </td>
1889 </tr>
1890</table>
1891<!-- ==================== METHOD DETAILS ==================== -->
1892<a name="section-MethodDetails"></a>
1893<table class="details" border="1" cellpadding="3"
1894 cellspacing="0" width="100%" bgcolor="white">
1895<tr bgcolor="#70b0f0" class="table-header">
1896 <td colspan="2" class="table-header">
1897 <table border="0" cellpadding="0" cellspacing="0" width="100%">
1898 <tr valign="top">
1899 <td align="left"><span class="table-header">Method Details</span></td>
1900 <td align="right" valign="top"
1901 ><span class="options">[<a href="#section-MethodDetails"
1902 class="privatelink" onclick="toggle_private();"
1903 >hide private</a>]</span></td>
1904 </tr>
1905 </table>
1906 </td>
1907</tr>
1908</table>
1909<a name="__init__"></a>
1910<div>
1911<table class="details" border="1" cellpadding="3"
1912 cellspacing="0" width="100%" bgcolor="white">
1913<tr><td>
1914 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1915 <tr valign="top"><td>
1916 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>)</span>
1917 <br /><em class="fname">(Constructor)</em>
1918 </h3>
1919 </td><td align="right" valign="top"
1920 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.__init__">source&nbsp;code</a></span>&nbsp;
1921 </td>
1922 </tr></table>
1923
1924 <p>Initialize client</p>
1925 <dl class="fields">
1926 <dt>Overrides:
1927 object.__init__
1928 </dt>
1929 </dl>
1930</td></tr></table>
1931</div>
1932<a name="connect"></a>
1933<div>
1934<table class="details" border="1" cellpadding="3"
1935 cellspacing="0" width="100%" bgcolor="white">
1936<tr><td>
1937 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1938 <tr valign="top"><td>
1939 <h3 class="epydoc"><span class="sig"><span class="sig-name">connect</span>(<span class="sig-arg">self</span>,
1940 <span class="sig-arg">**connectargs</span>)</span>
1941 </h3>
1942 </td><td align="right" valign="top"
1943 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.connect">source&nbsp;code</a></span>&nbsp;
1944 </td>
1945 </tr></table>
1946
1947 <p>Creates ssh handle for ONOS cli.</p>
1948 <dl class="fields">
1949 <dt>Overrides:
1950 component.Component.connect
1951 </dt>
1952 </dl>
1953</td></tr></table>
1954</div>
1955<a name="disconnect"></a>
1956<div>
1957<table class="details" border="1" cellpadding="3"
1958 cellspacing="0" width="100%" bgcolor="white">
1959<tr><td>
1960 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1961 <tr valign="top"><td>
1962 <h3 class="epydoc"><span class="sig"><span class="sig-name">disconnect</span>(<span class="sig-arg">self</span>)</span>
1963 </h3>
1964 </td><td align="right" valign="top"
1965 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.disconnect">source&nbsp;code</a></span>&nbsp;
1966 </td>
1967 </tr></table>
1968
1969 <p>Called when Test is complete to disconnect the ONOS handle.</p>
1970 <dl class="fields">
1971 <dt>Overrides:
1972 component.Component.disconnect
1973 </dt>
1974 </dl>
1975</td></tr></table>
1976</div>
1977<a name="logout"></a>
1978<div>
1979<table class="details" border="1" cellpadding="3"
1980 cellspacing="0" width="100%" bgcolor="white">
1981<tr><td>
1982 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1983 <tr valign="top"><td>
1984 <h3 class="epydoc"><span class="sig"><span class="sig-name">logout</span>(<span class="sig-arg">self</span>)</span>
1985 </h3>
1986 </td><td align="right" valign="top"
1987 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.logout">source&nbsp;code</a></span>&nbsp;
1988 </td>
1989 </tr></table>
1990
1991 <pre class="literalblock">
1992
1993Sends 'logout' command to ONOS cli
1994Returns main.TRUE if exited CLI and
1995 main.FALSE on timeout (not guranteed you are disconnected)
1996 None on TypeError
1997 Exits test on unknown error or pexpect exits unexpectedly
1998
1999</pre>
2000 <dl class="fields">
2001 </dl>
2002</td></tr></table>
2003</div>
2004<a name="setCell"></a>
2005<div>
2006<table class="details" border="1" cellpadding="3"
2007 cellspacing="0" width="100%" bgcolor="white">
2008<tr><td>
2009 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2010 <tr valign="top"><td>
2011 <h3 class="epydoc"><span class="sig"><span class="sig-name">setCell</span>(<span class="sig-arg">self</span>,
2012 <span class="sig-arg">cellname</span>)</span>
2013 </h3>
2014 </td><td align="right" valign="top"
2015 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.setCell">source&nbsp;code</a></span>&nbsp;
2016 </td>
2017 </tr></table>
2018
2019 <p>Calls 'cell &lt;name&gt;' to set the environment variables on
2020 ONOSbench</p>
2021 <p>Before issuing any cli commands, set the environment variable
2022 first.</p>
2023 <dl class="fields">
2024 </dl>
2025</td></tr></table>
2026</div>
2027<a name="startOnosCli"></a>
2028<div>
2029<table class="details" border="1" cellpadding="3"
2030 cellspacing="0" width="100%" bgcolor="white">
2031<tr><td>
2032 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2033 <tr valign="top"><td>
2034 <h3 class="epydoc"><span class="sig"><span class="sig-name">startOnosCli</span>(<span class="sig-arg">self</span>,
2035 <span class="sig-arg">ONOSIp</span>,
2036 <span class="sig-arg">karafTimeout</span>=<span class="sig-default">&quot;&quot;</span>,
2037 <span class="sig-arg">commandlineTimeout</span>=<span class="sig-default">10</span>,
2038 <span class="sig-arg">onosStartTimeout</span>=<span class="sig-default">60</span>)</span>
2039 </h3>
2040 </td><td align="right" valign="top"
2041 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.startOnosCli">source&nbsp;code</a></span>&nbsp;
2042 </td>
2043 </tr></table>
2044
2045 <p>karafTimeout is an optional argument. karafTimeout value passed by
2046 user would be used to set the current karaf shell idle timeout. Note that
2047 when ever this property is modified the shell will exit and the
2048 subsequent login would reflect new idle timeout. Below is an example to
2049 start a session with 60 seconds idle timeout ( input value is in
2050 milliseconds ):</p>
2051 <p>tValue = &quot;60000&quot; main.ONOScli1.startOnosCli( ONOSIp,
2052 karafTimeout=tValue )</p>
2053 <p>Note: karafTimeout is left as str so that this could be read and
2054 passed to startOnosCli from PARAMS file as str.</p>
2055 <dl class="fields">
2056 </dl>
2057</td></tr></table>
2058</div>
2059<a name="log"></a>
2060<div>
2061<table class="details" border="1" cellpadding="3"
2062 cellspacing="0" width="100%" bgcolor="white">
2063<tr><td>
2064 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2065 <tr valign="top"><td>
2066 <h3 class="epydoc"><span class="sig"><span class="sig-name">log</span>(<span class="sig-arg">self</span>,
2067 <span class="sig-arg">cmdStr</span>,
2068 <span class="sig-arg">level</span>=<span class="sig-default">&quot;&quot;</span>)</span>
2069 </h3>
2070 </td><td align="right" valign="top"
2071 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.log">source&nbsp;code</a></span>&nbsp;
2072 </td>
2073 </tr></table>
2074
2075 <p>log the commands in the onos CLI. returns main.TRUE on success
2076 returns main.FALSE if Error occurred Available level: DEBUG, TRACE, INFO,
2077 WARN, ERROR Level defaults to INFO</p>
2078 <dl class="fields">
2079 <dt>Overrides:
2080 component.Component.log
2081 </dt>
2082 </dl>
2083</td></tr></table>
2084</div>
2085<a name="sendline"></a>
2086<div>
2087<table class="details" border="1" cellpadding="3"
2088 cellspacing="0" width="100%" bgcolor="white">
2089<tr><td>
2090 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2091 <tr valign="top"><td>
2092 <h3 class="epydoc"><span class="sig"><span class="sig-name">sendline</span>(<span class="sig-arg">self</span>,
2093 <span class="sig-arg">cmdStr</span>,
2094 <span class="sig-arg">debug</span>=<span class="sig-default">False</span>)</span>
2095 </h3>
2096 </td><td align="right" valign="top"
2097 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.sendline">source&nbsp;code</a></span>&nbsp;
2098 </td>
2099 </tr></table>
2100
2101 <p>Send a completely user specified string to the onos&gt; prompt. Use
2102 this function if you have a very specific command to send.</p>
2103 <p>Warning: There are no sanity checking to commands sent using this
2104 method.</p>
2105 <dl class="fields">
2106 </dl>
2107</td></tr></table>
2108</div>
2109<a name="addNode"></a>
2110<div>
2111<table class="details" border="1" cellpadding="3"
2112 cellspacing="0" width="100%" bgcolor="white">
2113<tr><td>
2114 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2115 <tr valign="top"><td>
2116 <h3 class="epydoc"><span class="sig"><span class="sig-name">addNode</span>(<span class="sig-arg">self</span>,
2117 <span class="sig-arg">nodeId</span>,
2118 <span class="sig-arg">ONOSIp</span>,
2119 <span class="sig-arg">tcpPort</span>=<span class="sig-default">&quot;&quot;</span>)</span>
2120 </h3>
2121 </td><td align="right" valign="top"
2122 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.addNode">source&nbsp;code</a></span>&nbsp;
2123 </td>
2124 </tr></table>
2125
2126 <pre class="literalblock">
2127
2128Adds a new cluster node by ID and address information.
2129Required:
2130 * nodeId
2131 * ONOSIp
2132Optional:
2133 * tcpPort
2134
2135</pre>
2136 <dl class="fields">
2137 </dl>
2138</td></tr></table>
2139</div>
2140<a name="removeNode"></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">removeNode</span>(<span class="sig-arg">self</span>,
2148 <span class="sig-arg">nodeId</span>)</span>
2149 </h3>
2150 </td><td align="right" valign="top"
2151 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.removeNode">source&nbsp;code</a></span>&nbsp;
2152 </td>
2153 </tr></table>
2154
2155 <pre class="literalblock">
2156
2157Removes a cluster by ID
2158Issues command: 'remove-node [&lt;node-id&gt;]'
2159Required:
2160 * nodeId
2161
2162</pre>
2163 <dl class="fields">
2164 </dl>
2165</td></tr></table>
2166</div>
2167<a name="nodes"></a>
2168<div>
2169<table class="details" border="1" cellpadding="3"
2170 cellspacing="0" width="100%" bgcolor="white">
2171<tr><td>
2172 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2173 <tr valign="top"><td>
2174 <h3 class="epydoc"><span class="sig"><span class="sig-name">nodes</span>(<span class="sig-arg">self</span>,
2175 <span class="sig-arg">jsonFormat</span>=<span class="sig-default">True</span>)</span>
2176 </h3>
2177 </td><td align="right" valign="top"
2178 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.nodes">source&nbsp;code</a></span>&nbsp;
2179 </td>
2180 </tr></table>
2181
2182 <pre class="literalblock">
2183
2184List the nodes currently visible
2185Issues command: 'nodes'
2186Optional argument:
2187 * jsonFormat - boolean indicating if you want output in json
2188
2189</pre>
2190 <dl class="fields">
2191 </dl>
2192</td></tr></table>
2193</div>
2194<a name="topology"></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">topology</span>(<span class="sig-arg">self</span>)</span>
2202 </h3>
2203 </td><td align="right" valign="top"
2204 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.topology">source&nbsp;code</a></span>&nbsp;
2205 </td>
2206 </tr></table>
2207
2208 <pre class="literalblock">
2209
2210Definition:
2211 Returns the output of topology command.
2212Return:
2213 topology = current ONOS topology
2214
2215</pre>
2216 <dl class="fields">
2217 </dl>
2218</td></tr></table>
2219</div>
2220<a name="featureInstall"></a>
2221<div>
2222<table class="details" border="1" cellpadding="3"
2223 cellspacing="0" width="100%" bgcolor="white">
2224<tr><td>
2225 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2226 <tr valign="top"><td>
2227 <h3 class="epydoc"><span class="sig"><span class="sig-name">featureInstall</span>(<span class="sig-arg">self</span>,
2228 <span class="sig-arg">featureStr</span>)</span>
2229 </h3>
2230 </td><td align="right" valign="top"
2231 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.featureInstall">source&nbsp;code</a></span>&nbsp;
2232 </td>
2233 </tr></table>
2234
2235 <pre class="literalblock">
2236
2237Installs a specified feature by issuing command:
2238 'feature:install &lt;feature_str&gt;'
2239NOTE: This is now deprecated, you should use the activateApp method
2240 instead
2241
2242</pre>
2243 <dl class="fields">
2244 </dl>
2245</td></tr></table>
2246</div>
2247<a name="featureUninstall"></a>
2248<div>
2249<table class="details" border="1" cellpadding="3"
2250 cellspacing="0" width="100%" bgcolor="white">
2251<tr><td>
2252 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2253 <tr valign="top"><td>
2254 <h3 class="epydoc"><span class="sig"><span class="sig-name">featureUninstall</span>(<span class="sig-arg">self</span>,
2255 <span class="sig-arg">featureStr</span>)</span>
2256 </h3>
2257 </td><td align="right" valign="top"
2258 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.featureUninstall">source&nbsp;code</a></span>&nbsp;
2259 </td>
2260 </tr></table>
2261
2262 <pre class="literalblock">
2263
2264Uninstalls a specified feature by issuing command:
2265 'feature:uninstall &lt;feature_str&gt;'
2266NOTE: This is now deprecated, you should use the deactivateApp method
2267 instead
2268
2269</pre>
2270 <dl class="fields">
2271 </dl>
2272</td></tr></table>
2273</div>
2274<a name="deviceRemove"></a>
2275<div>
2276<table class="details" border="1" cellpadding="3"
2277 cellspacing="0" width="100%" bgcolor="white">
2278<tr><td>
2279 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2280 <tr valign="top"><td>
2281 <h3 class="epydoc"><span class="sig"><span class="sig-name">deviceRemove</span>(<span class="sig-arg">self</span>,
2282 <span class="sig-arg">deviceId</span>)</span>
2283 </h3>
2284 </td><td align="right" valign="top"
2285 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.deviceRemove">source&nbsp;code</a></span>&nbsp;
2286 </td>
2287 </tr></table>
2288
2289 <p>Removes particular device from storage</p>
2290 <p>TODO: refactor this function</p>
2291 <dl class="fields">
2292 </dl>
2293</td></tr></table>
2294</div>
2295<a name="devices"></a>
2296<div>
2297<table class="details" border="1" cellpadding="3"
2298 cellspacing="0" width="100%" bgcolor="white">
2299<tr><td>
2300 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2301 <tr valign="top"><td>
2302 <h3 class="epydoc"><span class="sig"><span class="sig-name">devices</span>(<span class="sig-arg">self</span>,
2303 <span class="sig-arg">jsonFormat</span>=<span class="sig-default">True</span>)</span>
2304 </h3>
2305 </td><td align="right" valign="top"
2306 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.devices">source&nbsp;code</a></span>&nbsp;
2307 </td>
2308 </tr></table>
2309
2310 <pre class="literalblock">
2311
2312Lists all infrastructure devices or switches
2313Optional argument:
2314 * jsonFormat - boolean indicating if you want output in json
2315
2316</pre>
2317 <dl class="fields">
2318 </dl>
2319</td></tr></table>
2320</div>
2321<a name="checkMasters"></a>
2322<div>
2323<table class="details" border="1" cellpadding="3"
2324 cellspacing="0" width="100%" bgcolor="white">
2325<tr><td>
2326 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2327 <tr valign="top"><td>
2328 <h3 class="epydoc"><span class="sig"><span class="sig-name">checkMasters</span>(<span class="sig-arg">self</span>,
2329 <span class="sig-arg">jsonFormat</span>=<span class="sig-default">True</span>)</span>
2330 </h3>
2331 </td><td align="right" valign="top"
2332 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.checkMasters">source&nbsp;code</a></span>&nbsp;
2333 </td>
2334 </tr></table>
2335
2336 <pre class="literalblock">
2337
2338Returns the output of the masters command.
2339Optional argument:
2340 * jsonFormat - boolean indicating if you want output in json
2341
2342</pre>
2343 <dl class="fields">
2344 </dl>
2345</td></tr></table>
2346</div>
2347<a name="checkBalanceMasters"></a>
2348<div>
2349<table class="details" border="1" cellpadding="3"
2350 cellspacing="0" width="100%" bgcolor="white">
2351<tr><td>
2352 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2353 <tr valign="top"><td>
2354 <h3 class="epydoc"><span class="sig"><span class="sig-name">checkBalanceMasters</span>(<span class="sig-arg">self</span>,
2355 <span class="sig-arg">jsonFormat</span>=<span class="sig-default">True</span>)</span>
2356 </h3>
2357 </td><td align="right" valign="top"
2358 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.checkBalanceMasters">source&nbsp;code</a></span>&nbsp;
2359 </td>
2360 </tr></table>
2361
2362 <p>Uses the master command to check that the devices' leadership is
2363 evenly divided</p>
2364 <p>Dependencies: checkMasters() and summary()</p>
2365 <p>Returns main.True if the devices are balanced Returns main.False if
2366 the devices are unbalanced Exits on Exception Returns None on
2367 TypeError</p>
2368 <dl class="fields">
2369 </dl>
2370</td></tr></table>
2371</div>
2372<a name="links"></a>
2373<div>
2374<table class="details" border="1" cellpadding="3"
2375 cellspacing="0" width="100%" bgcolor="white">
2376<tr><td>
2377 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2378 <tr valign="top"><td>
2379 <h3 class="epydoc"><span class="sig"><span class="sig-name">links</span>(<span class="sig-arg">self</span>,
2380 <span class="sig-arg">jsonFormat</span>=<span class="sig-default">True</span>)</span>
2381 </h3>
2382 </td><td align="right" valign="top"
2383 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.links">source&nbsp;code</a></span>&nbsp;
2384 </td>
2385 </tr></table>
2386
2387 <pre class="literalblock">
2388
2389Lists all core links
2390Optional argument:
2391 * jsonFormat - boolean indicating if you want output in json
2392
2393</pre>
2394 <dl class="fields">
2395 </dl>
2396</td></tr></table>
2397</div>
2398<a name="ports"></a>
2399<div>
2400<table class="details" border="1" cellpadding="3"
2401 cellspacing="0" width="100%" bgcolor="white">
2402<tr><td>
2403 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2404 <tr valign="top"><td>
2405 <h3 class="epydoc"><span class="sig"><span class="sig-name">ports</span>(<span class="sig-arg">self</span>,
2406 <span class="sig-arg">jsonFormat</span>=<span class="sig-default">True</span>)</span>
2407 </h3>
2408 </td><td align="right" valign="top"
2409 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.ports">source&nbsp;code</a></span>&nbsp;
2410 </td>
2411 </tr></table>
2412
2413 <pre class="literalblock">
2414
2415Lists all ports
2416Optional argument:
2417 * jsonFormat - boolean indicating if you want output in json
2418
2419</pre>
2420 <dl class="fields">
2421 </dl>
2422</td></tr></table>
2423</div>
2424<a name="roles"></a>
2425<div>
2426<table class="details" border="1" cellpadding="3"
2427 cellspacing="0" width="100%" bgcolor="white">
2428<tr><td>
2429 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2430 <tr valign="top"><td>
2431 <h3 class="epydoc"><span class="sig"><span class="sig-name">roles</span>(<span class="sig-arg">self</span>,
2432 <span class="sig-arg">jsonFormat</span>=<span class="sig-default">True</span>)</span>
2433 </h3>
2434 </td><td align="right" valign="top"
2435 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.roles">source&nbsp;code</a></span>&nbsp;
2436 </td>
2437 </tr></table>
2438
2439 <pre class="literalblock">
2440
2441Lists all devices and the controllers with roles assigned to them
2442Optional argument:
2443 * jsonFormat - boolean indicating if you want output in json
2444
2445</pre>
2446 <dl class="fields">
2447 </dl>
2448</td></tr></table>
2449</div>
2450<a name="getRole"></a>
2451<div>
2452<table class="details" border="1" cellpadding="3"
2453 cellspacing="0" width="100%" bgcolor="white">
2454<tr><td>
2455 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2456 <tr valign="top"><td>
2457 <h3 class="epydoc"><span class="sig"><span class="sig-name">getRole</span>(<span class="sig-arg">self</span>,
2458 <span class="sig-arg">deviceId</span>)</span>
2459 </h3>
2460 </td><td align="right" valign="top"
2461 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.getRole">source&nbsp;code</a></span>&nbsp;
2462 </td>
2463 </tr></table>
2464
2465 <p>Given the a string containing the json representation of the
2466 &quot;roles&quot; cli command and a partial or whole device id, returns a
2467 json object containing the roles output for the first device whose id
2468 contains &quot;device_id&quot;</p>
2469 <p>Returns: A dict of the role assignments for the given device or None
2470 if no match</p>
2471 <dl class="fields">
2472 </dl>
2473</td></tr></table>
2474</div>
2475<a name="rolesNotNull"></a>
2476<div>
2477<table class="details" border="1" cellpadding="3"
2478 cellspacing="0" width="100%" bgcolor="white">
2479<tr><td>
2480 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2481 <tr valign="top"><td>
2482 <h3 class="epydoc"><span class="sig"><span class="sig-name">rolesNotNull</span>(<span class="sig-arg">self</span>)</span>
2483 </h3>
2484 </td><td align="right" valign="top"
2485 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.rolesNotNull">source&nbsp;code</a></span>&nbsp;
2486 </td>
2487 </tr></table>
2488
2489 <pre class="literalblock">
2490
2491Iterates through each device and checks if there is a master assigned
2492Returns: main.TRUE if each device has a master
2493 main.FALSE any device has no master
2494
2495</pre>
2496 <dl class="fields">
2497 </dl>
2498</td></tr></table>
2499</div>
2500<a name="paths"></a>
2501<div>
2502<table class="details" border="1" cellpadding="3"
2503 cellspacing="0" width="100%" bgcolor="white">
2504<tr><td>
2505 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2506 <tr valign="top"><td>
2507 <h3 class="epydoc"><span class="sig"><span class="sig-name">paths</span>(<span class="sig-arg">self</span>,
2508 <span class="sig-arg">srcId</span>,
2509 <span class="sig-arg">dstId</span>)</span>
2510 </h3>
2511 </td><td align="right" valign="top"
2512 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.paths">source&nbsp;code</a></span>&nbsp;
2513 </td>
2514 </tr></table>
2515
2516 <p>Returns string of paths, and the cost. Issues command: onos:paths
2517 &lt;src&gt; &lt;dst&gt;</p>
2518 <dl class="fields">
2519 </dl>
2520</td></tr></table>
2521</div>
2522<a name="hosts"></a>
2523<div>
2524<table class="details" border="1" cellpadding="3"
2525 cellspacing="0" width="100%" bgcolor="white">
2526<tr><td>
2527 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2528 <tr valign="top"><td>
2529 <h3 class="epydoc"><span class="sig"><span class="sig-name">hosts</span>(<span class="sig-arg">self</span>,
2530 <span class="sig-arg">jsonFormat</span>=<span class="sig-default">True</span>)</span>
2531 </h3>
2532 </td><td align="right" valign="top"
2533 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.hosts">source&nbsp;code</a></span>&nbsp;
2534 </td>
2535 </tr></table>
2536
2537 <pre class="literalblock">
2538
2539Lists all discovered hosts
2540Optional argument:
2541 * jsonFormat - boolean indicating if you want output in json
2542
2543</pre>
2544 <dl class="fields">
2545 </dl>
2546</td></tr></table>
2547</div>
2548<a name="getHost"></a>
2549<div>
2550<table class="details" border="1" cellpadding="3"
2551 cellspacing="0" width="100%" bgcolor="white">
2552<tr><td>
2553 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2554 <tr valign="top"><td>
2555 <h3 class="epydoc"><span class="sig"><span class="sig-name">getHost</span>(<span class="sig-arg">self</span>,
2556 <span class="sig-arg">mac</span>)</span>
2557 </h3>
2558 </td><td align="right" valign="top"
2559 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.getHost">source&nbsp;code</a></span>&nbsp;
2560 </td>
2561 </tr></table>
2562
2563 <pre class="literalblock">
2564
2565Return the first host from the hosts api whose 'id' contains 'mac'
2566
2567Note: mac must be a colon separated mac address, but could be a
2568 partial mac address
2569
2570Return None if there is no match
2571
2572</pre>
2573 <dl class="fields">
2574 </dl>
2575</td></tr></table>
2576</div>
2577<a name="getHostsId"></a>
2578<div>
2579<table class="details" border="1" cellpadding="3"
2580 cellspacing="0" width="100%" bgcolor="white">
2581<tr><td>
2582 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2583 <tr valign="top"><td>
2584 <h3 class="epydoc"><span class="sig"><span class="sig-name">getHostsId</span>(<span class="sig-arg">self</span>,
2585 <span class="sig-arg">hostList</span>)</span>
2586 </h3>
2587 </td><td align="right" valign="top"
2588 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.getHostsId">source&nbsp;code</a></span>&nbsp;
2589 </td>
2590 </tr></table>
2591
2592 <pre class="literalblock">
2593
2594Obtain list of hosts
2595Issues command: 'onos&gt; hosts'
2596
2597Required:
2598 * hostList: List of hosts obtained by Mininet
2599IMPORTANT:
2600 This function assumes that you started your
2601 topology with the option '--mac'.
2602 Furthermore, it assumes that value of VLAN is '-1'
2603Description:
2604 Converts mininet hosts ( h1, h2, h3... ) into
2605 ONOS format ( 00:00:00:00:00:01/-1 , ... )
2606
2607</pre>
2608 <dl class="fields">
2609 </dl>
2610</td></tr></table>
2611</div>
2612<a name="addHostIntent"></a>
2613<div>
2614<table class="details" border="1" cellpadding="3"
2615 cellspacing="0" width="100%" bgcolor="white">
2616<tr><td>
2617 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2618 <tr valign="top"><td>
2619 <h3 class="epydoc"><span class="sig"><span class="sig-name">addHostIntent</span>(<span class="sig-arg">self</span>,
2620 <span class="sig-arg">hostIdOne</span>,
2621 <span class="sig-arg">hostIdTwo</span>)</span>
2622 </h3>
2623 </td><td align="right" valign="top"
2624 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.addHostIntent">source&nbsp;code</a></span>&nbsp;
2625 </td>
2626 </tr></table>
2627
2628 <pre class="literalblock">
2629
2630Required:
2631 * hostIdOne: ONOS host id for host1
2632 * hostIdTwo: ONOS host id for host2
2633Description:
2634 Adds a host-to-host intent ( bidirectional ) by
2635 specifying the two hosts.
2636Returns:
2637 A string of the intent id or None on Error
2638
2639</pre>
2640 <dl class="fields">
2641 </dl>
2642</td></tr></table>
2643</div>
2644<a name="addOpticalIntent"></a>
2645<div>
2646<table class="details" border="1" cellpadding="3"
2647 cellspacing="0" width="100%" bgcolor="white">
2648<tr><td>
2649 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2650 <tr valign="top"><td>
2651 <h3 class="epydoc"><span class="sig"><span class="sig-name">addOpticalIntent</span>(<span class="sig-arg">self</span>,
2652 <span class="sig-arg">ingressDevice</span>,
2653 <span class="sig-arg">egressDevice</span>)</span>
2654 </h3>
2655 </td><td align="right" valign="top"
2656 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.addOpticalIntent">source&nbsp;code</a></span>&nbsp;
2657 </td>
2658 </tr></table>
2659
2660 <pre class="literalblock">
2661
2662Required:
2663 * ingressDevice: device id of ingress device
2664 * egressDevice: device id of egress device
2665Optional:
2666 TODO: Still needs to be implemented via dev side
2667Description:
2668 Adds an optical intent by specifying an ingress and egress device
2669Returns:
2670 A string of the intent id or None on error
2671
2672</pre>
2673 <dl class="fields">
2674 </dl>
2675</td></tr></table>
2676</div>
2677<a name="addPointIntent"></a>
2678<div>
2679<table class="details" border="1" cellpadding="3"
2680 cellspacing="0" width="100%" bgcolor="white">
2681<tr><td>
2682 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2683 <tr valign="top"><td>
2684 <h3 class="epydoc"><span class="sig"><span class="sig-name">addPointIntent</span>(<span class="sig-arg">self</span>,
2685 <span class="sig-arg">ingressDevice</span>,
2686 <span class="sig-arg">egressDevice</span>,
2687 <span class="sig-arg">portIngress</span>=<span class="sig-default">&quot;&quot;</span>,
2688 <span class="sig-arg">portEgress</span>=<span class="sig-default">&quot;&quot;</span>,
2689 <span class="sig-arg">ethType</span>=<span class="sig-default">&quot;&quot;</span>,
2690 <span class="sig-arg">ethSrc</span>=<span class="sig-default">&quot;&quot;</span>,
2691 <span class="sig-arg">ethDst</span>=<span class="sig-default">&quot;&quot;</span>,
2692 <span class="sig-arg">bandwidth</span>=<span class="sig-default">&quot;&quot;</span>,
2693 <span class="sig-arg">lambdaAlloc</span>=<span class="sig-default">False</span>,
2694 <span class="sig-arg">ipProto</span>=<span class="sig-default">&quot;&quot;</span>,
2695 <span class="sig-arg">ipSrc</span>=<span class="sig-default">&quot;&quot;</span>,
2696 <span class="sig-arg">ipDst</span>=<span class="sig-default">&quot;&quot;</span>,
2697 <span class="sig-arg">tcpSrc</span>=<span class="sig-default">&quot;&quot;</span>,
2698 <span class="sig-arg">tcpDst</span>=<span class="sig-default">&quot;&quot;</span>)</span>
2699 </h3>
2700 </td><td align="right" valign="top"
2701 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.addPointIntent">source&nbsp;code</a></span>&nbsp;
2702 </td>
2703 </tr></table>
2704
2705 <pre class="literalblock">
2706
2707Required:
2708 * ingressDevice: device id of ingress device
2709 * egressDevice: device id of egress device
2710Optional:
2711 * ethType: specify ethType
2712 * ethSrc: specify ethSrc ( i.e. src mac addr )
2713 * ethDst: specify ethDst ( i.e. dst mac addr )
2714 * bandwidth: specify bandwidth capacity of link
2715 * lambdaAlloc: if True, intent will allocate lambda
2716 for the specified intent
2717 * ipProto: specify ip protocol
2718 * ipSrc: specify ip source address
2719 * ipDst: specify ip destination address
2720 * tcpSrc: specify tcp source port
2721 * tcpDst: specify tcp destination port
2722Description:
2723 Adds a point-to-point intent ( uni-directional ) by
2724 specifying device id's and optional fields
2725Returns:
2726 A string of the intent id or None on error
2727
2728NOTE: This function may change depending on the
2729 options developers provide for point-to-point
2730 intent via cli
2731
2732</pre>
2733 <dl class="fields">
2734 </dl>
2735</td></tr></table>
2736</div>
2737<a name="addMultipointToSinglepointIntent"></a>
2738<div>
2739<table class="details" border="1" cellpadding="3"
2740 cellspacing="0" width="100%" bgcolor="white">
2741<tr><td>
2742 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2743 <tr valign="top"><td>
2744 <h3 class="epydoc"><span class="sig"><span class="sig-name">addMultipointToSinglepointIntent</span>(<span class="sig-arg">self</span>,
2745 <span class="sig-arg">ingressDeviceList</span>,
2746 <span class="sig-arg">egressDevice</span>,
2747 <span class="sig-arg">portIngressList</span>=<span class="sig-default">None</span>,
2748 <span class="sig-arg">portEgress</span>=<span class="sig-default">&quot;&quot;</span>,
2749 <span class="sig-arg">ethType</span>=<span class="sig-default">&quot;&quot;</span>,
2750 <span class="sig-arg">ethSrc</span>=<span class="sig-default">&quot;&quot;</span>,
2751 <span class="sig-arg">ethDst</span>=<span class="sig-default">&quot;&quot;</span>,
2752 <span class="sig-arg">bandwidth</span>=<span class="sig-default">&quot;&quot;</span>,
2753 <span class="sig-arg">lambdaAlloc</span>=<span class="sig-default">False</span>,
2754 <span class="sig-arg">ipProto</span>=<span class="sig-default">&quot;&quot;</span>,
2755 <span class="sig-arg">ipSrc</span>=<span class="sig-default">&quot;&quot;</span>,
2756 <span class="sig-arg">ipDst</span>=<span class="sig-default">&quot;&quot;</span>,
2757 <span class="sig-arg">tcpSrc</span>=<span class="sig-default">&quot;&quot;</span>,
2758 <span class="sig-arg">tcpDst</span>=<span class="sig-default">&quot;&quot;</span>,
2759 <span class="sig-arg">setEthSrc</span>=<span class="sig-default">&quot;&quot;</span>,
2760 <span class="sig-arg">setEthDst</span>=<span class="sig-default">&quot;&quot;</span>)</span>
2761 </h3>
2762 </td><td align="right" valign="top"
2763 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.addMultipointToSinglepointIntent">source&nbsp;code</a></span>&nbsp;
2764 </td>
2765 </tr></table>
2766
2767 <pre class="literalblock">
2768
2769Note:
2770 This function assumes the format of all ingress devices
2771 is same. That is, all ingress devices include port numbers
2772 with a &quot;/&quot; or all ingress devices could specify device
2773 ids and port numbers seperately.
2774Required:
2775 * ingressDeviceList: List of device ids of ingress device
2776 ( Atleast 2 ingress devices required in the list )
2777 * egressDevice: device id of egress device
2778Optional:
2779 * ethType: specify ethType
2780 * ethSrc: specify ethSrc ( i.e. src mac addr )
2781 * ethDst: specify ethDst ( i.e. dst mac addr )
2782 * bandwidth: specify bandwidth capacity of link
2783 * lambdaAlloc: if True, intent will allocate lambda
2784 for the specified intent
2785 * ipProto: specify ip protocol
2786 * ipSrc: specify ip source address
2787 * ipDst: specify ip destination address
2788 * tcpSrc: specify tcp source port
2789 * tcpDst: specify tcp destination port
2790 * setEthSrc: action to Rewrite Source MAC Address
2791 * setEthDst: action to Rewrite Destination MAC Address
2792Description:
2793 Adds a multipoint-to-singlepoint intent ( uni-directional ) by
2794 specifying device id's and optional fields
2795Returns:
2796 A string of the intent id or None on error
2797
2798NOTE: This function may change depending on the
2799 options developers provide for multipoint-to-singlepoint
2800 intent via cli
2801
2802</pre>
2803 <dl class="fields">
2804 </dl>
2805</td></tr></table>
2806</div>
2807<a name="addSinglepointToMultipointIntent"></a>
2808<div>
2809<table class="details" border="1" cellpadding="3"
2810 cellspacing="0" width="100%" bgcolor="white">
2811<tr><td>
2812 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2813 <tr valign="top"><td>
2814 <h3 class="epydoc"><span class="sig"><span class="sig-name">addSinglepointToMultipointIntent</span>(<span class="sig-arg">self</span>,
2815 <span class="sig-arg">ingressDevice</span>,
2816 <span class="sig-arg">egressDeviceList</span>,
2817 <span class="sig-arg">portIngress</span>=<span class="sig-default">&quot;&quot;</span>,
2818 <span class="sig-arg">portEgressList</span>=<span class="sig-default">None</span>,
2819 <span class="sig-arg">ethType</span>=<span class="sig-default">&quot;&quot;</span>,
2820 <span class="sig-arg">ethSrc</span>=<span class="sig-default">&quot;&quot;</span>,
2821 <span class="sig-arg">ethDst</span>=<span class="sig-default">&quot;&quot;</span>,
2822 <span class="sig-arg">bandwidth</span>=<span class="sig-default">&quot;&quot;</span>,
2823 <span class="sig-arg">lambdaAlloc</span>=<span class="sig-default">False</span>,
2824 <span class="sig-arg">ipProto</span>=<span class="sig-default">&quot;&quot;</span>,
2825 <span class="sig-arg">ipSrc</span>=<span class="sig-default">&quot;&quot;</span>,
2826 <span class="sig-arg">ipDst</span>=<span class="sig-default">&quot;&quot;</span>,
2827 <span class="sig-arg">tcpSrc</span>=<span class="sig-default">&quot;&quot;</span>,
2828 <span class="sig-arg">tcpDst</span>=<span class="sig-default">&quot;&quot;</span>,
2829 <span class="sig-arg">setEthSrc</span>=<span class="sig-default">&quot;&quot;</span>,
2830 <span class="sig-arg">setEthDst</span>=<span class="sig-default">&quot;&quot;</span>)</span>
2831 </h3>
2832 </td><td align="right" valign="top"
2833 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.addSinglepointToMultipointIntent">source&nbsp;code</a></span>&nbsp;
2834 </td>
2835 </tr></table>
2836
2837 <pre class="literalblock">
2838
2839Note:
2840 This function assumes the format of all egress devices
2841 is same. That is, all egress devices include port numbers
2842 with a &quot;/&quot; or all egress devices could specify device
2843 ids and port numbers seperately.
2844Required:
2845 * EgressDeviceList: List of device ids of egress device
2846 ( Atleast 2 eress devices required in the list )
2847 * ingressDevice: device id of ingress device
2848Optional:
2849 * ethType: specify ethType
2850 * ethSrc: specify ethSrc ( i.e. src mac addr )
2851 * ethDst: specify ethDst ( i.e. dst mac addr )
2852 * bandwidth: specify bandwidth capacity of link
2853 * lambdaAlloc: if True, intent will allocate lambda
2854 for the specified intent
2855 * ipProto: specify ip protocol
2856 * ipSrc: specify ip source address
2857 * ipDst: specify ip destination address
2858 * tcpSrc: specify tcp source port
2859 * tcpDst: specify tcp destination port
2860 * setEthSrc: action to Rewrite Source MAC Address
2861 * setEthDst: action to Rewrite Destination MAC Address
2862Description:
2863 Adds a singlepoint-to-multipoint intent ( uni-directional ) by
2864 specifying device id's and optional fields
2865Returns:
2866 A string of the intent id or None on error
2867
2868NOTE: This function may change depending on the
2869 options developers provide for singlepoint-to-multipoint
2870 intent via cli
2871
2872</pre>
2873 <dl class="fields">
2874 </dl>
2875</td></tr></table>
2876</div>
2877<a name="addMplsIntent"></a>
2878<div>
2879<table class="details" border="1" cellpadding="3"
2880 cellspacing="0" width="100%" bgcolor="white">
2881<tr><td>
2882 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2883 <tr valign="top"><td>
2884 <h3 class="epydoc"><span class="sig"><span class="sig-name">addMplsIntent</span>(<span class="sig-arg">self</span>,
2885 <span class="sig-arg">ingressDevice</span>,
2886 <span class="sig-arg">egressDevice</span>,
2887 <span class="sig-arg">ingressPort</span>=<span class="sig-default">&quot;&quot;</span>,
2888 <span class="sig-arg">egressPort</span>=<span class="sig-default">&quot;&quot;</span>,
2889 <span class="sig-arg">ethType</span>=<span class="sig-default">&quot;&quot;</span>,
2890 <span class="sig-arg">ethSrc</span>=<span class="sig-default">&quot;&quot;</span>,
2891 <span class="sig-arg">ethDst</span>=<span class="sig-default">&quot;&quot;</span>,
2892 <span class="sig-arg">bandwidth</span>=<span class="sig-default">&quot;&quot;</span>,
2893 <span class="sig-arg">lambdaAlloc</span>=<span class="sig-default">False</span>,
2894 <span class="sig-arg">ipProto</span>=<span class="sig-default">&quot;&quot;</span>,
2895 <span class="sig-arg">ipSrc</span>=<span class="sig-default">&quot;&quot;</span>,
2896 <span class="sig-arg">ipDst</span>=<span class="sig-default">&quot;&quot;</span>,
2897 <span class="sig-arg">tcpSrc</span>=<span class="sig-default">&quot;&quot;</span>,
2898 <span class="sig-arg">tcpDst</span>=<span class="sig-default">&quot;&quot;</span>,
2899 <span class="sig-arg">ingressLabel</span>=<span class="sig-default">&quot;&quot;</span>,
2900 <span class="sig-arg">egressLabel</span>=<span class="sig-default">&quot;&quot;</span>,
2901 <span class="sig-arg">priority</span>=<span class="sig-default">&quot;&quot;</span>)</span>
2902 </h3>
2903 </td><td align="right" valign="top"
2904 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.addMplsIntent">source&nbsp;code</a></span>&nbsp;
2905 </td>
2906 </tr></table>
2907
2908 <pre class="literalblock">
2909
2910Required:
2911 * ingressDevice: device id of ingress device
2912 * egressDevice: device id of egress device
2913Optional:
2914 * ethType: specify ethType
2915 * ethSrc: specify ethSrc ( i.e. src mac addr )
2916 * ethDst: specify ethDst ( i.e. dst mac addr )
2917 * bandwidth: specify bandwidth capacity of link
2918 * lambdaAlloc: if True, intent will allocate lambda
2919 for the specified intent
2920 * ipProto: specify ip protocol
2921 * ipSrc: specify ip source address
2922 * ipDst: specify ip destination address
2923 * tcpSrc: specify tcp source port
2924 * tcpDst: specify tcp destination port
2925 * ingressLabel: Ingress MPLS label
2926 * egressLabel: Egress MPLS label
2927Description:
2928 Adds MPLS intent by
2929 specifying device id's and optional fields
2930Returns:
2931 A string of the intent id or None on error
2932
2933NOTE: This function may change depending on the
2934 options developers provide for MPLS
2935 intent via cli
2936
2937</pre>
2938 <dl class="fields">
2939 </dl>
2940</td></tr></table>
2941</div>
2942<a name="removeIntent"></a>
2943<div>
2944<table class="details" border="1" cellpadding="3"
2945 cellspacing="0" width="100%" bgcolor="white">
2946<tr><td>
2947 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2948 <tr valign="top"><td>
2949 <h3 class="epydoc"><span class="sig"><span class="sig-name">removeIntent</span>(<span class="sig-arg">self</span>,
2950 <span class="sig-arg">intentId</span>,
2951 <span class="sig-arg">app</span>=<span class="sig-default">'org.onosproject.cli'</span>,
2952 <span class="sig-arg">purge</span>=<span class="sig-default">False</span>,
2953 <span class="sig-arg">sync</span>=<span class="sig-default">False</span>)</span>
2954 </h3>
2955 </td><td align="right" valign="top"
2956 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.removeIntent">source&nbsp;code</a></span>&nbsp;
2957 </td>
2958 </tr></table>
2959
2960 <pre class="literalblock">
2961
2962Remove intent for specified application id and intent id
2963Optional args:-
2964-s or --sync: Waits for the removal before returning
2965-p or --purge: Purge the intent from the store after removal
2966
2967Returns:
2968 main.False on error and
2969 cli output otherwise
2970
2971</pre>
2972 <dl class="fields">
2973 </dl>
2974</td></tr></table>
2975</div>
2976<a name="routes"></a>
2977<div>
2978<table class="details" border="1" cellpadding="3"
2979 cellspacing="0" width="100%" bgcolor="white">
2980<tr><td>
2981 <table width="100%" cellpadding="0" cellspacing="0" border="0">
2982 <tr valign="top"><td>
2983 <h3 class="epydoc"><span class="sig"><span class="sig-name">routes</span>(<span class="sig-arg">self</span>,
2984 <span class="sig-arg">jsonFormat</span>=<span class="sig-default">False</span>)</span>
2985 </h3>
2986 </td><td align="right" valign="top"
2987 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.routes">source&nbsp;code</a></span>&nbsp;
2988 </td>
2989 </tr></table>
2990
2991 <pre class="literalblock">
2992
2993NOTE: This method should be used after installing application:
2994 onos-app-sdnip
2995Optional:
2996 * jsonFormat: enable output formatting in json
2997Description:
2998 Obtain all routes in the system
2999
3000</pre>
3001 <dl class="fields">
3002 </dl>
3003</td></tr></table>
3004</div>
3005<a name="intents"></a>
3006<div>
3007<table class="details" border="1" cellpadding="3"
3008 cellspacing="0" width="100%" bgcolor="white">
3009<tr><td>
3010 <table width="100%" cellpadding="0" cellspacing="0" border="0">
3011 <tr valign="top"><td>
3012 <h3 class="epydoc"><span class="sig"><span class="sig-name">intents</span>(<span class="sig-arg">self</span>,
3013 <span class="sig-arg">jsonFormat</span>=<span class="sig-default">True</span>)</span>
3014 </h3>
3015 </td><td align="right" valign="top"
3016 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.intents">source&nbsp;code</a></span>&nbsp;
3017 </td>
3018 </tr></table>
3019
3020 <pre class="literalblock">
3021
3022Optional:
3023 * jsonFormat: enable output formatting in json
3024Description:
3025 Obtain intents currently installed
3026
3027</pre>
3028 <dl class="fields">
3029 </dl>
3030</td></tr></table>
3031</div>
3032<a name="getIntentState"></a>
3033<div>
3034<table class="details" border="1" cellpadding="3"
3035 cellspacing="0" width="100%" bgcolor="white">
3036<tr><td>
3037 <table width="100%" cellpadding="0" cellspacing="0" border="0">
3038 <tr valign="top"><td>
3039 <h3 class="epydoc"><span class="sig"><span class="sig-name">getIntentState</span>(<span class="sig-arg">self</span>,
3040 <span class="sig-arg">intentsId</span>,
3041 <span class="sig-arg">intentsJson</span>=<span class="sig-default">None</span>)</span>
3042 </h3>
3043 </td><td align="right" valign="top"
3044 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.getIntentState">source&nbsp;code</a></span>&nbsp;
3045 </td>
3046 </tr></table>
3047
3048 <p>Check intent state. Accepts a single intent ID (string type) or a list
3049 of intent IDs. Returns the state(string type) of the id if a single
3050 intent ID is accepted. Returns a dictionary with intent IDs as the key
3051 and its corresponding states as the values Parameters: intentId: intent
3052 ID (string type) intentsJson: parsed json object from the onos:intents
3053 api Returns: state = An intent's state- INSTALL,WITHDRAWN etc. stateDict
3054 = Dictionary of intent's state. intent ID as the keys and state as the
3055 values.</p>
3056 <dl class="fields">
3057 </dl>
3058</td></tr></table>
3059</div>
3060<a name="checkIntentState"></a>
3061<div>
3062<table class="details" border="1" cellpadding="3"
3063 cellspacing="0" width="100%" bgcolor="white">
3064<tr><td>
3065 <table width="100%" cellpadding="0" cellspacing="0" border="0">
3066 <tr valign="top"><td>
3067 <h3 class="epydoc"><span class="sig"><span class="sig-name">checkIntentState</span>(<span class="sig-arg">self</span>,
3068 <span class="sig-arg">intentsId</span>,
3069 <span class="sig-arg">expectedState</span>=<span class="sig-default">'INSTALLED'</span>)</span>
3070 </h3>
3071 </td><td align="right" valign="top"
3072 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.checkIntentState">source&nbsp;code</a></span>&nbsp;
3073 </td>
3074 </tr></table>
3075
3076 <pre class="literalblock">
3077
3078Description:
3079 Check intents state
3080Required:
3081 intentsId - List of intents ID to be checked
3082Optional:
3083 expectedState - Check the expected state(s) of each intents
3084 state in the list.
3085 *NOTE: You can pass in a list of expected state,
3086 Eg: expectedState = [ 'INSTALLED' , 'INSTALLING' ]
3087Return:
3088 Returns main.TRUE only if all intent are the same as expected states
3089 , otherwise, returns main.FALSE.
3090
3091</pre>
3092 <dl class="fields">
3093 </dl>
3094</td></tr></table>
3095</div>
3096<a name="flows"></a>
3097<div>
3098<table class="details" border="1" cellpadding="3"
3099 cellspacing="0" width="100%" bgcolor="white">
3100<tr><td>
3101 <table width="100%" cellpadding="0" cellspacing="0" border="0">
3102 <tr valign="top"><td>
3103 <h3 class="epydoc"><span class="sig"><span class="sig-name">flows</span>(<span class="sig-arg">self</span>,
3104 <span class="sig-arg">jsonFormat</span>=<span class="sig-default">True</span>)</span>
3105 </h3>
3106 </td><td align="right" valign="top"
3107 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.flows">source&nbsp;code</a></span>&nbsp;
3108 </td>
3109 </tr></table>
3110
3111 <pre class="literalblock">
3112
3113Optional:
3114 * jsonFormat: enable output formatting in json
3115Description:
3116 Obtain flows currently installed
3117
3118</pre>
3119 <dl class="fields">
3120 </dl>
3121</td></tr></table>
3122</div>
3123<a name="pushTestIntents"></a>
3124<div>
3125<table class="details" border="1" cellpadding="3"
3126 cellspacing="0" width="100%" bgcolor="white">
3127<tr><td>
3128 <table width="100%" cellpadding="0" cellspacing="0" border="0">
3129 <tr valign="top"><td>
3130 <h3 class="epydoc"><span class="sig"><span class="sig-name">pushTestIntents</span>(<span class="sig-arg">self</span>,
3131 <span class="sig-arg">dpidSrc</span>,
3132 <span class="sig-arg">dpidDst</span>,
3133 <span class="sig-arg">numIntents</span>,
3134 <span class="sig-arg">numMult</span>=<span class="sig-default">&quot;&quot;</span>,
3135 <span class="sig-arg">appId</span>=<span class="sig-default">&quot;&quot;</span>,
3136 <span class="sig-arg">report</span>=<span class="sig-default">True</span>)</span>
3137 </h3>
3138 </td><td align="right" valign="top"
3139 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.pushTestIntents">source&nbsp;code</a></span>&nbsp;
3140 </td>
3141 </tr></table>
3142
3143 <pre class="literalblock">
3144
3145Description:
3146 Push a number of intents in a batch format to
3147 a specific point-to-point intent definition
3148Required:
3149 * dpidSrc: specify source dpid
3150 * dpidDst: specify destination dpid
3151 * numIntents: specify number of intents to push
3152Optional:
3153 * numMult: number multiplier for multiplying
3154 the number of intents specified
3155 * appId: specify the application id init to further
3156 modularize the intents
3157 * report: default True, returns latency information
3158
3159</pre>
3160 <dl class="fields">
3161 </dl>
3162</td></tr></table>
3163</div>
3164<a name="intentsEventsMetrics"></a>
3165<div>
3166<table class="details" border="1" cellpadding="3"
3167 cellspacing="0" width="100%" bgcolor="white">
3168<tr><td>
3169 <table width="100%" cellpadding="0" cellspacing="0" border="0">
3170 <tr valign="top"><td>
3171 <h3 class="epydoc"><span class="sig"><span class="sig-name">intentsEventsMetrics</span>(<span class="sig-arg">self</span>,
3172 <span class="sig-arg">jsonFormat</span>=<span class="sig-default">True</span>)</span>
3173 </h3>
3174 </td><td align="right" valign="top"
3175 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.intentsEventsMetrics">source&nbsp;code</a></span>&nbsp;
3176 </td>
3177 </tr></table>
3178
3179 <pre class="literalblock">
3180
3181Description:Returns topology metrics
3182Optional:
3183 * jsonFormat: enable json formatting of output
3184
3185</pre>
3186 <dl class="fields">
3187 </dl>
3188</td></tr></table>
3189</div>
3190<a name="topologyEventsMetrics"></a>
3191<div>
3192<table class="details" border="1" cellpadding="3"
3193 cellspacing="0" width="100%" bgcolor="white">
3194<tr><td>
3195 <table width="100%" cellpadding="0" cellspacing="0" border="0">
3196 <tr valign="top"><td>
3197 <h3 class="epydoc"><span class="sig"><span class="sig-name">topologyEventsMetrics</span>(<span class="sig-arg">self</span>,
3198 <span class="sig-arg">jsonFormat</span>=<span class="sig-default">True</span>)</span>
3199 </h3>
3200 </td><td align="right" valign="top"
3201 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.topologyEventsMetrics">source&nbsp;code</a></span>&nbsp;
3202 </td>
3203 </tr></table>
3204
3205 <pre class="literalblock">
3206
3207Description:Returns topology metrics
3208Optional:
3209 * jsonFormat: enable json formatting of output
3210
3211</pre>
3212 <dl class="fields">
3213 </dl>
3214</td></tr></table>
3215</div>
3216<a name="getAllIntentsId"></a>
3217<div>
3218<table class="details" border="1" cellpadding="3"
3219 cellspacing="0" width="100%" bgcolor="white">
3220<tr><td>
3221 <table width="100%" cellpadding="0" cellspacing="0" border="0">
3222 <tr valign="top"><td>
3223 <h3 class="epydoc"><span class="sig"><span class="sig-name">getAllIntentsId</span>(<span class="sig-arg">self</span>)</span>
3224 </h3>
3225 </td><td align="right" valign="top"
3226 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.getAllIntentsId">source&nbsp;code</a></span>&nbsp;
3227 </td>
3228 </tr></table>
3229
3230 <pre class="literalblock">
3231
3232Description:
3233 Obtain all intent id's in a list
3234
3235</pre>
3236 <dl class="fields">
3237 </dl>
3238</td></tr></table>
3239</div>
3240<a name="getAllDevicesId"></a>
3241<div>
3242<table class="details" border="1" cellpadding="3"
3243 cellspacing="0" width="100%" bgcolor="white">
3244<tr><td>
3245 <table width="100%" cellpadding="0" cellspacing="0" border="0">
3246 <tr valign="top"><td>
3247 <h3 class="epydoc"><span class="sig"><span class="sig-name">getAllDevicesId</span>(<span class="sig-arg">self</span>)</span>
3248 </h3>
3249 </td><td align="right" valign="top"
3250 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.getAllDevicesId">source&nbsp;code</a></span>&nbsp;
3251 </td>
3252 </tr></table>
3253
3254 <p>Use 'devices' function to obtain list of all devices and parse the
3255 result to obtain a list of all device id's. Returns this list. Returns
3256 empty list if no devices exist List is ordered sequentially</p>
3257 <p>This function may be useful if you are not sure of the device id, and
3258 wish to execute other commands using the ids. By obtaining the list of
3259 device ids on the fly, you can iterate through the list to get
3260 mastership, etc.</p>
3261 <dl class="fields">
3262 </dl>
3263</td></tr></table>
3264</div>
3265<a name="getAllNodesId"></a>
3266<div>
3267<table class="details" border="1" cellpadding="3"
3268 cellspacing="0" width="100%" bgcolor="white">
3269<tr><td>
3270 <table width="100%" cellpadding="0" cellspacing="0" border="0">
3271 <tr valign="top"><td>
3272 <h3 class="epydoc"><span class="sig"><span class="sig-name">getAllNodesId</span>(<span class="sig-arg">self</span>)</span>
3273 </h3>
3274 </td><td align="right" valign="top"
3275 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.getAllNodesId">source&nbsp;code</a></span>&nbsp;
3276 </td>
3277 </tr></table>
3278
3279 <pre class="literalblock">
3280
3281Uses 'nodes' function to obtain list of all nodes
3282and parse the result of nodes to obtain just the
3283node id's.
3284Returns:
3285 list of node id's
3286
3287</pre>
3288 <dl class="fields">
3289 </dl>
3290</td></tr></table>
3291</div>
3292<a name="checkStatus"></a>
3293<div>
3294<table class="details" border="1" cellpadding="3"
3295 cellspacing="0" width="100%" bgcolor="white">
3296<tr><td>
3297 <table width="100%" cellpadding="0" cellspacing="0" border="0">
3298 <tr valign="top"><td>
3299 <h3 class="epydoc"><span class="sig"><span class="sig-name">checkStatus</span>(<span class="sig-arg">self</span>,
3300 <span class="sig-arg">ip</span>,
3301 <span class="sig-arg">numoswitch</span>,
3302 <span class="sig-arg">numolink</span>,
3303 <span class="sig-arg">logLevel</span>=<span class="sig-default">&quot;info&quot;</span>)</span>
3304 </h3>
3305 </td><td align="right" valign="top"
3306 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.checkStatus">source&nbsp;code</a></span>&nbsp;
3307 </td>
3308 </tr></table>
3309
3310 <pre class="literalblock">
3311
3312Checks the number of switches &amp; links that ONOS sees against the
3313supplied values. By default this will report to main.log, but the
3314log level can be specified.
3315
3316Params: ip = ip used for the onos cli
3317 numoswitch = expected number of switches
3318 numolink = expected number of links
3319 logLevel = level to log to. Currently accepts
3320 'info', 'warn' and 'report'
3321
3322
3323logLevel can
3324
3325Returns: main.TRUE if the number of switches and links are correct,
3326 main.FALSE if the number of switches and links is incorrect,
3327 and main.ERROR otherwise
3328
3329</pre>
3330 <dl class="fields">
3331 </dl>
3332</td></tr></table>
3333</div>
3334<a name="deviceRole"></a>
3335<div>
3336<table class="details" border="1" cellpadding="3"
3337 cellspacing="0" width="100%" bgcolor="white">
3338<tr><td>
3339 <table width="100%" cellpadding="0" cellspacing="0" border="0">
3340 <tr valign="top"><td>
3341 <h3 class="epydoc"><span class="sig"><span class="sig-name">deviceRole</span>(<span class="sig-arg">self</span>,
3342 <span class="sig-arg">deviceId</span>,
3343 <span class="sig-arg">onosNode</span>,
3344 <span class="sig-arg">role</span>=<span class="sig-default">&quot;master&quot;</span>)</span>
3345 </h3>
3346 </td><td align="right" valign="top"
3347 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.deviceRole">source&nbsp;code</a></span>&nbsp;
3348 </td>
3349 </tr></table>
3350
3351 <pre class="literalblock">
3352
3353Calls the device-role cli command.
3354deviceId must be the id of a device as seen in the onos devices command
3355onosNode is the ip of one of the onos nodes in the cluster
3356role must be either master, standby, or none
3357
3358Returns:
3359 main.TRUE or main.FALSE based on argument verification and
3360 main.ERROR if command returns and error
3361
3362</pre>
3363 <dl class="fields">
3364 </dl>
3365</td></tr></table>
3366</div>
3367<a name="clusters"></a>
3368<div>
3369<table class="details" border="1" cellpadding="3"
3370 cellspacing="0" width="100%" bgcolor="white">
3371<tr><td>
3372 <table width="100%" cellpadding="0" cellspacing="0" border="0">
3373 <tr valign="top"><td>
3374 <h3 class="epydoc"><span class="sig"><span class="sig-name">clusters</span>(<span class="sig-arg">self</span>,
3375 <span class="sig-arg">jsonFormat</span>=<span class="sig-default">True</span>)</span>
3376 </h3>
3377 </td><td align="right" valign="top"
3378 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.clusters">source&nbsp;code</a></span>&nbsp;
3379 </td>
3380 </tr></table>
3381
3382 <pre class="literalblock">
3383
3384Lists all clusters
3385Optional argument:
3386 * jsonFormat - boolean indicating if you want output in json
3387
3388</pre>
3389 <dl class="fields">
3390 </dl>
3391</td></tr></table>
3392</div>
3393<a name="electionTestLeader"></a>
3394<div>
3395<table class="details" border="1" cellpadding="3"
3396 cellspacing="0" width="100%" bgcolor="white">
3397<tr><td>
3398 <table width="100%" cellpadding="0" cellspacing="0" border="0">
3399 <tr valign="top"><td>
3400 <h3 class="epydoc"><span class="sig"><span class="sig-name">electionTestLeader</span>(<span class="sig-arg">self</span>)</span>
3401 </h3>
3402 </td><td align="right" valign="top"
3403 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.electionTestLeader">source&nbsp;code</a></span>&nbsp;
3404 </td>
3405 </tr></table>
3406
3407 <pre class="literalblock">
3408
3409CLI command to get the current leader for the Election test application
3410NOTE: Requires installation of the onos-app-election feature
3411Returns: Node IP of the leader if one exists
3412 None if none exists
3413 Main.FALSE on error
3414
3415</pre>
3416 <dl class="fields">
3417 </dl>
3418</td></tr></table>
3419</div>
3420<a name="electionTestRun"></a>
3421<div>
3422<table class="details" border="1" cellpadding="3"
3423 cellspacing="0" width="100%" bgcolor="white">
3424<tr><td>
3425 <table width="100%" cellpadding="0" cellspacing="0" border="0">
3426 <tr valign="top"><td>
3427 <h3 class="epydoc"><span class="sig"><span class="sig-name">electionTestRun</span>(<span class="sig-arg">self</span>)</span>
3428 </h3>
3429 </td><td align="right" valign="top"
3430 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.electionTestRun">source&nbsp;code</a></span>&nbsp;
3431 </td>
3432 </tr></table>
3433
3434 <pre class="literalblock">
3435
3436CLI command to run for leadership of the Election test application.
3437NOTE: Requires installation of the onos-app-election feature
3438Returns: Main.TRUE on success
3439 Main.FALSE on error
3440
3441</pre>
3442 <dl class="fields">
3443 </dl>
3444</td></tr></table>
3445</div>
3446<a name="electionTestWithdraw"></a>
3447<div>
3448<table class="details" border="1" cellpadding="3"
3449 cellspacing="0" width="100%" bgcolor="white">
3450<tr><td>
3451 <table width="100%" cellpadding="0" cellspacing="0" border="0">
3452 <tr valign="top"><td>
3453 <h3 class="epydoc"><span class="sig"><span class="sig-name">electionTestWithdraw</span>(<span class="sig-arg">self</span>)</span>
3454 </h3>
3455 </td><td align="right" valign="top"
3456 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.electionTestWithdraw">source&nbsp;code</a></span>&nbsp;
3457 </td>
3458 </tr></table>
3459
3460 <pre class="literalblock">
3461
3462* CLI command to withdraw the local node from leadership election for
3463* the Election test application.
3464#NOTE: Requires installation of the onos-app-election feature
3465Returns: Main.TRUE on success
3466 Main.FALSE on error
3467
3468</pre>
3469 <dl class="fields">
3470 </dl>
3471</td></tr></table>
3472</div>
3473<a name="leaders"></a>
3474<div>
3475<table class="details" border="1" cellpadding="3"
3476 cellspacing="0" width="100%" bgcolor="white">
3477<tr><td>
3478 <table width="100%" cellpadding="0" cellspacing="0" border="0">
3479 <tr valign="top"><td>
3480 <h3 class="epydoc"><span class="sig"><span class="sig-name">leaders</span>(<span class="sig-arg">self</span>,
3481 <span class="sig-arg">jsonFormat</span>=<span class="sig-default">True</span>)</span>
3482 </h3>
3483 </td><td align="right" valign="top"
3484 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.leaders">source&nbsp;code</a></span>&nbsp;
3485 </td>
3486 </tr></table>
3487
3488 <pre class="literalblock">
3489
3490Returns the output of the leaders command.
3491Optional argument:
3492 * jsonFormat - boolean indicating if you want output in json
3493
3494</pre>
3495 <dl class="fields">
3496 </dl>
3497</td></tr></table>
3498</div>
3499<a name="leaderCandidates"></a>
3500<div>
3501<table class="details" border="1" cellpadding="3"
3502 cellspacing="0" width="100%" bgcolor="white">
3503<tr><td>
3504 <table width="100%" cellpadding="0" cellspacing="0" border="0">
3505 <tr valign="top"><td>
3506 <h3 class="epydoc"><span class="sig"><span class="sig-name">leaderCandidates</span>(<span class="sig-arg">self</span>,
3507 <span class="sig-arg">jsonFormat</span>=<span class="sig-default">True</span>)</span>
3508 </h3>
3509 </td><td align="right" valign="top"
3510 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.leaderCandidates">source&nbsp;code</a></span>&nbsp;
3511 </td>
3512 </tr></table>
3513
3514 <pre class="literalblock">
3515
3516Returns the output of the leaders -c command.
3517Optional argument:
3518 * jsonFormat - boolean indicating if you want output in json
3519
3520</pre>
3521 <dl class="fields">
3522 </dl>
3523</td></tr></table>
3524</div>
3525<a name="apps"></a>
3526<div>
3527<table class="details" border="1" cellpadding="3"
3528 cellspacing="0" width="100%" bgcolor="white">
3529<tr><td>
3530 <table width="100%" cellpadding="0" cellspacing="0" border="0">
3531 <tr valign="top"><td>
3532 <h3 class="epydoc"><span class="sig"><span class="sig-name">apps</span>(<span class="sig-arg">self</span>,
3533 <span class="sig-arg">jsonFormat</span>=<span class="sig-default">True</span>)</span>
3534 </h3>
3535 </td><td align="right" valign="top"
3536 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.apps">source&nbsp;code</a></span>&nbsp;
3537 </td>
3538 </tr></table>
3539
3540 <p>Returns the output of the apps command for ONOS. This command lists
3541 information about installed ONOS applications</p>
3542 <dl class="fields">
3543 </dl>
3544</td></tr></table>
3545</div>
3546<a name="appStatus"></a>
3547<div>
3548<table class="details" border="1" cellpadding="3"
3549 cellspacing="0" width="100%" bgcolor="white">
3550<tr><td>
3551 <table width="100%" cellpadding="0" cellspacing="0" border="0">
3552 <tr valign="top"><td>
3553 <h3 class="epydoc"><span class="sig"><span class="sig-name">appStatus</span>(<span class="sig-arg">self</span>,
3554 <span class="sig-arg">appName</span>)</span>
3555 </h3>
3556 </td><td align="right" valign="top"
3557 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.appStatus">source&nbsp;code</a></span>&nbsp;
3558 </td>
3559 </tr></table>
3560
3561 <pre class="literalblock">
3562
3563Uses the onos:apps cli command to return the status of an application.
3564Returns:
3565 &quot;ACTIVE&quot; - If app is installed and activated
3566 &quot;INSTALLED&quot; - If app is installed and deactivated
3567 &quot;UNINSTALLED&quot; - If app is not installed
3568 None - on error
3569
3570</pre>
3571 <dl class="fields">
3572 </dl>
3573</td></tr></table>
3574</div>
3575<a name="app"></a>
3576<div>
3577<table class="details" border="1" cellpadding="3"
3578 cellspacing="0" width="100%" bgcolor="white">
3579<tr><td>
3580 <table width="100%" cellpadding="0" cellspacing="0" border="0">
3581 <tr valign="top"><td>
3582 <h3 class="epydoc"><span class="sig"><span class="sig-name">app</span>(<span class="sig-arg">self</span>,
3583 <span class="sig-arg">appName</span>,
3584 <span class="sig-arg">option</span>)</span>
3585 </h3>
3586 </td><td align="right" valign="top"
3587 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.app">source&nbsp;code</a></span>&nbsp;
3588 </td>
3589 </tr></table>
3590
3591 <p>Interacts with the app command for ONOS. This command manages
3592 application inventory.</p>
3593 <dl class="fields">
3594 </dl>
3595</td></tr></table>
3596</div>
3597<a name="activateApp"></a>
3598<div>
3599<table class="details" border="1" cellpadding="3"
3600 cellspacing="0" width="100%" bgcolor="white">
3601<tr><td>
3602 <table width="100%" cellpadding="0" cellspacing="0" border="0">
3603 <tr valign="top"><td>
3604 <h3 class="epydoc"><span class="sig"><span class="sig-name">activateApp</span>(<span class="sig-arg">self</span>,
3605 <span class="sig-arg">appName</span>,
3606 <span class="sig-arg">check</span>=<span class="sig-default">True</span>)</span>
3607 </h3>
3608 </td><td align="right" valign="top"
3609 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.activateApp">source&nbsp;code</a></span>&nbsp;
3610 </td>
3611 </tr></table>
3612
3613 <pre class="literalblock">
3614
3615Activate an app that is already installed in ONOS
3616appName is the hierarchical app name, not the feature name
3617If check is True, method will check the status of the app after the
3618command is issued
3619Returns main.TRUE if the command was successfully sent
3620 main.FALSE if the cli responded with an error or given
3621 incorrect input
3622
3623</pre>
3624 <dl class="fields">
3625 </dl>
3626</td></tr></table>
3627</div>
3628<a name="deactivateApp"></a>
3629<div>
3630<table class="details" border="1" cellpadding="3"
3631 cellspacing="0" width="100%" bgcolor="white">
3632<tr><td>
3633 <table width="100%" cellpadding="0" cellspacing="0" border="0">
3634 <tr valign="top"><td>
3635 <h3 class="epydoc"><span class="sig"><span class="sig-name">deactivateApp</span>(<span class="sig-arg">self</span>,
3636 <span class="sig-arg">appName</span>,
3637 <span class="sig-arg">check</span>=<span class="sig-default">True</span>)</span>
3638 </h3>
3639 </td><td align="right" valign="top"
3640 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.deactivateApp">source&nbsp;code</a></span>&nbsp;
3641 </td>
3642 </tr></table>
3643
3644 <pre class="literalblock">
3645
3646Deactivate an app that is already activated in ONOS
3647appName is the hierarchical app name, not the feature name
3648If check is True, method will check the status of the app after the
3649command is issued
3650Returns main.TRUE if the command was successfully sent
3651 main.FALSE if the cli responded with an error or given
3652 incorrect input
3653
3654</pre>
3655 <dl class="fields">
3656 </dl>
3657</td></tr></table>
3658</div>
3659<a name="uninstallApp"></a>
3660<div>
3661<table class="details" border="1" cellpadding="3"
3662 cellspacing="0" width="100%" bgcolor="white">
3663<tr><td>
3664 <table width="100%" cellpadding="0" cellspacing="0" border="0">
3665 <tr valign="top"><td>
3666 <h3 class="epydoc"><span class="sig"><span class="sig-name">uninstallApp</span>(<span class="sig-arg">self</span>,
3667 <span class="sig-arg">appName</span>,
3668 <span class="sig-arg">check</span>=<span class="sig-default">True</span>)</span>
3669 </h3>
3670 </td><td align="right" valign="top"
3671 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.uninstallApp">source&nbsp;code</a></span>&nbsp;
3672 </td>
3673 </tr></table>
3674
3675 <pre class="literalblock">
3676
3677Uninstall an app that is already installed in ONOS
3678appName is the hierarchical app name, not the feature name
3679If check is True, method will check the status of the app after the
3680command is issued
3681Returns main.TRUE if the command was successfully sent
3682 main.FALSE if the cli responded with an error or given
3683 incorrect input
3684
3685</pre>
3686 <dl class="fields">
3687 </dl>
3688</td></tr></table>
3689</div>
3690<a name="appToIDCheck"></a>
3691<div>
3692<table class="details" border="1" cellpadding="3"
3693 cellspacing="0" width="100%" bgcolor="white">
3694<tr><td>
3695 <table width="100%" cellpadding="0" cellspacing="0" border="0">
3696 <tr valign="top"><td>
3697 <h3 class="epydoc"><span class="sig"><span class="sig-name">appToIDCheck</span>(<span class="sig-arg">self</span>)</span>
3698 </h3>
3699 </td><td align="right" valign="top"
3700 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.appToIDCheck">source&nbsp;code</a></span>&nbsp;
3701 </td>
3702 </tr></table>
3703
3704 <pre class="literalblock">
3705
3706This method will check that each application's ID listed in 'apps' is
3707the same as the ID listed in 'app-ids'. The check will also check that
3708there are no duplicate IDs issued. Note that an app ID should be
3709a globaly unique numerical identifier for app/app-like features. Once
3710an ID is registered, the ID is never freed up so that if an app is
3711reinstalled it will have the same ID.
3712
3713Returns: main.TRUE if the check passes and
3714 main.FALSE if the check fails or
3715 main.ERROR if there is some error in processing the test
3716
3717</pre>
3718 <dl class="fields">
3719 </dl>
3720</td></tr></table>
3721</div>
3722<a name="getCfg"></a>
3723<div>
3724<table class="details" border="1" cellpadding="3"
3725 cellspacing="0" width="100%" bgcolor="white">
3726<tr><td>
3727 <table width="100%" cellpadding="0" cellspacing="0" border="0">
3728 <tr valign="top"><td>
3729 <h3 class="epydoc"><span class="sig"><span class="sig-name">getCfg</span>(<span class="sig-arg">self</span>,
3730 <span class="sig-arg">component</span>=<span class="sig-default">None</span>,
3731 <span class="sig-arg">propName</span>=<span class="sig-default">None</span>,
3732 <span class="sig-arg">short</span>=<span class="sig-default">False</span>,
3733 <span class="sig-arg">jsonFormat</span>=<span class="sig-default">True</span>)</span>
3734 </h3>
3735 </td><td align="right" valign="top"
3736 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.getCfg">source&nbsp;code</a></span>&nbsp;
3737 </td>
3738 </tr></table>
3739
3740 <pre class="literalblock">
3741
3742Get configuration settings from onos cli
3743Optional arguments:
3744 component - Optionally only list configurations for a specific
3745 component. If None, all components with configurations
3746 are displayed. Case Sensitive string.
3747 propName - If component is specified, propName option will show
3748 only this specific configuration from that component.
3749 Case Sensitive string.
3750 jsonFormat - Returns output as json. Note that this will override
3751 the short option
3752 short - Short, less verbose, version of configurations.
3753 This is overridden by the json option
3754returns:
3755 Output from cli as a string or None on error
3756
3757</pre>
3758 <dl class="fields">
3759 </dl>
3760</td></tr></table>
3761</div>
3762<a name="setCfg"></a>
3763<div>
3764<table class="details" border="1" cellpadding="3"
3765 cellspacing="0" width="100%" bgcolor="white">
3766<tr><td>
3767 <table width="100%" cellpadding="0" cellspacing="0" border="0">
3768 <tr valign="top"><td>
3769 <h3 class="epydoc"><span class="sig"><span class="sig-name">setCfg</span>(<span class="sig-arg">self</span>,
3770 <span class="sig-arg">component</span>,
3771 <span class="sig-arg">propName</span>,
3772 <span class="sig-arg">value</span>=<span class="sig-default">None</span>,
3773 <span class="sig-arg">check</span>=<span class="sig-default">True</span>)</span>
3774 </h3>
3775 </td><td align="right" valign="top"
3776 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.setCfg">source&nbsp;code</a></span>&nbsp;
3777 </td>
3778 </tr></table>
3779
3780 <pre class="literalblock">
3781
3782Set/Unset configuration settings from ONOS cli
3783Required arguments:
3784 component - The case sensitive name of the component whose
3785 property is to be set
3786 propName - The case sensitive name of the property to be set/unset
3787Optional arguments:
3788 value - The value to set the property to. If None, will unset the
3789 property and revert it to it's default value(if applicable)
3790 check - Boolean, Check whether the option was successfully set this
3791 only applies when a value is given.
3792returns:
3793 main.TRUE on success or main.FALSE on failure. If check is False,
3794 will return main.TRUE unless there is an error
3795
3796</pre>
3797 <dl class="fields">
3798 </dl>
3799</td></tr></table>
3800</div>
3801<a name="setTestAdd"></a>
3802<div>
3803<table class="details" border="1" cellpadding="3"
3804 cellspacing="0" width="100%" bgcolor="white">
3805<tr><td>
3806 <table width="100%" cellpadding="0" cellspacing="0" border="0">
3807 <tr valign="top"><td>
3808 <h3 class="epydoc"><span class="sig"><span class="sig-name">setTestAdd</span>(<span class="sig-arg">self</span>,
3809 <span class="sig-arg">setName</span>,
3810 <span class="sig-arg">values</span>)</span>
3811 </h3>
3812 </td><td align="right" valign="top"
3813 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.setTestAdd">source&nbsp;code</a></span>&nbsp;
3814 </td>
3815 </tr></table>
3816
3817 <pre class="literalblock">
3818
3819CLI command to add elements to a distributed set.
3820Arguments:
3821 setName - The name of the set to add to.
3822 values - The value(s) to add to the set, space seperated.
3823Example usages:
3824 setTestAdd( &quot;set1&quot;, &quot;a b c&quot; )
3825 setTestAdd( &quot;set2&quot;, &quot;1&quot; )
3826returns:
3827 main.TRUE on success OR
3828 main.FALSE if elements were already in the set OR
3829 main.ERROR on error
3830
3831</pre>
3832 <dl class="fields">
3833 </dl>
3834</td></tr></table>
3835</div>
3836<a name="setTestRemove"></a>
3837<div>
3838<table class="details" border="1" cellpadding="3"
3839 cellspacing="0" width="100%" bgcolor="white">
3840<tr><td>
3841 <table width="100%" cellpadding="0" cellspacing="0" border="0">
3842 <tr valign="top"><td>
3843 <h3 class="epydoc"><span class="sig"><span class="sig-name">setTestRemove</span>(<span class="sig-arg">self</span>,
3844 <span class="sig-arg">setName</span>,
3845 <span class="sig-arg">values</span>,
3846 <span class="sig-arg">clear</span>=<span class="sig-default">False</span>,
3847 <span class="sig-arg">retain</span>=<span class="sig-default">False</span>)</span>
3848 </h3>
3849 </td><td align="right" valign="top"
3850 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.setTestRemove">source&nbsp;code</a></span>&nbsp;
3851 </td>
3852 </tr></table>
3853
3854 <pre class="literalblock">
3855
3856CLI command to remove elements from a distributed set.
3857Required arguments:
3858 setName - The name of the set to remove from.
3859 values - The value(s) to remove from the set, space seperated.
3860Optional arguments:
3861 clear - Clear all elements from the set
3862 retain - Retain only the given values. (intersection of the
3863 original set and the given set)
3864returns:
3865 main.TRUE on success OR
3866 main.FALSE if the set was not changed OR
3867 main.ERROR on error
3868
3869</pre>
3870 <dl class="fields">
3871 </dl>
3872</td></tr></table>
3873</div>
3874<a name="setTestGet"></a>
3875<div>
3876<table class="details" border="1" cellpadding="3"
3877 cellspacing="0" width="100%" bgcolor="white">
3878<tr><td>
3879 <table width="100%" cellpadding="0" cellspacing="0" border="0">
3880 <tr valign="top"><td>
3881 <h3 class="epydoc"><span class="sig"><span class="sig-name">setTestGet</span>(<span class="sig-arg">self</span>,
3882 <span class="sig-arg">setName</span>,
3883 <span class="sig-arg">values</span>=<span class="sig-default">&quot;&quot;</span>)</span>
3884 </h3>
3885 </td><td align="right" valign="top"
3886 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.setTestGet">source&nbsp;code</a></span>&nbsp;
3887 </td>
3888 </tr></table>
3889
3890 <pre class="literalblock">
3891
3892CLI command to get the elements in a distributed set.
3893Required arguments:
3894 setName - The name of the set to remove from.
3895Optional arguments:
3896 values - The value(s) to check if in the set, space seperated.
3897returns:
3898 main.ERROR on error OR
3899 A list of elements in the set if no optional arguments are
3900 supplied OR
3901 A tuple containing the list then:
3902 main.FALSE if the given values are not in the set OR
3903 main.TRUE if the given values are in the set OR
3904
3905</pre>
3906 <dl class="fields">
3907 </dl>
3908</td></tr></table>
3909</div>
3910<a name="setTestSize"></a>
3911<div>
3912<table class="details" border="1" cellpadding="3"
3913 cellspacing="0" width="100%" bgcolor="white">
3914<tr><td>
3915 <table width="100%" cellpadding="0" cellspacing="0" border="0">
3916 <tr valign="top"><td>
3917 <h3 class="epydoc"><span class="sig"><span class="sig-name">setTestSize</span>(<span class="sig-arg">self</span>,
3918 <span class="sig-arg">setName</span>)</span>
3919 </h3>
3920 </td><td align="right" valign="top"
3921 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.setTestSize">source&nbsp;code</a></span>&nbsp;
3922 </td>
3923 </tr></table>
3924
3925 <pre class="literalblock">
3926
3927CLI command to get the elements in a distributed set.
3928Required arguments:
3929 setName - The name of the set to remove from.
3930returns:
3931 The integer value of the size returned or
3932 None on error
3933
3934</pre>
3935 <dl class="fields">
3936 </dl>
3937</td></tr></table>
3938</div>
3939<a name="counters"></a>
3940<div>
3941<table class="details" border="1" cellpadding="3"
3942 cellspacing="0" width="100%" bgcolor="white">
3943<tr><td>
3944 <table width="100%" cellpadding="0" cellspacing="0" border="0">
3945 <tr valign="top"><td>
3946 <h3 class="epydoc"><span class="sig"><span class="sig-name">counters</span>(<span class="sig-arg">self</span>,
3947 <span class="sig-arg">jsonFormat</span>=<span class="sig-default">True</span>)</span>
3948 </h3>
3949 </td><td align="right" valign="top"
3950 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.counters">source&nbsp;code</a></span>&nbsp;
3951 </td>
3952 </tr></table>
3953
3954 <pre class="literalblock">
3955
3956Command to list the various counters in the system.
3957returns:
3958 if jsonFormat, a string of the json object returned by the cli
3959 command
3960 if not jsonFormat, the normal string output of the cli command
3961 None on error
3962
3963</pre>
3964 <dl class="fields">
3965 </dl>
3966</td></tr></table>
3967</div>
3968<a name="counterTestAddAndGet"></a>
3969<div>
3970<table class="details" border="1" cellpadding="3"
3971 cellspacing="0" width="100%" bgcolor="white">
3972<tr><td>
3973 <table width="100%" cellpadding="0" cellspacing="0" border="0">
3974 <tr valign="top"><td>
3975 <h3 class="epydoc"><span class="sig"><span class="sig-name">counterTestAddAndGet</span>(<span class="sig-arg">self</span>,
3976 <span class="sig-arg">counter</span>,
3977 <span class="sig-arg">delta</span>=<span class="sig-default">1</span>,
3978 <span class="sig-arg">inMemory</span>=<span class="sig-default">False</span>)</span>
3979 </h3>
3980 </td><td align="right" valign="top"
3981 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.counterTestAddAndGet">source&nbsp;code</a></span>&nbsp;
3982 </td>
3983 </tr></table>
3984
3985 <pre class="literalblock">
3986
3987CLI command to add a delta to then get a distributed counter.
3988Required arguments:
3989 counter - The name of the counter to increment.
3990Optional arguments:
3991 delta - The long to add to the counter
3992 inMemory - use in memory map for the counter
3993returns:
3994 integer value of the counter or
3995 None on Error
3996
3997</pre>
3998 <dl class="fields">
3999 </dl>
4000</td></tr></table>
4001</div>
4002<a name="counterTestGetAndAdd"></a>
4003<div>
4004<table class="details" border="1" cellpadding="3"
4005 cellspacing="0" width="100%" bgcolor="white">
4006<tr><td>
4007 <table width="100%" cellpadding="0" cellspacing="0" border="0">
4008 <tr valign="top"><td>
4009 <h3 class="epydoc"><span class="sig"><span class="sig-name">counterTestGetAndAdd</span>(<span class="sig-arg">self</span>,
4010 <span class="sig-arg">counter</span>,
4011 <span class="sig-arg">delta</span>=<span class="sig-default">1</span>,
4012 <span class="sig-arg">inMemory</span>=<span class="sig-default">False</span>)</span>
4013 </h3>
4014 </td><td align="right" valign="top"
4015 ><span class="codelink"><a href="TestON.drivers.common.cli.onosclidriver-pysrc.html#OnosCliDriver.counterTestGetAndAdd">source&nbsp;code</a></span>&nbsp;
4016 </td>
4017 </tr></table>
4018
4019 <pre class="literalblock">
4020
4021CLI command to get a distributed counter then add a delta to it.
4022Required arguments:
4023 counter - The name of the counter to increment.
4024Optional arguments:
4025 delta - The long to add to the counter
4026 inMemory - use in memory map for the counter
4027returns:
4028 integer value of the counter or
4029 None on Error
4030
4031</pre>
4032 <dl class="fields">
4033 </dl>
4034</td></tr></table>
4035</div>
4036<br />
4037<!-- ==================== NAVIGATION BAR ==================== -->
4038<table class="navbar" border="0" width="100%" cellpadding="0"
4039 bgcolor="#a0c0ff" cellspacing="0">
4040 <tr valign="middle">
4041 <!-- Home link -->
4042 <th>&nbsp;&nbsp;&nbsp;<a
4043 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
4044
4045 <!-- Tree link -->
4046 <th>&nbsp;&nbsp;&nbsp;<a
4047 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
4048
4049 <!-- Index link -->
4050 <th>&nbsp;&nbsp;&nbsp;<a
4051 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
4052
4053 <!-- Help link -->
4054 <th>&nbsp;&nbsp;&nbsp;<a
4055 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
4056
4057 <!-- Project homepage -->
4058 <th class="navbar" align="right" width="100%">
4059 <table border="0" cellpadding="0" cellspacing="0">
4060 <tr><th class="navbar" align="center"
4061 >TestON</th>
4062 </tr></table></th>
4063 </tr>
4064</table>
4065<table border="0" cellpadding="0" cellspacing="0" width="100%%">
4066 <tr>
4067 <td align="left" class="footer">
4068 Generated by Epydoc 3.0.1 on Mon Aug 10 11:12:35 2015
4069 </td>
4070 <td align="right" class="footer">
4071 <a target="mainFrame" href="http://epydoc.sourceforge.net"
4072 >http://epydoc.sourceforge.net</a>
4073 </td>
4074 </tr>
4075</table>
4076
4077<script type="text/javascript">
4078 <!--
4079 // Private objects are initially displayed (because if
4080 // javascript is turned off then we want them to be
4081 // visible); but by default, we want to hide them. So hide
4082 // them unless we have a cookie that says to show them.
4083 checkCookie();
4084 // -->
4085</script>
4086</body>
4087</html>