Gitiles
Code Review Sign In
gerrit.onosproject.org / OnosSystemTest / bae64d8d1b35c6e0c4f600e55a39f319c009ad05 / . / TestON / Documentation / TestON_Document / TestON.drivers.common.cli.tool.dpctlclidriver.DpctlCliDriver-class.html
blob: 7452bebd1509d2d8a5f1a2af4ad084fdfca23d88 [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.tool.dpctlclidriver.DpctlCliDriver</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>
<th class="navbar" width="100%"></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.tool-module.html">Package&nbsp;tool</a> ::
<a href="TestON.drivers.common.cli.tool.dpctlclidriver-module.html">Module&nbsp;dpctlclidriver</a> ::
Class&nbsp;DpctlCliDriver
</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.tool.dpctlclidriver.DpctlCliDriver-class.html"
target="_top">no&nbsp;frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<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>
<pre class="base-tree">
object --+
|
<a href="TestON.drivers.component.Component-class.html">component.Component</a> --+
|
<a href="TestON.drivers.common.clidriver.CLI-class.html">clidriver.CLI</a> --+
|
<a href="TestON.drivers.common.cli.toolsdriver.Tools-class.html">toolsdriver.Tools</a> --+
|
<strong class="uidshort">DpctlCliDriver</strong>
</pre>
<hr />
<p>DpctlCliDriver driver class provides the basic functions of DPCTL
controller</p>
<!-- ==================== 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.tool.dpctlclidriver.DpctlCliDriver-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>)</span><br />
x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.__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.tool.dpctlclidriver.DpctlCliDriver-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.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.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="addFlow"></a><span class="summary-sig-name">addFlow</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">**flowParameters</span>)</span><br />
addFlow create a new flow entry into flow table using
&quot;dpctl&quot;</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.addFlow">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="showFlow"></a><span class="summary-sig-name">showFlow</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">**flowParameters</span>)</span><br />
showFlow dumps the flow entries of flow table using &quot;dpctl&quot;</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.showFlow">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="dumpFlow"></a><span class="summary-sig-name">dumpFlow</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">**flowParameters</span>)</span><br />
dumpFlow gives installed flow information</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.dumpFlow">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="dumpTables"></a><span class="summary-sig-name">dumpTables</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">**flowParameters</span>)</span><br />
dumpTables gives statistics for each of the flow tables used by
datapath switch.</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.dumpTables">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="dumpPorts"></a><span class="summary-sig-name">dumpPorts</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">**flowParameters</span>)</span><br />
dumpPorts gives ports information</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.dumpPorts">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.tool.dpctlclidriver.DpctlCliDriver-class.html#dumpAggregate" class="summary-sig-name">dumpAggregate</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">**flowParameters</span>)</span><br />
dumpAggregate gives installed flow information.ggregate statistics
for flows in datapath WITCH's tables that match flows.</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.dumpAggregate">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="delFlow"></a><span class="summary-sig-name">delFlow</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">**flowParameters</span>)</span><br />
delFlow Deletes entries from the datapath switch's tables that match
flow</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.delFlow">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="show"></a><span class="summary-sig-name">show</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">**flowParameters</span>)</span><br />
show gives information on datapath switch including information on
its flow tables and ports.</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.show">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.tool.dpctlclidriver.DpctlCliDriver-class.html#showStatus" class="summary-sig-name">showStatus</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">**flowParameters</span>)</span><br />
showStatus gives a series of key-value pairs that report the status
of switch.</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.showStatus">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="desc_set"></a><span class="summary-sig-name">desc_set</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">**flowParameters</span>)</span><br />
desc_set Sets the switch description (as returned in ofp_desc_stats)
to string (max length is DESC_STR_LEN)</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.desc_set">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="dumpDesc"></a><span class="summary-sig-name">dumpDesc</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">**flowParameters</span>)</span><br />
dumpDesc Sets the switch description (as returned in ofp_desc_stats)
to string (max length is DESC_STR_LEN)</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.dumpDesc">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><a href="TestON.drivers.common.clidriver.CLI-class.html">clidriver.CLI</a></code></b>:
<code><a href="TestON.drivers.common.clidriver.CLI-class.html#disconnect">disconnect</a></code>,
<code><a href="TestON.drivers.common.clidriver.CLI-class.html#execute">execute</a></code>,
<code><a href="TestON.drivers.common.clidriver.CLI-class.html#onfail">onfail</a></code>,
<code><a href="TestON.drivers.common.clidriver.CLI-class.html#runAsSudoUser">runAsSudoUser</a></code>,
<code><a href="TestON.drivers.common.clidriver.CLI-class.html#secureCopy">secureCopy</a></code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="TestON.drivers.component.Component-class.html">component.Component</a></code></b>:
<code><a href="TestON.drivers.component.Component-class.html#__getattr__">__getattr__</a></code>,
<code><a href="TestON.drivers.component.Component-class.html#cleanup">cleanup</a></code>,
<code><a href="TestON.drivers.component.Component-class.html#close_log_handles">close_log_handles</a></code>,
<code><a href="TestON.drivers.component.Component-class.html#config">config</a></code>,
<code><a href="TestON.drivers.component.Component-class.html#experimentRun">experimentRun</a></code>,
<code><a href="TestON.drivers.component.Component-class.html#get_version">get_version</a></code>,
<code><a href="TestON.drivers.component.Component-class.html#log">log</a></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.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.__init__">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>x.__init__(...) initializes x; see x.__class__.__doc__ 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.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.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:
<a href="TestON.drivers.component.Component-class.html#connect">component.Component.connect</a>
</dt>
</dl>
</td></tr></table>
</div>
<a name="dumpAggregate"></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">dumpAggregate</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">**flowParameters</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.dumpAggregate">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>dumpAggregate gives installed flow information.ggregate statistics
for flows in datapath WITCH's tables that match flows. If flows is
omitted, the statistics are aggregated across all flows in the datapath's
flow tables</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="showStatus"></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">showStatus</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">**flowParameters</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.showStatus">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>showStatus gives a series of key-value pairs that report the status of
switch. If key is specified, only the key-value pairs whose key names
begin with key are printed.</p>
<dl class="fields">
</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>
<th class="navbar" width="100%"></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 Mar 11 12:56:26 2013
</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>