Gitiles
Code Review Sign In
gerrit.onosproject.org / OnosSystemTest / a1cdd89614292d9758aeb97acf8b9ae1cf4526a3 / . / TestON / Documentation / TestON_Document / TestON.drivers.common.api.controller.onosrestdriver.OnosRestDriver-class.html
blob: e2a31a3afc03153ae98510c3598acb9beb6c0946 [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.api.controller.onosrestdriver.OnosRestDriver</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.api-module.html">Package&nbsp;api</a> ::
49 <a href="TestON.drivers.common.api.controller-module.html">Package&nbsp;controller</a> ::
50 <a href="TestON.drivers.common.api.controller.onosrestdriver-module.html">Module&nbsp;onosrestdriver</a> ::
51 Class&nbsp;OnosRestDriver
52 </span>
53 </td>
54 <td>
55 <table cellpadding="0" cellspacing="0">
56 <!-- hide/show private -->
57 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
58 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
59 <tr><td align="right"><span class="options"
60 >[<a href="frames.html" target="_top">frames</a
61 >]&nbsp;|&nbsp;<a href="TestON.drivers.common.api.controller.onosrestdriver.OnosRestDriver-class.html"
62 target="_top">no&nbsp;frames</a>]</span></td></tr>
63 </table>
64 </td>
65 </tr>
66</table>
67<!-- ==================== CLASS DESCRIPTION ==================== -->
68<h1 class="epydoc">Class OnosRestDriver</h1><p class="nomargin-top"><span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver">source&nbsp;code</a></span></p>
69<center>
70<center> <map id="class_hierarchy_for_onosrestdr" name="class_hierarchy_for_onosrestdr">
71<area shape="rect" id="node1" href="TestON.drivers.common.api.controller.onosrestdriver.OnosRestDriver-class.html" title="OnosRestDriver" alt="" coords="5,6,120,31"/>
72<area shape="rect" id="node2" href="TestON.drivers.common.api.controllerdriver.Controller-class.html" title="controllerdriver.Controller" alt="" coords="145,6,311,31"/>
73<area shape="rect" id="node3" href="TestON.drivers.common.apidriver.API-class.html" title="apidriver.API" alt="" coords="335,6,432,31"/>
74<area shape="rect" id="node4" href="javascript:void(0);" title="component.Component" alt="" coords="457,6,615,31"/>
75</map>
76 <img src="class_hierarchy_for_onosrestdr.gif" alt='' usemap="#class_hierarchy_for_onosrestdr" ismap="ismap" class="graph-without-title" />
77</center>
78</center>
79<hr />
80<!-- ==================== INSTANCE METHODS ==================== -->
81<a name="section-InstanceMethods"></a>
82<table class="summary" border="1" cellpadding="3"
83 cellspacing="0" width="100%" bgcolor="white">
84<tr bgcolor="#70b0f0" class="table-header">
85 <td colspan="2" class="table-header">
86 <table border="0" cellpadding="0" cellspacing="0" width="100%">
87 <tr valign="top">
88 <td align="left"><span class="table-header">Instance Methods</span></td>
89 <td align="right" valign="top"
90 ><span class="options">[<a href="#section-InstanceMethods"
91 class="privatelink" onclick="toggle_private();"
92 >hide private</a>]</span></td>
93 </tr>
94 </table>
95 </td>
96</tr>
97<tr>
98 <td width="15%" align="right" valign="top" class="summary">
99 <span class="summary-type">&nbsp;</span>
100 </td><td class="summary">
101 <table width="100%" cellpadding="0" cellspacing="0" border="0">
102 <tr>
103 <td><span class="summary-sig"><a href="TestON.drivers.common.api.controller.onosrestdriver.OnosRestDriver-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>)</span><br />
104 x.__init__(...) initializes x; see help(type(x)) for signature</td>
105 <td align="right" valign="top">
106 <span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.__init__">source&nbsp;code</a></span>
107
108 </td>
109 </tr>
110 </table>
111
112 </td>
113 </tr>
114<tr>
115 <td width="15%" align="right" valign="top" class="summary">
116 <span class="summary-type">&nbsp;</span>
117 </td><td class="summary">
118 <table width="100%" cellpadding="0" cellspacing="0" border="0">
119 <tr>
120 <td><span class="summary-sig"><a href="TestON.drivers.common.api.controller.onosrestdriver.OnosRestDriver-class.html#connect" class="summary-sig-name">connect</a>(<span class="summary-sig-arg">self</span>,
121 <span class="summary-sig-arg">**connectargs</span>)</span><br />
122 Connection will establish to the remote host using ssh.</td>
123 <td align="right" valign="top">
124 <span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.connect">source&nbsp;code</a></span>
125
126 </td>
127 </tr>
128 </table>
129
130 </td>
131 </tr>
132<tr>
133 <td width="15%" align="right" valign="top" class="summary">
134 <span class="summary-type">&nbsp;</span>
135 </td><td class="summary">
136 <table width="100%" cellpadding="0" cellspacing="0" border="0">
137 <tr>
138 <td><span class="summary-sig"><a href="TestON.drivers.common.api.controller.onosrestdriver.OnosRestDriver-class.html#send" class="summary-sig-name">send</a>(<span class="summary-sig-arg">self</span>,
139 <span class="summary-sig-arg">ip</span>,
140 <span class="summary-sig-arg">port</span>,
141 <span class="summary-sig-arg">url</span>,
142 <span class="summary-sig-arg">base</span>=<span class="summary-sig-default">&quot;/onos/v1&quot;</span>,
143 <span class="summary-sig-arg">method</span>=<span class="summary-sig-default">&quot;GET&quot;</span>,
144 <span class="summary-sig-arg">query</span>=<span class="summary-sig-default">None</span>,
145 <span class="summary-sig-arg">data</span>=<span class="summary-sig-default">None</span>)</span><br />
146 Arguments:
147 str ip: ONOS IP Address
148 str port: ONOS REST Port
149 str url: ONOS REST url path.</td>
150 <td align="right" valign="top">
151 <span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.send">source&nbsp;code</a></span>
152
153 </td>
154 </tr>
155 </table>
156
157 </td>
158 </tr>
159<tr>
160 <td width="15%" align="right" valign="top" class="summary">
161 <span class="summary-type">&nbsp;</span>
162 </td><td class="summary">
163 <table width="100%" cellpadding="0" cellspacing="0" border="0">
164 <tr>
165 <td><span class="summary-sig"><a href="TestON.drivers.common.api.controller.onosrestdriver.OnosRestDriver-class.html#intents" class="summary-sig-name">intents</a>(<span class="summary-sig-arg">self</span>,
166 <span class="summary-sig-arg">ip</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>,
167 <span class="summary-sig-arg">port</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>)</span><br />
168 Description:...</td>
169 <td align="right" valign="top">
170 <span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.intents">source&nbsp;code</a></span>
171
172 </td>
173 </tr>
174 </table>
175
176 </td>
177 </tr>
178<tr>
179 <td width="15%" align="right" valign="top" class="summary">
180 <span class="summary-type">&nbsp;</span>
181 </td><td class="summary">
182 <table width="100%" cellpadding="0" cellspacing="0" border="0">
183 <tr>
184 <td><span class="summary-sig"><a href="TestON.drivers.common.api.controller.onosrestdriver.OnosRestDriver-class.html#intent" class="summary-sig-name">intent</a>(<span class="summary-sig-arg">self</span>,
185 <span class="summary-sig-arg">intentId</span>,
186 <span class="summary-sig-arg">appId</span>=<span class="summary-sig-default">&quot;org.onosproject.cli&quot;</span>,
187 <span class="summary-sig-arg">ip</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>,
188 <span class="summary-sig-arg">port</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>)</span><br />
189 Description:...</td>
190 <td align="right" valign="top">
191 <span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.intent">source&nbsp;code</a></span>
192
193 </td>
194 </tr>
195 </table>
196
197 </td>
198 </tr>
199<tr>
200 <td width="15%" align="right" valign="top" class="summary">
201 <span class="summary-type">&nbsp;</span>
202 </td><td class="summary">
203 <table width="100%" cellpadding="0" cellspacing="0" border="0">
204 <tr>
205 <td><span class="summary-sig"><a href="TestON.drivers.common.api.controller.onosrestdriver.OnosRestDriver-class.html#apps" class="summary-sig-name">apps</a>(<span class="summary-sig-arg">self</span>,
206 <span class="summary-sig-arg">ip</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>,
207 <span class="summary-sig-arg">port</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>)</span><br />
208 Description:...</td>
209 <td align="right" valign="top">
210 <span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.apps">source&nbsp;code</a></span>
211
212 </td>
213 </tr>
214 </table>
215
216 </td>
217 </tr>
218<tr>
219 <td width="15%" align="right" valign="top" class="summary">
220 <span class="summary-type">&nbsp;</span>
221 </td><td class="summary">
222 <table width="100%" cellpadding="0" cellspacing="0" border="0">
223 <tr>
224 <td><span class="summary-sig"><a href="TestON.drivers.common.api.controller.onosrestdriver.OnosRestDriver-class.html#activateApp" class="summary-sig-name">activateApp</a>(<span class="summary-sig-arg">self</span>,
225 <span class="summary-sig-arg">appName</span>,
226 <span class="summary-sig-arg">ip</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>,
227 <span class="summary-sig-arg">port</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>,
228 <span class="summary-sig-arg">check</span>=<span class="summary-sig-default">True</span>)</span><br />
229 Decription:...</td>
230 <td align="right" valign="top">
231 <span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.activateApp">source&nbsp;code</a></span>
232
233 </td>
234 </tr>
235 </table>
236
237 </td>
238 </tr>
239<tr>
240 <td width="15%" align="right" valign="top" class="summary">
241 <span class="summary-type">&nbsp;</span>
242 </td><td class="summary">
243 <table width="100%" cellpadding="0" cellspacing="0" border="0">
244 <tr>
245 <td><span class="summary-sig"><a href="TestON.drivers.common.api.controller.onosrestdriver.OnosRestDriver-class.html#deactivateApp" class="summary-sig-name">deactivateApp</a>(<span class="summary-sig-arg">self</span>,
246 <span class="summary-sig-arg">appName</span>,
247 <span class="summary-sig-arg">ip</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>,
248 <span class="summary-sig-arg">port</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>,
249 <span class="summary-sig-arg">check</span>=<span class="summary-sig-default">True</span>)</span><br />
250 Required:...</td>
251 <td align="right" valign="top">
252 <span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.deactivateApp">source&nbsp;code</a></span>
253
254 </td>
255 </tr>
256 </table>
257
258 </td>
259 </tr>
260<tr>
261 <td width="15%" align="right" valign="top" class="summary">
262 <span class="summary-type">&nbsp;</span>
263 </td><td class="summary">
264 <table width="100%" cellpadding="0" cellspacing="0" border="0">
265 <tr>
266 <td><span class="summary-sig"><a href="TestON.drivers.common.api.controller.onosrestdriver.OnosRestDriver-class.html#getApp" class="summary-sig-name">getApp</a>(<span class="summary-sig-arg">self</span>,
267 <span class="summary-sig-arg">appName</span>,
268 <span class="summary-sig-arg">project</span>=<span class="summary-sig-default">&quot;org.onosproject.&quot;</span>,
269 <span class="summary-sig-arg">ip</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>,
270 <span class="summary-sig-arg">port</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>)</span><br />
271 Decription:...</td>
272 <td align="right" valign="top">
273 <span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.getApp">source&nbsp;code</a></span>
274
275 </td>
276 </tr>
277 </table>
278
279 </td>
280 </tr>
281<tr>
282 <td width="15%" align="right" valign="top" class="summary">
283 <span class="summary-type">&nbsp;</span>
284 </td><td class="summary">
285 <table width="100%" cellpadding="0" cellspacing="0" border="0">
286 <tr>
287 <td><span class="summary-sig"><a href="TestON.drivers.common.api.controller.onosrestdriver.OnosRestDriver-class.html#addHostIntent" class="summary-sig-name">addHostIntent</a>(<span class="summary-sig-arg">self</span>,
288 <span class="summary-sig-arg">hostIdOne</span>,
289 <span class="summary-sig-arg">hostIdTwo</span>,
290 <span class="summary-sig-arg">appId</span>=<span class="summary-sig-default">'org.onosproject.cli'</span>,
291 <span class="summary-sig-arg">ip</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>,
292 <span class="summary-sig-arg">port</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>)</span><br />
293 Description:
294 Adds a host-to-host intent ( bidirectional ) by
295 specifying the two hosts.</td>
296 <td align="right" valign="top">
297 <span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.addHostIntent">source&nbsp;code</a></span>
298
299 </td>
300 </tr>
301 </table>
302
303 </td>
304 </tr>
305<tr>
306 <td width="15%" align="right" valign="top" class="summary">
307 <span class="summary-type">&nbsp;</span>
308 </td><td class="summary">
309 <table width="100%" cellpadding="0" cellspacing="0" border="0">
310 <tr>
311 <td><span class="summary-sig"><a href="TestON.drivers.common.api.controller.onosrestdriver.OnosRestDriver-class.html#addPointIntent" class="summary-sig-name">addPointIntent</a>(<span class="summary-sig-arg">self</span>,
312 <span class="summary-sig-arg">ingressDevice</span>,
313 <span class="summary-sig-arg">egressDevice</span>,
314 <span class="summary-sig-arg">appId</span>=<span class="summary-sig-default">'org.onosproject.cli'</span>,
315 <span class="summary-sig-arg">ingressPort</span>=<span class="summary-sig-default">&quot;&quot;</span>,
316 <span class="summary-sig-arg">egressPort</span>=<span class="summary-sig-default">&quot;&quot;</span>,
317 <span class="summary-sig-arg">ethType</span>=<span class="summary-sig-default">&quot;&quot;</span>,
318 <span class="summary-sig-arg">ethSrc</span>=<span class="summary-sig-default">&quot;&quot;</span>,
319 <span class="summary-sig-arg">ethDst</span>=<span class="summary-sig-default">&quot;&quot;</span>,
320 <span class="summary-sig-arg">bandwidth</span>=<span class="summary-sig-default">&quot;&quot;</span>,
321 <span class="summary-sig-arg">lambdaAlloc</span>=<span class="summary-sig-default">False</span>,
322 <span class="summary-sig-arg">ipProto</span>=<span class="summary-sig-default">&quot;&quot;</span>,
323 <span class="summary-sig-arg">ipSrc</span>=<span class="summary-sig-default">&quot;&quot;</span>,
324 <span class="summary-sig-arg">ipDst</span>=<span class="summary-sig-default">&quot;&quot;</span>,
325 <span class="summary-sig-arg">tcpSrc</span>=<span class="summary-sig-default">&quot;&quot;</span>,
326 <span class="summary-sig-arg">tcpDst</span>=<span class="summary-sig-default">&quot;&quot;</span>,
327 <span class="summary-sig-arg">ip</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>,
328 <span class="summary-sig-arg">port</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>)</span><br />
329 Description:
330 Adds a point-to-point intent ( uni-directional ) by
331 specifying device id's and optional fields
332Required:
333 * ingressDevice: device id of ingress device
334 * egressDevice: device id of egress device
335Optional:
336 * ethType: specify ethType
337 * ethSrc: specify ethSrc ( i.e.</td>
338 <td align="right" valign="top">
339 <span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.addPointIntent">source&nbsp;code</a></span>
340
341 </td>
342 </tr>
343 </table>
344
345 </td>
346 </tr>
347<tr>
348 <td width="15%" align="right" valign="top" class="summary">
349 <span class="summary-type">&nbsp;</span>
350 </td><td class="summary">
351 <table width="100%" cellpadding="0" cellspacing="0" border="0">
352 <tr>
353 <td><span class="summary-sig"><a name="removeIntent"></a><span class="summary-sig-name">removeIntent</span>(<span class="summary-sig-arg">self</span>,
354 <span class="summary-sig-arg">intentId</span>,
355 <span class="summary-sig-arg">appId</span>=<span class="summary-sig-default">'org.onosproject.cli'</span>,
356 <span class="summary-sig-arg">ip</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>,
357 <span class="summary-sig-arg">port</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>)</span><br />
358 Remove intent for specified application id and intent id; Returns
359 None for exception</td>
360 <td align="right" valign="top">
361 <span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.removeIntent">source&nbsp;code</a></span>
362
363 </td>
364 </tr>
365 </table>
366
367 </td>
368 </tr>
369<tr>
370 <td width="15%" align="right" valign="top" class="summary">
371 <span class="summary-type">&nbsp;</span>
372 </td><td class="summary">
373 <table width="100%" cellpadding="0" cellspacing="0" border="0">
374 <tr>
375 <td><span class="summary-sig"><a name="getIntentsId"></a><span class="summary-sig-name">getIntentsId</span>(<span class="summary-sig-arg">self</span>,
376 <span class="summary-sig-arg">ip</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>,
377 <span class="summary-sig-arg">port</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>)</span><br />
378 Returns a list of intents id; Returns None for exception</td>
379 <td align="right" valign="top">
380 <span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.getIntentsId">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 href="TestON.drivers.common.api.controller.onosrestdriver.OnosRestDriver-class.html#removeAllIntents" class="summary-sig-name">removeAllIntents</a>(<span class="summary-sig-arg">self</span>,
395 <span class="summary-sig-arg">intentIdList</span>=<span class="summary-sig-default">'ALL'</span>,
396 <span class="summary-sig-arg">appId</span>=<span class="summary-sig-default">'org.onosproject.cli'</span>,
397 <span class="summary-sig-arg">ip</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>,
398 <span class="summary-sig-arg">port</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>,
399 <span class="summary-sig-arg">delay</span>=<span class="summary-sig-default">5</span>)</span><br />
400 Description:...</td>
401 <td align="right" valign="top">
402 <span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.removeAllIntents">source&nbsp;code</a></span>
403
404 </td>
405 </tr>
406 </table>
407
408 </td>
409 </tr>
410<tr>
411 <td width="15%" align="right" valign="top" class="summary">
412 <span class="summary-type">&nbsp;</span>
413 </td><td class="summary">
414 <table width="100%" cellpadding="0" cellspacing="0" border="0">
415 <tr>
416 <td><span class="summary-sig"><a href="TestON.drivers.common.api.controller.onosrestdriver.OnosRestDriver-class.html#hosts" class="summary-sig-name">hosts</a>(<span class="summary-sig-arg">self</span>,
417 <span class="summary-sig-arg">ip</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>,
418 <span class="summary-sig-arg">port</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>)</span><br />
419 Description:...</td>
420 <td align="right" valign="top">
421 <span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.hosts">source&nbsp;code</a></span>
422
423 </td>
424 </tr>
425 </table>
426
427 </td>
428 </tr>
429<tr>
430 <td width="15%" align="right" valign="top" class="summary">
431 <span class="summary-type">&nbsp;</span>
432 </td><td class="summary">
433 <table width="100%" cellpadding="0" cellspacing="0" border="0">
434 <tr>
435 <td><span class="summary-sig"><a href="TestON.drivers.common.api.controller.onosrestdriver.OnosRestDriver-class.html#getHost" class="summary-sig-name">getHost</a>(<span class="summary-sig-arg">self</span>,
436 <span class="summary-sig-arg">mac</span>,
437 <span class="summary-sig-arg">vlan</span>=<span class="summary-sig-default">&quot;-1&quot;</span>,
438 <span class="summary-sig-arg">ip</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>,
439 <span class="summary-sig-arg">port</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>)</span><br />
440 Description:
441 Gets the information from the given host
442Required:
443 str mac - MAC address of the host
444Optional:
445 str vlan - VLAN tag of the host, defaults to -1
446Returns:
447 Return the host id from the hosts/mac/vlan output in REST api
448 whose 'id' contains mac/vlan; Returns None for exception;
449 Returns main.FALSE if error on requests</td>
450 <td align="right" valign="top">
451 <span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.getHost">source&nbsp;code</a></span>
452
453 </td>
454 </tr>
455 </table>
456
457 </td>
458 </tr>
459<tr>
460 <td width="15%" align="right" valign="top" class="summary">
461 <span class="summary-type">&nbsp;</span>
462 </td><td class="summary">
463 <table width="100%" cellpadding="0" cellspacing="0" border="0">
464 <tr>
465 <td><span class="summary-sig"><a href="TestON.drivers.common.api.controller.onosrestdriver.OnosRestDriver-class.html#topology" class="summary-sig-name">topology</a>(<span class="summary-sig-arg">self</span>,
466 <span class="summary-sig-arg">ip</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>,
467 <span class="summary-sig-arg">port</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>)</span><br />
468 Description:...</td>
469 <td align="right" valign="top">
470 <span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.topology">source&nbsp;code</a></span>
471
472 </td>
473 </tr>
474 </table>
475
476 </td>
477 </tr>
478<tr>
479 <td width="15%" align="right" valign="top" class="summary">
480 <span class="summary-type">&nbsp;</span>
481 </td><td class="summary">
482 <table width="100%" cellpadding="0" cellspacing="0" border="0">
483 <tr>
484 <td><span class="summary-sig"><a href="TestON.drivers.common.api.controller.onosrestdriver.OnosRestDriver-class.html#getIntentState" class="summary-sig-name">getIntentState</a>(<span class="summary-sig-arg">self</span>,
485 <span class="summary-sig-arg">intentsId</span>,
486 <span class="summary-sig-arg">intentsJson</span>=<span class="summary-sig-default">None</span>,
487 <span class="summary-sig-arg">ip</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>,
488 <span class="summary-sig-arg">port</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>)</span><br />
489 Description:
490 Get intent state.</td>
491 <td align="right" valign="top">
492 <span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.getIntentState">source&nbsp;code</a></span>
493
494 </td>
495 </tr>
496 </table>
497
498 </td>
499 </tr>
500<tr>
501 <td width="15%" align="right" valign="top" class="summary">
502 <span class="summary-type">&nbsp;</span>
503 </td><td class="summary">
504 <table width="100%" cellpadding="0" cellspacing="0" border="0">
505 <tr>
506 <td><span class="summary-sig"><a href="TestON.drivers.common.api.controller.onosrestdriver.OnosRestDriver-class.html#checkIntentState" class="summary-sig-name">checkIntentState</a>(<span class="summary-sig-arg">self</span>,
507 <span class="summary-sig-arg">intentsId</span>=<span class="summary-sig-default">&quot;ALL&quot;</span>,
508 <span class="summary-sig-arg">expectedState</span>=<span class="summary-sig-default">'INSTALLED'</span>,
509 <span class="summary-sig-arg">ip</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>,
510 <span class="summary-sig-arg">port</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>)</span><br />
511 Description:
512 Check intents state based on expected state which defaults to
513 INSTALLED state
514Required:
515 intentsId - List of intents ID to be checked
516Optional:
517 expectedState - Check the expected state(s) of each intents
518 state in the list.</td>
519 <td align="right" valign="top">
520 <span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.checkIntentState">source&nbsp;code</a></span>
521
522 </td>
523 </tr>
524 </table>
525
526 </td>
527 </tr>
528<tr>
529 <td width="15%" align="right" valign="top" class="summary">
530 <span class="summary-type">&nbsp;</span>
531 </td><td class="summary">
532 <table width="100%" cellpadding="0" cellspacing="0" border="0">
533 <tr>
534 <td><span class="summary-sig"><a href="TestON.drivers.common.api.controller.onosrestdriver.OnosRestDriver-class.html#flows" class="summary-sig-name">flows</a>(<span class="summary-sig-arg">self</span>,
535 <span class="summary-sig-arg">ip</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>,
536 <span class="summary-sig-arg">port</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>)</span><br />
537 Description:...</td>
538 <td align="right" valign="top">
539 <span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.flows">source&nbsp;code</a></span>
540
541 </td>
542 </tr>
543 </table>
544
545 </td>
546 </tr>
547<tr>
548 <td width="15%" align="right" valign="top" class="summary">
549 <span class="summary-type">&nbsp;</span>
550 </td><td class="summary">
551 <table width="100%" cellpadding="0" cellspacing="0" border="0">
552 <tr>
553 <td><span class="summary-sig"><a href="TestON.drivers.common.api.controller.onosrestdriver.OnosRestDriver-class.html#getFlows" class="summary-sig-name">getFlows</a>(<span class="summary-sig-arg">self</span>,
554 <span class="summary-sig-arg">device</span>,
555 <span class="summary-sig-arg">flowId</span>=<span class="summary-sig-default">0</span>,
556 <span class="summary-sig-arg">ip</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>,
557 <span class="summary-sig-arg">port</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>)</span><br />
558 Description:...</td>
559 <td align="right" valign="top">
560 <span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.getFlows">source&nbsp;code</a></span>
561
562 </td>
563 </tr>
564 </table>
565
566 </td>
567 </tr>
568<tr>
569 <td width="15%" align="right" valign="top" class="summary">
570 <span class="summary-type">&nbsp;</span>
571 </td><td class="summary">
572 <table width="100%" cellpadding="0" cellspacing="0" border="0">
573 <tr>
574 <td><span class="summary-sig"><a href="TestON.drivers.common.api.controller.onosrestdriver.OnosRestDriver-class.html#addFlow" class="summary-sig-name">addFlow</a>(<span class="summary-sig-arg">self</span>,
575 <span class="summary-sig-arg">deviceId</span>,
576 <span class="summary-sig-arg">appId</span>=<span class="summary-sig-default">0</span>,
577 <span class="summary-sig-arg">ingressPort</span>=<span class="summary-sig-default">&quot;&quot;</span>,
578 <span class="summary-sig-arg">egressPort</span>=<span class="summary-sig-default">&quot;&quot;</span>,
579 <span class="summary-sig-arg">ethType</span>=<span class="summary-sig-default">&quot;&quot;</span>,
580 <span class="summary-sig-arg">ethSrc</span>=<span class="summary-sig-default">&quot;&quot;</span>,
581 <span class="summary-sig-arg">ethDst</span>=<span class="summary-sig-default">&quot;&quot;</span>,
582 <span class="summary-sig-arg">bandwidth</span>=<span class="summary-sig-default">&quot;&quot;</span>,
583 <span class="summary-sig-arg">lambdaAlloc</span>=<span class="summary-sig-default">False</span>,
584 <span class="summary-sig-arg">ipProto</span>=<span class="summary-sig-default">&quot;&quot;</span>,
585 <span class="summary-sig-arg">ipSrc</span>=<span class="summary-sig-default">&quot;&quot;</span>,
586 <span class="summary-sig-arg">ipDst</span>=<span class="summary-sig-default">&quot;&quot;</span>,
587 <span class="summary-sig-arg">tcpSrc</span>=<span class="summary-sig-default">&quot;&quot;</span>,
588 <span class="summary-sig-arg">tcpDst</span>=<span class="summary-sig-default">&quot;&quot;</span>,
589 <span class="summary-sig-arg">ip</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>,
590 <span class="summary-sig-arg">port</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>)</span><br />
591 Description:
592 Creates a single flow in the specified device
593Required:
594 * deviceId: id of the device
595Optional:
596 * ingressPort: port ingress device
597 * egressPort: port of egress device
598 * ethType: specify ethType
599 * ethSrc: specify ethSrc ( i.e.</td>
600 <td align="right" valign="top">
601 <span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.addFlow">source&nbsp;code</a></span>
602
603 </td>
604 </tr>
605 </table>
606
607 </td>
608 </tr>
609<tr>
610 <td width="15%" align="right" valign="top" class="summary">
611 <span class="summary-type">&nbsp;</span>
612 </td><td class="summary">
613 <table width="100%" cellpadding="0" cellspacing="0" border="0">
614 <tr>
615 <td><span class="summary-sig"><a href="TestON.drivers.common.api.controller.onosrestdriver.OnosRestDriver-class.html#removeFlow" class="summary-sig-name">removeFlow</a>(<span class="summary-sig-arg">self</span>,
616 <span class="summary-sig-arg">deviceId</span>,
617 <span class="summary-sig-arg">flowId</span>,
618 <span class="summary-sig-arg">ip</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>,
619 <span class="summary-sig-arg">port</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>)</span><br />
620 Description:...</td>
621 <td align="right" valign="top">
622 <span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.removeFlow">source&nbsp;code</a></span>
623
624 </td>
625 </tr>
626 </table>
627
628 </td>
629 </tr>
630<tr>
631 <td width="15%" align="right" valign="top" class="summary">
632 <span class="summary-type">&nbsp;</span>
633 </td><td class="summary">
634 <table width="100%" cellpadding="0" cellspacing="0" border="0">
635 <tr>
636 <td><span class="summary-sig"><a href="TestON.drivers.common.api.controller.onosrestdriver.OnosRestDriver-class.html#checkFlowsState" class="summary-sig-name">checkFlowsState</a>(<span class="summary-sig-arg">self</span>,
637 <span class="summary-sig-arg">ip</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>,
638 <span class="summary-sig-arg">port</span>=<span class="summary-sig-default">&quot;DEFAULT&quot;</span>)</span><br />
639 Description:...</td>
640 <td align="right" valign="top">
641 <span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.checkFlowsState">source&nbsp;code</a></span>
642
643 </td>
644 </tr>
645 </table>
646
647 </td>
648 </tr>
649 <tr>
650 <td colspan="2" class="summary">
651 <p class="indent-wrapped-lines"><b>Inherited from <code>component.Component</code></b>:
652 <code>__getattr__</code>,
653 <code>cleanup</code>,
654 <code>close_log_handles</code>,
655 <code>config</code>,
656 <code>disconnect</code>,
657 <code>execute</code>,
658 <code>experimentRun</code>,
659 <code>get_version</code>,
660 <code>log</code>
661 </p>
662 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
663 <code>__delattr__</code>,
664 <code>__format__</code>,
665 <code>__getattribute__</code>,
666 <code>__hash__</code>,
667 <code>__new__</code>,
668 <code>__reduce__</code>,
669 <code>__reduce_ex__</code>,
670 <code>__repr__</code>,
671 <code>__setattr__</code>,
672 <code>__sizeof__</code>,
673 <code>__str__</code>,
674 <code>__subclasshook__</code>
675 </p>
676 </td>
677 </tr>
678</table>
679<!-- ==================== PROPERTIES ==================== -->
680<a name="section-Properties"></a>
681<table class="summary" border="1" cellpadding="3"
682 cellspacing="0" width="100%" bgcolor="white">
683<tr bgcolor="#70b0f0" class="table-header">
684 <td colspan="2" class="table-header">
685 <table border="0" cellpadding="0" cellspacing="0" width="100%">
686 <tr valign="top">
687 <td align="left"><span class="table-header">Properties</span></td>
688 <td align="right" valign="top"
689 ><span class="options">[<a href="#section-Properties"
690 class="privatelink" onclick="toggle_private();"
691 >hide private</a>]</span></td>
692 </tr>
693 </table>
694 </td>
695</tr>
696 <tr>
697 <td colspan="2" class="summary">
698 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
699 <code>__class__</code>
700 </p>
701 </td>
702 </tr>
703</table>
704<!-- ==================== METHOD DETAILS ==================== -->
705<a name="section-MethodDetails"></a>
706<table class="details" border="1" cellpadding="3"
707 cellspacing="0" width="100%" bgcolor="white">
708<tr bgcolor="#70b0f0" class="table-header">
709 <td colspan="2" class="table-header">
710 <table border="0" cellpadding="0" cellspacing="0" width="100%">
711 <tr valign="top">
712 <td align="left"><span class="table-header">Method Details</span></td>
713 <td align="right" valign="top"
714 ><span class="options">[<a href="#section-MethodDetails"
715 class="privatelink" onclick="toggle_private();"
716 >hide private</a>]</span></td>
717 </tr>
718 </table>
719 </td>
720</tr>
721</table>
722<a name="__init__"></a>
723<div>
724<table class="details" border="1" cellpadding="3"
725 cellspacing="0" width="100%" bgcolor="white">
726<tr><td>
727 <table width="100%" cellpadding="0" cellspacing="0" border="0">
728 <tr valign="top"><td>
729 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>)</span>
730 <br /><em class="fname">(Constructor)</em>
731 </h3>
732 </td><td align="right" valign="top"
733 ><span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.__init__">source&nbsp;code</a></span>&nbsp;
734 </td>
735 </tr></table>
736
737 <p>x.__init__(...) initializes x; see help(type(x)) for signature</p>
738 <dl class="fields">
739 <dt>Overrides:
740 object.__init__
741 <dd><em class="note">(inherited documentation)</em></dd>
742 </dt>
743 </dl>
744</td></tr></table>
745</div>
746<a name="connect"></a>
747<div>
748<table class="details" border="1" cellpadding="3"
749 cellspacing="0" width="100%" bgcolor="white">
750<tr><td>
751 <table width="100%" cellpadding="0" cellspacing="0" border="0">
752 <tr valign="top"><td>
753 <h3 class="epydoc"><span class="sig"><span class="sig-name">connect</span>(<span class="sig-arg">self</span>,
754 <span class="sig-arg">**connectargs</span>)</span>
755 </h3>
756 </td><td align="right" valign="top"
757 ><span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.connect">source&nbsp;code</a></span>&nbsp;
758 </td>
759 </tr></table>
760
761 <p>Connection will establish to the remote host using ssh. It will take
762 user_name ,ip_address and password as arguments&lt;br&gt; and will return
763 the handle.</p>
764 <dl class="fields">
765 <dt>Overrides:
766 component.Component.connect
767 </dt>
768 </dl>
769</td></tr></table>
770</div>
771<a name="send"></a>
772<div>
773<table class="details" border="1" cellpadding="3"
774 cellspacing="0" width="100%" bgcolor="white">
775<tr><td>
776 <table width="100%" cellpadding="0" cellspacing="0" border="0">
777 <tr valign="top"><td>
778 <h3 class="epydoc"><span class="sig"><span class="sig-name">send</span>(<span class="sig-arg">self</span>,
779 <span class="sig-arg">ip</span>,
780 <span class="sig-arg">port</span>,
781 <span class="sig-arg">url</span>,
782 <span class="sig-arg">base</span>=<span class="sig-default">&quot;/onos/v1&quot;</span>,
783 <span class="sig-arg">method</span>=<span class="sig-default">&quot;GET&quot;</span>,
784 <span class="sig-arg">query</span>=<span class="sig-default">None</span>,
785 <span class="sig-arg">data</span>=<span class="sig-default">None</span>)</span>
786 </h3>
787 </td><td align="right" valign="top"
788 ><span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.send">source&nbsp;code</a></span>&nbsp;
789 </td>
790 </tr></table>
791
792 <pre class="literalblock">
793
794Arguments:
795 str ip: ONOS IP Address
796 str port: ONOS REST Port
797 str url: ONOS REST url path.
798 NOTE that this is is only the relative path. IE &quot;/devices&quot;
799 str base: The base url for the given REST api. Applications could
800 potentially have their own base url
801 str method: HTTP method type
802 dict query: Dictionary to be sent in the query string for
803 the request
804 dict data: Dictionary to be sent in the body of the request
805
806</pre>
807 <dl class="fields">
808 </dl>
809</td></tr></table>
810</div>
811<a name="intents"></a>
812<div>
813<table class="details" border="1" cellpadding="3"
814 cellspacing="0" width="100%" bgcolor="white">
815<tr><td>
816 <table width="100%" cellpadding="0" cellspacing="0" border="0">
817 <tr valign="top"><td>
818 <h3 class="epydoc"><span class="sig"><span class="sig-name">intents</span>(<span class="sig-arg">self</span>,
819 <span class="sig-arg">ip</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>,
820 <span class="sig-arg">port</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>)</span>
821 </h3>
822 </td><td align="right" valign="top"
823 ><span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.intents">source&nbsp;code</a></span>&nbsp;
824 </td>
825 </tr></table>
826
827 <pre class="literalblock">
828
829Description:
830 Gets a list of dictionary of all intents in the system
831Returns:
832 A list of dictionary of intents in string type to match the cli
833 version for now; Returns main.FALSE if error on request;
834 Returns None for exception
835
836</pre>
837 <dl class="fields">
838 </dl>
839</td></tr></table>
840</div>
841<a name="intent"></a>
842<div>
843<table class="details" border="1" cellpadding="3"
844 cellspacing="0" width="100%" bgcolor="white">
845<tr><td>
846 <table width="100%" cellpadding="0" cellspacing="0" border="0">
847 <tr valign="top"><td>
848 <h3 class="epydoc"><span class="sig"><span class="sig-name">intent</span>(<span class="sig-arg">self</span>,
849 <span class="sig-arg">intentId</span>,
850 <span class="sig-arg">appId</span>=<span class="sig-default">&quot;org.onosproject.cli&quot;</span>,
851 <span class="sig-arg">ip</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>,
852 <span class="sig-arg">port</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>)</span>
853 </h3>
854 </td><td align="right" valign="top"
855 ><span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.intent">source&nbsp;code</a></span>&nbsp;
856 </td>
857 </tr></table>
858
859 <pre class="literalblock">
860
861Description:
862 Get the specific intent information of the given application ID and
863 intent ID
864Required:
865 str intentId - Intent id in hexadecimal form
866Optional:
867 str appId - application id of intent
868Returns:
869 Returns an information dictionary of the given intent;
870 Returns main.FALSE if error on requests; Returns None for exception
871NOTE:
872 The GET /intents REST api command accepts application id but the
873 api will get updated to accept application name instead
874
875</pre>
876 <dl class="fields">
877 </dl>
878</td></tr></table>
879</div>
880<a name="apps"></a>
881<div>
882<table class="details" border="1" cellpadding="3"
883 cellspacing="0" width="100%" bgcolor="white">
884<tr><td>
885 <table width="100%" cellpadding="0" cellspacing="0" border="0">
886 <tr valign="top"><td>
887 <h3 class="epydoc"><span class="sig"><span class="sig-name">apps</span>(<span class="sig-arg">self</span>,
888 <span class="sig-arg">ip</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>,
889 <span class="sig-arg">port</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>)</span>
890 </h3>
891 </td><td align="right" valign="top"
892 ><span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.apps">source&nbsp;code</a></span>&nbsp;
893 </td>
894 </tr></table>
895
896 <pre class="literalblock">
897
898Description:
899 Returns all the current application installed in the system
900Returns:
901 List of dictionary of installed application; Returns main.FALSE for
902 error on request; Returns None for exception
903
904</pre>
905 <dl class="fields">
906 </dl>
907</td></tr></table>
908</div>
909<a name="activateApp"></a>
910<div>
911<table class="details" border="1" cellpadding="3"
912 cellspacing="0" width="100%" bgcolor="white">
913<tr><td>
914 <table width="100%" cellpadding="0" cellspacing="0" border="0">
915 <tr valign="top"><td>
916 <h3 class="epydoc"><span class="sig"><span class="sig-name">activateApp</span>(<span class="sig-arg">self</span>,
917 <span class="sig-arg">appName</span>,
918 <span class="sig-arg">ip</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>,
919 <span class="sig-arg">port</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>,
920 <span class="sig-arg">check</span>=<span class="sig-default">True</span>)</span>
921 </h3>
922 </td><td align="right" valign="top"
923 ><span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.activateApp">source&nbsp;code</a></span>&nbsp;
924 </td>
925 </tr></table>
926
927 <pre class="literalblock">
928
929Decription:
930 Activate an app that is already installed in ONOS
931Optional:
932 bool check - If check is True, method will check the status
933 of the app after the command is issued
934Returns:
935 Returns main.TRUE if the command was successfully or main.FALSE
936 if the REST responded with an error or given incorrect input;
937 Returns None for exception
938
939</pre>
940 <dl class="fields">
941 </dl>
942</td></tr></table>
943</div>
944<a name="deactivateApp"></a>
945<div>
946<table class="details" border="1" cellpadding="3"
947 cellspacing="0" width="100%" bgcolor="white">
948<tr><td>
949 <table width="100%" cellpadding="0" cellspacing="0" border="0">
950 <tr valign="top"><td>
951 <h3 class="epydoc"><span class="sig"><span class="sig-name">deactivateApp</span>(<span class="sig-arg">self</span>,
952 <span class="sig-arg">appName</span>,
953 <span class="sig-arg">ip</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>,
954 <span class="sig-arg">port</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>,
955 <span class="sig-arg">check</span>=<span class="sig-default">True</span>)</span>
956 </h3>
957 </td><td align="right" valign="top"
958 ><span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.deactivateApp">source&nbsp;code</a></span>&nbsp;
959 </td>
960 </tr></table>
961
962 <pre class="literalblock">
963
964Required:
965 Deactivate an app that is already activated in ONOS
966Optional:
967 bool check - If check is True, method will check the status of the
968 app after the command is issued
969Returns:
970 Returns main.TRUE if the command was successfully sent
971 main.FALSE if the REST responded with an error or given
972 incorrect input; Returns None for exception
973
974</pre>
975 <dl class="fields">
976 </dl>
977</td></tr></table>
978</div>
979<a name="getApp"></a>
980<div>
981<table class="details" border="1" cellpadding="3"
982 cellspacing="0" width="100%" bgcolor="white">
983<tr><td>
984 <table width="100%" cellpadding="0" cellspacing="0" border="0">
985 <tr valign="top"><td>
986 <h3 class="epydoc"><span class="sig"><span class="sig-name">getApp</span>(<span class="sig-arg">self</span>,
987 <span class="sig-arg">appName</span>,
988 <span class="sig-arg">project</span>=<span class="sig-default">&quot;org.onosproject.&quot;</span>,
989 <span class="sig-arg">ip</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>,
990 <span class="sig-arg">port</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>)</span>
991 </h3>
992 </td><td align="right" valign="top"
993 ><span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.getApp">source&nbsp;code</a></span>&nbsp;
994 </td>
995 </tr></table>
996
997 <pre class="literalblock">
998
999Decription:
1000 Gets the informaion of the given application
1001Required:
1002 str name - Name of onos application
1003Returns:
1004 Returns a dictionary of information ONOS application in string type;
1005 Returns main.FALSE if error on requests; Returns None for exception
1006
1007</pre>
1008 <dl class="fields">
1009 </dl>
1010</td></tr></table>
1011</div>
1012<a name="addHostIntent"></a>
1013<div>
1014<table class="details" border="1" cellpadding="3"
1015 cellspacing="0" width="100%" bgcolor="white">
1016<tr><td>
1017 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1018 <tr valign="top"><td>
1019 <h3 class="epydoc"><span class="sig"><span class="sig-name">addHostIntent</span>(<span class="sig-arg">self</span>,
1020 <span class="sig-arg">hostIdOne</span>,
1021 <span class="sig-arg">hostIdTwo</span>,
1022 <span class="sig-arg">appId</span>=<span class="sig-default">'org.onosproject.cli'</span>,
1023 <span class="sig-arg">ip</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>,
1024 <span class="sig-arg">port</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>)</span>
1025 </h3>
1026 </td><td align="right" valign="top"
1027 ><span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.addHostIntent">source&nbsp;code</a></span>&nbsp;
1028 </td>
1029 </tr></table>
1030
1031 <pre class="literalblock">
1032
1033Description:
1034 Adds a host-to-host intent ( bidirectional ) by
1035 specifying the two hosts.
1036Required:
1037 * hostIdOne: ONOS host id for host1
1038 * hostIdTwo: ONOS host id for host2
1039Optional:
1040 str appId - Application name of intent identifier
1041Returns:
1042 Returns main.TRUE for successful requests; Returns main.FALSE if
1043 error on requests; Returns None for exceptions
1044
1045</pre>
1046 <dl class="fields">
1047 </dl>
1048</td></tr></table>
1049</div>
1050<a name="addPointIntent"></a>
1051<div>
1052<table class="details" border="1" cellpadding="3"
1053 cellspacing="0" width="100%" bgcolor="white">
1054<tr><td>
1055 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1056 <tr valign="top"><td>
1057 <h3 class="epydoc"><span class="sig"><span class="sig-name">addPointIntent</span>(<span class="sig-arg">self</span>,
1058 <span class="sig-arg">ingressDevice</span>,
1059 <span class="sig-arg">egressDevice</span>,
1060 <span class="sig-arg">appId</span>=<span class="sig-default">'org.onosproject.cli'</span>,
1061 <span class="sig-arg">ingressPort</span>=<span class="sig-default">&quot;&quot;</span>,
1062 <span class="sig-arg">egressPort</span>=<span class="sig-default">&quot;&quot;</span>,
1063 <span class="sig-arg">ethType</span>=<span class="sig-default">&quot;&quot;</span>,
1064 <span class="sig-arg">ethSrc</span>=<span class="sig-default">&quot;&quot;</span>,
1065 <span class="sig-arg">ethDst</span>=<span class="sig-default">&quot;&quot;</span>,
1066 <span class="sig-arg">bandwidth</span>=<span class="sig-default">&quot;&quot;</span>,
1067 <span class="sig-arg">lambdaAlloc</span>=<span class="sig-default">False</span>,
1068 <span class="sig-arg">ipProto</span>=<span class="sig-default">&quot;&quot;</span>,
1069 <span class="sig-arg">ipSrc</span>=<span class="sig-default">&quot;&quot;</span>,
1070 <span class="sig-arg">ipDst</span>=<span class="sig-default">&quot;&quot;</span>,
1071 <span class="sig-arg">tcpSrc</span>=<span class="sig-default">&quot;&quot;</span>,
1072 <span class="sig-arg">tcpDst</span>=<span class="sig-default">&quot;&quot;</span>,
1073 <span class="sig-arg">ip</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>,
1074 <span class="sig-arg">port</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>)</span>
1075 </h3>
1076 </td><td align="right" valign="top"
1077 ><span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.addPointIntent">source&nbsp;code</a></span>&nbsp;
1078 </td>
1079 </tr></table>
1080
1081 <pre class="literalblock">
1082
1083Description:
1084 Adds a point-to-point intent ( uni-directional ) by
1085 specifying device id's and optional fields
1086Required:
1087 * ingressDevice: device id of ingress device
1088 * egressDevice: device id of egress device
1089Optional:
1090 * ethType: specify ethType
1091 * ethSrc: specify ethSrc ( i.e. src mac addr )
1092 * ethDst: specify ethDst ( i.e. dst mac addr )
1093 * bandwidth: specify bandwidth capacity of link (TODO)
1094 * lambdaAlloc: if True, intent will allocate lambda
1095 for the specified intent (TODO)
1096 * ipProto: specify ip protocol
1097 * ipSrc: specify ip source address with mask eg. ip#/24
1098 * ipDst: specify ip destination address eg. ip#/24
1099 * tcpSrc: specify tcp source port
1100 * tcpDst: specify tcp destination port
1101Returns:
1102 Returns main.TRUE for successful requests; Returns main.FALSE if
1103 no ingress|egress port found and if error on requests;
1104 Returns None for exceptions
1105NOTE:
1106 The ip and port option are for the requests input's ip and port
1107 of the ONOS node
1108
1109</pre>
1110 <dl class="fields">
1111 </dl>
1112</td></tr></table>
1113</div>
1114<a name="removeAllIntents"></a>
1115<div>
1116<table class="details" border="1" cellpadding="3"
1117 cellspacing="0" width="100%" bgcolor="white">
1118<tr><td>
1119 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1120 <tr valign="top"><td>
1121 <h3 class="epydoc"><span class="sig"><span class="sig-name">removeAllIntents</span>(<span class="sig-arg">self</span>,
1122 <span class="sig-arg">intentIdList</span>=<span class="sig-default">'ALL'</span>,
1123 <span class="sig-arg">appId</span>=<span class="sig-default">'org.onosproject.cli'</span>,
1124 <span class="sig-arg">ip</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>,
1125 <span class="sig-arg">port</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>,
1126 <span class="sig-arg">delay</span>=<span class="sig-default">5</span>)</span>
1127 </h3>
1128 </td><td align="right" valign="top"
1129 ><span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.removeAllIntents">source&nbsp;code</a></span>&nbsp;
1130 </td>
1131 </tr></table>
1132
1133 <pre class="literalblock">
1134
1135Description:
1136 Remove all the intents
1137Returns:
1138 Returns main.TRUE if all intents are removed, otherwise returns
1139 main.FALSE; Returns None for exception
1140
1141</pre>
1142 <dl class="fields">
1143 </dl>
1144</td></tr></table>
1145</div>
1146<a name="hosts"></a>
1147<div>
1148<table class="details" border="1" cellpadding="3"
1149 cellspacing="0" width="100%" bgcolor="white">
1150<tr><td>
1151 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1152 <tr valign="top"><td>
1153 <h3 class="epydoc"><span class="sig"><span class="sig-name">hosts</span>(<span class="sig-arg">self</span>,
1154 <span class="sig-arg">ip</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>,
1155 <span class="sig-arg">port</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>)</span>
1156 </h3>
1157 </td><td align="right" valign="top"
1158 ><span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.hosts">source&nbsp;code</a></span>&nbsp;
1159 </td>
1160 </tr></table>
1161
1162 <pre class="literalblock">
1163
1164Description:
1165 Get a list of dictionary of all discovered hosts
1166Returns:
1167 Returns a list of dictionary of information of the hosts currently
1168 discovered by ONOS; Returns main.FALSE if error on requests;
1169 Returns None for exception
1170
1171</pre>
1172 <dl class="fields">
1173 </dl>
1174</td></tr></table>
1175</div>
1176<a name="getHost"></a>
1177<div>
1178<table class="details" border="1" cellpadding="3"
1179 cellspacing="0" width="100%" bgcolor="white">
1180<tr><td>
1181 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1182 <tr valign="top"><td>
1183 <h3 class="epydoc"><span class="sig"><span class="sig-name">getHost</span>(<span class="sig-arg">self</span>,
1184 <span class="sig-arg">mac</span>,
1185 <span class="sig-arg">vlan</span>=<span class="sig-default">&quot;-1&quot;</span>,
1186 <span class="sig-arg">ip</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>,
1187 <span class="sig-arg">port</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>)</span>
1188 </h3>
1189 </td><td align="right" valign="top"
1190 ><span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.getHost">source&nbsp;code</a></span>&nbsp;
1191 </td>
1192 </tr></table>
1193
1194 <pre class="literalblock">
1195
1196Description:
1197 Gets the information from the given host
1198Required:
1199 str mac - MAC address of the host
1200Optional:
1201 str vlan - VLAN tag of the host, defaults to -1
1202Returns:
1203 Return the host id from the hosts/mac/vlan output in REST api
1204 whose 'id' contains mac/vlan; Returns None for exception;
1205 Returns main.FALSE if error on requests
1206
1207NOTE:
1208 Not sure what this function should do, any suggestion?
1209
1210</pre>
1211 <dl class="fields">
1212 </dl>
1213</td></tr></table>
1214</div>
1215<a name="topology"></a>
1216<div>
1217<table class="details" border="1" cellpadding="3"
1218 cellspacing="0" width="100%" bgcolor="white">
1219<tr><td>
1220 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1221 <tr valign="top"><td>
1222 <h3 class="epydoc"><span class="sig"><span class="sig-name">topology</span>(<span class="sig-arg">self</span>,
1223 <span class="sig-arg">ip</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>,
1224 <span class="sig-arg">port</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>)</span>
1225 </h3>
1226 </td><td align="right" valign="top"
1227 ><span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.topology">source&nbsp;code</a></span>&nbsp;
1228 </td>
1229 </tr></table>
1230
1231 <pre class="literalblock">
1232
1233Description:
1234 Gets the overview of network topology
1235Returns:
1236 Returns a dictionary containing information about network topology;
1237 Returns None for exception
1238
1239</pre>
1240 <dl class="fields">
1241 </dl>
1242</td></tr></table>
1243</div>
1244<a name="getIntentState"></a>
1245<div>
1246<table class="details" border="1" cellpadding="3"
1247 cellspacing="0" width="100%" bgcolor="white">
1248<tr><td>
1249 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1250 <tr valign="top"><td>
1251 <h3 class="epydoc"><span class="sig"><span class="sig-name">getIntentState</span>(<span class="sig-arg">self</span>,
1252 <span class="sig-arg">intentsId</span>,
1253 <span class="sig-arg">intentsJson</span>=<span class="sig-default">None</span>,
1254 <span class="sig-arg">ip</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>,
1255 <span class="sig-arg">port</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>)</span>
1256 </h3>
1257 </td><td align="right" valign="top"
1258 ><span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.getIntentState">source&nbsp;code</a></span>&nbsp;
1259 </td>
1260 </tr></table>
1261
1262 <pre class="literalblock">
1263
1264Description:
1265 Get intent state.
1266 Accepts a single intent ID (string type) or a list of intent IDs.
1267 Returns the state(string type) of the id if a single intent ID is
1268 accepted.
1269Required:
1270 intentId: intent ID (string type)
1271 intentsJson: parsed json object from the onos:intents api
1272Returns:
1273 Returns a dictionary with intent IDs as the key and its
1274 corresponding states as the values; Returns None for invalid IDs or
1275 Type error and any exceptions
1276NOTE:
1277 An intent's state consist of INSTALLED,WITHDRAWN etc.
1278
1279</pre>
1280 <dl class="fields">
1281 </dl>
1282</td></tr></table>
1283</div>
1284<a name="checkIntentState"></a>
1285<div>
1286<table class="details" border="1" cellpadding="3"
1287 cellspacing="0" width="100%" bgcolor="white">
1288<tr><td>
1289 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1290 <tr valign="top"><td>
1291 <h3 class="epydoc"><span class="sig"><span class="sig-name">checkIntentState</span>(<span class="sig-arg">self</span>,
1292 <span class="sig-arg">intentsId</span>=<span class="sig-default">&quot;ALL&quot;</span>,
1293 <span class="sig-arg">expectedState</span>=<span class="sig-default">'INSTALLED'</span>,
1294 <span class="sig-arg">ip</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>,
1295 <span class="sig-arg">port</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>)</span>
1296 </h3>
1297 </td><td align="right" valign="top"
1298 ><span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.checkIntentState">source&nbsp;code</a></span>&nbsp;
1299 </td>
1300 </tr></table>
1301
1302 <pre class="literalblock">
1303
1304Description:
1305 Check intents state based on expected state which defaults to
1306 INSTALLED state
1307Required:
1308 intentsId - List of intents ID to be checked
1309Optional:
1310 expectedState - Check the expected state(s) of each intents
1311 state in the list.
1312 *NOTE: You can pass in a list of expected state,
1313 Eg: expectedState = [ 'INSTALLED' , 'INSTALLING' ]
1314Return:
1315 Returns main.TRUE only if all intent are the same as expected states
1316 , otherwise, returns main.FALSE; Returns None for general exception
1317
1318</pre>
1319 <dl class="fields">
1320 </dl>
1321</td></tr></table>
1322</div>
1323<a name="flows"></a>
1324<div>
1325<table class="details" border="1" cellpadding="3"
1326 cellspacing="0" width="100%" bgcolor="white">
1327<tr><td>
1328 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1329 <tr valign="top"><td>
1330 <h3 class="epydoc"><span class="sig"><span class="sig-name">flows</span>(<span class="sig-arg">self</span>,
1331 <span class="sig-arg">ip</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>,
1332 <span class="sig-arg">port</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>)</span>
1333 </h3>
1334 </td><td align="right" valign="top"
1335 ><span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.flows">source&nbsp;code</a></span>&nbsp;
1336 </td>
1337 </tr></table>
1338
1339 <pre class="literalblock">
1340
1341Description:
1342 Get flows currently added to the system
1343NOTE:
1344 The flows -j cli command has completely different format than
1345 the REST output; Returns None for exception
1346
1347</pre>
1348 <dl class="fields">
1349 </dl>
1350</td></tr></table>
1351</div>
1352<a name="getFlows"></a>
1353<div>
1354<table class="details" border="1" cellpadding="3"
1355 cellspacing="0" width="100%" bgcolor="white">
1356<tr><td>
1357 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1358 <tr valign="top"><td>
1359 <h3 class="epydoc"><span class="sig"><span class="sig-name">getFlows</span>(<span class="sig-arg">self</span>,
1360 <span class="sig-arg">device</span>,
1361 <span class="sig-arg">flowId</span>=<span class="sig-default">0</span>,
1362 <span class="sig-arg">ip</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>,
1363 <span class="sig-arg">port</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>)</span>
1364 </h3>
1365 </td><td align="right" valign="top"
1366 ><span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.getFlows">source&nbsp;code</a></span>&nbsp;
1367 </td>
1368 </tr></table>
1369
1370 <pre class="literalblock">
1371
1372Description:
1373 Gets all the flows of the device or get a specific flow in the
1374 device by giving its flow ID
1375Required:
1376 str device - device/switch Id
1377Optional:
1378 int/hex flowId - ID of the flow
1379
1380</pre>
1381 <dl class="fields">
1382 </dl>
1383</td></tr></table>
1384</div>
1385<a name="addFlow"></a>
1386<div>
1387<table class="details" border="1" cellpadding="3"
1388 cellspacing="0" width="100%" bgcolor="white">
1389<tr><td>
1390 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1391 <tr valign="top"><td>
1392 <h3 class="epydoc"><span class="sig"><span class="sig-name">addFlow</span>(<span class="sig-arg">self</span>,
1393 <span class="sig-arg">deviceId</span>,
1394 <span class="sig-arg">appId</span>=<span class="sig-default">0</span>,
1395 <span class="sig-arg">ingressPort</span>=<span class="sig-default">&quot;&quot;</span>,
1396 <span class="sig-arg">egressPort</span>=<span class="sig-default">&quot;&quot;</span>,
1397 <span class="sig-arg">ethType</span>=<span class="sig-default">&quot;&quot;</span>,
1398 <span class="sig-arg">ethSrc</span>=<span class="sig-default">&quot;&quot;</span>,
1399 <span class="sig-arg">ethDst</span>=<span class="sig-default">&quot;&quot;</span>,
1400 <span class="sig-arg">bandwidth</span>=<span class="sig-default">&quot;&quot;</span>,
1401 <span class="sig-arg">lambdaAlloc</span>=<span class="sig-default">False</span>,
1402 <span class="sig-arg">ipProto</span>=<span class="sig-default">&quot;&quot;</span>,
1403 <span class="sig-arg">ipSrc</span>=<span class="sig-default">&quot;&quot;</span>,
1404 <span class="sig-arg">ipDst</span>=<span class="sig-default">&quot;&quot;</span>,
1405 <span class="sig-arg">tcpSrc</span>=<span class="sig-default">&quot;&quot;</span>,
1406 <span class="sig-arg">tcpDst</span>=<span class="sig-default">&quot;&quot;</span>,
1407 <span class="sig-arg">ip</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>,
1408 <span class="sig-arg">port</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>)</span>
1409 </h3>
1410 </td><td align="right" valign="top"
1411 ><span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.addFlow">source&nbsp;code</a></span>&nbsp;
1412 </td>
1413 </tr></table>
1414
1415 <pre class="literalblock">
1416
1417Description:
1418 Creates a single flow in the specified device
1419Required:
1420 * deviceId: id of the device
1421Optional:
1422 * ingressPort: port ingress device
1423 * egressPort: port of egress device
1424 * ethType: specify ethType
1425 * ethSrc: specify ethSrc ( i.e. src mac addr )
1426 * ethDst: specify ethDst ( i.e. dst mac addr )
1427 * ipProto: specify ip protocol
1428 * ipSrc: specify ip source address with mask eg. ip#/24
1429 * ipDst: specify ip destination address eg. ip#/24
1430 * tcpSrc: specify tcp source port
1431 * tcpDst: specify tcp destination port
1432Returns:
1433 Returns main.TRUE for successful requests; Returns main.FALSE
1434 if error on requests;
1435 Returns None for exceptions
1436NOTE:
1437 The ip and port option are for the requests input's ip and port
1438 of the ONOS node
1439
1440</pre>
1441 <dl class="fields">
1442 </dl>
1443</td></tr></table>
1444</div>
1445<a name="removeFlow"></a>
1446<div>
1447<table class="details" border="1" cellpadding="3"
1448 cellspacing="0" width="100%" bgcolor="white">
1449<tr><td>
1450 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1451 <tr valign="top"><td>
1452 <h3 class="epydoc"><span class="sig"><span class="sig-name">removeFlow</span>(<span class="sig-arg">self</span>,
1453 <span class="sig-arg">deviceId</span>,
1454 <span class="sig-arg">flowId</span>,
1455 <span class="sig-arg">ip</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>,
1456 <span class="sig-arg">port</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>)</span>
1457 </h3>
1458 </td><td align="right" valign="top"
1459 ><span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.removeFlow">source&nbsp;code</a></span>&nbsp;
1460 </td>
1461 </tr></table>
1462
1463 <pre class="literalblock">
1464
1465Description:
1466 Remove specific device flow
1467Required:
1468 str deviceId - id of the device
1469 str flowId - id of the flow
1470Return:
1471 Returns main.TRUE if successfully deletes flows, otherwise
1472 Returns main.FALSE, Returns None on error
1473
1474</pre>
1475 <dl class="fields">
1476 </dl>
1477</td></tr></table>
1478</div>
1479<a name="checkFlowsState"></a>
1480<div>
1481<table class="details" border="1" cellpadding="3"
1482 cellspacing="0" width="100%" bgcolor="white">
1483<tr><td>
1484 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1485 <tr valign="top"><td>
1486 <h3 class="epydoc"><span class="sig"><span class="sig-name">checkFlowsState</span>(<span class="sig-arg">self</span>,
1487 <span class="sig-arg">ip</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>,
1488 <span class="sig-arg">port</span>=<span class="sig-default">&quot;DEFAULT&quot;</span>)</span>
1489 </h3>
1490 </td><td align="right" valign="top"
1491 ><span class="codelink"><a href="TestON.drivers.common.api.controller.onosrestdriver-pysrc.html#OnosRestDriver.checkFlowsState">source&nbsp;code</a></span>&nbsp;
1492 </td>
1493 </tr></table>
1494
1495 <pre class="literalblock">
1496
1497Description:
1498 Check if all the current flows are in ADDED state
1499Return:
1500 returnValue - Returns main.TRUE only if all flows are in
1501 return main.FALSE otherwise;
1502 Returns None for exception
1503
1504</pre>
1505 <dl class="fields">
1506 </dl>
1507</td></tr></table>
1508</div>
1509<br />
1510<!-- ==================== NAVIGATION BAR ==================== -->
1511<table class="navbar" border="0" width="100%" cellpadding="0"
1512 bgcolor="#a0c0ff" cellspacing="0">
1513 <tr valign="middle">
1514 <!-- Home link -->
1515 <th>&nbsp;&nbsp;&nbsp;<a
1516 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
1517
1518 <!-- Tree link -->
1519 <th>&nbsp;&nbsp;&nbsp;<a
1520 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
1521
1522 <!-- Index link -->
1523 <th>&nbsp;&nbsp;&nbsp;<a
1524 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
1525
1526 <!-- Help link -->
1527 <th>&nbsp;&nbsp;&nbsp;<a
1528 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
1529
1530 <!-- Project homepage -->
1531 <th class="navbar" align="right" width="100%">
1532 <table border="0" cellpadding="0" cellspacing="0">
1533 <tr><th class="navbar" align="center"
1534 >TestON</th>
1535 </tr></table></th>
1536 </tr>
1537</table>
1538<table border="0" cellpadding="0" cellspacing="0" width="100%%">
1539 <tr>
1540 <td align="left" class="footer">
1541 Generated by Epydoc 3.0.1 on Mon Aug 10 11:12:35 2015
1542 </td>
1543 <td align="right" class="footer">
1544 <a target="mainFrame" href="http://epydoc.sourceforge.net"
1545 >http://epydoc.sourceforge.net</a>
1546 </td>
1547 </tr>
1548</table>
1549
1550<script type="text/javascript">
1551 <!--
1552 // Private objects are initially displayed (because if
1553 // javascript is turned off then we want them to be
1554 // visible); but by default, we want to hide them. So hide
1555 // them unless we have a cookie that says to show them.
1556 checkCookie();
1557 // -->
1558</script>
1559</body>
1560</html>