Gitiles
Code Review Sign In
gerrit.onosproject.org / OnosSystemTest / 116647a39df3add2551c5d01412e8360eb4d1be2 / . / TestON / Documentation / TestON_Document / TestON.drivers.common.cli.quaggaclidriver.QuaggaCliDriver-class.html
blob: 488311cd255379313e74f9ee054ec6b01f1ae188 [file] [log] [blame]
<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>TestON.drivers.common.cli.quaggaclidriver.QuaggaCliDriver</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
>TestON</th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="TestON-module.html">Package&nbsp;TestON</a> ::
<a href="TestON.drivers-module.html">Package&nbsp;drivers</a> ::
<a href="TestON.drivers.common-module.html">Package&nbsp;common</a> ::
<a href="TestON.drivers.common.cli-module.html">Package&nbsp;cli</a> ::
<a href="TestON.drivers.common.cli.quaggaclidriver-module.html">Module&nbsp;quaggaclidriver</a> ::
Class&nbsp;QuaggaCliDriver
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>]&nbsp;|&nbsp;<a href="TestON.drivers.common.cli.quaggaclidriver.QuaggaCliDriver-class.html"
target="_top">no&nbsp;frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<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>
<center>
<center> <map id="class_hierarchy_for_quaggaclid" name="class_hierarchy_for_quaggaclid">
<area shape="rect" id="node1" href="TestON.drivers.common.cli.quaggaclidriver.QuaggaCliDriver-class.html" title="QuaggaCliDriver" alt="" coords="5,6,123,31"/>
<area shape="rect" id="node2" href="TestON.drivers.common.clidriver.CLI-class.html" title="clidriver.CLI" alt="" coords="147,6,239,31"/>
<area shape="rect" id="node3" href="javascript:void(0);" title="component.Component" alt="" coords="264,6,421,31"/>
</map>
<img src="class_hierarchy_for_quaggaclid.gif" alt='' usemap="#class_hierarchy_for_quaggaclid" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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 />
x.__init__(...) initializes x; see help(type(x)) for signature</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.__init__">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">**connectargs</span>)</span><br />
Connection will establish to the remote host using ssh.</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.connect">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.connectQuagga">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="loginQuagga"></a><span class="summary-sig-name">loginQuagga</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">ip_address</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.loginQuagga">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="enterConfig"></a><span class="summary-sig-name">enterConfig</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">asn</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.enterConfig">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="generatePrefixes"></a><span class="summary-sig-name">generatePrefixes</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">net</span>,
<span class="summary-sig-arg">numRoutes</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.generatePrefixes">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="generateExpectedSingleRouteIntent"></a><span class="summary-sig-name">generateExpectedSingleRouteIntent</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">prefix</span>,
<span class="summary-sig-arg">nextHop</span>,
<span class="summary-sig-arg">nextHopMac</span>,
<span class="summary-sig-arg">sdnipData</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.generateExpectedSingleRouteIntent">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="generateExpectedOnePeerRouteIntents"></a><span class="summary-sig-name">generateExpectedOnePeerRouteIntents</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">prefixes</span>,
<span class="summary-sig-arg">nextHop</span>,
<span class="summary-sig-arg">nextHopMac</span>,
<span class="summary-sig-arg">sdnipJsonFilePath</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.generateExpectedOnePeerRouteIntents">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.generateExpectedRouteIntents">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="extractActualRoutesOneDotZero"></a><span class="summary-sig-name">extractActualRoutesOneDotZero</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">getRoutesResult</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.extractActualRoutesOneDotZero">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="extractActualRoutesMaster"></a><span class="summary-sig-name">extractActualRoutesMaster</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">getRoutesResult</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.extractActualRoutesMaster">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="extractActualRouteIntents"></a><span class="summary-sig-name">extractActualRouteIntents</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">getIntentsResult</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.extractActualRouteIntents">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="extractActualRouteIntentNum"></a><span class="summary-sig-name">extractActualRouteIntentNum</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">getIntentsResult</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.extractActualRouteIntentNum">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="extractActualBgpIntentNum"></a><span class="summary-sig-name">extractActualBgpIntentNum</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">getIntentsResult</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.extractActualBgpIntentNum">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="extractActualBgpIntents"></a><span class="summary-sig-name">extractActualBgpIntents</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">getIntentsResult</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.extractActualBgpIntents">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="generateExpectedBgpIntents"></a><span class="summary-sig-name">generateExpectedBgpIntents</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">sdnipJsonFilePath</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.generateExpectedBgpIntents">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="addRoutes"></a><span class="summary-sig-name">addRoutes</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">routes</span>,
<span class="summary-sig-arg">routeRate</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.addRoutes">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="deleteRoutes"></a><span class="summary-sig-name">deleteRoutes</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">routes</span>,
<span class="summary-sig-arg">routeRate</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.deleteRoutes">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="pingTest"></a><span class="summary-sig-name">pingTest</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">ip_address</span>,
<span class="summary-sig-arg">pingTestFile</span>,
<span class="summary-sig-arg">pingTestResultFile</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.pingTest">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="addRoute"></a><span class="summary-sig-name">addRoute</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">net</span>,
<span class="summary-sig-arg">numRoutes</span>,
<span class="summary-sig-arg">routeRate</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.addRoute">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="delRoute"></a><span class="summary-sig-name">delRoute</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">net</span>,
<span class="summary-sig-arg">numRoutes</span>,
<span class="summary-sig-arg">routeRate</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.delRoute">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="checkRoutes"></a><span class="summary-sig-name">checkRoutes</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">brand</span>,
<span class="summary-sig-arg">ip</span>,
<span class="summary-sig-arg">user</span>,
<span class="summary-sig-arg">pw</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.checkRoutes">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">peer</span>,
<span class="summary-sig-arg">peer_as</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.disable_bgp_peer">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">peer</span>,
<span class="summary-sig-arg">peer_as</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.enable_bgp_peer">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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 />
Called when Test is complete to disconnect the Quagga handle.</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.disconnect">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">**execparams</span>)</span><br />
It facilitates the command line execution of a given command.
<em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.execute">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="onfail"></a><span class="summary-sig-name">onfail</span>(<span class="summary-sig-arg">self</span>)</span>
<em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.onfail">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">response</span>)</span>
<em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.remove_contol_chars">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="runAsSudoUser"></a><span class="summary-sig-name">runAsSudoUser</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">handle</span>,
<span class="summary-sig-arg">pwd</span>,
<span class="summary-sig-arg">default</span>)</span>
<em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.runAsSudoUser">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">user_name</span>,
<span class="summary-sig-arg">ip_address</span>,
<span class="summary-sig-arg">filepath</span>,
<span class="summary-sig-arg">pwd</span>,
<span class="summary-sig-arg">dst_path</span>)</span><br />
Connection will establish to the remote host using ssh.
<em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.secureCopy">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>component.Component</code></b>:
<code>__getattr__</code>,
<code>cleanup</code>,
<code>close_log_handles</code>,
<code>config</code>,
<code>experimentRun</code>,
<code>get_version</code>,
<code>log</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__format__</code>,
<code>__getattribute__</code>,
<code>__hash__</code>,
<code>__new__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__repr__</code>,
<code>__setattr__</code>,
<code>__sizeof__</code>,
<code>__str__</code>,
<code>__subclasshook__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Properties</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Properties"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__class__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.__init__">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>x.__init__(...) initializes x; see help(type(x)) for signature</p>
<dl class="fields">
<dt>Overrides:
object.__init__
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<a name="connect"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">connect</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">**connectargs</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.connect">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>Connection will establish to the remote host using ssh. It will take
user_name ,ip_address and password as arguments&lt;br&gt; and will return
the handle.</p>
<dl class="fields">
<dt>Overrides:
component.Component.connect
</dt>
</dl>
</td></tr></table>
</div>
<a name="disconnect"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">disconnect</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="TestON.drivers.common.cli.quaggaclidriver-pysrc.html#QuaggaCliDriver.disconnect">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>Called when Test is complete to disconnect the Quagga handle.</p>
<dl class="fields">
<dt>Overrides:
component.Component.disconnect
</dt>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
>TestON</th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Mon Aug 10 11:12:35 2015
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>