Gitiles
Code Review Sign In
gerrit.onosproject.org / OnosSystemTest / b8aa26d890028b77da2a8f9d9f6d77ea57468289 / . / TestON / Documentation / TestON_Document / TestON.bin.generatedriver.GenerateDriver-class.html
blob: 1e6157e8a6f884d5c7ab7da878be36d8c13558c7 [file] [log] [blame]
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]1<?xml version="1.0" encoding="ascii"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6 <title>TestON.bin.generatedriver.GenerateDriver</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
9</head>
10
11<body bgcolor="white" text="black" link="blue" vlink="#204080"
12 alink="#204080">
13<!-- ==================== NAVIGATION BAR ==================== -->
14<table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
16 <tr valign="middle">
17 <!-- Home link -->
18 <th>&nbsp;&nbsp;&nbsp;<a
19 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
20
21 <!-- Tree link -->
22 <th>&nbsp;&nbsp;&nbsp;<a
23 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
24
25 <!-- Index link -->
26 <th>&nbsp;&nbsp;&nbsp;<a
27 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28
29 <!-- Help link -->
30 <th>&nbsp;&nbsp;&nbsp;<a
31 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
32
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]33 <!-- Project homepage -->
34 <th class="navbar" align="right" width="100%">
35 <table border="0" cellpadding="0" cellspacing="0">
36 <tr><th class="navbar" align="center"
37 >TestON</th>
38 </tr></table></th>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]39 </tr>
40</table>
41<table width="100%" cellpadding="0" cellspacing="0">
42 <tr valign="top">
43 <td width="100%">
44 <span class="breadcrumbs">
45 <a href="TestON-module.html">Package&nbsp;TestON</a> ::
46 <a href="TestON.bin-module.html">Package&nbsp;bin</a> ::
47 <a href="TestON.bin.generatedriver-module.html">Module&nbsp;generatedriver</a> ::
48 Class&nbsp;GenerateDriver
49 </span>
50 </td>
51 <td>
52 <table cellpadding="0" cellspacing="0">
53 <!-- hide/show private -->
54 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
55 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
56 <tr><td align="right"><span class="options"
57 >[<a href="frames.html" target="_top">frames</a
58 >]&nbsp;|&nbsp;<a href="TestON.bin.generatedriver.GenerateDriver-class.html"
59 target="_top">no&nbsp;frames</a>]</span></td></tr>
60 </table>
61 </td>
62 </tr>
63</table>
64<!-- ==================== CLASS DESCRIPTION ==================== -->
65<h1 class="epydoc">Class GenerateDriver</h1><p class="nomargin-top"><span class="codelink"><a href="TestON.bin.generatedriver-pysrc.html#GenerateDriver">source&nbsp;code</a></span></p>
66<p>This will</p>
67
68<!-- ==================== INSTANCE METHODS ==================== -->
69<a name="section-InstanceMethods"></a>
70<table class="summary" border="1" cellpadding="3"
71 cellspacing="0" width="100%" bgcolor="white">
72<tr bgcolor="#70b0f0" class="table-header">
73 <td colspan="2" class="table-header">
74 <table border="0" cellpadding="0" cellspacing="0" width="100%">
75 <tr valign="top">
76 <td align="left"><span class="table-header">Instance Methods</span></td>
77 <td align="right" valign="top"
78 ><span class="options">[<a href="#section-InstanceMethods"
79 class="privatelink" onclick="toggle_private();"
80 >hide private</a>]</span></td>
81 </tr>
82 </table>
83 </td>
84</tr>
85<tr>
86 <td width="15%" align="right" valign="top" class="summary">
87 <span class="summary-type">&nbsp;</span>
88 </td><td class="summary">
89 <table width="100%" cellpadding="0" cellspacing="0" border="0">
90 <tr>
91 <td><span class="summary-sig"><a name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>)</span></td>
92 <td align="right" valign="top">
93 <span class="codelink"><a href="TestON.bin.generatedriver-pysrc.html#GenerateDriver.__init__">source&nbsp;code</a></span>
94
95 </td>
96 </tr>
97 </table>
98
99 </td>
100 </tr>
101<tr>
102 <td width="15%" align="right" valign="top" class="summary">
103 <span class="summary-type">&nbsp;</span>
104 </td><td class="summary">
105 <table width="100%" cellpadding="0" cellspacing="0" border="0">
106 <tr>
107 <td><span class="summary-sig"><a href="TestON.bin.generatedriver.GenerateDriver-class.html#connect" class="summary-sig-name">connect</a>(<span class="summary-sig-arg">self</span>,
108 <span class="summary-sig-arg">**connectargs</span>)</span><br />
109 Connection will establish to the remote host using ssh.</td>
110 <td align="right" valign="top">
111 <span class="codelink"><a href="TestON.bin.generatedriver-pysrc.html#GenerateDriver.connect">source&nbsp;code</a></span>
112
113 </td>
114 </tr>
115 </table>
116
117 </td>
118 </tr>
119<tr>
120 <td width="15%" align="right" valign="top" class="summary">
121 <span class="summary-type">&nbsp;</span>
122 </td><td class="summary">
123 <table width="100%" cellpadding="0" cellspacing="0" border="0">
124 <tr>
125 <td><span class="summary-sig"><a name="execute"></a><span class="summary-sig-name">execute</span>(<span class="summary-sig-arg">self</span>,
126 <span class="summary-sig-arg">**execparams</span>)</span><br />
127 This method will execute the command and will check for the expected
128 prompt.</td>
129 <td align="right" valign="top">
130 <span class="codelink"><a href="TestON.bin.generatedriver-pysrc.html#GenerateDriver.execute">source&nbsp;code</a></span>
131
132 </td>
133 </tr>
134 </table>
135
136 </td>
137 </tr>
138<tr>
139 <td width="15%" align="right" valign="top" class="summary">
140 <span class="summary-type">&nbsp;</span>
141 </td><td class="summary">
142 <table width="100%" cellpadding="0" cellspacing="0" border="0">
143 <tr>
144 <td><span class="summary-sig"><a name="configure"></a><span class="summary-sig-name">configure</span>(<span class="summary-sig-arg">self</span>)</span><br />
145 Will start the Configure mode of the device.</td>
146 <td align="right" valign="top">
147 <span class="codelink"><a href="TestON.bin.generatedriver-pysrc.html#GenerateDriver.configure">source&nbsp;code</a></span>
148
149 </td>
150 </tr>
151 </table>
152
153 </td>
154 </tr>
155<tr>
156 <td width="15%" align="right" valign="top" class="summary">
157 <span class="summary-type">&nbsp;</span>
158 </td><td class="summary">
159 <table width="100%" cellpadding="0" cellspacing="0" border="0">
160 <tr>
161 <td><span class="summary-sig"><a name="get_command_help"></a><span class="summary-sig-name">get_command_help</span>(<span class="summary-sig-arg">self</span>,
162 <span class="summary-sig-arg">command</span>)</span><br />
163 Will get the help of the Command</td>
164 <td align="right" valign="top">
165 <span class="codelink"><a href="TestON.bin.generatedriver-pysrc.html#GenerateDriver.get_command_help">source&nbsp;code</a></span>
166
167 </td>
168 </tr>
169 </table>
170
171 </td>
172 </tr>
173<tr>
174 <td width="15%" align="right" valign="top" class="summary">
175 <span class="summary-type">&nbsp;</span>
176 </td><td class="summary">
177 <table width="100%" cellpadding="0" cellspacing="0" border="0">
178 <tr>
179 <td><span class="summary-sig"><a name="get_command_details"></a><span class="summary-sig-name">get_command_details</span>(<span class="summary-sig-arg">self</span>,
180 <span class="summary-sig-arg">command</span>)</span><br />
181 Will Update the command_dictionary with the available commands
182 details</td>
183 <td align="right" valign="top">
184 <span class="codelink"><a href="TestON.bin.generatedriver-pysrc.html#GenerateDriver.get_command_details">source&nbsp;code</a></span>
185
186 </td>
187 </tr>
188 </table>
189
190 </td>
191 </tr>
192<tr>
193 <td width="15%" align="right" valign="top" class="summary">
194 <span class="summary-type">&nbsp;</span>
195 </td><td class="summary">
196 <table width="100%" cellpadding="0" cellspacing="0" border="0">
197 <tr>
198 <td><span class="summary-sig"><a name="print_details"></a><span class="summary-sig-name">print_details</span>(<span class="summary-sig-arg">self</span>,
199 <span class="summary-sig-arg">command_dictionary</span>)</span><br />
200 Will print the details in Tree Format</td>
201 <td align="right" valign="top">
202 <span class="codelink"><a href="TestON.bin.generatedriver-pysrc.html#GenerateDriver.print_details">source&nbsp;code</a></span>
203
204 </td>
205 </tr>
206 </table>
207
208 </td>
209 </tr>
210<tr>
211 <td width="15%" align="right" valign="top" class="summary">
212 <span class="summary-type">&nbsp;</span>
213 </td><td class="summary">
214 <table width="100%" cellpadding="0" cellspacing="0" border="0">
215 <tr>
216 <td><span class="summary-sig"><a name="get_details_recursive"></a><span class="summary-sig-name">get_details_recursive</span>(<span class="summary-sig-arg">self</span>,
217 <span class="summary-sig-arg">main_comand</span>)</span></td>
218 <td align="right" valign="top">
219 <span class="codelink"><a href="TestON.bin.generatedriver-pysrc.html#GenerateDriver.get_details_recursive">source&nbsp;code</a></span>
220
221 </td>
222 </tr>
223 </table>
224
225 </td>
226 </tr>
227<tr>
228 <td width="15%" align="right" valign="top" class="summary">
229 <span class="summary-type">&nbsp;</span>
230 </td><td class="summary">
231 <table width="100%" cellpadding="0" cellspacing="0" border="0">
232 <tr>
233 <td><span class="summary-sig"><a name="create_driver"></a><span class="summary-sig-name">create_driver</span>(<span class="summary-sig-arg">self</span>)</span></td>
234 <td align="right" valign="top">
235 <span class="codelink"><a href="TestON.bin.generatedriver-pysrc.html#GenerateDriver.create_driver">source&nbsp;code</a></span>
236
237 </td>
238 </tr>
239 </table>
240
241 </td>
242 </tr>
243<tr>
244 <td width="15%" align="right" valign="top" class="summary">
245 <span class="summary-type">&nbsp;</span>
246 </td><td class="summary">
247 <table width="100%" cellpadding="0" cellspacing="0" border="0">
248 <tr>
249 <td><span class="summary-sig"><a name="disconnect"></a><span class="summary-sig-name">disconnect</span>(<span class="summary-sig-arg">self</span>)</span></td>
250 <td align="right" valign="top">
251 <span class="codelink"><a href="TestON.bin.generatedriver-pysrc.html#GenerateDriver.disconnect">source&nbsp;code</a></span>
252
253 </td>
254 </tr>
255 </table>
256
257 </td>
258 </tr>
259</table>
260<!-- ==================== METHOD DETAILS ==================== -->
261<a name="section-MethodDetails"></a>
262<table class="details" border="1" cellpadding="3"
263 cellspacing="0" width="100%" bgcolor="white">
264<tr bgcolor="#70b0f0" class="table-header">
265 <td colspan="2" class="table-header">
266 <table border="0" cellpadding="0" cellspacing="0" width="100%">
267 <tr valign="top">
268 <td align="left"><span class="table-header">Method Details</span></td>
269 <td align="right" valign="top"
270 ><span class="options">[<a href="#section-MethodDetails"
271 class="privatelink" onclick="toggle_private();"
272 >hide private</a>]</span></td>
273 </tr>
274 </table>
275 </td>
276</tr>
277</table>
278<a name="connect"></a>
279<div>
280<table class="details" border="1" cellpadding="3"
281 cellspacing="0" width="100%" bgcolor="white">
282<tr><td>
283 <table width="100%" cellpadding="0" cellspacing="0" border="0">
284 <tr valign="top"><td>
285 <h3 class="epydoc"><span class="sig"><span class="sig-name">connect</span>(<span class="sig-arg">self</span>,
286 <span class="sig-arg">**connectargs</span>)</span>
287 </h3>
288 </td><td align="right" valign="top"
289 ><span class="codelink"><a href="TestON.bin.generatedriver-pysrc.html#GenerateDriver.connect">source&nbsp;code</a></span>&nbsp;
290 </td>
291 </tr></table>
292
293 <p>Connection will establish to the remote host using ssh. It will take
294 user_name ,ip_address and password as arguments&lt;br&gt; and will return
295 the handle.</p>
296 <dl class="fields">
297 </dl>
298</td></tr></table>
299</div>
300<br />
301<!-- ==================== NAVIGATION BAR ==================== -->
302<table class="navbar" border="0" width="100%" cellpadding="0"
303 bgcolor="#a0c0ff" cellspacing="0">
304 <tr valign="middle">
305 <!-- Home link -->
306 <th>&nbsp;&nbsp;&nbsp;<a
307 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
308
309 <!-- Tree link -->
310 <th>&nbsp;&nbsp;&nbsp;<a
311 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
312
313 <!-- Index link -->
314 <th>&nbsp;&nbsp;&nbsp;<a
315 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
316
317 <!-- Help link -->
318 <th>&nbsp;&nbsp;&nbsp;<a
319 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
320
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]321 <!-- Project homepage -->
322 <th class="navbar" align="right" width="100%">
323 <table border="0" cellpadding="0" cellspacing="0">
324 <tr><th class="navbar" align="center"
325 >TestON</th>
326 </tr></table></th>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]327 </tr>
328</table>
329<table border="0" cellpadding="0" cellspacing="0" width="100%%">
330 <tr>
331 <td align="left" class="footer">
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]332 Generated by Epydoc 3.0.1 on Mon Aug 10 11:12:34 2015
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]333 </td>
334 <td align="right" class="footer">
335 <a target="mainFrame" href="http://epydoc.sourceforge.net"
336 >http://epydoc.sourceforge.net</a>
337 </td>
338 </tr>
339</table>
340
341<script type="text/javascript">
342 <!--
343 // Private objects are initially displayed (because if
344 // javascript is turned off then we want them to be
345 // visible); but by default, we want to hide them. So hide
346 // them unless we have a cookie that says to show them.
347 checkCookie();
348 // -->
349</script>
350</body>
351</html>