Gitiles
Code Review Sign In
gerrit.onosproject.org / OnosSystemTest / 915100cedefb8f9145d4b367092591c524ead52e / . / TestON / Documentation / TestON_Document / TestON.drivers.common.apidriver.API-class.html
blob: 973efa1b2227ef6beba06be54684a2688328f23c [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>
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]6 <title>TestON.drivers.common.apidriver.API</title>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]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> ::
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]48 <a href="TestON.drivers.common.apidriver-module.html">Module&nbsp;apidriver</a> ::
49 Class&nbsp;API
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]50 </span>
51 </td>
52 <td>
53 <table cellpadding="0" cellspacing="0">
54 <!-- hide/show private -->
55 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
56 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
57 <tr><td align="right"><span class="options"
58 >[<a href="frames.html" target="_top">frames</a
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]59 >]&nbsp;|&nbsp;<a href="TestON.drivers.common.apidriver.API-class.html"
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]60 target="_top">no&nbsp;frames</a>]</span></td></tr>
61 </table>
62 </td>
63 </tr>
64</table>
65<!-- ==================== CLASS DESCRIPTION ==================== -->
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]66<h1 class="epydoc">Class API</h1><p class="nomargin-top"><span class="codelink"><a href="TestON.drivers.common.apidriver-pysrc.html#API">source&nbsp;code</a></span></p>
67<center>
68<center> <map id="class_hierarchy_for_api" name="class_hierarchy_for_api">
69<area shape="rect" id="node1" href="TestON.drivers.common.apidriver.API-class.html" title="API" alt="" coords="5,6,48,31"/>
70<area shape="rect" id="node2" href="javascript:void(0);" title="component.Component" alt="" coords="73,6,231,31"/>
71</map>
72 <img src="class_hierarchy_for_api.gif" alt='' usemap="#class_hierarchy_for_api" ismap="ismap" class="graph-without-title" />
73</center>
74</center>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]75<hr />
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]76<p>This will define common functions for CLI included.</p>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]77
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>
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]101 <td><span class="summary-sig"><a href="TestON.drivers.common.apidriver.API-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>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]103 <td align="right" valign="top">
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]104 <span class="codelink"><a href="TestON.drivers.common.apidriver-pysrc.html#API.__init__">source&nbsp;code</a></span>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]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>
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]118 <td><span class="summary-sig"><a href="TestON.drivers.common.apidriver.API-class.html#connect" class="summary-sig-name">connect</a>(<span class="summary-sig-arg">self</span>)</span><br />
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]119 Connection will establish to the remote host using ssh.</td>
120 <td align="right" valign="top">
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]121 <span class="codelink"><a href="TestON.drivers.common.apidriver-pysrc.html#API.connect">source&nbsp;code</a></span>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]122
123 </td>
124 </tr>
125 </table>
126
127 </td>
128 </tr>
129 <tr>
130 <td colspan="2" class="summary">
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]131 <p class="indent-wrapped-lines"><b>Inherited from <code>component.Component</code></b>:
132 <code>__getattr__</code>,
133 <code>cleanup</code>,
134 <code>close_log_handles</code>,
135 <code>config</code>,
136 <code>disconnect</code>,
137 <code>execute</code>,
138 <code>experimentRun</code>,
139 <code>get_version</code>,
140 <code>log</code>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]141 </p>
142 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
143 <code>__delattr__</code>,
144 <code>__format__</code>,
145 <code>__getattribute__</code>,
146 <code>__hash__</code>,
147 <code>__new__</code>,
148 <code>__reduce__</code>,
149 <code>__reduce_ex__</code>,
150 <code>__repr__</code>,
151 <code>__setattr__</code>,
152 <code>__sizeof__</code>,
153 <code>__str__</code>,
154 <code>__subclasshook__</code>
155 </p>
156 </td>
157 </tr>
158</table>
159<!-- ==================== PROPERTIES ==================== -->
160<a name="section-Properties"></a>
161<table class="summary" border="1" cellpadding="3"
162 cellspacing="0" width="100%" bgcolor="white">
163<tr bgcolor="#70b0f0" class="table-header">
164 <td colspan="2" class="table-header">
165 <table border="0" cellpadding="0" cellspacing="0" width="100%">
166 <tr valign="top">
167 <td align="left"><span class="table-header">Properties</span></td>
168 <td align="right" valign="top"
169 ><span class="options">[<a href="#section-Properties"
170 class="privatelink" onclick="toggle_private();"
171 >hide private</a>]</span></td>
172 </tr>
173 </table>
174 </td>
175</tr>
176 <tr>
177 <td colspan="2" class="summary">
178 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
179 <code>__class__</code>
180 </p>
181 </td>
182 </tr>
183</table>
184<!-- ==================== METHOD DETAILS ==================== -->
185<a name="section-MethodDetails"></a>
186<table class="details" border="1" cellpadding="3"
187 cellspacing="0" width="100%" bgcolor="white">
188<tr bgcolor="#70b0f0" class="table-header">
189 <td colspan="2" class="table-header">
190 <table border="0" cellpadding="0" cellspacing="0" width="100%">
191 <tr valign="top">
192 <td align="left"><span class="table-header">Method Details</span></td>
193 <td align="right" valign="top"
194 ><span class="options">[<a href="#section-MethodDetails"
195 class="privatelink" onclick="toggle_private();"
196 >hide private</a>]</span></td>
197 </tr>
198 </table>
199 </td>
200</tr>
201</table>
202<a name="__init__"></a>
203<div>
204<table class="details" border="1" cellpadding="3"
205 cellspacing="0" width="100%" bgcolor="white">
206<tr><td>
207 <table width="100%" cellpadding="0" cellspacing="0" border="0">
208 <tr valign="top"><td>
209 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>)</span>
210 <br /><em class="fname">(Constructor)</em>
211 </h3>
212 </td><td align="right" valign="top"
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]213 ><span class="codelink"><a href="TestON.drivers.common.apidriver-pysrc.html#API.__init__">source&nbsp;code</a></span>&nbsp;
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]214 </td>
215 </tr></table>
216
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]217 <p>x.__init__(...) initializes x; see help(type(x)) for signature</p>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]218 <dl class="fields">
219 <dt>Overrides:
220 object.__init__
221 <dd><em class="note">(inherited documentation)</em></dd>
222 </dt>
223 </dl>
224</td></tr></table>
225</div>
226<a name="connect"></a>
227<div>
228<table class="details" border="1" cellpadding="3"
229 cellspacing="0" width="100%" bgcolor="white">
230<tr><td>
231 <table width="100%" cellpadding="0" cellspacing="0" border="0">
232 <tr valign="top"><td>
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]233 <h3 class="epydoc"><span class="sig"><span class="sig-name">connect</span>(<span class="sig-arg">self</span>)</span>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]234 </h3>
235 </td><td align="right" valign="top"
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]236 ><span class="codelink"><a href="TestON.drivers.common.apidriver-pysrc.html#API.connect">source&nbsp;code</a></span>&nbsp;
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]237 </td>
238 </tr></table>
239
240 <p>Connection will establish to the remote host using ssh. It will take
241 user_name ,ip_address and password as arguments&lt;br&gt; and will return
242 the handle.</p>
243 <dl class="fields">
244 <dt>Overrides:
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]245 component.Component.connect
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]246 </dt>
247 </dl>
248</td></tr></table>
249</div>
250<br />
251<!-- ==================== NAVIGATION BAR ==================== -->
252<table class="navbar" border="0" width="100%" cellpadding="0"
253 bgcolor="#a0c0ff" cellspacing="0">
254 <tr valign="middle">
255 <!-- Home link -->
256 <th>&nbsp;&nbsp;&nbsp;<a
257 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
258
259 <!-- Tree link -->
260 <th>&nbsp;&nbsp;&nbsp;<a
261 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
262
263 <!-- Index link -->
264 <th>&nbsp;&nbsp;&nbsp;<a
265 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
266
267 <!-- Help link -->
268 <th>&nbsp;&nbsp;&nbsp;<a
269 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
270
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]271 <!-- Project homepage -->
272 <th class="navbar" align="right" width="100%">
273 <table border="0" cellpadding="0" cellspacing="0">
274 <tr><th class="navbar" align="center"
275 >TestON</th>
276 </tr></table></th>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]277 </tr>
278</table>
279<table border="0" cellpadding="0" cellspacing="0" width="100%%">
280 <tr>
281 <td align="left" class="footer">
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]282 Generated by Epydoc 3.0.1 on Mon Aug 10 11:12:35 2015
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]283 </td>
284 <td align="right" class="footer">
285 <a target="mainFrame" href="http://epydoc.sourceforge.net"
286 >http://epydoc.sourceforge.net</a>
287 </td>
288 </tr>
289</table>
290
291<script type="text/javascript">
292 <!--
293 // Private objects are initially displayed (because if
294 // javascript is turned off then we want them to be
295 // visible); but by default, we want to hide them. So hide
296 // them unless we have a cookie that says to show them.
297 checkCookie();
298 // -->
299</script>
300</body>
301</html>