Gitiles
Code Review Sign In
gerrit.onosproject.org / OnosSystemTest / 528ad29a6587182886a9b066412ece8faf3ec856 / . / TestON / Documentation / TestON_Document / TestON.drivers.common.cli.tool.dpctlclidriver.DpctlCliDriver-class.html
blob: cd188f17701a1c1747189fffe01265cdb207e37f [file] [log] [blame]
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]1<?xml version="1.0" encoding="ascii"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6 <title>TestON.drivers.common.cli.tool.dpctlclidriver.DpctlCliDriver</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
9</head>
10
11<body bgcolor="white" text="black" link="blue" vlink="#204080"
12 alink="#204080">
13<!-- ==================== NAVIGATION BAR ==================== -->
14<table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
16 <tr valign="middle">
17 <!-- Home link -->
18 <th>&nbsp;&nbsp;&nbsp;<a
19 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
20
21 <!-- Tree link -->
22 <th>&nbsp;&nbsp;&nbsp;<a
23 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
24
25 <!-- Index link -->
26 <th>&nbsp;&nbsp;&nbsp;<a
27 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28
29 <!-- Help link -->
30 <th>&nbsp;&nbsp;&nbsp;<a
31 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
32
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]33 <!-- Project homepage -->
34 <th class="navbar" align="right" width="100%">
35 <table border="0" cellpadding="0" cellspacing="0">
36 <tr><th class="navbar" align="center"
37 >TestON</th>
38 </tr></table></th>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]39 </tr>
40</table>
41<table width="100%" cellpadding="0" cellspacing="0">
42 <tr valign="top">
43 <td width="100%">
44 <span class="breadcrumbs">
45 <a href="TestON-module.html">Package&nbsp;TestON</a> ::
46 <a href="TestON.drivers-module.html">Package&nbsp;drivers</a> ::
47 <a href="TestON.drivers.common-module.html">Package&nbsp;common</a> ::
48 <a href="TestON.drivers.common.cli-module.html">Package&nbsp;cli</a> ::
49 <a href="TestON.drivers.common.cli.tool-module.html">Package&nbsp;tool</a> ::
50 <a href="TestON.drivers.common.cli.tool.dpctlclidriver-module.html">Module&nbsp;dpctlclidriver</a> ::
51 Class&nbsp;DpctlCliDriver
52 </span>
53 </td>
54 <td>
55 <table cellpadding="0" cellspacing="0">
56 <!-- hide/show private -->
57 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
58 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
59 <tr><td align="right"><span class="options"
60 >[<a href="frames.html" target="_top">frames</a
61 >]&nbsp;|&nbsp;<a href="TestON.drivers.common.cli.tool.dpctlclidriver.DpctlCliDriver-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 DpctlCliDriver</h1><p class="nomargin-top"><span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver">source&nbsp;code</a></span></p>
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]69<center>
70<center> <map id="class_hierarchy_for_dpctlclidr" name="class_hierarchy_for_dpctlclidr">
71<area shape="rect" id="node1" href="TestON.drivers.common.cli.tool.dpctlclidriver.DpctlCliDriver-class.html" title="DpctlCliDriver" alt="" coords="5,6,109,31"/>
72<area shape="rect" id="node2" href="TestON.drivers.common.cli.toolsdriver.Tools-class.html" title="toolsdriver.Tools" alt="" coords="134,6,252,31"/>
73<area shape="rect" id="node3" href="TestON.drivers.common.clidriver.CLI-class.html" title="clidriver.CLI" alt="" coords="277,6,368,31"/>
74<area shape="rect" id="node4" href="javascript:void(0);" title="component.Component" alt="" coords="393,6,551,31"/>
75</map>
76 <img src="class_hierarchy_for_dpctlclidr.gif" alt='' usemap="#class_hierarchy_for_dpctlclidr" ismap="ismap" class="graph-without-title" />
77</center>
78</center>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]79<hr />
80<p>DpctlCliDriver driver class provides the basic functions of DPCTL
81 controller</p>
82
83<!-- ==================== INSTANCE METHODS ==================== -->
84<a name="section-InstanceMethods"></a>
85<table class="summary" border="1" cellpadding="3"
86 cellspacing="0" width="100%" bgcolor="white">
87<tr bgcolor="#70b0f0" class="table-header">
88 <td colspan="2" class="table-header">
89 <table border="0" cellpadding="0" cellspacing="0" width="100%">
90 <tr valign="top">
91 <td align="left"><span class="table-header">Instance Methods</span></td>
92 <td align="right" valign="top"
93 ><span class="options">[<a href="#section-InstanceMethods"
94 class="privatelink" onclick="toggle_private();"
95 >hide private</a>]</span></td>
96 </tr>
97 </table>
98 </td>
99</tr>
100<tr>
101 <td width="15%" align="right" valign="top" class="summary">
102 <span class="summary-type">&nbsp;</span>
103 </td><td class="summary">
104 <table width="100%" cellpadding="0" cellspacing="0" border="0">
105 <tr>
106 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.tool.dpctlclidriver.DpctlCliDriver-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>)</span><br />
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]107 x.__init__(...) initializes x; see help(type(x)) for signature</td>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]108 <td align="right" valign="top">
109 <span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.__init__">source&nbsp;code</a></span>
110
111 </td>
112 </tr>
113 </table>
114
115 </td>
116 </tr>
117<tr>
118 <td width="15%" align="right" valign="top" class="summary">
119 <span class="summary-type">&nbsp;</span>
120 </td><td class="summary">
121 <table width="100%" cellpadding="0" cellspacing="0" border="0">
122 <tr>
123 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.tool.dpctlclidriver.DpctlCliDriver-class.html#connect" class="summary-sig-name">connect</a>(<span class="summary-sig-arg">self</span>,
124 <span class="summary-sig-arg">**connectargs</span>)</span><br />
125 Connection will establish to the remote host using ssh.</td>
126 <td align="right" valign="top">
127 <span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.connect">source&nbsp;code</a></span>
128
129 </td>
130 </tr>
131 </table>
132
133 </td>
134 </tr>
135<tr>
136 <td width="15%" align="right" valign="top" class="summary">
137 <span class="summary-type">&nbsp;</span>
138 </td><td class="summary">
139 <table width="100%" cellpadding="0" cellspacing="0" border="0">
140 <tr>
141 <td><span class="summary-sig"><a name="addFlow"></a><span class="summary-sig-name">addFlow</span>(<span class="summary-sig-arg">self</span>,
142 <span class="summary-sig-arg">**flowParameters</span>)</span><br />
143 addFlow create a new flow entry into flow table using
144 &quot;dpctl&quot;</td>
145 <td align="right" valign="top">
146 <span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.addFlow">source&nbsp;code</a></span>
147
148 </td>
149 </tr>
150 </table>
151
152 </td>
153 </tr>
154<tr>
155 <td width="15%" align="right" valign="top" class="summary">
156 <span class="summary-type">&nbsp;</span>
157 </td><td class="summary">
158 <table width="100%" cellpadding="0" cellspacing="0" border="0">
159 <tr>
160 <td><span class="summary-sig"><a name="showFlow"></a><span class="summary-sig-name">showFlow</span>(<span class="summary-sig-arg">self</span>,
161 <span class="summary-sig-arg">**flowParameters</span>)</span><br />
162 showFlow dumps the flow entries of flow table using &quot;dpctl&quot;</td>
163 <td align="right" valign="top">
164 <span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.showFlow">source&nbsp;code</a></span>
165
166 </td>
167 </tr>
168 </table>
169
170 </td>
171 </tr>
172<tr>
173 <td width="15%" align="right" valign="top" class="summary">
174 <span class="summary-type">&nbsp;</span>
175 </td><td class="summary">
176 <table width="100%" cellpadding="0" cellspacing="0" border="0">
177 <tr>
178 <td><span class="summary-sig"><a name="dumpFlow"></a><span class="summary-sig-name">dumpFlow</span>(<span class="summary-sig-arg">self</span>,
179 <span class="summary-sig-arg">**flowParameters</span>)</span><br />
180 dumpFlow gives installed flow information</td>
181 <td align="right" valign="top">
182 <span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.dumpFlow">source&nbsp;code</a></span>
183
184 </td>
185 </tr>
186 </table>
187
188 </td>
189 </tr>
190<tr>
191 <td width="15%" align="right" valign="top" class="summary">
192 <span class="summary-type">&nbsp;</span>
193 </td><td class="summary">
194 <table width="100%" cellpadding="0" cellspacing="0" border="0">
195 <tr>
196 <td><span class="summary-sig"><a name="dumpTables"></a><span class="summary-sig-name">dumpTables</span>(<span class="summary-sig-arg">self</span>,
197 <span class="summary-sig-arg">**flowParameters</span>)</span><br />
198 dumpTables gives statistics for each of the flow tables used by
199 datapath switch.</td>
200 <td align="right" valign="top">
201 <span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.dumpTables">source&nbsp;code</a></span>
202
203 </td>
204 </tr>
205 </table>
206
207 </td>
208 </tr>
209<tr>
210 <td width="15%" align="right" valign="top" class="summary">
211 <span class="summary-type">&nbsp;</span>
212 </td><td class="summary">
213 <table width="100%" cellpadding="0" cellspacing="0" border="0">
214 <tr>
215 <td><span class="summary-sig"><a name="dumpPorts"></a><span class="summary-sig-name">dumpPorts</span>(<span class="summary-sig-arg">self</span>,
216 <span class="summary-sig-arg">**flowParameters</span>)</span><br />
217 dumpPorts gives ports information</td>
218 <td align="right" valign="top">
219 <span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.dumpPorts">source&nbsp;code</a></span>
220
221 </td>
222 </tr>
223 </table>
224
225 </td>
226 </tr>
227<tr>
228 <td width="15%" align="right" valign="top" class="summary">
229 <span class="summary-type">&nbsp;</span>
230 </td><td class="summary">
231 <table width="100%" cellpadding="0" cellspacing="0" border="0">
232 <tr>
233 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.tool.dpctlclidriver.DpctlCliDriver-class.html#dumpAggregate" class="summary-sig-name">dumpAggregate</a>(<span class="summary-sig-arg">self</span>,
234 <span class="summary-sig-arg">**flowParameters</span>)</span><br />
235 dumpAggregate gives installed flow information.ggregate statistics
236 for flows in datapath WITCH's tables that match flows.</td>
237 <td align="right" valign="top">
238 <span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.dumpAggregate">source&nbsp;code</a></span>
239
240 </td>
241 </tr>
242 </table>
243
244 </td>
245 </tr>
246<tr>
247 <td width="15%" align="right" valign="top" class="summary">
248 <span class="summary-type">&nbsp;</span>
249 </td><td class="summary">
250 <table width="100%" cellpadding="0" cellspacing="0" border="0">
251 <tr>
252 <td><span class="summary-sig"><a name="delFlow"></a><span class="summary-sig-name">delFlow</span>(<span class="summary-sig-arg">self</span>,
253 <span class="summary-sig-arg">**flowParameters</span>)</span><br />
254 delFlow Deletes entries from the datapath switch's tables that match
255 flow</td>
256 <td align="right" valign="top">
257 <span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.delFlow">source&nbsp;code</a></span>
258
259 </td>
260 </tr>
261 </table>
262
263 </td>
264 </tr>
265<tr>
266 <td width="15%" align="right" valign="top" class="summary">
267 <span class="summary-type">&nbsp;</span>
268 </td><td class="summary">
269 <table width="100%" cellpadding="0" cellspacing="0" border="0">
270 <tr>
271 <td><span class="summary-sig"><a name="show"></a><span class="summary-sig-name">show</span>(<span class="summary-sig-arg">self</span>,
272 <span class="summary-sig-arg">**flowParameters</span>)</span><br />
273 show gives information on datapath switch including information on
274 its flow tables and ports.</td>
275 <td align="right" valign="top">
276 <span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.show">source&nbsp;code</a></span>
277
278 </td>
279 </tr>
280 </table>
281
282 </td>
283 </tr>
284<tr>
285 <td width="15%" align="right" valign="top" class="summary">
286 <span class="summary-type">&nbsp;</span>
287 </td><td class="summary">
288 <table width="100%" cellpadding="0" cellspacing="0" border="0">
289 <tr>
290 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.tool.dpctlclidriver.DpctlCliDriver-class.html#showStatus" class="summary-sig-name">showStatus</a>(<span class="summary-sig-arg">self</span>,
291 <span class="summary-sig-arg">**flowParameters</span>)</span><br />
292 showStatus gives a series of key-value pairs that report the status
293 of switch.</td>
294 <td align="right" valign="top">
295 <span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.showStatus">source&nbsp;code</a></span>
296
297 </td>
298 </tr>
299 </table>
300
301 </td>
302 </tr>
303<tr>
304 <td width="15%" align="right" valign="top" class="summary">
305 <span class="summary-type">&nbsp;</span>
306 </td><td class="summary">
307 <table width="100%" cellpadding="0" cellspacing="0" border="0">
308 <tr>
309 <td><span class="summary-sig"><a name="desc_set"></a><span class="summary-sig-name">desc_set</span>(<span class="summary-sig-arg">self</span>,
310 <span class="summary-sig-arg">**flowParameters</span>)</span><br />
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]311 desc_set Sets the switch description ( as returned in ofp_desc_stats
312 ) to string ( max length is DESC_STR_LEN )</td>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]313 <td align="right" valign="top">
314 <span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.desc_set">source&nbsp;code</a></span>
315
316 </td>
317 </tr>
318 </table>
319
320 </td>
321 </tr>
322<tr>
323 <td width="15%" align="right" valign="top" class="summary">
324 <span class="summary-type">&nbsp;</span>
325 </td><td class="summary">
326 <table width="100%" cellpadding="0" cellspacing="0" border="0">
327 <tr>
328 <td><span class="summary-sig"><a name="dumpDesc"></a><span class="summary-sig-name">dumpDesc</span>(<span class="summary-sig-arg">self</span>,
329 <span class="summary-sig-arg">**flowParameters</span>)</span><br />
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]330 dumpDesc Sets the switch description ( as returned in ofp_desc_stats
331 ) to string ( max length is DESC_STR_LEN )</td>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]332 <td align="right" valign="top">
333 <span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.dumpDesc">source&nbsp;code</a></span>
334
335 </td>
336 </tr>
337 </table>
338
339 </td>
340 </tr>
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]341<tr>
342 <td width="15%" align="right" valign="top" class="summary">
343 <span class="summary-type">&nbsp;</span>
344 </td><td class="summary">
345 <table width="100%" cellpadding="0" cellspacing="0" border="0">
346 <tr>
347 <td><span class="summary-sig"><a href="TestON.drivers.common.clidriver.CLI-class.html#disconnect" class="summary-sig-name">disconnect</a>(<span class="summary-sig-arg">self</span>)</span>
348 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
349 <td align="right" valign="top">
350 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.disconnect">source&nbsp;code</a></span>
351
352 </td>
353 </tr>
354 </table>
355
356 </td>
357 </tr>
358<tr>
359 <td width="15%" align="right" valign="top" class="summary">
360 <span class="summary-type">&nbsp;</span>
361 </td><td class="summary">
362 <table width="100%" cellpadding="0" cellspacing="0" border="0">
363 <tr>
364 <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>,
365 <span class="summary-sig-arg">**execparams</span>)</span><br />
366 It facilitates the command line execution of a given command.
367 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
368 <td align="right" valign="top">
369 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.execute">source&nbsp;code</a></span>
370
371 </td>
372 </tr>
373 </table>
374
375 </td>
376 </tr>
377<tr>
378 <td width="15%" align="right" valign="top" class="summary">
379 <span class="summary-type">&nbsp;</span>
380 </td><td class="summary">
381 <table width="100%" cellpadding="0" cellspacing="0" border="0">
382 <tr>
383 <td><span class="summary-sig"><a name="onfail"></a><span class="summary-sig-name">onfail</span>(<span class="summary-sig-arg">self</span>)</span>
384 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
385 <td align="right" valign="top">
386 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.onfail">source&nbsp;code</a></span>
387
388 </td>
389 </tr>
390 </table>
391
392 </td>
393 </tr>
394<tr>
395 <td width="15%" align="right" valign="top" class="summary">
396 <span class="summary-type">&nbsp;</span>
397 </td><td class="summary">
398 <table width="100%" cellpadding="0" cellspacing="0" border="0">
399 <tr>
400 <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>,
401 <span class="summary-sig-arg">response</span>)</span>
402 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
403 <td align="right" valign="top">
404 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.remove_contol_chars">source&nbsp;code</a></span>
405
406 </td>
407 </tr>
408 </table>
409
410 </td>
411 </tr>
412<tr>
413 <td width="15%" align="right" valign="top" class="summary">
414 <span class="summary-type">&nbsp;</span>
415 </td><td class="summary">
416 <table width="100%" cellpadding="0" cellspacing="0" border="0">
417 <tr>
418 <td><span class="summary-sig"><a name="runAsSudoUser"></a><span class="summary-sig-name">runAsSudoUser</span>(<span class="summary-sig-arg">self</span>,
419 <span class="summary-sig-arg">handle</span>,
420 <span class="summary-sig-arg">pwd</span>,
421 <span class="summary-sig-arg">default</span>)</span>
422 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
423 <td align="right" valign="top">
424 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.runAsSudoUser">source&nbsp;code</a></span>
425
426 </td>
427 </tr>
428 </table>
429
430 </td>
431 </tr>
432<tr>
433 <td width="15%" align="right" valign="top" class="summary">
434 <span class="summary-type">&nbsp;</span>
435 </td><td class="summary">
436 <table width="100%" cellpadding="0" cellspacing="0" border="0">
437 <tr>
438 <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>,
439 <span class="summary-sig-arg">user_name</span>,
440 <span class="summary-sig-arg">ip_address</span>,
441 <span class="summary-sig-arg">filepath</span>,
442 <span class="summary-sig-arg">pwd</span>,
443 <span class="summary-sig-arg">dst_path</span>)</span><br />
444 Connection will establish to the remote host using ssh.
445 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
446 <td align="right" valign="top">
447 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.secureCopy">source&nbsp;code</a></span>
448
449 </td>
450 </tr>
451 </table>
452
453 </td>
454 </tr>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]455 <tr>
456 <td colspan="2" class="summary">
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]457 <p class="indent-wrapped-lines"><b>Inherited from <code>component.Component</code></b>:
458 <code>__getattr__</code>,
459 <code>cleanup</code>,
460 <code>close_log_handles</code>,
461 <code>config</code>,
462 <code>experimentRun</code>,
463 <code>get_version</code>,
464 <code>log</code>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]465 </p>
466 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
467 <code>__delattr__</code>,
468 <code>__format__</code>,
469 <code>__getattribute__</code>,
470 <code>__hash__</code>,
471 <code>__new__</code>,
472 <code>__reduce__</code>,
473 <code>__reduce_ex__</code>,
474 <code>__repr__</code>,
475 <code>__setattr__</code>,
476 <code>__sizeof__</code>,
477 <code>__str__</code>,
478 <code>__subclasshook__</code>
479 </p>
480 </td>
481 </tr>
482</table>
483<!-- ==================== PROPERTIES ==================== -->
484<a name="section-Properties"></a>
485<table class="summary" border="1" cellpadding="3"
486 cellspacing="0" width="100%" bgcolor="white">
487<tr bgcolor="#70b0f0" class="table-header">
488 <td colspan="2" class="table-header">
489 <table border="0" cellpadding="0" cellspacing="0" width="100%">
490 <tr valign="top">
491 <td align="left"><span class="table-header">Properties</span></td>
492 <td align="right" valign="top"
493 ><span class="options">[<a href="#section-Properties"
494 class="privatelink" onclick="toggle_private();"
495 >hide private</a>]</span></td>
496 </tr>
497 </table>
498 </td>
499</tr>
500 <tr>
501 <td colspan="2" class="summary">
502 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
503 <code>__class__</code>
504 </p>
505 </td>
506 </tr>
507</table>
508<!-- ==================== METHOD DETAILS ==================== -->
509<a name="section-MethodDetails"></a>
510<table class="details" border="1" cellpadding="3"
511 cellspacing="0" width="100%" bgcolor="white">
512<tr bgcolor="#70b0f0" class="table-header">
513 <td colspan="2" class="table-header">
514 <table border="0" cellpadding="0" cellspacing="0" width="100%">
515 <tr valign="top">
516 <td align="left"><span class="table-header">Method Details</span></td>
517 <td align="right" valign="top"
518 ><span class="options">[<a href="#section-MethodDetails"
519 class="privatelink" onclick="toggle_private();"
520 >hide private</a>]</span></td>
521 </tr>
522 </table>
523 </td>
524</tr>
525</table>
526<a name="__init__"></a>
527<div>
528<table class="details" border="1" cellpadding="3"
529 cellspacing="0" width="100%" bgcolor="white">
530<tr><td>
531 <table width="100%" cellpadding="0" cellspacing="0" border="0">
532 <tr valign="top"><td>
533 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>)</span>
534 <br /><em class="fname">(Constructor)</em>
535 </h3>
536 </td><td align="right" valign="top"
537 ><span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.__init__">source&nbsp;code</a></span>&nbsp;
538 </td>
539 </tr></table>
540
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]541 <p>x.__init__(...) initializes x; see help(type(x)) for signature</p>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]542 <dl class="fields">
543 <dt>Overrides:
544 object.__init__
545 <dd><em class="note">(inherited documentation)</em></dd>
546 </dt>
547 </dl>
548</td></tr></table>
549</div>
550<a name="connect"></a>
551<div>
552<table class="details" border="1" cellpadding="3"
553 cellspacing="0" width="100%" bgcolor="white">
554<tr><td>
555 <table width="100%" cellpadding="0" cellspacing="0" border="0">
556 <tr valign="top"><td>
557 <h3 class="epydoc"><span class="sig"><span class="sig-name">connect</span>(<span class="sig-arg">self</span>,
558 <span class="sig-arg">**connectargs</span>)</span>
559 </h3>
560 </td><td align="right" valign="top"
561 ><span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.connect">source&nbsp;code</a></span>&nbsp;
562 </td>
563 </tr></table>
564
565 <p>Connection will establish to the remote host using ssh. It will take
566 user_name ,ip_address and password as arguments&lt;br&gt; and will return
567 the handle.</p>
568 <dl class="fields">
569 <dt>Overrides:
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]570 component.Component.connect
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]571 </dt>
572 </dl>
573</td></tr></table>
574</div>
575<a name="dumpAggregate"></a>
576<div>
577<table class="details" border="1" cellpadding="3"
578 cellspacing="0" width="100%" bgcolor="white">
579<tr><td>
580 <table width="100%" cellpadding="0" cellspacing="0" border="0">
581 <tr valign="top"><td>
582 <h3 class="epydoc"><span class="sig"><span class="sig-name">dumpAggregate</span>(<span class="sig-arg">self</span>,
583 <span class="sig-arg">**flowParameters</span>)</span>
584 </h3>
585 </td><td align="right" valign="top"
586 ><span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.dumpAggregate">source&nbsp;code</a></span>&nbsp;
587 </td>
588 </tr></table>
589
590 <p>dumpAggregate gives installed flow information.ggregate statistics
591 for flows in datapath WITCH's tables that match flows. If flows is
592 omitted, the statistics are aggregated across all flows in the datapath's
593 flow tables</p>
594 <dl class="fields">
595 </dl>
596</td></tr></table>
597</div>
598<a name="showStatus"></a>
599<div>
600<table class="details" border="1" cellpadding="3"
601 cellspacing="0" width="100%" bgcolor="white">
602<tr><td>
603 <table width="100%" cellpadding="0" cellspacing="0" border="0">
604 <tr valign="top"><td>
605 <h3 class="epydoc"><span class="sig"><span class="sig-name">showStatus</span>(<span class="sig-arg">self</span>,
606 <span class="sig-arg">**flowParameters</span>)</span>
607 </h3>
608 </td><td align="right" valign="top"
609 ><span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.showStatus">source&nbsp;code</a></span>&nbsp;
610 </td>
611 </tr></table>
612
613 <p>showStatus gives a series of key-value pairs that report the status of
614 switch. If key is specified, only the key-value pairs whose key names
615 begin with key are printed.</p>
616 <dl class="fields">
617 </dl>
618</td></tr></table>
619</div>
620<br />
621<!-- ==================== NAVIGATION BAR ==================== -->
622<table class="navbar" border="0" width="100%" cellpadding="0"
623 bgcolor="#a0c0ff" cellspacing="0">
624 <tr valign="middle">
625 <!-- Home link -->
626 <th>&nbsp;&nbsp;&nbsp;<a
627 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
628
629 <!-- Tree link -->
630 <th>&nbsp;&nbsp;&nbsp;<a
631 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
632
633 <!-- Index link -->
634 <th>&nbsp;&nbsp;&nbsp;<a
635 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
636
637 <!-- Help link -->
638 <th>&nbsp;&nbsp;&nbsp;<a
639 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
640
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]641 <!-- Project homepage -->
642 <th class="navbar" align="right" width="100%">
643 <table border="0" cellpadding="0" cellspacing="0">
644 <tr><th class="navbar" align="center"
645 >TestON</th>
646 </tr></table></th>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]647 </tr>
648</table>
649<table border="0" cellpadding="0" cellspacing="0" width="100%%">
650 <tr>
651 <td align="left" class="footer">
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]652 Generated by Epydoc 3.0.1 on Mon Aug 10 11:12:35 2015
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]653 </td>
654 <td align="right" class="footer">
655 <a target="mainFrame" href="http://epydoc.sourceforge.net"
656 >http://epydoc.sourceforge.net</a>
657 </td>
658 </tr>
659</table>
660
661<script type="text/javascript">
662 <!--
663 // Private objects are initially displayed (because if
664 // javascript is turned off then we want them to be
665 // visible); but by default, we want to hide them. So hide
666 // them unless we have a cookie that says to show them.
667 checkCookie();
668 // -->
669</script>
670</body>
671</html>