blob: 488311cd255379313e74f9ee054ec6b01f1ae188 [file] [log] [blame]
Jon Halla1cdd892015-08-10 13:36:28 -07001<?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.quaggaclidriver.QuaggaCliDriver</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
9</head>
10
11<body bgcolor="white" text="black" link="blue" vlink="#204080"
12 alink="#204080">
13<!-- ==================== NAVIGATION BAR ==================== -->
14<table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
16 <tr valign="middle">
17 <!-- Home link -->
18 <th>&nbsp;&nbsp;&nbsp;<a
19 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
20
21 <!-- Tree link -->
22 <th>&nbsp;&nbsp;&nbsp;<a
23 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
24
25 <!-- Index link -->
26 <th>&nbsp;&nbsp;&nbsp;<a
27 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28
29 <!-- Help link -->
30 <th>&nbsp;&nbsp;&nbsp;<a
31 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
32
33 <!-- Project homepage -->
34 <th class="navbar" align="right" width="100%">
35 <table border="0" cellpadding="0" cellspacing="0">
36 <tr><th class="navbar" align="center"
37 >TestON</th>
38 </tr></table></th>
39 </tr>
40</table>
41<table width="100%" cellpadding="0" cellspacing="0">
42 <tr valign="top">
43 <td width="100%">
44 <span class="breadcrumbs">
45 <a href="TestON-module.html">Package&nbsp;TestON</a> ::
46 <a href="TestON.drivers-module.html">Package&nbsp;drivers</a> ::
47 <a href="TestON.drivers.common-module.html">Package&nbsp;common</a> ::
48 <a href="TestON.drivers.common.cli-module.html">Package&nbsp;cli</a> ::
49 <a href="TestON.drivers.common.cli.quaggaclidriver-module.html">Module&nbsp;quaggaclidriver</a> ::
50 Class&nbsp;QuaggaCliDriver
51 </span>
52 </td>
53 <td>
54 <table cellpadding="0" cellspacing="0">
55 <!-- hide/show private -->
56 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
57 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
58 <tr><td align="right"><span class="options"
59 >[<a href="frames.html" target="_top">frames</a
60 >]&nbsp;|&nbsp;<a href="TestON.drivers.common.cli.quaggaclidriver.QuaggaCliDriver-class.html"
61 target="_top">no&nbsp;frames</a>]</span></td></tr>
62 </table>
63 </td>
64 </tr>
65</table>
66<!-- ==================== CLASS DESCRIPTION ==================== -->
67<h1 class="epydoc">Class QuaggaCliDriver</h1><p class="nomargin-top"><span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver">source&nbsp;code</a></span></p>
68<center>
69<center> <map id="class_hierarchy_for_quaggaclid" name="class_hierarchy_for_quaggaclid">
70<area shape="rect" id="node1" href="TestON.drivers.common.cli.quaggaclidriver.QuaggaCliDriver-class.html" title="QuaggaCliDriver" alt="" coords="5,6,123,31"/>
71<area shape="rect" id="node2" href="TestON.drivers.common.clidriver.CLI-class.html" title="clidriver.CLI" alt="" coords="147,6,239,31"/>
72<area shape="rect" id="node3" href="javascript:void(0);" title="component.Component" alt="" coords="264,6,421,31"/>
73</map>
74 <img src="class_hierarchy_for_quaggaclid.gif" alt='' usemap="#class_hierarchy_for_quaggaclid" ismap="ismap" class="graph-without-title" />
75</center>
76</center>
77<hr />
78<!-- ==================== INSTANCE METHODS ==================== -->
79<a name="section-InstanceMethods"></a>
80<table class="summary" border="1" cellpadding="3"
81 cellspacing="0" width="100%" bgcolor="white">
82<tr bgcolor="#70b0f0" class="table-header">
83 <td colspan="2" class="table-header">
84 <table border="0" cellpadding="0" cellspacing="0" width="100%">
85 <tr valign="top">
86 <td align="left"><span class="table-header">Instance Methods</span></td>
87 <td align="right" valign="top"
88 ><span class="options">[<a href="#section-InstanceMethods"
89 class="privatelink" onclick="toggle_private();"
90 >hide private</a>]</span></td>
91 </tr>
92 </table>
93 </td>
94</tr>
95<tr>
96 <td width="15%" align="right" valign="top" class="summary">
97 <span class="summary-type">&nbsp;</span>
98 </td><td class="summary">
99 <table width="100%" cellpadding="0" cellspacing="0" border="0">
100 <tr>
101 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.quaggaclidriver.QuaggaCliDriver-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>)</span><br />
102 x.__init__(...) initializes x; see help(type(x)) for signature</td>
103 <td align="right" valign="top">
104 <span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.__init__">source&nbsp;code</a></span>
105
106 </td>
107 </tr>
108 </table>
109
110 </td>
111 </tr>
112<tr>
113 <td width="15%" align="right" valign="top" class="summary">
114 <span class="summary-type">&nbsp;</span>
115 </td><td class="summary">
116 <table width="100%" cellpadding="0" cellspacing="0" border="0">
117 <tr>
118 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.quaggaclidriver.QuaggaCliDriver-class.html#connect" class="summary-sig-name">connect</a>(<span class="summary-sig-arg">self</span>,
119 <span class="summary-sig-arg">**connectargs</span>)</span><br />
120 Connection will establish to the remote host using ssh.</td>
121 <td align="right" valign="top">
122 <span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.connect">source&nbsp;code</a></span>
123
124 </td>
125 </tr>
126 </table>
127
128 </td>
129 </tr>
130<tr>
131 <td width="15%" align="right" valign="top" class="summary">
132 <span class="summary-type">&nbsp;</span>
133 </td><td class="summary">
134 <table width="100%" cellpadding="0" cellspacing="0" border="0">
135 <tr>
136 <td><span class="summary-sig"><a name="connectQuagga"></a><span class="summary-sig-name">connectQuagga</span>(<span class="summary-sig-arg">self</span>)</span></td>
137 <td align="right" valign="top">
138 <span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.connectQuagga">source&nbsp;code</a></span>
139
140 </td>
141 </tr>
142 </table>
143
144 </td>
145 </tr>
146<tr>
147 <td width="15%" align="right" valign="top" class="summary">
148 <span class="summary-type">&nbsp;</span>
149 </td><td class="summary">
150 <table width="100%" cellpadding="0" cellspacing="0" border="0">
151 <tr>
152 <td><span class="summary-sig"><a name="loginQuagga"></a><span class="summary-sig-name">loginQuagga</span>(<span class="summary-sig-arg">self</span>,
153 <span class="summary-sig-arg">ip_address</span>)</span></td>
154 <td align="right" valign="top">
155 <span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.loginQuagga">source&nbsp;code</a></span>
156
157 </td>
158 </tr>
159 </table>
160
161 </td>
162 </tr>
163<tr>
164 <td width="15%" align="right" valign="top" class="summary">
165 <span class="summary-type">&nbsp;</span>
166 </td><td class="summary">
167 <table width="100%" cellpadding="0" cellspacing="0" border="0">
168 <tr>
169 <td><span class="summary-sig"><a name="enterConfig"></a><span class="summary-sig-name">enterConfig</span>(<span class="summary-sig-arg">self</span>,
170 <span class="summary-sig-arg">asn</span>)</span></td>
171 <td align="right" valign="top">
172 <span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.enterConfig">source&nbsp;code</a></span>
173
174 </td>
175 </tr>
176 </table>
177
178 </td>
179 </tr>
180<tr>
181 <td width="15%" align="right" valign="top" class="summary">
182 <span class="summary-type">&nbsp;</span>
183 </td><td class="summary">
184 <table width="100%" cellpadding="0" cellspacing="0" border="0">
185 <tr>
186 <td><span class="summary-sig"><a name="generatePrefixes"></a><span class="summary-sig-name">generatePrefixes</span>(<span class="summary-sig-arg">self</span>,
187 <span class="summary-sig-arg">net</span>,
188 <span class="summary-sig-arg">numRoutes</span>)</span></td>
189 <td align="right" valign="top">
190 <span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.generatePrefixes">source&nbsp;code</a></span>
191
192 </td>
193 </tr>
194 </table>
195
196 </td>
197 </tr>
198<tr>
199 <td width="15%" align="right" valign="top" class="summary">
200 <span class="summary-type">&nbsp;</span>
201 </td><td class="summary">
202 <table width="100%" cellpadding="0" cellspacing="0" border="0">
203 <tr>
204 <td><span class="summary-sig"><a name="generateExpectedSingleRouteIntent"></a><span class="summary-sig-name">generateExpectedSingleRouteIntent</span>(<span class="summary-sig-arg">self</span>,
205 <span class="summary-sig-arg">prefix</span>,
206 <span class="summary-sig-arg">nextHop</span>,
207 <span class="summary-sig-arg">nextHopMac</span>,
208 <span class="summary-sig-arg">sdnipData</span>)</span></td>
209 <td align="right" valign="top">
210 <span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.generateExpectedSingleRouteIntent">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 name="generateExpectedOnePeerRouteIntents"></a><span class="summary-sig-name">generateExpectedOnePeerRouteIntents</span>(<span class="summary-sig-arg">self</span>,
225 <span class="summary-sig-arg">prefixes</span>,
226 <span class="summary-sig-arg">nextHop</span>,
227 <span class="summary-sig-arg">nextHopMac</span>,
228 <span class="summary-sig-arg">sdnipJsonFilePath</span>)</span></td>
229 <td align="right" valign="top">
230 <span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.generateExpectedOnePeerRouteIntents">source&nbsp;code</a></span>
231
232 </td>
233 </tr>
234 </table>
235
236 </td>
237 </tr>
238<tr>
239 <td width="15%" align="right" valign="top" class="summary">
240 <span class="summary-type">&nbsp;</span>
241 </td><td class="summary">
242 <table width="100%" cellpadding="0" cellspacing="0" border="0">
243 <tr>
244 <td><span class="summary-sig"><a name="generateExpectedRouteIntents"></a><span class="summary-sig-name">generateExpectedRouteIntents</span>(<span class="summary-sig-arg">self</span>)</span></td>
245 <td align="right" valign="top">
246 <span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.generateExpectedRouteIntents">source&nbsp;code</a></span>
247
248 </td>
249 </tr>
250 </table>
251
252 </td>
253 </tr>
254<tr>
255 <td width="15%" align="right" valign="top" class="summary">
256 <span class="summary-type">&nbsp;</span>
257 </td><td class="summary">
258 <table width="100%" cellpadding="0" cellspacing="0" border="0">
259 <tr>
260 <td><span class="summary-sig"><a name="extractActualRoutesOneDotZero"></a><span class="summary-sig-name">extractActualRoutesOneDotZero</span>(<span class="summary-sig-arg">self</span>,
261 <span class="summary-sig-arg">getRoutesResult</span>)</span></td>
262 <td align="right" valign="top">
263 <span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.extractActualRoutesOneDotZero">source&nbsp;code</a></span>
264
265 </td>
266 </tr>
267 </table>
268
269 </td>
270 </tr>
271<tr>
272 <td width="15%" align="right" valign="top" class="summary">
273 <span class="summary-type">&nbsp;</span>
274 </td><td class="summary">
275 <table width="100%" cellpadding="0" cellspacing="0" border="0">
276 <tr>
277 <td><span class="summary-sig"><a name="extractActualRoutesMaster"></a><span class="summary-sig-name">extractActualRoutesMaster</span>(<span class="summary-sig-arg">self</span>,
278 <span class="summary-sig-arg">getRoutesResult</span>)</span></td>
279 <td align="right" valign="top">
280 <span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.extractActualRoutesMaster">source&nbsp;code</a></span>
281
282 </td>
283 </tr>
284 </table>
285
286 </td>
287 </tr>
288<tr>
289 <td width="15%" align="right" valign="top" class="summary">
290 <span class="summary-type">&nbsp;</span>
291 </td><td class="summary">
292 <table width="100%" cellpadding="0" cellspacing="0" border="0">
293 <tr>
294 <td><span class="summary-sig"><a name="extractActualRouteIntents"></a><span class="summary-sig-name">extractActualRouteIntents</span>(<span class="summary-sig-arg">self</span>,
295 <span class="summary-sig-arg">getIntentsResult</span>)</span></td>
296 <td align="right" valign="top">
297 <span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.extractActualRouteIntents">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 name="extractActualRouteIntentNum"></a><span class="summary-sig-name">extractActualRouteIntentNum</span>(<span class="summary-sig-arg">self</span>,
312 <span class="summary-sig-arg">getIntentsResult</span>)</span></td>
313 <td align="right" valign="top">
314 <span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.extractActualRouteIntentNum">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="extractActualBgpIntentNum"></a><span class="summary-sig-name">extractActualBgpIntentNum</span>(<span class="summary-sig-arg">self</span>,
329 <span class="summary-sig-arg">getIntentsResult</span>)</span></td>
330 <td align="right" valign="top">
331 <span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.extractActualBgpIntentNum">source&nbsp;code</a></span>
332
333 </td>
334 </tr>
335 </table>
336
337 </td>
338 </tr>
339<tr>
340 <td width="15%" align="right" valign="top" class="summary">
341 <span class="summary-type">&nbsp;</span>
342 </td><td class="summary">
343 <table width="100%" cellpadding="0" cellspacing="0" border="0">
344 <tr>
345 <td><span class="summary-sig"><a name="extractActualBgpIntents"></a><span class="summary-sig-name">extractActualBgpIntents</span>(<span class="summary-sig-arg">self</span>,
346 <span class="summary-sig-arg">getIntentsResult</span>)</span></td>
347 <td align="right" valign="top">
348 <span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.extractActualBgpIntents">source&nbsp;code</a></span>
349
350 </td>
351 </tr>
352 </table>
353
354 </td>
355 </tr>
356<tr>
357 <td width="15%" align="right" valign="top" class="summary">
358 <span class="summary-type">&nbsp;</span>
359 </td><td class="summary">
360 <table width="100%" cellpadding="0" cellspacing="0" border="0">
361 <tr>
362 <td><span class="summary-sig"><a name="generateExpectedBgpIntents"></a><span class="summary-sig-name">generateExpectedBgpIntents</span>(<span class="summary-sig-arg">self</span>,
363 <span class="summary-sig-arg">sdnipJsonFilePath</span>)</span></td>
364 <td align="right" valign="top">
365 <span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.generateExpectedBgpIntents">source&nbsp;code</a></span>
366
367 </td>
368 </tr>
369 </table>
370
371 </td>
372 </tr>
373<tr>
374 <td width="15%" align="right" valign="top" class="summary">
375 <span class="summary-type">&nbsp;</span>
376 </td><td class="summary">
377 <table width="100%" cellpadding="0" cellspacing="0" border="0">
378 <tr>
379 <td><span class="summary-sig"><a name="addRoutes"></a><span class="summary-sig-name">addRoutes</span>(<span class="summary-sig-arg">self</span>,
380 <span class="summary-sig-arg">routes</span>,
381 <span class="summary-sig-arg">routeRate</span>)</span></td>
382 <td align="right" valign="top">
383 <span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.addRoutes">source&nbsp;code</a></span>
384
385 </td>
386 </tr>
387 </table>
388
389 </td>
390 </tr>
391<tr>
392 <td width="15%" align="right" valign="top" class="summary">
393 <span class="summary-type">&nbsp;</span>
394 </td><td class="summary">
395 <table width="100%" cellpadding="0" cellspacing="0" border="0">
396 <tr>
397 <td><span class="summary-sig"><a name="deleteRoutes"></a><span class="summary-sig-name">deleteRoutes</span>(<span class="summary-sig-arg">self</span>,
398 <span class="summary-sig-arg">routes</span>,
399 <span class="summary-sig-arg">routeRate</span>)</span></td>
400 <td align="right" valign="top">
401 <span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.deleteRoutes">source&nbsp;code</a></span>
402
403 </td>
404 </tr>
405 </table>
406
407 </td>
408 </tr>
409<tr>
410 <td width="15%" align="right" valign="top" class="summary">
411 <span class="summary-type">&nbsp;</span>
412 </td><td class="summary">
413 <table width="100%" cellpadding="0" cellspacing="0" border="0">
414 <tr>
415 <td><span class="summary-sig"><a name="pingTest"></a><span class="summary-sig-name">pingTest</span>(<span class="summary-sig-arg">self</span>,
416 <span class="summary-sig-arg">ip_address</span>,
417 <span class="summary-sig-arg">pingTestFile</span>,
418 <span class="summary-sig-arg">pingTestResultFile</span>)</span></td>
419 <td align="right" valign="top">
420 <span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.pingTest">source&nbsp;code</a></span>
421
422 </td>
423 </tr>
424 </table>
425
426 </td>
427 </tr>
428<tr>
429 <td width="15%" align="right" valign="top" class="summary">
430 <span class="summary-type">&nbsp;</span>
431 </td><td class="summary">
432 <table width="100%" cellpadding="0" cellspacing="0" border="0">
433 <tr>
434 <td><span class="summary-sig"><a name="addRoute"></a><span class="summary-sig-name">addRoute</span>(<span class="summary-sig-arg">self</span>,
435 <span class="summary-sig-arg">net</span>,
436 <span class="summary-sig-arg">numRoutes</span>,
437 <span class="summary-sig-arg">routeRate</span>)</span></td>
438 <td align="right" valign="top">
439 <span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.addRoute">source&nbsp;code</a></span>
440
441 </td>
442 </tr>
443 </table>
444
445 </td>
446 </tr>
447<tr>
448 <td width="15%" align="right" valign="top" class="summary">
449 <span class="summary-type">&nbsp;</span>
450 </td><td class="summary">
451 <table width="100%" cellpadding="0" cellspacing="0" border="0">
452 <tr>
453 <td><span class="summary-sig"><a name="delRoute"></a><span class="summary-sig-name">delRoute</span>(<span class="summary-sig-arg">self</span>,
454 <span class="summary-sig-arg">net</span>,
455 <span class="summary-sig-arg">numRoutes</span>,
456 <span class="summary-sig-arg">routeRate</span>)</span></td>
457 <td align="right" valign="top">
458 <span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.delRoute">source&nbsp;code</a></span>
459
460 </td>
461 </tr>
462 </table>
463
464 </td>
465 </tr>
466<tr>
467 <td width="15%" align="right" valign="top" class="summary">
468 <span class="summary-type">&nbsp;</span>
469 </td><td class="summary">
470 <table width="100%" cellpadding="0" cellspacing="0" border="0">
471 <tr>
472 <td><span class="summary-sig"><a name="checkRoutes"></a><span class="summary-sig-name">checkRoutes</span>(<span class="summary-sig-arg">self</span>,
473 <span class="summary-sig-arg">brand</span>,
474 <span class="summary-sig-arg">ip</span>,
475 <span class="summary-sig-arg">user</span>,
476 <span class="summary-sig-arg">pw</span>)</span></td>
477 <td align="right" valign="top">
478 <span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.checkRoutes">source&nbsp;code</a></span>
479
480 </td>
481 </tr>
482 </table>
483
484 </td>
485 </tr>
486<tr>
487 <td width="15%" align="right" valign="top" class="summary">
488 <span class="summary-type">&nbsp;</span>
489 </td><td class="summary">
490 <table width="100%" cellpadding="0" cellspacing="0" border="0">
491 <tr>
492 <td><span class="summary-sig"><a name="disable_bgp_peer"></a><span class="summary-sig-name">disable_bgp_peer</span>(<span class="summary-sig-arg">self</span>,
493 <span class="summary-sig-arg">peer</span>,
494 <span class="summary-sig-arg">peer_as</span>)</span></td>
495 <td align="right" valign="top">
496 <span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.disable_bgp_peer">source&nbsp;code</a></span>
497
498 </td>
499 </tr>
500 </table>
501
502 </td>
503 </tr>
504<tr>
505 <td width="15%" align="right" valign="top" class="summary">
506 <span class="summary-type">&nbsp;</span>
507 </td><td class="summary">
508 <table width="100%" cellpadding="0" cellspacing="0" border="0">
509 <tr>
510 <td><span class="summary-sig"><a name="enable_bgp_peer"></a><span class="summary-sig-name">enable_bgp_peer</span>(<span class="summary-sig-arg">self</span>,
511 <span class="summary-sig-arg">peer</span>,
512 <span class="summary-sig-arg">peer_as</span>)</span></td>
513 <td align="right" valign="top">
514 <span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.enable_bgp_peer">source&nbsp;code</a></span>
515
516 </td>
517 </tr>
518 </table>
519
520 </td>
521 </tr>
522<tr>
523 <td width="15%" align="right" valign="top" class="summary">
524 <span class="summary-type">&nbsp;</span>
525 </td><td class="summary">
526 <table width="100%" cellpadding="0" cellspacing="0" border="0">
527 <tr>
528 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.quaggaclidriver.QuaggaCliDriver-class.html#disconnect" class="summary-sig-name">disconnect</a>(<span class="summary-sig-arg">self</span>)</span><br />
529 Called when Test is complete to disconnect the Quagga handle.</td>
530 <td align="right" valign="top">
531 <span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.disconnect">source&nbsp;code</a></span>
532
533 </td>
534 </tr>
535 </table>
536
537 </td>
538 </tr>
539<tr>
540 <td width="15%" align="right" valign="top" class="summary">
541 <span class="summary-type">&nbsp;</span>
542 </td><td class="summary">
543 <table width="100%" cellpadding="0" cellspacing="0" border="0">
544 <tr>
545 <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>,
546 <span class="summary-sig-arg">**execparams</span>)</span><br />
547 It facilitates the command line execution of a given command.
548 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
549 <td align="right" valign="top">
550 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.execute">source&nbsp;code</a></span>
551
552 </td>
553 </tr>
554 </table>
555
556 </td>
557 </tr>
558<tr>
559 <td width="15%" align="right" valign="top" class="summary">
560 <span class="summary-type">&nbsp;</span>
561 </td><td class="summary">
562 <table width="100%" cellpadding="0" cellspacing="0" border="0">
563 <tr>
564 <td><span class="summary-sig"><a name="onfail"></a><span class="summary-sig-name">onfail</span>(<span class="summary-sig-arg">self</span>)</span>
565 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
566 <td align="right" valign="top">
567 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.onfail">source&nbsp;code</a></span>
568
569 </td>
570 </tr>
571 </table>
572
573 </td>
574 </tr>
575<tr>
576 <td width="15%" align="right" valign="top" class="summary">
577 <span class="summary-type">&nbsp;</span>
578 </td><td class="summary">
579 <table width="100%" cellpadding="0" cellspacing="0" border="0">
580 <tr>
581 <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>,
582 <span class="summary-sig-arg">response</span>)</span>
583 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
584 <td align="right" valign="top">
585 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.remove_contol_chars">source&nbsp;code</a></span>
586
587 </td>
588 </tr>
589 </table>
590
591 </td>
592 </tr>
593<tr>
594 <td width="15%" align="right" valign="top" class="summary">
595 <span class="summary-type">&nbsp;</span>
596 </td><td class="summary">
597 <table width="100%" cellpadding="0" cellspacing="0" border="0">
598 <tr>
599 <td><span class="summary-sig"><a name="runAsSudoUser"></a><span class="summary-sig-name">runAsSudoUser</span>(<span class="summary-sig-arg">self</span>,
600 <span class="summary-sig-arg">handle</span>,
601 <span class="summary-sig-arg">pwd</span>,
602 <span class="summary-sig-arg">default</span>)</span>
603 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
604 <td align="right" valign="top">
605 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.runAsSudoUser">source&nbsp;code</a></span>
606
607 </td>
608 </tr>
609 </table>
610
611 </td>
612 </tr>
613<tr>
614 <td width="15%" align="right" valign="top" class="summary">
615 <span class="summary-type">&nbsp;</span>
616 </td><td class="summary">
617 <table width="100%" cellpadding="0" cellspacing="0" border="0">
618 <tr>
619 <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>,
620 <span class="summary-sig-arg">user_name</span>,
621 <span class="summary-sig-arg">ip_address</span>,
622 <span class="summary-sig-arg">filepath</span>,
623 <span class="summary-sig-arg">pwd</span>,
624 <span class="summary-sig-arg">dst_path</span>)</span><br />
625 Connection will establish to the remote host using ssh.
626 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
627 <td align="right" valign="top">
628 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.secureCopy">source&nbsp;code</a></span>
629
630 </td>
631 </tr>
632 </table>
633
634 </td>
635 </tr>
636 <tr>
637 <td colspan="2" class="summary">
638 <p class="indent-wrapped-lines"><b>Inherited from <code>component.Component</code></b>:
639 <code>__getattr__</code>,
640 <code>cleanup</code>,
641 <code>close_log_handles</code>,
642 <code>config</code>,
643 <code>experimentRun</code>,
644 <code>get_version</code>,
645 <code>log</code>
646 </p>
647 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
648 <code>__delattr__</code>,
649 <code>__format__</code>,
650 <code>__getattribute__</code>,
651 <code>__hash__</code>,
652 <code>__new__</code>,
653 <code>__reduce__</code>,
654 <code>__reduce_ex__</code>,
655 <code>__repr__</code>,
656 <code>__setattr__</code>,
657 <code>__sizeof__</code>,
658 <code>__str__</code>,
659 <code>__subclasshook__</code>
660 </p>
661 </td>
662 </tr>
663</table>
664<!-- ==================== PROPERTIES ==================== -->
665<a name="section-Properties"></a>
666<table class="summary" border="1" cellpadding="3"
667 cellspacing="0" width="100%" bgcolor="white">
668<tr bgcolor="#70b0f0" class="table-header">
669 <td colspan="2" class="table-header">
670 <table border="0" cellpadding="0" cellspacing="0" width="100%">
671 <tr valign="top">
672 <td align="left"><span class="table-header">Properties</span></td>
673 <td align="right" valign="top"
674 ><span class="options">[<a href="#section-Properties"
675 class="privatelink" onclick="toggle_private();"
676 >hide private</a>]</span></td>
677 </tr>
678 </table>
679 </td>
680</tr>
681 <tr>
682 <td colspan="2" class="summary">
683 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
684 <code>__class__</code>
685 </p>
686 </td>
687 </tr>
688</table>
689<!-- ==================== METHOD DETAILS ==================== -->
690<a name="section-MethodDetails"></a>
691<table class="details" border="1" cellpadding="3"
692 cellspacing="0" width="100%" bgcolor="white">
693<tr bgcolor="#70b0f0" class="table-header">
694 <td colspan="2" class="table-header">
695 <table border="0" cellpadding="0" cellspacing="0" width="100%">
696 <tr valign="top">
697 <td align="left"><span class="table-header">Method Details</span></td>
698 <td align="right" valign="top"
699 ><span class="options">[<a href="#section-MethodDetails"
700 class="privatelink" onclick="toggle_private();"
701 >hide private</a>]</span></td>
702 </tr>
703 </table>
704 </td>
705</tr>
706</table>
707<a name="__init__"></a>
708<div>
709<table class="details" border="1" cellpadding="3"
710 cellspacing="0" width="100%" bgcolor="white">
711<tr><td>
712 <table width="100%" cellpadding="0" cellspacing="0" border="0">
713 <tr valign="top"><td>
714 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>)</span>
715 <br /><em class="fname">(Constructor)</em>
716 </h3>
717 </td><td align="right" valign="top"
718 ><span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.__init__">source&nbsp;code</a></span>&nbsp;
719 </td>
720 </tr></table>
721
722 <p>x.__init__(...) initializes x; see help(type(x)) for signature</p>
723 <dl class="fields">
724 <dt>Overrides:
725 object.__init__
726 <dd><em class="note">(inherited documentation)</em></dd>
727 </dt>
728 </dl>
729</td></tr></table>
730</div>
731<a name="connect"></a>
732<div>
733<table class="details" border="1" cellpadding="3"
734 cellspacing="0" width="100%" bgcolor="white">
735<tr><td>
736 <table width="100%" cellpadding="0" cellspacing="0" border="0">
737 <tr valign="top"><td>
738 <h3 class="epydoc"><span class="sig"><span class="sig-name">connect</span>(<span class="sig-arg">self</span>,
739 <span class="sig-arg">**connectargs</span>)</span>
740 </h3>
741 </td><td align="right" valign="top"
742 ><span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.connect">source&nbsp;code</a></span>&nbsp;
743 </td>
744 </tr></table>
745
746 <p>Connection will establish to the remote host using ssh. It will take
747 user_name ,ip_address and password as arguments&lt;br&gt; and will return
748 the handle.</p>
749 <dl class="fields">
750 <dt>Overrides:
751 component.Component.connect
752 </dt>
753 </dl>
754</td></tr></table>
755</div>
756<a name="disconnect"></a>
757<div>
758<table class="details" border="1" cellpadding="3"
759 cellspacing="0" width="100%" bgcolor="white">
760<tr><td>
761 <table width="100%" cellpadding="0" cellspacing="0" border="0">
762 <tr valign="top"><td>
763 <h3 class="epydoc"><span class="sig"><span class="sig-name">disconnect</span>(<span class="sig-arg">self</span>)</span>
764 </h3>
765 </td><td align="right" valign="top"
766 ><span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.disconnect">source&nbsp;code</a></span>&nbsp;
767 </td>
768 </tr></table>
769
770 <p>Called when Test is complete to disconnect the Quagga handle.</p>
771 <dl class="fields">
772 <dt>Overrides:
773 component.Component.disconnect
774 </dt>
775 </dl>
776</td></tr></table>
777</div>
778<br />
779<!-- ==================== NAVIGATION BAR ==================== -->
780<table class="navbar" border="0" width="100%" cellpadding="0"
781 bgcolor="#a0c0ff" cellspacing="0">
782 <tr valign="middle">
783 <!-- Home link -->
784 <th>&nbsp;&nbsp;&nbsp;<a
785 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
786
787 <!-- Tree link -->
788 <th>&nbsp;&nbsp;&nbsp;<a
789 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
790
791 <!-- Index link -->
792 <th>&nbsp;&nbsp;&nbsp;<a
793 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
794
795 <!-- Help link -->
796 <th>&nbsp;&nbsp;&nbsp;<a
797 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
798
799 <!-- Project homepage -->
800 <th class="navbar" align="right" width="100%">
801 <table border="0" cellpadding="0" cellspacing="0">
802 <tr><th class="navbar" align="center"
803 >TestON</th>
804 </tr></table></th>
805 </tr>
806</table>
807<table border="0" cellpadding="0" cellspacing="0" width="100%%">
808 <tr>
809 <td align="left" class="footer">
810 Generated by Epydoc 3.0.1 on Mon Aug 10 11:12:35 2015
811 </td>
812 <td align="right" class="footer">
813 <a target="mainFrame" href="http://epydoc.sourceforge.net"
814 >http://epydoc.sourceforge.net</a>
815 </td>
816 </tr>
817</table>
818
819<script type="text/javascript">
820 <!--
821 // Private objects are initially displayed (because if
822 // javascript is turned off then we want them to be
823 // visible); but by default, we want to hide them. So hide
824 // them unless we have a cookie that says to show them.
825 checkCookie();
826 // -->
827</script>
828</body>
829</html>