Gitiles
Code Review Sign In
gerrit.onosproject.org / OnosSystemTest / c4c812cb1afa815598d313ee1ce7a71236df7d2c / . / TestON / Documentation / TestON_Document / TestON.drivers.common.cli.emulator.lincoedriver.LincOEDriver-class.html
blob: 476b1241a2db17fa401ef3106c27fa41c971aaac [file] [log] [blame]
Jon Halla1cdd892015-08-10 13:36:28 -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.drivers.common.cli.emulator.lincoedriver.LincOEDriver</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 <!-- 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>
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> ::
48 <a href="TestON.drivers.common.cli-module.html">Package&nbsp;cli</a> ::
49 <a href="TestON.drivers.common.cli.emulator-module.html">Package&nbsp;emulator</a> ::
50 <a href="TestON.drivers.common.cli.emulator.lincoedriver-module.html">Module&nbsp;lincoedriver</a> ::
51 Class&nbsp;LincOEDriver
52 </span>
53 </td>
54 <td>
55 <table cellpadding="0" cellspacing="0">
56 <!-- hide/show private -->
57 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
58 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
59 <tr><td align="right"><span class="options"
60 >[<a href="frames.html" target="_top">frames</a
61 >]&nbsp;|&nbsp;<a href="TestON.drivers.common.cli.emulator.lincoedriver.LincOEDriver-class.html"
62 target="_top">no&nbsp;frames</a>]</span></td></tr>
63 </table>
64 </td>
65 </tr>
66</table>
67<!-- ==================== CLASS DESCRIPTION ==================== -->
68<h1 class="epydoc">Class LincOEDriver</h1><p class="nomargin-top"><span class="codelink"><a href="TestON.drivers.common.cli.emulator.lincoedriver-pysrc.html#LincOEDriver">source&nbsp;code</a></span></p>
69<center>
70<center> <map id="class_hierarchy_for_lincoedriv" name="class_hierarchy_for_lincoedriv">
71<area shape="rect" id="node1" href="TestON.drivers.common.cli.emulator.lincoedriver.LincOEDriver-class.html" title="LincOEDriver" alt="" coords="5,6,104,31"/>
72<area shape="rect" id="node2" href="TestON.drivers.common.cli.emulatordriver.Emulator-class.html" title="emulatordriver.Emulator" alt="" coords="128,6,287,31"/>
73<area shape="rect" id="node3" href="TestON.drivers.common.clidriver.CLI-class.html" title="clidriver.CLI" alt="" coords="313,6,404,31"/>
74<area shape="rect" id="node4" href="javascript:void(0);" title="component.Component" alt="" coords="429,6,587,31"/>
75</map>
76 <img src="class_hierarchy_for_lincoedriv.gif" alt='' usemap="#class_hierarchy_for_lincoedriv" ismap="ismap" class="graph-without-title" />
77</center>
78</center>
79<hr />
80<p>LincOEDriver class will handle all emulator functions</p>
81
82<!-- ==================== INSTANCE METHODS ==================== -->
83<a name="section-InstanceMethods"></a>
84<table class="summary" border="1" cellpadding="3"
85 cellspacing="0" width="100%" bgcolor="white">
86<tr bgcolor="#70b0f0" class="table-header">
87 <td colspan="2" class="table-header">
88 <table border="0" cellpadding="0" cellspacing="0" width="100%">
89 <tr valign="top">
90 <td align="left"><span class="table-header">Instance Methods</span></td>
91 <td align="right" valign="top"
92 ><span class="options">[<a href="#section-InstanceMethods"
93 class="privatelink" onclick="toggle_private();"
94 >hide private</a>]</span></td>
95 </tr>
96 </table>
97 </td>
98</tr>
99<tr>
100 <td width="15%" align="right" valign="top" class="summary">
101 <span class="summary-type">&nbsp;</span>
102 </td><td class="summary">
103 <table width="100%" cellpadding="0" cellspacing="0" border="0">
104 <tr>
105 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.lincoedriver.LincOEDriver-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>)</span><br />
106 x.__init__(...) initializes x; see help(type(x)) for signature</td>
107 <td align="right" valign="top">
108 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.lincoedriver-pysrc.html#LincOEDriver.__init__">source&nbsp;code</a></span>
109
110 </td>
111 </tr>
112 </table>
113
114 </td>
115 </tr>
116<tr>
117 <td width="15%" align="right" valign="top" class="summary">
118 <span class="summary-type">&nbsp;</span>
119 </td><td class="summary">
120 <table width="100%" cellpadding="0" cellspacing="0" border="0">
121 <tr>
122 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.lincoedriver.LincOEDriver-class.html#connect" class="summary-sig-name">connect</a>(<span class="summary-sig-arg">self</span>,
123 <span class="summary-sig-arg">**connectargs</span>)</span><br />
124 Create ssh handle for Linc-OE cli</td>
125 <td align="right" valign="top">
126 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.lincoedriver-pysrc.html#LincOEDriver.connect">source&nbsp;code</a></span>
127
128 </td>
129 </tr>
130 </table>
131
132 </td>
133 </tr>
134<tr>
135 <td width="15%" align="right" valign="top" class="summary">
136 <span class="summary-type">&nbsp;</span>
137 </td><td class="summary">
138 <table width="100%" cellpadding="0" cellspacing="0" border="0">
139 <tr>
140 <td><span class="summary-sig"><a name="startConsole"></a><span class="summary-sig-name">startConsole</span>(<span class="summary-sig-arg">self</span>)</span></td>
141 <td align="right" valign="top">
142 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.lincoedriver-pysrc.html#LincOEDriver.startConsole">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="build"></a><span class="summary-sig-name">build</span>(<span class="summary-sig-arg">self</span>)</span><br />
157 Build Linc-OE with the specified settings</td>
158 <td align="right" valign="top">
159 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.lincoedriver-pysrc.html#LincOEDriver.build">source&nbsp;code</a></span>
160
161 </td>
162 </tr>
163 </table>
164
165 </td>
166 </tr>
167<tr>
168 <td width="15%" align="right" valign="top" class="summary">
169 <span class="summary-type">&nbsp;</span>
170 </td><td class="summary">
171 <table width="100%" cellpadding="0" cellspacing="0" border="0">
172 <tr>
173 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.lincoedriver.LincOEDriver-class.html#setInterfaceUp" class="summary-sig-name">setInterfaceUp</a>(<span class="summary-sig-arg">self</span>,
174 <span class="summary-sig-arg">intfs</span>)</span><br />
175 Specify interface to bring up.</td>
176 <td align="right" valign="top">
177 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.lincoedriver-pysrc.html#LincOEDriver.setInterfaceUp">source&nbsp;code</a></span>
178
179 </td>
180 </tr>
181 </table>
182
183 </td>
184 </tr>
185<tr>
186 <td width="15%" align="right" valign="top" class="summary">
187 <span class="summary-type">&nbsp;</span>
188 </td><td class="summary">
189 <table width="100%" cellpadding="0" cellspacing="0" border="0">
190 <tr>
191 <td><span class="summary-sig"><a name="startSwitch"></a><span class="summary-sig-name">startSwitch</span>(<span class="summary-sig-arg">self</span>,
192 <span class="summary-sig-arg">swId</span>)</span><br />
193 Start a logical switch using switch id</td>
194 <td align="right" valign="top">
195 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.lincoedriver-pysrc.html#LincOEDriver.startSwitch">source&nbsp;code</a></span>
196
197 </td>
198 </tr>
199 </table>
200
201 </td>
202 </tr>
203<tr>
204 <td width="15%" align="right" valign="top" class="summary">
205 <span class="summary-type">&nbsp;</span>
206 </td><td class="summary">
207 <table width="100%" cellpadding="0" cellspacing="0" border="0">
208 <tr>
209 <td><span class="summary-sig"><a name="stopSwitch"></a><span class="summary-sig-name">stopSwitch</span>(<span class="summary-sig-arg">self</span>,
210 <span class="summary-sig-arg">swId</span>)</span><br />
211 Stop a logical switch using switch id</td>
212 <td align="right" valign="top">
213 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.lincoedriver-pysrc.html#LincOEDriver.stopSwitch">source&nbsp;code</a></span>
214
215 </td>
216 </tr>
217 </table>
218
219 </td>
220 </tr>
221<tr>
222 <td width="15%" align="right" valign="top" class="summary">
223 <span class="summary-type">&nbsp;</span>
224 </td><td class="summary">
225 <table width="100%" cellpadding="0" cellspacing="0" border="0">
226 <tr>
227 <td><span class="summary-sig"><a name="getDatapathId"></a><span class="summary-sig-name">getDatapathId</span>(<span class="summary-sig-arg">self</span>,
228 <span class="summary-sig-arg">swId</span>)</span><br />
229 Get datapath id of a specific switch by switch id</td>
230 <td align="right" valign="top">
231 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.lincoedriver-pysrc.html#LincOEDriver.getDatapathId">source&nbsp;code</a></span>
232
233 </td>
234 </tr>
235 </table>
236
237 </td>
238 </tr>
239<tr>
240 <td width="15%" align="right" valign="top" class="summary">
241 <span class="summary-type">&nbsp;</span>
242 </td><td class="summary">
243 <table width="100%" cellpadding="0" cellspacing="0" border="0">
244 <tr>
245 <td><span class="summary-sig"><a name="attachLincOESession"></a><span class="summary-sig-name">attachLincOESession</span>(<span class="summary-sig-arg">self</span>)</span><br />
246 Since executing opticalTest.py will give you mininet prompt, you
247 would at some point require to get onto console of LincOE
248 ((linc@onosTestBench)1&gt;) to execute commands like bring a optical
249 port up or down on a ROADM You can attach to console of Linc-OE
250 session by a cmd: sudo ~/linc-oe/rel/linc/bin/linc attach</td>
251 <td align="right" valign="top">
252 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.lincoedriver-pysrc.html#LincOEDriver.attachLincOESession">source&nbsp;code</a></span>
253
254 </td>
255 </tr>
256 </table>
257
258 </td>
259 </tr>
260<tr>
261 <td width="15%" align="right" valign="top" class="summary">
262 <span class="summary-type">&nbsp;</span>
263 </td><td class="summary">
264 <table width="100%" cellpadding="0" cellspacing="0" border="0">
265 <tr>
266 <td><span class="summary-sig"><a name="listPorts"></a><span class="summary-sig-name">listPorts</span>(<span class="summary-sig-arg">self</span>,
267 <span class="summary-sig-arg">swId</span>)</span><br />
268 List all ports of a switch by switch id</td>
269 <td align="right" valign="top">
270 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.lincoedriver-pysrc.html#LincOEDriver.listPorts">source&nbsp;code</a></span>
271
272 </td>
273 </tr>
274 </table>
275
276 </td>
277 </tr>
278<tr>
279 <td width="15%" align="right" valign="top" class="summary">
280 <span class="summary-type">&nbsp;</span>
281 </td><td class="summary">
282 <table width="100%" cellpadding="0" cellspacing="0" border="0">
283 <tr>
284 <td><span class="summary-sig"><a name="portUp"></a><span class="summary-sig-name">portUp</span>(<span class="summary-sig-arg">self</span>,
285 <span class="summary-sig-arg">swId</span>,
286 <span class="summary-sig-arg">ptId</span>)</span><br />
287 Bring port up using switch id and port id</td>
288 <td align="right" valign="top">
289 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.lincoedriver-pysrc.html#LincOEDriver.portUp">source&nbsp;code</a></span>
290
291 </td>
292 </tr>
293 </table>
294
295 </td>
296 </tr>
297<tr>
298 <td width="15%" align="right" valign="top" class="summary">
299 <span class="summary-type">&nbsp;</span>
300 </td><td class="summary">
301 <table width="100%" cellpadding="0" cellspacing="0" border="0">
302 <tr>
303 <td><span class="summary-sig"><a name="portDown"></a><span class="summary-sig-name">portDown</span>(<span class="summary-sig-arg">self</span>,
304 <span class="summary-sig-arg">swId</span>,
305 <span class="summary-sig-arg">ptId</span>)</span><br />
306 Bring port down using switch id and port id</td>
307 <td align="right" valign="top">
308 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.lincoedriver-pysrc.html#LincOEDriver.portDown">source&nbsp;code</a></span>
309
310 </td>
311 </tr>
312 </table>
313
314 </td>
315 </tr>
316<tr>
317 <td width="15%" align="right" valign="top" class="summary">
318 <span class="summary-type">&nbsp;</span>
319 </td><td class="summary">
320 <table width="100%" cellpadding="0" cellspacing="0" border="0">
321 <tr>
322 <td><span class="summary-sig"><a name="stopLincOEConsole"></a><span class="summary-sig-name">stopLincOEConsole</span>(<span class="summary-sig-arg">self</span>)</span><br />
323 This function is only used for packet optical testing Send disconnect
324 prompt to Linc-OE CLI ( CTRL+C ) and kill the linc process</td>
325 <td align="right" valign="top">
326 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.lincoedriver-pysrc.html#LincOEDriver.stopLincOEConsole">source&nbsp;code</a></span>
327
328 </td>
329 </tr>
330 </table>
331
332 </td>
333 </tr>
334<tr>
335 <td width="15%" align="right" valign="top" class="summary">
336 <span class="summary-type">&nbsp;</span>
337 </td><td class="summary">
338 <table width="100%" cellpadding="0" cellspacing="0" border="0">
339 <tr>
340 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.emulator.lincoedriver.LincOEDriver-class.html#disconnect" class="summary-sig-name">disconnect</a>(<span class="summary-sig-arg">self</span>)</span><br />
341 Send disconnect prompt to Linc-OE CLI ( CTRL+C ) and kill the linc
342 process</td>
343 <td align="right" valign="top">
344 <span class="codelink"><a href="TestON.drivers.common.cli.emulator.lincoedriver-pysrc.html#LincOEDriver.disconnect">source&nbsp;code</a></span>
345
346 </td>
347 </tr>
348 </table>
349
350 </td>
351 </tr>
352<tr>
353 <td width="15%" align="right" valign="top" class="summary">
354 <span class="summary-type">&nbsp;</span>
355 </td><td class="summary">
356 <table width="100%" cellpadding="0" cellspacing="0" border="0">
357 <tr>
358 <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>,
359 <span class="summary-sig-arg">**execparams</span>)</span><br />
360 It facilitates the command line execution of a given command.
361 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
362 <td align="right" valign="top">
363 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.execute">source&nbsp;code</a></span>
364
365 </td>
366 </tr>
367 </table>
368
369 </td>
370 </tr>
371<tr>
372 <td width="15%" align="right" valign="top" class="summary">
373 <span class="summary-type">&nbsp;</span>
374 </td><td class="summary">
375 <table width="100%" cellpadding="0" cellspacing="0" border="0">
376 <tr>
377 <td><span class="summary-sig"><a name="onfail"></a><span class="summary-sig-name">onfail</span>(<span class="summary-sig-arg">self</span>)</span>
378 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
379 <td align="right" valign="top">
380 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.onfail">source&nbsp;code</a></span>
381
382 </td>
383 </tr>
384 </table>
385
386 </td>
387 </tr>
388<tr>
389 <td width="15%" align="right" valign="top" class="summary">
390 <span class="summary-type">&nbsp;</span>
391 </td><td class="summary">
392 <table width="100%" cellpadding="0" cellspacing="0" border="0">
393 <tr>
394 <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>,
395 <span class="summary-sig-arg">response</span>)</span>
396 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
397 <td align="right" valign="top">
398 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.remove_contol_chars">source&nbsp;code</a></span>
399
400 </td>
401 </tr>
402 </table>
403
404 </td>
405 </tr>
406<tr>
407 <td width="15%" align="right" valign="top" class="summary">
408 <span class="summary-type">&nbsp;</span>
409 </td><td class="summary">
410 <table width="100%" cellpadding="0" cellspacing="0" border="0">
411 <tr>
412 <td><span class="summary-sig"><a name="runAsSudoUser"></a><span class="summary-sig-name">runAsSudoUser</span>(<span class="summary-sig-arg">self</span>,
413 <span class="summary-sig-arg">handle</span>,
414 <span class="summary-sig-arg">pwd</span>,
415 <span class="summary-sig-arg">default</span>)</span>
416 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
417 <td align="right" valign="top">
418 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.runAsSudoUser">source&nbsp;code</a></span>
419
420 </td>
421 </tr>
422 </table>
423
424 </td>
425 </tr>
426<tr>
427 <td width="15%" align="right" valign="top" class="summary">
428 <span class="summary-type">&nbsp;</span>
429 </td><td class="summary">
430 <table width="100%" cellpadding="0" cellspacing="0" border="0">
431 <tr>
432 <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>,
433 <span class="summary-sig-arg">user_name</span>,
434 <span class="summary-sig-arg">ip_address</span>,
435 <span class="summary-sig-arg">filepath</span>,
436 <span class="summary-sig-arg">pwd</span>,
437 <span class="summary-sig-arg">dst_path</span>)</span><br />
438 Connection will establish to the remote host using ssh.
439 <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
440 <td align="right" valign="top">
441 <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.secureCopy">source&nbsp;code</a></span>
442
443 </td>
444 </tr>
445 </table>
446
447 </td>
448 </tr>
449 <tr>
450 <td colspan="2" class="summary">
451 <p class="indent-wrapped-lines"><b>Inherited from <code>component.Component</code></b>:
452 <code>__getattr__</code>,
453 <code>cleanup</code>,
454 <code>close_log_handles</code>,
455 <code>config</code>,
456 <code>experimentRun</code>,
457 <code>get_version</code>,
458 <code>log</code>
459 </p>
460 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
461 <code>__delattr__</code>,
462 <code>__format__</code>,
463 <code>__getattribute__</code>,
464 <code>__hash__</code>,
465 <code>__new__</code>,
466 <code>__reduce__</code>,
467 <code>__reduce_ex__</code>,
468 <code>__repr__</code>,
469 <code>__setattr__</code>,
470 <code>__sizeof__</code>,
471 <code>__str__</code>,
472 <code>__subclasshook__</code>
473 </p>
474 </td>
475 </tr>
476</table>
477<!-- ==================== PROPERTIES ==================== -->
478<a name="section-Properties"></a>
479<table class="summary" border="1" cellpadding="3"
480 cellspacing="0" width="100%" bgcolor="white">
481<tr bgcolor="#70b0f0" class="table-header">
482 <td colspan="2" class="table-header">
483 <table border="0" cellpadding="0" cellspacing="0" width="100%">
484 <tr valign="top">
485 <td align="left"><span class="table-header">Properties</span></td>
486 <td align="right" valign="top"
487 ><span class="options">[<a href="#section-Properties"
488 class="privatelink" onclick="toggle_private();"
489 >hide private</a>]</span></td>
490 </tr>
491 </table>
492 </td>
493</tr>
494 <tr>
495 <td colspan="2" class="summary">
496 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
497 <code>__class__</code>
498 </p>
499 </td>
500 </tr>
501</table>
502<!-- ==================== METHOD DETAILS ==================== -->
503<a name="section-MethodDetails"></a>
504<table class="details" border="1" cellpadding="3"
505 cellspacing="0" width="100%" bgcolor="white">
506<tr bgcolor="#70b0f0" class="table-header">
507 <td colspan="2" class="table-header">
508 <table border="0" cellpadding="0" cellspacing="0" width="100%">
509 <tr valign="top">
510 <td align="left"><span class="table-header">Method Details</span></td>
511 <td align="right" valign="top"
512 ><span class="options">[<a href="#section-MethodDetails"
513 class="privatelink" onclick="toggle_private();"
514 >hide private</a>]</span></td>
515 </tr>
516 </table>
517 </td>
518</tr>
519</table>
520<a name="__init__"></a>
521<div>
522<table class="details" border="1" cellpadding="3"
523 cellspacing="0" width="100%" bgcolor="white">
524<tr><td>
525 <table width="100%" cellpadding="0" cellspacing="0" border="0">
526 <tr valign="top"><td>
527 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>)</span>
528 <br /><em class="fname">(Constructor)</em>
529 </h3>
530 </td><td align="right" valign="top"
531 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.lincoedriver-pysrc.html#LincOEDriver.__init__">source&nbsp;code</a></span>&nbsp;
532 </td>
533 </tr></table>
534
535 <p>x.__init__(...) initializes x; see help(type(x)) for signature</p>
536 <dl class="fields">
537 <dt>Overrides:
538 object.__init__
539 <dd><em class="note">(inherited documentation)</em></dd>
540 </dt>
541 </dl>
542</td></tr></table>
543</div>
544<a name="connect"></a>
545<div>
546<table class="details" border="1" cellpadding="3"
547 cellspacing="0" width="100%" bgcolor="white">
548<tr><td>
549 <table width="100%" cellpadding="0" cellspacing="0" border="0">
550 <tr valign="top"><td>
551 <h3 class="epydoc"><span class="sig"><span class="sig-name">connect</span>(<span class="sig-arg">self</span>,
552 <span class="sig-arg">**connectargs</span>)</span>
553 </h3>
554 </td><td align="right" valign="top"
555 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.lincoedriver-pysrc.html#LincOEDriver.connect">source&nbsp;code</a></span>&nbsp;
556 </td>
557 </tr></table>
558
559 <p>Create ssh handle for Linc-OE cli</p>
560 <dl class="fields">
561 <dt>Overrides:
562 component.Component.connect
563 </dt>
564 </dl>
565</td></tr></table>
566</div>
567<a name="setInterfaceUp"></a>
568<div>
569<table class="details" border="1" cellpadding="3"
570 cellspacing="0" width="100%" bgcolor="white">
571<tr><td>
572 <table width="100%" cellpadding="0" cellspacing="0" border="0">
573 <tr valign="top"><td>
574 <h3 class="epydoc"><span class="sig"><span class="sig-name">setInterfaceUp</span>(<span class="sig-arg">self</span>,
575 <span class="sig-arg">intfs</span>)</span>
576 </h3>
577 </td><td align="right" valign="top"
578 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.lincoedriver-pysrc.html#LincOEDriver.setInterfaceUp">source&nbsp;code</a></span>&nbsp;
579 </td>
580 </tr></table>
581
582 <p>Specify interface to bring up. When Linc-OE is started, tap interfaces
583 should be created. They must be brought up manually</p>
584 <dl class="fields">
585 </dl>
586</td></tr></table>
587</div>
588<a name="disconnect"></a>
589<div>
590<table class="details" border="1" cellpadding="3"
591 cellspacing="0" width="100%" bgcolor="white">
592<tr><td>
593 <table width="100%" cellpadding="0" cellspacing="0" border="0">
594 <tr valign="top"><td>
595 <h3 class="epydoc"><span class="sig"><span class="sig-name">disconnect</span>(<span class="sig-arg">self</span>)</span>
596 </h3>
597 </td><td align="right" valign="top"
598 ><span class="codelink"><a href="TestON.drivers.common.cli.emulator.lincoedriver-pysrc.html#LincOEDriver.disconnect">source&nbsp;code</a></span>&nbsp;
599 </td>
600 </tr></table>
601
602 <p>Send disconnect prompt to Linc-OE CLI ( CTRL+C ) and kill the linc
603 process</p>
604 <dl class="fields">
605 <dt>Overrides:
606 component.Component.disconnect
607 </dt>
608 </dl>
609</td></tr></table>
610</div>
611<br />
612<!-- ==================== NAVIGATION BAR ==================== -->
613<table class="navbar" border="0" width="100%" cellpadding="0"
614 bgcolor="#a0c0ff" cellspacing="0">
615 <tr valign="middle">
616 <!-- Home link -->
617 <th>&nbsp;&nbsp;&nbsp;<a
618 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
619
620 <!-- Tree link -->
621 <th>&nbsp;&nbsp;&nbsp;<a
622 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
623
624 <!-- Index link -->
625 <th>&nbsp;&nbsp;&nbsp;<a
626 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
627
628 <!-- Help link -->
629 <th>&nbsp;&nbsp;&nbsp;<a
630 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
631
632 <!-- Project homepage -->
633 <th class="navbar" align="right" width="100%">
634 <table border="0" cellpadding="0" cellspacing="0">
635 <tr><th class="navbar" align="center"
636 >TestON</th>
637 </tr></table></th>
638 </tr>
639</table>
640<table border="0" cellpadding="0" cellspacing="0" width="100%%">
641 <tr>
642 <td align="left" class="footer">
643 Generated by Epydoc 3.0.1 on Mon Aug 10 11:12:35 2015
644 </td>
645 <td align="right" class="footer">
646 <a target="mainFrame" href="http://epydoc.sourceforge.net"
647 >http://epydoc.sourceforge.net</a>
648 </td>
649 </tr>
650</table>
651
652<script type="text/javascript">
653 <!--
654 // Private objects are initially displayed (because if
655 // javascript is turned off then we want them to be
656 // visible); but by default, we want to hide them. So hide
657 // them unless we have a cookie that says to show them.
658 checkCookie();
659 // -->
660</script>
661</body>
662</html>