blob: 082b12af4776857ed9e8ffb004a6787c8f3e4ba5 [file] [log] [blame]
adminbae64d82013-08-01 10:50:15 -07001<?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.api.fvtapidriver</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 -070033 <!-- 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 -070039 </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.api-module.html">Package&nbsp;api</a> ::
49 Module&nbsp;fvtapidriver
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
59 >]&nbsp;|&nbsp;<a href="TestON.drivers.common.api.fvtapidriver-module.html"
60 target="_top">no&nbsp;frames</a>]</span></td></tr>
61 </table>
62 </td>
63 </tr>
64</table>
65<!-- ==================== MODULE DESCRIPTION ==================== -->
66<h1 class="epydoc">Module fvtapidriver</h1><p class="nomargin-top"><span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html">source&nbsp;code</a></span></p>
Jon Halla1cdd892015-08-10 13:36:28 -070067<pre class="literalblock">
adminbae64d82013-08-01 10:50:15 -070068
Jon Halla1cdd892015-08-10 13:36:28 -070069Created on 26-Oct-2012
70
71author:: Anil Kumar ( anilkumar.s@paxterrasolutions.com )
72
73
74 TestON is free software: you can redistribute it and/or modify
75 it under the terms of the GNU General Public License as published by
76 the Free Software Foundation, either version 2 of the License, or
77 ( at your option ) any later version.
78
79 TestON is distributed in the hope that it will be useful,
80 but WITHOUT ANY WARRANTY; without even the implied warranty of
81 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
82 GNU General Public License for more details.
83
84 You should have received a copy of the GNU General Public License
85 along with TestON. If not, see &lt;http://www.gnu.org/licenses/&gt;.
86
87
88fvtapidriver is the basic driver which will handle the fvtapidriver functions
89
90</pre>
91
92<!-- ==================== CLASSES ==================== -->
adminbae64d82013-08-01 10:50:15 -070093<a name="section-Classes"></a>
94<table class="summary" border="1" cellpadding="3"
95 cellspacing="0" width="100%" bgcolor="white">
96<tr bgcolor="#70b0f0" class="table-header">
97 <td colspan="2" class="table-header">
98 <table border="0" cellpadding="0" cellspacing="0" width="100%">
99 <tr valign="top">
100 <td align="left"><span class="table-header">Classes</span></td>
101 <td align="right" valign="top"
102 ><span class="options">[<a href="#section-Classes"
103 class="privatelink" onclick="toggle_private();"
104 >hide private</a>]</span></td>
105 </tr>
106 </table>
107 </td>
108</tr>
109<tr>
110 <td width="15%" align="right" valign="top" class="summary">
111 <span class="summary-type">&nbsp;</span>
112 </td><td class="summary">
113 <a href="TestON.drivers.common.api.fvtapidriver.FvtApiDriver-class.html" class="summary-name">FvtApiDriver</a>
114 </td>
115 </tr>
116</table>
117<!-- ==================== FUNCTIONS ==================== -->
118<a name="section-Functions"></a>
119<table class="summary" border="1" cellpadding="3"
120 cellspacing="0" width="100%" bgcolor="white">
121<tr bgcolor="#70b0f0" class="table-header">
122 <td colspan="2" class="table-header">
123 <table border="0" cellpadding="0" cellspacing="0" width="100%">
124 <tr valign="top">
125 <td align="left"><span class="table-header">Functions</span></td>
126 <td align="right" valign="top"
127 ><span class="options">[<a href="#section-Functions"
128 class="privatelink" onclick="toggle_private();"
129 >hide private</a>]</span></td>
130 </tr>
131 </table>
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="test_set_init"></a><span class="summary-sig-name">test_set_init</span>(<span class="summary-sig-arg">config</span>)</span><br />
Jon Halla1cdd892015-08-10 13:36:28 -0700141 Set up function for basic test classes config: The configuration
142 dictionary; see fvt</td>
adminbae64d82013-08-01 10:50:15 -0700143 <td align="right" valign="top">
144 <span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#test_set_init">source&nbsp;code</a></span>
145
146 </td>
147 </tr>
148 </table>
149
150 </td>
151 </tr>
152</table>
153<!-- ==================== VARIABLES ==================== -->
154<a name="section-Variables"></a>
155<table class="summary" border="1" cellpadding="3"
156 cellspacing="0" width="100%" bgcolor="white">
157<tr bgcolor="#70b0f0" class="table-header">
158 <td colspan="2" class="table-header">
159 <table border="0" cellpadding="0" cellspacing="0" width="100%">
160 <tr valign="top">
161 <td align="left"><span class="table-header">Variables</span></td>
162 <td align="right" valign="top"
163 ><span class="options">[<a href="#section-Variables"
164 class="privatelink" onclick="toggle_private();"
165 >hide private</a>]</span></td>
166 </tr>
167 </table>
168 </td>
169</tr>
170<tr>
171 <td width="15%" align="right" valign="top" class="summary">
172 <span class="summary-type">&nbsp;</span>
173 </td><td class="summary">
174 <a href="TestON.drivers.common.api.fvtapidriver-module.html#config_default" class="summary-name">config_default</a> = <code title="{&quot;param&quot;: None, &quot;fv_cmd&quot;: &quot;/home/openflow/flowvisor/scripts/flowvisor.\
175sh&quot;, &quot;platform&quot;: &quot;local&quot;, &quot;controller_host&quot;: &quot;127.0.0.1&quot;, &quot;controller_\
176port&quot;: 6633, &quot;timeout&quot;: 3, &quot;port_count&quot;: 4, &quot;base_of_port&quot;: 1, &quot;base_i\
177f_index&quot;: 1, &quot;test_spec&quot;: &quot;all&quot;, &quot;test_dir&quot;: &quot;.&quot;, &quot;log_file&quot;: &quot;/home/o\
178penflow/fvt.log&quot;, &quot;list&quot;: False, &quot;debug&quot;: &quot;debug&quot;, &quot;dbg_level&quot;: loggin\
179g.DEBUG, &quot;port_map&quot;: {}, &quot;test_params&quot;: &quot;None&quot;}">{&quot;param&quot;: None, &quot;fv_cmd&quot;: &quot;/home/openflow/flo<code class="variable-ellipsis">...</code></code>
180 </td>
181 </tr>
182</table>
183<!-- ==================== VARIABLES DETAILS ==================== -->
184<a name="section-VariablesDetails"></a>
185<table class="details" border="1" cellpadding="3"
186 cellspacing="0" width="100%" bgcolor="white">
187<tr bgcolor="#70b0f0" class="table-header">
188 <td colspan="2" class="table-header">
189 <table border="0" cellpadding="0" cellspacing="0" width="100%">
190 <tr valign="top">
191 <td align="left"><span class="table-header">Variables Details</span></td>
192 <td align="right" valign="top"
193 ><span class="options">[<a href="#section-VariablesDetails"
194 class="privatelink" onclick="toggle_private();"
195 >hide private</a>]</span></td>
196 </tr>
197 </table>
198 </td>
199</tr>
200</table>
201<a name="config_default"></a>
202<div>
203<table class="details" border="1" cellpadding="3"
204 cellspacing="0" width="100%" bgcolor="white">
205<tr><td>
206 <h3 class="epydoc">config_default</h3>
207
208 <dl class="fields">
209 </dl>
210 <dl class="fields">
211 <dt>Value:</dt>
212 <dd><table><tr><td><pre class="variable">
213{&quot;param&quot;: None, &quot;fv_cmd&quot;: &quot;/home/openflow/flowvisor/scripts/flowvisor.<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
214sh&quot;, &quot;platform&quot;: &quot;local&quot;, &quot;controller_host&quot;: &quot;127.0.0.1&quot;, &quot;controller_<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
215port&quot;: 6633, &quot;timeout&quot;: 3, &quot;port_count&quot;: 4, &quot;base_of_port&quot;: 1, &quot;base_i<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
216f_index&quot;: 1, &quot;test_spec&quot;: &quot;all&quot;, &quot;test_dir&quot;: &quot;.&quot;, &quot;log_file&quot;: &quot;/home/o<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
217penflow/fvt.log&quot;, &quot;list&quot;: False, &quot;debug&quot;: &quot;debug&quot;, &quot;dbg_level&quot;: loggin<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
218g.DEBUG, &quot;port_map&quot;: {}, &quot;test_params&quot;: &quot;None&quot;}
219</pre></td></tr></table>
220</dd>
221 </dl>
222</td></tr></table>
223</div>
224<br />
225<!-- ==================== NAVIGATION BAR ==================== -->
226<table class="navbar" border="0" width="100%" cellpadding="0"
227 bgcolor="#a0c0ff" cellspacing="0">
228 <tr valign="middle">
229 <!-- Home link -->
230 <th>&nbsp;&nbsp;&nbsp;<a
231 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
232
233 <!-- Tree link -->
234 <th>&nbsp;&nbsp;&nbsp;<a
235 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
236
237 <!-- Index link -->
238 <th>&nbsp;&nbsp;&nbsp;<a
239 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
240
241 <!-- Help link -->
242 <th>&nbsp;&nbsp;&nbsp;<a
243 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
244
Jon Halla1cdd892015-08-10 13:36:28 -0700245 <!-- Project homepage -->
246 <th class="navbar" align="right" width="100%">
247 <table border="0" cellpadding="0" cellspacing="0">
248 <tr><th class="navbar" align="center"
249 >TestON</th>
250 </tr></table></th>
adminbae64d82013-08-01 10:50:15 -0700251 </tr>
252</table>
253<table border="0" cellpadding="0" cellspacing="0" width="100%%">
254 <tr>
255 <td align="left" class="footer">
Jon Halla1cdd892015-08-10 13:36:28 -0700256 Generated by Epydoc 3.0.1 on Mon Aug 10 11:12:34 2015
adminbae64d82013-08-01 10:50:15 -0700257 </td>
258 <td align="right" class="footer">
259 <a target="mainFrame" href="http://epydoc.sourceforge.net"
260 >http://epydoc.sourceforge.net</a>
261 </td>
262 </tr>
263</table>
264
265<script type="text/javascript">
266 <!--
267 // Private objects are initially displayed (because if
268 // javascript is turned off then we want them to be
269 // visible); but by default, we want to hide them. So hide
270 // them unless we have a cookie that says to show them.
271 checkCookie();
272 // -->
273</script>
274</body>
275</html>