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