[nd] Don't use inline for RDMA reads. (mlnx 5666)
[mirror/winof/.git] / docs / Manual.htm
1 \r
2 <head>\r
3 <style>\r
4 <!--\r
5 div.Section1\r
6         {page:Section1;}\r
7 -->\r
8 </style>\r
9 </head>\r
10 \r
11 <h1 align="left">\r
12 <img border="0" src="openfabrics.gif" width="107" height="93">&nbsp; \r
13 <a href="#TOP"></a> </h1>\r
14 <h1 align="center">Windows OpenFabrics </h1>\r
15 <h1 align="center">User's Manual</h1>\r
16 <h2 align="center">Release 2.2</h2>\r
17 <h3 align="center">\r
18 <!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%m/%d/%Y" startspan -->12/29/2009<!--webbot bot="Timestamp" endspan i-checksum="12659" --></h3>\r
19 <h2 align="left"><u>Overview</u></h2>\r
20 <p align="left"><span style="FONT-SIZE: 12pt; FONT-FAMILY: 'Times New Roman'">\r
21 The Windows OpenFabrics (WinOF) package is composed of software modules intended \r
22 for use on Microsoft Windows based computer systems connected via an InfiniBand \r
23 fabric.</span></p>\r
24 <p align="left">The Windows OpenFabrics software package contains the \r
25 following:<br>\r
26 <br>\r
27 OpenFabrics Infiniband core drivers and Upper Level Protocols (ULPs):</p>\r
28 <ul>\r
29         <li>\r
30         <p align="left">HCA (Host Channel Adapter) driver </li>\r
31         <li>\r
32         <p style="text-indent: -.25in; margin-left: .5in"><span dir="LTR">MTHCA -<span style='background-position: 0% 0%; mso-highlight:yellow; background-image:none; background-repeat:repeat; background-attachment:scroll'> \r
33         Mellanox </span></span><span style='background-position: 0% 0%; mso-highlight:yellow; background-image:none; background-repeat:repeat; background-attachment:scroll'> \r
34         InfiniHost low level driver. See \r
35         Release_notes.htm for a list of supported devices.</span></li>\r
36         <li>\r
37         <p style="text-indent: -.25in; margin-left: .5in">\r
38         <span style="background-position: 0% 0%">MLX4&nbsp;&nbsp;&nbsp; - Mellanox \r
39         ConnectX low level driver.</span><span\r
40 style='background-position: 0% 0%; mso-highlight:yellow; background-image:none; background-repeat:repeat; background-attachment:scroll'> <o:p></o:p></span>\r
41         </li>\r
42 <li>\r
43 <p align="left">Infiniband Core modules: IB verbs and IB access layer</li>\r
44 <li>\r
45 <p align="left">Upper Layer Protocols: IPoIB, WSD, NetworkDirect, VNIC, SRP Initiator and uDAPL</li>\r
46 </ul>\r
47 <p align="left">OpenFabrics Tools:</p>\r
48 <ul>\r
49         <li>\r
50         <p align="left">OpenSM: InfiniBand Subnet Manager</li>\r
51 <li>\r
52 <p align="left">Performance tests</li>\r
53 <li>\r
54 <p align="left">Diagnostic tools</li>\r
55 </ul>\r
56 <p align="left">Documentation</p>\r
57 <ul>\r
58         <li>\r
59         <p align="left">User's manual</li>\r
60 <li>\r
61 <p align="left">Release Notes</li>\r
62 </ul>\r
63 <p align="left">&nbsp;</p>\r
64 <h2 align="left"><u><a name="TOP"></a>WinOF Features</u></h2>\r
65 <ul>\r
66         <li>\r
67         <h3 align="left"><a href="#Tools">Tools &amp; Diagnostics</a></h3></li>\r
68 </ul>\r
69 <ul>\r
70         <li>\r
71         <h3 align="left"><a href="#IPoIB">IPoIB - Internet Protocols over InfiniBand</a></h3>\r
72         </li>\r
73         <li>\r
74         <h3 align="left"><a href="#winsockdirect">Winsock Direct Service Provider</a></h3>\r
75         </li>\r
76         <li>\r
77         <h3 align="left"><a href="#Network_Direct_Service_Provider">NetworkDirect \r
78         Service Provider</a></h3>\r
79         </li>\r
80         <li>\r
81         <h3 align="left"><a href="#DAT">DAT and uDAPL</a></h3>\r
82 <ul>\r
83         <li>\r
84         <h4 align="left"><a href="#DAPLTEST">DAPLtest</a></h4></li>\r
85         <li>\r
86         <h4 align="left"><a href="#DAPLtest-examples">DAPLtest Examples</a></h4>\r
87         </li>\r
88         <li>\r
89         <p align="left"><b><a href="#DAT_App_Build">DAT Application Build</a></b><br>\r
90         <br>&nbsp;</li>\r
91 </ul></li>\r
92         <li>\r
93         <h3 align="left"><a href="#SRP">SRP (SCSI over RDMA) Protocol Driver</a></h3></li>\r
94         <li>\r
95         <h3 align="left"><u><font color="#0000FF"><a href="#QLOGICVNIC">QLogic VNIC_Driver</a></font></u></h3></li>\r
96         <li>\r
97         <h3 align="left"><u><a href="#InfiniBand_Software_Development_Kit">\r
98         InfiniBand Software Development Kit</a></u></h3></li>\r
99         <li>\r
100         <h3 align="left"><a href="#WinVerbs">WinVerbs</a></h3></li>\r
101 </ul>\r
102 <h3 align="left">&nbsp;</h3>\r
103 <p align="left">&nbsp;</p>\r
104 <p align="left">&nbsp;</p>\r
105 <BLOCKQUOTE></BLOCKQUOTE>\r
106 <h2 align="left"><a name="verbs_benchmarks0"></a><a name="Tools">Tools</a></h2>\r
107 <hr>\r
108 <blockquote>\r
109         <blockquote>\r
110                 <p align="left">The OpenFabrics Alliance Windows release contains a set of \r
111         user mode tools which are designed to faciliate the smooth operation of an \r
112         Windows OpenFabrics installation. These tools are available from a command \r
113                 window (cmd.exe) as the installation path '%SystemDrive%\Program \r
114                 Files\WinOF' is appended to the system wide search path registry entry. \r
115                 A start menu short-cut 'WinOF Cmd Window' is provided to faciliate \r
116                 correction tool operation.</p>\r
117                 <h4 align="left"><u>IPoIB Partition Management</u></h4>\r
118                 <ul>\r
119                         <li>\r
120                         <p align="left"><a href="#InfiniBand_Partition_Management">part_man</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
121                         Manage (add/remove/show) IPoIB partitions.</li>\r
122         </ul>\r
123         <h4 align="left"><u>Infiniband Subnet Management</u></h4>\r
124                 <ul>\r
125                         <li>\r
126                         <p align="left"><a href="#opensm">opensm</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Open Subnet \r
127         Management - configure and manage an InfiniBand subnet</li>\r
128                         <li>\r
129                         <p align="left"><a href="#osmtest">osmtest</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Subnet management tests</li>\r
130                         <li>\r
131                         <p align="left"><a href="#ibtrapgen">ib_trapgen</a>&nbsp;&nbsp;&nbsp;&nbsp; Generate Infiniband Subnet \r
132         Management Traps for testing purposes</li>\r
133                 </ul>\r
134         <h4 align="left"><u>QLogic VNIC Child Device Management</u></h4>\r
135                 <ul>\r
136                         <li>\r
137                         <p align="left"><a href="#qlgcvnicconfig">qlgcvnic_config</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Configuration \r
138                         utility used to configure IB Stack to create VNIC child devices as per user's requirement.</li>\r
139                 </ul>\r
140                 <h4 align="left"><a href="#verbs_benchmarks"><font color="#000000">Performance</font></a></h4>\r
141                 <ul>\r
142                         <li>\r
143                         <p align="left"><a href="#ibsend_lat">ib_send_lat</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Infiniband send \r
144 latency measurement</li>\r
145                         <li>\r
146                         <p align="left"><a href="#ibsend_bw">ib_send_bw</a>&nbsp;&nbsp;&nbsp;&nbsp;Infiniband send bandwidth \r
147         measurement</li>\r
148                         <li>\r
149                         <p align="left"><a href="#ibwrite_lat">ib_write_lat</a>&nbsp;&nbsp;&nbsp;&nbsp; Infiniband RDMA write \r
150 latency measurement</li>\r
151                         <li>\r
152                         <p align="left">i<a href="#ibwrite_bw">b_write_bw</a>&nbsp;&nbsp;&nbsp; Infiniband RDMA write bandwidth \r
153 measurement</li>\r
154                         <li>\r
155                         <p align="left"><a href="#ttcp">ttcp</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
156 TCP performance measurements</li>\r
157                 </ul>\r
158                 <h4 align="left"><a href="#diags"><font color="#000000">Diagnostics</font></a></h4>\r
159                 <ul>\r
160                         <li>\r
161                         <p align="left"><a href="#cmtest">cmtest&nbsp;</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Connection Manager tests</li>\r
162                         <li>\r
163                         <p align="left"><a href="#iblimits">ib_limits</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
164         InfiniBand verb tests</li>\r
165                         <li>\r
166                         <p align="left"><a href="#printip">printIP</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Display \r
167 an Internet Protocol address associated with an IB GUID.</li>\r
168                         <li>\r
169                         <p align="left"><a href="#vstat">vstat</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Display HCA attributes (lids), statistics and error counters.</li>\r
170                 </ul>\r
171                 <h4 align="left"><u><font color="#0000FF"><a href="#diags">\r
172                 <font color="#000000">OFED </font> </a> </font></u>\r
173                 <a href="#diags"><font color="#000000">Diagnostics</font></a></h4>\r
174                 <ul>\r
175                         <li>\r
176                         <p align="left"><a href="#IBADDR">ibaddr</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
177                         Query InfiniBand address(es)</li>\r
178                         <li>\r
179                         <p align="left"><a href="#IBLINKINFO">iblinkinfo</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
180                         Report link info for all links in the fabric</li>\r
181                         <li>\r
182                         <p align="left"><a href="#IBNETDISCOVER">ibnetdiscover&nbsp;</a>&nbsp;&nbsp; Generate a fabric \r
183                         topology.</li>\r
184                         <li>\r
185                         <p align="left"><a href="#IBPING">ibping</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
186                         Ping an InfiniBand address</li>\r
187                         <li>\r
188                         <p align="left"><a href="#IBPORTSTATE">ibportstate</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
189                         Display InfiniBand port specific information.</li>\r
190                         <li>\r
191                         <p align="left"><a href="#IBQUERYERRORS">ibqueryerrors</a>&nbsp;&nbsp;&nbsp; Query and report \r
192                         non-zero IB port counters</li>\r
193                         <li>\r
194                         <p align="left"><a href="#IBROUTE">ibroute</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
195                         Query InfiniBand switch forwarding tables</li>\r
196                         <li>\r
197                         <p align="left"><a href="#ibstat">ibstat</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Display HCA stats.</li>\r
198                         <li>\r
199                         <p align="left"><a href="#IBSYSSTAT">ibsysstat</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
200                         System status for an InfiniBand address</li>\r
201                         <li>\r
202                         <p align="left"><a href="#IBTRACERT">ibtracert</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
203                         Trace InfiniBand path</li>\r
204                         <li>\r
205                         <p align="left"><a href="#ibv_devinfo">ibv_devinfo</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
206                         Display HCA device information.</li>\r
207                         <li>\r
208                         <p align="left"><a href="#PERFQUERY">perfquery </a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
209                         Query InfiniBand performance counters</li>\r
210                         <li>\r
211                         <p align="left"><a href="#SAQUERY">saquery</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; SA (Subnet Administrator) query test</li>\r
212                         <li>\r
213                         <p align="left"><a href="#SMINFO">sminfo</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
214                         Query InfiniBand SMInfo attributes</li>\r
215                         <li>\r
216                         <p align="left"><a href="#SMPDUMP">smpdump</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
217                         Dump InfiniBand subnet management attributes</li>\r
218                         <li>\r
219                         <p align="left"><a href="#SMPQUERY">smpquery</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
220                         Query InfiniBand subnet management attributes</li>\r
221                         <li>\r
222                         <p align="left"><a href="#VENDSTAT">vendstat&nbsp;</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Query InfiniBand vendor specific functions</li>\r
223                 </ul>\r
224         </blockquote>\r
225 </blockquote>\r
226 <h4 align="left"><a href="#TOP"><font color="#000000">&lt;return-to-top&gt;</font></a></h4>\r
227 <p align="left">&nbsp;</p>\r
228 <h2 align="left"><a name="verbs_benchmarks"></a>User mode micro-benchmarks</h2>\r
229 <hr>\r
230 <p align="left">The following user-mode test programs are intended as useful \r
231 micro-benchmarks for HW or SW \r
232 tuning and/or functional testing.</p>\r
233 <blockquote>\r
234         <p align="left">Tests use CPU cycle counters to get time stamps without \r
235         context switch.<br>\r
236         <br>Tests measure round-trip time but report half of that as one-way latency<br>\r
237         (i.e.. May not be sufficiently accurate for \r
238         asymmetrical configurations).<br>\r
239         <br>Min/Median/Max result is reported.<br>The median (vs. average) is less sensitive to extreme scores.<br>Typically the &quot;Max&quot; value is the first value measured.<br>\r
240         <br>larger samples only marginally help. The default (1000) is pretty good.<br>Note that an array of cycles_t (typically unsigned long) is allocated<br>once to collect samples and again to store the difference between them.<br>Really big sample sizes (e.g. 1 million) might expose other problems<br>with the program.<br>\r
241         <br>&quot;-H&quot; option will dump the histogram for additional statistical analysis.<br>See xgraph, ygraph, r-base (http://www.r-project.org/), pspp, or other\r
242         <br>statistical math programs.<br><br>Architectures tested: x86, x86_64, ia64</p>\r
243         <p align="left">Also see <a href="#WinVerbs">winverbs</a> performance tools.</p>\r
244 </blockquote>\r
245 <h4 align="left"><a name="ibsend_lat"></a><br>\r
246 ib_send_lat.exe&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - latency test with \r
247 send transactions</h4>\r
248 <blockquote>\r
249         <p align="left">Usage:</p>\r
250         <blockquote>\r
251                 <p align="left">ib_send_lat start a server and wait for connection<br>\r
252                 ib_send_lat &lt;host&gt; connect to server at &lt;host&gt;</p>\r
253         </blockquote>\r
254         <p align="left">Options:</p>\r
255         <blockquote>\r
256                 <p align="left">-p, --port=&lt;port&gt; listen on/connect to port &lt;port&gt; \r
257                 (default 18515)<br>\r
258                 -c, --connection=&lt;RC/UC&gt; connection type RC/UC (default RC)<br>\r
259                 -m, --mtu=&lt;mtu&gt; mtu size (default 2048)<br>\r
260                 -d, --ib-dev=&lt;dev&gt; use IB device &lt;dev&gt; (default first device found)<br>\r
261                 -i, --ib-port=&lt;port&gt; use port &lt;port&gt; of IB device (default 1)<br>\r
262                 -s, --size=&lt;size&gt; size of message to exchange (default 1)<br>\r
263                 -t, --tx-depth=&lt;dep&gt; size of tx queue (default 50)<br>\r
264                 -l, --signal signal completion on each msg<br>\r
265                 -a, --all Run sizes from 2 till 2^23<br>\r
266                 -n, --iters=&lt;iters&gt; number of exchanges (at least 2, default 1000)<br>\r
267                 -C, --report-cycles report times in cpu cycle units (default \r
268                 microseconds)<br>\r
269                 -H, --report-histogram print out all results (default print summary \r
270                 only)<br>\r
271                 -U, --report-unsorted (implies -H) print out unsorted results (default \r
272                 sorted)<br>\r
273                 -V, --version display version number<br>\r
274                 -e, --events sleep on CQ events (default poll)</p>\r
275         </blockquote>\r
276 </blockquote>\r
277 <h4 align="left"><a name="ibsend_bw"></a><br>\r
278 ib_send_bw.exe&nbsp;&nbsp;&nbsp;&nbsp; - BW (BandWidth) test with send transactions</h4>\r
279 <blockquote>\r
280         <p align="left">Usage:</p>\r
281         <blockquote>\r
282                 <p align="left">ib_send_bw start a server and wait for connection<br>\r
283                 ib_send_bw &lt;host&gt; connect to server at &lt;host&gt;</p>\r
284         </blockquote>\r
285         <p align="left">Options:</p>\r
286         <blockquote>\r
287                 <p align="left">-p, --port=&lt;port&gt; listen on/connect to port &lt;port&gt; \r
288                 (default 18515)<br>\r
289                 -d, --ib-dev=&lt;dev&gt; use IB device &lt;dev&gt; (default first device found)<br>\r
290                 -i, --ib-port=&lt;port&gt; use port &lt;port&gt; of IB device (default 1)<br>\r
291                 -c, --connection=&lt;RC/UC&gt; connection type RC/UC/UD (default RC)<br>\r
292                 -m, --mtu=&lt;mtu&gt; mtu size (default 1024)<br>\r
293                 -s, --size=&lt;size&gt; size of message to exchange (default 65536)<br>\r
294                 -a, --all Run sizes from 2 till 2^23<br>\r
295                 -t, --tx-depth=&lt;dep&gt; size of tx queue (default 300)<br>\r
296                 -n, --iters=&lt;iters&gt; number of exchanges (at least 2, default 1000)<br>\r
297                 -b, --bidirectional measure bidirectional bandwidth (default \r
298                 unidirectional)<br>\r
299                 -V, --version display version number<br>\r
300                 -e, --events sleep on CQ events (default poll)</p>\r
301         </blockquote>\r
302 </blockquote>\r
303 <h4 align="left"><a name="ibwrite_lat"></a><br>\r
304 ib_write_lat.exe&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - latency test with RDMA write \r
305 transactions</h4>\r
306 <blockquote>\r
307         <p align="left">Usage:</p>\r
308         <blockquote>\r
309                 <p align="left">ib_write_lat start a server and wait for connection<br>\r
310                 ib_write_lat &lt;host&gt; connect to server at &lt;host&gt;</p>\r
311         </blockquote>\r
312         <p align="left">Options:</p>\r
313         <blockquote>\r
314                 <p align="left">-p, --port=&lt;port&gt; listen on/connect to port &lt;port&gt; \r
315                 (default 18515)<br>\r
316                 -c, --connection=&lt;RC/UC&gt; connection type RC/UC (default RC)<br>\r
317                 -m, --mtu=&lt;mtu&gt; mtu size (default 1024)<br>\r
318                 -d, --ib-dev=&lt;dev&gt; use IB device &lt;dev&gt; (default first device found)<br>\r
319                 -i, --ib-port=&lt;port&gt; use port &lt;port&gt; of IB device (default 1)<br>\r
320                 -s, --size=&lt;size&gt; size of message to exchange (default 1)<br>\r
321                 -a, --all Run sizes from 2 till 2^23<br>\r
322                 -t, --tx-depth=&lt;dep&gt; size of tx queue (default 50)<br>\r
323                 -n, --iters=&lt;iters&gt; number of exchanges (at least 2, default 1000)<br>\r
324                 -C, --report-cycles report times in cpu cycle units (default \r
325                 microseconds)<br>\r
326                 -H, --report-histogram print out all results (default print summary \r
327                 only)<br>\r
328                 -U, --report-unsorted (implies -H) print out unsorted results (default \r
329                 sorted)<br>\r
330                 -V, --version display version number</p>\r
331         </blockquote>\r
332 </blockquote>\r
333 <h4 align="left"><a name="ibwrite_bw"></a><br>\r
334 ib_write_bw.exe&nbsp;&nbsp;&nbsp;&nbsp; - BW test with RDMA write transactions</h4>\r
335 <blockquote>\r
336         <p align="left">Usage:</p>\r
337         <blockquote>\r
338                 <p align="left">ib_write_bw&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
339                 # start a server and wait for connection<br>\r
340                 ib_write_bw &lt;host&gt;&nbsp;&nbsp;&nbsp; # connect to server at &lt;host&gt;</p>\r
341         </blockquote>\r
342         <p align="left">Options:</p>\r
343         <blockquote>\r
344                 <p align="left">-p, --port=&lt;port&gt; listen on/connect to port &lt;port&gt; \r
345                 (default 18515)<br>\r
346                 -d, --ib-dev=&lt;dev&gt; use IB device &lt;dev&gt; (default first device found)<br>\r
347                 -i, --ib-port=&lt;port&gt; use port &lt;port&gt; of IB device (default 1)<br>\r
348                 -c, --connection=&lt;RC/UC&gt; connection type RC/UC (default RC)<br>\r
349                 -m, --mtu=&lt;mtu&gt; mtu size (default 1024)<br>\r
350                 -g, --post=&lt;num of posts&gt; number of posts for each qp in the chain \r
351                 (default tx_depth)<br>\r
352                 -q, --qp=&lt;num of qp's&gt; Num of qp's(default 1)<br>\r
353                 -s, --size=&lt;size&gt; size of message to exchange (default 65536)<br>\r
354                 -a, --all Run sizes from 2 till 2^23<br>\r
355                 -t, --tx-depth=&lt;dep&gt; size of tx queue (default 100)<br>\r
356                 -n, --iters=&lt;iters&gt; number of exchanges (at least 2, default 5000)<br>\r
357                 -b, --bidirectional measure bidirectional bandwidth (default \r
358                 unidirectional)<br>\r
359                 -V, --version display version number</p>\r
360         </blockquote>\r
361 </blockquote>\r
362 <h4 align="left"><a href="#TOP"><font color="#000000">&lt;return-to-top&gt;</font></a></h4>\r
363 <p align="left"><br>\r
364 &nbsp;</p>\r
365 <h4 align="left"><a name="ttcp"></a><br>\r
366 ttcp - Test TCP performance</h4>\r
367 <p align="left">TTCP accesses the Windows socket layer, hence it does not access \r
368 IB verbs directly. IPoIB or WSD layers are invoked beneath the socket layer \r
369 depending on configuration. TTCP is included as a quick baseline performance \r
370 check.</p>\r
371 <blockquote>\r
372         <pre>Usage: ttcp -t [-options] host \r
373        ttcp -r [-options]\r
374 Common options:\r
375         -l ##   length of bufs read from or written to network (default 8192)\r
376         -u      use UDP instead of TCP\r
377         -p ##   port number to send to or listen at (default 5001)\r
378         -A      align the start of buffers to this modulus (default 16384)\r
379         -O      start buffers at this offset from the modulus (default 0)\r
380         -d      set SO_DEBUG socket option\r
381         -b ##   set socket buffer size (if supported)\r
382         -f X    format for rate: k,K = kilo{bit,byte}; m,M = mega; g,G = giga\r
383 Options specific to -t:\r
384         -n##    number of source bufs written to network (default 2048)\r
385         -D      don't buffer TCP writes (sets TCP_NODELAY socket option)\r
386 Options specific to -r:\r
387         -B      for -s, only output full blocks as specified by -l (for TAR)\r
388         -T      &quot;touch&quot;: access each byte as it's read</pre>\r
389         <p align="left">Requires a receiver (server) side and a transmitter (client) \r
390         side, host1 and host2 are IPoIB connected hosts.</p>\r
391         <p align="left">at host1 (receiver)&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
392         ttcp -r -f M -l 4096</p>\r
393         <p align="left">at host2 (transmitter)&nbsp;&nbsp;&nbsp; ttcp -t -f M -l \r
394         4096 -n1000 host1</p>\r
395 </blockquote>\r
396 <h4 align="left"><a href="#TOP"><font color="#000000">&lt;return-to-top&gt;</font></a></h4>\r
397 <p align="left">&nbsp;</p>\r
398 <p align="left">&nbsp;</p>\r
399 <h2 align="left"><a name="diags"></a>Diagnostics</h2>\r
400 <hr>\r
401 <BLOCKQUOTE></BLOCKQUOTE>\r
402 <h3 align="left"><a name="IBADDR">IBADDR</a>(8) OFED Diagnostics</h3>\r
403 <p align="left">NAME<br>\r
404 ibaddr - query InfiniBand address(es)<br>\r
405 <br>\r
406 SYNOPSIS<br>\r
407 ibaddr [-d(ebug)] [-D(irect)] [-G(uid)] [-l(id_show)] [-g(id_show)] [-C\r
408 ca_name] [-P ca_port] [-t(imeout) timeout_ms] [-V(ersion)] [-h(elp)]\r
409 [&lt;lid | dr_path | guid&gt;]<br>\r
410 <br>\r
411 DESCRIPTION<br>\r
412 Display the lid (and range) as well as the GID address of the port<br>\r
413 specified (by DR path, lid, or GUID) or the local port by default.<br>\r
414 <br>\r
415 Note: this utility can be used as simple address resolver.<br>\r
416 <br>\r
417 OPTIONS<br>\r
418 -G, --Guid<br>\r
419 show lid range and gid for GUID address<br>\r
420 <br>\r
421 -l, --lid_show<br>\r
422 show lid range only<br>\r
423 <br>\r
424 -L, --Lid_show<br>\r
425 show lid range (in decimal) only<br>\r
426 <br>\r
427 -g, --gid_show<br>\r
428 show gid address only<br>\r
429 <br>\r
430 <br>\r
431 COMMON OPTIONS<br>\r
432 Most WinOF diagnostics take the following common flags. The exact list<br>\r
433 of supported flags per utility can be found in the usage message and<br>\r
434 can be shown using the util_name -h syntax.<br>\r
435 <br>\r
436 # Debugging flags<br>\r
437 <br>\r
438 -d raise the IB debugging level.<br>\r
439 May be used several times (-ddd or -d -d -d).<br>\r
440 <br>\r
441 -e show send and receive errors (timeouts and others)<br>\r
442 <br>\r
443 -h show the usage message<br>\r
444 <br>\r
445 -v increase the application verbosity level.<br>\r
446 May be used several times (-vv or -v -v -v)<br>\r
447 <br>\r
448 -V show the version info.<br>\r
449 <br>\r
450 # Addressing flags<br>\r
451 <br>\r
452 -D use directed path address arguments. The path<br>\r
453 is a comma separated list of out ports.<br>\r
454 Examples:<br>\r
455 &quot;0&quot; # self port<br>\r
456 &quot;0,1,2,1,4&quot; # out via port 1, then 2, ...<br>\r
457 <br>\r
458 -G use GUID address argument. In most cases, it is the Port GUID.<br>\r
459 Example:<br>\r
460 &quot;0x08f1040023&quot;<br>\r
461 <br>\r
462 -s &lt;smlid&gt; use \92smlid\92 as the target lid for SM/SA queries.<br>\r
463 <br>\r
464 # Other common flags:<br>\r
465 <br>\r
466 -C &lt;ca_name&gt; use the specified ca_name.<br>\r
467 <br>\r
468 -P &lt;ca_port&gt; use the specified ca_port.<br>\r
469 <br>\r
470 -t &lt;timeout_ms&gt; override the default timeout for the solicited mads.<br>\r
471 <br>\r
472 Multiple CA/Multiple Port Support<br>\r
473 <br>\r
474 When no IB device or port is specified, the port to use is selected by<br>\r
475 the following criteria:<br>\r
476 <br>\r
477 1. the first port that is ACTIVE.<br>\r
478 <br>\r
479 2. if not found, the first port that is UP (physical link up).<br>\r
480 <br>\r
481 If a port and/or CA name is specified, the user request is attempted to<br>\r
482 be fulfilled, and will fail if it is not possible.<br>\r
483 <br>\r
484 <br>\r
485 EXAMPLES<br>\r
486 ibaddr # local port´s address<br>\r
487 <br>\r
488 ibaddr 32 # show lid range and gid of lid 32<br>\r
489 <br>\r
490 ibaddr -G 0x8f1040023 # same but using guid address<br>\r
491 <br>\r
492 ibaddr -l 32 # show lid range only<br>\r
493 <br>\r
494 ibaddr -L 32 # show decimal lid range only<br>\r
495 <br>\r
496 ibaddr -g 32 # show gid address only<br>\r
497 <br>\r
498 <br>\r
499 SEE ALSO<br>\r
500 ibroute(8), ibtracert(8)<br>\r
501 <br>\r
502 AUTHOR<br>\r
503 Hal Rosenstock<br>\r
504 &lt;halr@voltaire.com&gt;<br>\r
505 <br>\r
506 <br>\r
507 OFED June 18, 2007 IBADDR(8)<br>\r
508 &nbsp;</p>\r
509 <h3 align="left">&nbsp;</h3>\r
510 <h3 align="left"><a name="IBLINKINFO">IBLINKINFO</a>(8) OFED Diagnostics<br>\r
511 &nbsp;</h3>\r
512 <p align="left">NAME<br>\r
513 iblinkinfo - report link info for all links in the fabric<br>\r
514 <br>\r
515 <br>\r
516 SYNOPSIS<br>\r
517 iblinkinfo\r
518 [-Rhcdl -C &lt;ca_name&gt; -P &lt;ca_port&gt; -v &lt;lt,hoq,vlstall&gt; -S &lt;guid&gt; -D&lt;direct_route&gt;]<br>\r
519 <br>\r
520 <br>\r
521 DESCRIPTION<br>\r
522 iblinkinfo reports the link info for each port of each switch active<br>\r
523 in the IB fabric.<br>\r
524 <br>\r
525 <br>\r
526 OPTIONS<br>\r
527 -R Recalculate the ibnetdiscover information, ie do not use the<br>\r
528 cached information. This option is slower but should be used if<br>\r
529 the diag tools have not been used for some time or if there are<br>\r
530 other reasons to believe the fabric has changed.<br>\r
531 <br>\r
532 -S &lt;guid&gt;<br>\r
533 Output only the switch specified by &lt;guid&gt; (hex format)<br>\r
534 <br>\r
535 -D &lt;direct_route&gt;<br>\r
536 Output only the switch specified by the direct route path.<br>\r
537 <br>\r
538 -l Print all information for each link on one line. Default is to<br>\r
539 print a header with the switch information and then a list for<br>\r
540 each port (useful for grep´ing output).<br>\r
541 <br>\r
542 -d Print only switches which have a port in the &quot;Down&quot; state.<br>\r
543 <br>\r
544 -v &lt;lt,hoq,vlstall&gt;<br>\r
545 Verify additional switch settings (&lt;Life-<br>\r
546 Time&gt;,&lt;HoqLife&gt;,&lt;VLStallCount&gt;)<br>\r
547 <br>\r
548 -c Print port capabilities (enabled and supported values)<br>\r
549 <br>\r
550 -C &lt;ca_name&gt; use the specified ca_name for the search.<br>\r
551 <br>\r
552 -P &lt;ca_port&gt; use the specified ca_port for the search.<br>\r
553 <br>\r
554 <br>\r
555 <br>\r
556 AUTHOR<br>\r
557 Ira Weiny &lt;weiny2@llnl.gov&gt;<br>\r
558 <br>\r
559 <br>\r
560 OFED Jan 24, 2008 IBLINKINFO(8)</p>\r
561 <p align="left"><font color="#000000"><a href="#TOP">&lt;return-to-top&gt;</a></font><br>\r
562 &nbsp;</p>\r
563 <p align="left">&nbsp;</p>\r
564 <h3 align="left"><a name="IBNETDISCOVER">IBNETDISCOVER</a>(8) OFED Diagnostics<br>\r
565 &nbsp;</h3>\r
566 <p align="left">NAME<br>\r
567 ibnetdiscover - discover InfiniBand topology<br>\r
568 <br>\r
569 <br>\r
570 SYNOPSIS<br>\r
571 ibnetdiscover [-d(ebug)] [-e(rr_show)] [-v(erbose)] [-s(how)] [-l(ist)]<br>\r
572 [-g(rouping)] [-H(ca_list)] [-S(witch_list)] [-R(outer_list)] [-C<br>\r
573 ca_name] [-P ca_port] [-t(imeout) timeout_ms] [-V(ersion)] [--node-<br>\r
574 name-map &lt;node-name-map&gt;] [-p(orts)] [-h(elp)] [&lt;topology-file&gt;]<br>\r
575 <br>\r
576 <br>\r
577 DESCRIPTION<br>\r
578 ibnetdiscover performs IB subnet discovery and outputs a human readable<br>\r
579 topology file. GUIDs, node types, and port numbers are displayed as<br>\r
580 well as port LIDs and NodeDescriptions. All nodes (and links) are dis-<br>\r
581 played (full topology). Optionally, this utility can be used to list<br>\r
582 the current connected nodes by nodetype. The output is printed to<br>\r
583 standard output unless a topology file is specified.<br>\r
584 <br>\r
585 <br>\r
586 OPTIONS<br>\r
587 -l, --list<br>\r
588 List of connected nodes<br>\r
589 <br>\r
590 -g, --grouping<br>\r
591 Show grouping. Grouping correlates IB nodes by different vendor<br>\r
592 specific schemes. It may also show the switch external ports<br>\r
593 correspondence.<br>\r
594 <br>\r
595 -H, --Hca_list<br>\r
596 List of connected CAs<br>\r
597 <br>\r
598 -S, --Switch_list<br>\r
599 List of connected switches<br>\r
600 <br>\r
601 -R, --Router_list<br>\r
602 List of connected routers<br>\r
603 <br>\r
604 -s, --show<br>\r
605 Show progress information during discovery.<br>\r
606 <br>\r
607 --node-name-map &lt;node-name-map&gt;<br>\r
608 Specify a node name map. The node name map file maps GUIDs to<br>\r
609 more user friendly names. See file format below.<br>\r
610 <br>\r
611 -p, --ports<br>\r
612 Obtain a ports report which is a list of connected ports with<br>\r
613 relevant information (like LID, portnum, GUID, width, speed, and<br>\r
614 NodeDescription).<br>\r
615 <br>\r
616 <br>\r
617 COMMON OPTIONS<br>\r
618 Most OpenIB diagnostics take the following common flags. The exact list<br>\r
619 of supported flags per utility can be found in the usage message and<br>\r
620 can be shown using the util_name -h syntax.<br>\r
621 <br>\r
622 # Debugging flags<br>\r
623 <br>\r
624 -d raise the IB debugging level.<br>\r
625 May be used several times (-ddd or -d -d -d).<br>\r
626 <br>\r
627 -e show send and receive errors (timeouts and others)<br>\r
628 <br>\r
629 -h show the usage message<br>\r
630 <br>\r
631 -v increase the application verbosity level.<br>\r
632 May be used several times (-vv or -v -v -v)<br>\r
633 <br>\r
634 -V show the version info.<br>\r
635 <br>\r
636 # Other common flags:<br>\r
637 <br>\r
638 -C &lt;ca_name&gt; use the specified ca_name.<br>\r
639 <br>\r
640 -P &lt;ca_port&gt; use the specified ca_port.<br>\r
641 <br>\r
642 -t &lt;timeout_ms&gt; override the default timeout for the solicited mads.<br>\r
643 <br>\r
644 Multiple CA/Multiple Port Support<br>\r
645 <br>\r
646 When no IB device or port is specified, the port to use is selected by<br>\r
647 the following criteria:<br>\r
648 <br>\r
649 1. the first port that is ACTIVE.<br>\r
650 <br>\r
651 2. if not found, the first port that is UP (physical link up).<br>\r
652 <br>\r
653 If a port and/or CA name is specified, the user request is attempted to<br>\r
654 be fulfilled, and will fail if it is not possible.<br>\r
655 <br>\r
656 <br>\r
657 TOPOLOGY FILE FORMAT<br>\r
658 The topology file format is human readable and largely intuitive. Most<br>\r
659 identifiers are given textual names like vendor ID (vendid), device ID<br>\r
660 (device ID), GUIDs of various types (sysimgguid, caguid, switchguid,<br>\r
661 etc.). PortGUIDs are shown in parentheses (). For switches, this is<br>\r
662 shown on the switchguid line. For CA and router ports, it is shown on<br>\r
663 the connectivity lines. The IB node is identified followed by the num-<br>\r
664 ber of ports and a quoted the node GUID. On the right of this line is<br>\r
665 a comment (#) followed by the NodeDescription in quotes. If the node<br>\r
666 is a switch, this line also contains whether switch port 0 is base or<br>\r
667 enhanced, and the LID and LMC of port 0. Subsequent lines pertaining<br>\r
668 to this node show the connectivity. On the left is the port number of<br>\r
669 the current node. On the right is the peer node (node at other end of<br>\r
670 link). It is identified in quotes with nodetype followed by - followed<br>\r
671 by NodeGUID with the port number in square brackets. Further on the<br>\r
672 right is a comment (#). What follows the comment is dependent on the<br>\r
673 node type. If it it a switch node, it is followed by the NodeDescrip-<br>\r
674 tion in quotes and the LID of the peer node. If it is a CA or router<br>\r
675 node, it is followed by the local LID and LMC and then followed by the<br>\r
676 NodeDescription in quotes and the LID of the peer node. The active<br>\r
677 link width and speed are then appended to the end of this output line.<br>\r
678 <br>\r
679 An example of this is:<br>\r
680 #<br>\r
681 # Topology file: generated on Tue Jun 5 14:15:10 2007<br>\r
682 #<br>\r
683 # Max of 3 hops discovered<br>\r
684 # Initiated from node 0008f10403960558 port 0008f10403960559<br>\r
685 <br>\r
686 Non-Chassis Nodes<br>\r
687 <br>\r
688 vendid=0x8f1<br>\r
689 devid=0x5a06<br>\r
690 sysimgguid=0x5442ba00003000<br>\r
691 switchguid=0x5442ba00003080(5442ba00003080)<br>\r
692 Switch 24 &quot;S-005442ba00003080&quot; # &quot;ISR9024 Voltaire&quot; base port 0 lid 6 lmc 0<br>\r
693 [22] &quot;H-0008f10403961354&quot;[1](8f10403961355) # &quot;MT23108 InfiniHost Mellanox \r
694 Technologies&quot; lid 4 4xSDR<br>\r
695 [10] &quot;S-0008f10400410015&quot;[1] # &quot;SW-6IB4 Voltaire&quot; lid 3 4xSDR<br>\r
696 [8] &quot;H-0008f10403960558&quot;[2](8f1040396055a) # &quot;MT23108 InfiniHost Mellanox \r
697 Technologies&quot; lid 14 4xSDR<br>\r
698 [6] &quot;S-0008f10400410015&quot;[3] # &quot;SW-6IB4 Voltaire&quot; lid 3 4xSDR<br>\r
699 [12] &quot;H-0008f10403960558&quot;[1](8f10403960559) # &quot;MT23108 InfiniHost Mellanox \r
700 Technologies&quot; lid 10 4xSDR<br>\r
701 <br>\r
702 vendid=0x8f1<br>\r
703 devid=0x5a05<br>\r
704 switchguid=0x8f10400410015(8f10400410015)<br>\r
705 Switch 8 &quot;S-0008f10400410015&quot; # &quot;SW-6IB4 Voltaire&quot; base port 0 lid 3 lmc 0<br>\r
706 [6] &quot;H-0008f10403960984&quot;[1](8f10403960985) # &quot;MT23108 InfiniHost Mellanox \r
707 Technologies&quot; lid 16 4xSDR<br>\r
708 [4] &quot;H-005442b100004900&quot;[1](5442b100004901) # &quot;MT23108 InfiniHost Mellanox \r
709 Technologies&quot; lid 12 4xSDR<br>\r
710 [1] &quot;S-005442ba00003080&quot;[10] # &quot;ISR9024 Voltaire&quot; lid 6 1xSDR<br>\r
711 [3] &quot;S-005442ba00003080&quot;[6] # &quot;ISR9024 Voltaire&quot; lid 6 4xSDR<br>\r
712 <br>\r
713 vendid=0x2c9<br>\r
714 devid=0x5a44<br>\r
715 caguid=0x8f10403960984<br>\r
716 Ca 2 &quot;H-0008f10403960984&quot; # &quot;MT23108 InfiniHost Mellanox Technologies&quot;<br>\r
717 [1](8f10403960985) &quot;S-0008f10400410015&quot;[6] # lid 16 lmc 1 &quot;SW-6IB4 Voltaire&quot; lid \r
718 3 4xSDR<br>\r
719 <br>\r
720 vendid=0x2c9<br>\r
721 devid=0x5a44<br>\r
722 caguid=0x5442b100004900<br>\r
723 Ca 2 &quot;H-005442b100004900&quot; # &quot;MT23108 InfiniHost Mellanox Technologies&quot;<br>\r
724 [1](5442b100004901) &quot;S-0008f10400410015&quot;[4] # lid 12 lmc 1 &quot;SW-6IB4 Voltaire&quot; \r
725 lid 3 4xSDR<br>\r
726 <br>\r
727 vendid=0x2c9<br>\r
728 devid=0x5a44<br>\r
729 caguid=0x8f10403961354<br>\r
730 Ca 2 &quot;H-0008f10403961354&quot; # &quot;MT23108 InfiniHost Mellanox Technologies&quot;<br>\r
731 [1](8f10403961355) &quot;S-005442ba00003080&quot;[22] # lid 4 lmc 1 &quot;ISR9024 Voltaire&quot; lid \r
732 6 4xSDR<br>\r
733 <br>\r
734 vendid=0x2c9<br>\r
735 devid=0x5a44<br>\r
736 caguid=0x8f10403960558<br>\r
737 Ca 2 &quot;H-0008f10403960558&quot; # &quot;MT23108 InfiniHost Mellanox Technologies&quot;<br>\r
738 [2](8f1040396055a) &quot;S-005442ba00003080&quot;[8] # lid 14 lmc 1 &quot;ISR9024 Voltaire&quot; lid \r
739 6 4xSDR<br>\r
740 [1](8f10403960559) &quot;S-005442ba00003080&quot;[12] # lid 10 lmc 1 &quot;ISR9024 Voltaire&quot; \r
741 lid 6 1xSDR<br>\r
742 <br>\r
743 When grouping is used, IB nodes are organized into chasses which are<br>\r
744 numbered. Nodes which cannot be determined to be in a chassis are dis-<br>\r
745 played as &quot;Non-Chassis Nodes&quot;. External ports are also shown on the<br>\r
746 connectivity lines.<br>\r
747 <br>\r
748 <br>\r
749 <br>\r
750 NODE NAME MAP FILE FORMAT<br>\r
751 The node name map is used to specify user friendly names for nodes in<br>\r
752 the output. GUIDs are used to perform the lookup.<br>\r
753 <br>\r
754 <br>\r
755 Generically:<br>\r
756 <br>\r
757 # comment<br>\r
758 &lt;guid&gt; &quot;&lt;name&gt;&quot;<br>\r
759 <br>\r
760 <br>\r
761 Example:<br>\r
762 <br>\r
763 # IB1<br>\r
764 # Line cards<br>\r
765 0x0008f104003f125c &quot;IB1 (Rack 11 slot 1 ) ISR9288/ISR9096<br>\r
766 Voltaire sLB-24D&quot;<br>\r
767 0x0008f104003f125d &quot;IB1 (Rack 11 slot 1 ) ISR9288/ISR9096<br>\r
768 Voltaire sLB-24D&quot;<br>\r
769 0x0008f104003f10d2 &quot;IB1 (Rack 11 slot 2 ) ISR9288/ISR9096<br>\r
770 Voltaire sLB-24D&quot;<br>\r
771 0x0008f104003f10d3 &quot;IB1 (Rack 11 slot 2 ) ISR9288/ISR9096<br>\r
772 Voltaire sLB-24D&quot;<br>\r
773 0x0008f104003f10bf &quot;IB1 (Rack 11 slot 12 ) ISR9288/ISR9096<br>\r
774 Voltaire sLB-24D&quot;<br>\r
775 # Spines<br>\r
776 0x0008f10400400e2d &quot;IB1 (Rack 11 spine 1 ) ISR9288 Voltaire<br>\r
777 sFB-12D&quot;<br>\r
778 0x0008f10400400e2e &quot;IB1 (Rack 11 spine 1 ) ISR9288 Voltaire<br>\r
779 sFB-12D&quot;<br>\r
780 0x0008f10400400e2f &quot;IB1 (Rack 11 spine 1 ) ISR9288 Voltaire<br>\r
781 sFB-12D&quot;<br>\r
782 0x0008f10400400e31 &quot;IB1 (Rack 11 spine 2 ) ISR9288 Voltaire<br>\r
783 sFB-12D&quot;<br>\r
784 0x0008f10400400e32 &quot;IB1 (Rack 11 spine 2 ) ISR9288 Voltaire<br>\r
785 sFB-12D&quot;<br>\r
786 # GUID Node Name<br>\r
787 0x0008f10400411a08 &quot;SW1 (Rack 3) ISR9024 Voltaire 9024D&quot;<br>\r
788 0x0008f10400411a28 &quot;SW2 (Rack 3) ISR9024 Voltaire 9024D&quot;<br>\r
789 0x0008f10400411a34 &quot;SW3 (Rack 3) ISR9024 Voltaire 9024D&quot;<br>\r
790 0x0008f104004119d0 &quot;SW4 (Rack 3) ISR9024 Voltaire 9024D&quot;<br>\r
791 <br>\r
792 <br>\r
793 AUTHORS<br>\r
794 Hal Rosenstock&nbsp;&nbsp;&nbsp; &lt;halr@voltaire.com&gt;<br>\r
795 <br>\r
796 Ira Weiny&nbsp;&nbsp;&nbsp; &lt;weiny2@llnl.gov&gt;<br>\r
797 <br>\r
798 <br>\r
799 OFED January 3, 2008 IBNETDISCOVER(8)<br>\r
800 <br>\r
801 <font color="#000000"><a href="#TOP">&lt;return-to-top&gt;</a></font><br>\r
802 &nbsp;</p>\r
803 <p align="left">&nbsp;</p>\r
804 <h3 align="left"><a name="IBPING">IBPING</a>(8) OFED Diagnostics<br>\r
805 &nbsp;</h3>\r
806 <p align="left">NAME<br>\r
807 ibping - ping an InfiniBand address<br>\r
808 <br>\r
809 <br>\r
810 SYNOPSIS<br>\r
811 ibping [-d(ebug)] [-e(rr_show)] [-v(erbose)] [-G(uid)] [-C ca_name] [-P<br>\r
812 ca_port] [-s smlid] [-t(imeout) timeout_ms] [-V(ersion)] [-c<br>\r
813 ping_count] [-f(lood)] [-o oui] [-S(erver)] [-h(elp)] &lt;dest lid | guid&gt;<br>\r
814 <br>\r
815 <br>\r
816 DESCRIPTION<br>\r
817 ibping uses vendor mads to validate connectivity between IB nodes. On<br>\r
818 exit, (IP) ping like output is show. ibping is run as client/server.<br>\r
819 Default is to run as client. Note also that a default ping server is<br>\r
820 implemented within the kernel.<br>\r
821 <br>\r
822 <br>\r
823 OPTIONS<br>\r
824 -c stop after count packets<br>\r
825 <br>\r
826 -f, --flood<br>\r
827 flood destination: send packets back to back without delay<br>\r
828 <br>\r
829 -o, --oui<br>\r
830 use specified OUI number to multiplex vendor mads<br>\r
831 <br>\r
832 -S, --Server<br>\r
833 start in server mode (do not return)<br>\r
834 <br>\r
835 <br>\r
836 COMMON OPTIONS<br>\r
837 Most OFED diagnostics take the following common flags. The exact list<br>\r
838 of supported flags per utility can be found in the usage message and<br>\r
839 can be shown using the util_name -h syntax.<br>\r
840 <br>\r
841 # Debugging flags<br>\r
842 <br>\r
843 -d raise the IB debugging level.<br>\r
844 May be used several times (-ddd or -d -d -d).<br>\r
845 <br>\r
846 -e show send and receive errors (timeouts and others)<br>\r
847 <br>\r
848 -h show the usage message<br>\r
849 <br>\r
850 -v increase the application verbosity level.<br>\r
851 May be used several times (-vv or -v -v -v)<br>\r
852 <br>\r
853 -V show the version info.<br>\r
854 <br>\r
855 # Addressing flags<br>\r
856 <br>\r
857 -G use GUID address argument. In most cases, it is the Port GUID.<br>\r
858 Example:<br>\r
859 &quot;0x08f1040023&quot;<br>\r
860 <br>\r
861 -s &lt;smlid&gt; use \92smlid\92 as the target lid for SM/SA queries.<br>\r
862 <br>\r
863 # Other common flags:<br>\r
864 <br>\r
865 -C &lt;ca_name&gt; use the specified ca_name.<br>\r
866 <br>\r
867 -P &lt;ca_port&gt; use the specified ca_port.<br>\r
868 <br>\r
869 -t &lt;timeout_ms&gt; override the default timeout for the solicited mads.<br>\r
870 <br>\r
871 Multiple CA/Multiple Port Support<br>\r
872 <br>\r
873 When no IB device or port is specified, the port to use is selected by<br>\r
874 the following criteria:<br>\r
875 <br>\r
876 1. the first port that is ACTIVE.<br>\r
877 <br>\r
878 2. if not found, the first port that is UP (physical link up).<br>\r
879 <br>\r
880 If a port and/or CA name is specified, the user request is attempted to<br>\r
881 be fulfilled, and will fail if it is not possible.<br>\r
882 <br>\r
883 <br>\r
884 AUTHOR<br>\r
885 Hal Rosenstock &lt;halr@voltaire.com&gt;<br>\r
886 <br>\r
887 <br>\r
888 OFED August 11, 2006 IBPING(8)</p>\r
889 <p align="left"><br>\r
890 <font color="#000000"><a href="#TOP">&lt;return-to-top&gt;</a></font></p>\r
891 <h3 align="left">&nbsp;</h3>\r
892 <h3 align="left"><a name="IBPORTSTATE">IBPORTSTATE</a>(8) OFED Diagnostics</h3>\r
893 <p align="left"><br>\r
894 NAME<br>\r
895 ibportstate - handle port (physical) state and link speed of an Infini-<br>\r
896 Band port<br>\r
897 <br>\r
898 <br>\r
899 SYNOPSIS<br>\r
900 ibportstate [-d(ebug)] [-e(rr_show)] [-v(erbose)] [-D(irect)] [-G(uid)] [-s \r
901 smlid] [-V(ersion)] [-C ca_name] [-P ca_port] [-t(imeout) time-out_ms] [-h(elp)] \r
902 &lt;dest dr_path|lid|guid&gt; &lt;portnum&gt; [&lt;op&gt;]<br>\r
903 <br>\r
904 <br>\r
905 DESCRIPTION<br>\r
906 ibportstate allows the port state and port physical state of an IB port<br>\r
907 to be queried (in addition to link width and speed being validated rel-<br>\r
908 ative to the peer port when the port queried is a switch port), or a<br>\r
909 switch port to be disabled, enabled, or reset. It also allows the link<br>\r
910 speed enabled on any IB port to be adjusted.<br>\r
911 <br>\r
912 <br>\r
913 OPTIONS<br>\r
914 op Port operations allowed<br>\r
915 supported ops: enable, disable, reset, speed, query<br>\r
916 Default is query<br>\r
917 <br>\r
918 ops enable, disable, and reset are only allowed on switch ports<br>\r
919 (An error is indicated if attempted on CA or router ports)<br>\r
920 speed op is allowed on any port<br>\r
921 speed values are legal values for PortInfo:LinkSpeedEnabled<br>\r
922 (An error is indicated if PortInfo:LinkSpeedSupported does not support<br>\r
923 this setting)<br>\r
924 (NOTE: Speed changes are not effected until the port goes through<br>\r
925 link renegotiation)<br>\r
926 query also validates port characteristics (link width and speed)<br>\r
927 based on the peer port. This checking is done when the port<br>\r
928 queried is a switch port as it relies on combined routing<br>\r
929 (an initial LID route with directed routing to the peer) which<br>\r
930 can only be done on a switch. This peer port validation feature<br>\r
931 of query op requires LID routing to be functioning in the subnet.<br>\r
932 <br>\r
933 <br>\r
934 COMMON OPTIONS<br>\r
935 Most OFED diagnostics take the following common flags. The exact list<br>\r
936 of supported flags per utility can be found in the usage message and<br>\r
937 can be shown using the util_name -h syntax.<br>\r
938 <br>\r
939 # Debugging flags<br>\r
940 <br>\r
941 -d raise the IB debugging level.<br>\r
942 May be used several times (-ddd or -d -d -d).<br>\r
943 <br>\r
944 -e show send and receive errors (timeouts and others)<br>\r
945 <br>\r
946 -h show the usage message<br>\r
947 <br>\r
948 -v increase the application verbosity level.<br>\r
949 May be used several times (-vv or -v -v -v)<br>\r
950 <br>\r
951 -V show the version info.<br>\r
952 <br>\r
953 # Addressing flags<br>\r
954 <br>\r
955 -D use directed path address arguments. The path<br>\r
956 is a comma separated list of out ports.<br>\r
957 Examples:<br>\r
958 &quot;0&quot; # self port<br>\r
959 &quot;0,1,2,1,4&quot; # out via port 1, then 2, ...<br>\r
960 <br>\r
961 -G use GUID address argument. In most cases, it is the Port GUID.<br>\r
962 Example:<br>\r
963 &quot;0x08f1040023&quot;<br>\r
964 <br>\r
965 -s &lt;smlid&gt; use \92smlid\92 as the target lid for SM/SA queries.<br>\r
966 <br>\r
967 # Other common flags:<br>\r
968 <br>\r
969 -C &lt;ca_name&gt; use the specified ca_name.<br>\r
970 <br>\r
971 -P &lt;ca_port&gt; use the specified ca_port.<br>\r
972 <br>\r
973 -t &lt;timeout_ms&gt; override the default timeout for the solicited mads.<br>\r
974 <br>\r
975 Multiple CA/Multiple Port Support<br>\r
976 <br>\r
977 When no IB device or port is specified, the port to use is selected by<br>\r
978 the following criteria:<br>\r
979 <br>\r
980 1. the first port that is ACTIVE.<br>\r
981 <br>\r
982 2. if not found, the first port that is UP (physical link up).<br>\r
983 <br>\r
984 If a port and/or CA name is specified, the user request is attempted to<br>\r
985 be fulfilled, and will fail if it is not possible.<br>\r
986 <br>\r
987 <br>\r
988 EXAMPLES<br>\r
989 ibportstate 3 1 disable # by lid<br>\r
990 <br>\r
991 ibportstate -G 0x2C9000100D051 1 enable # by guid<br>\r
992 <br>\r
993 ibportstate -D 0 1 # (query) by direct route<br>\r
994 <br>\r
995 ibportstate 3 1 reset # by lid<br>\r
996 <br>\r
997 ibportstate 3 1 speed 1 # by lid<br>\r
998 <br>\r
999 <br>\r
1000 AUTHOR<br>\r
1001 Hal Rosenstock &lt;halr@voltaire.com&gt;<br>\r
1002 <br>\r
1003 <br>\r
1004 OFED October 19, 2006 IBPORTSTATE(8)</p>\r
1005 <p align="left"><br>\r
1006 <font color="#000000"><a href="#TOP">&lt;return-to-top&gt;</a></font></p>\r
1007 <h3 align="left">&nbsp;</h3>\r
1008 <h3 align="left"><a name="IBQUERYERRORS">IBQUERYERRORS</a>(8) OFED Diagnostics<br>\r
1009 &nbsp;</h3>\r
1010 <p align="left">NAME<br>\r
1011 ibqueryerrors - query and report non-zero IB port counters<br>\r
1012 <br>\r
1013 <br>\r
1014 SYNOPSIS<br>\r
1015 ibqueryerrors [-a -c -r -R -C &lt;ca_name&gt; -P &lt;ca_port&gt; -s<br>\r
1016 &lt;err1,err2,...&gt; -S &lt;switch_guid&gt; -D &lt;direct_route&gt; -d]<br>\r
1017 <br>\r
1018 <br>\r
1019 DESCRIPTION<br>\r
1020 ibqueryerrors reports the port counters of switches. This is simi-<br>\r
1021 lar to ibcheckerrors with the additional ability to filter out selected<br>\r
1022 errors, include the optional transmit and receive data counters, report<br>\r
1023 actions to remedy a non-zero count, and report full link information<br>\r
1024 for the link reported.<br>\r
1025 <br>\r
1026 <br>\r
1027 OPTIONS<br>\r
1028 -a Report an action to take. Some of the counters are not errors<br>\r
1029 in and of themselves. This reports some more information on<br>\r
1030 what the counters mean and what actions can/should be taken if<br>\r
1031 they are non-zero.<br>\r
1032 <br>\r
1033 -c Suppress some of the common &quot;side effect&quot; counters. These coun-<br>\r
1034 ters usually do not indicate an error condition and can be usu-<br>\r
1035 ally be safely ignored.<br>\r
1036 <br>\r
1037 -r Report the port information. This includes LID, port, external<br>\r
1038 port (if applicable), link speed setting, remote GUID, remote<br>\r
1039 port, remote external port (if applicable), and remote node<br>\r
1040 description information.<br>\r
1041 <br>\r
1042 -R Recalculate the ibnetdiscover information, ie do not use the<br>\r
1043 cached information. This option is slower but should be used if<br>\r
1044 the diag tools have not been used for some time or if there are<br>\r
1045 other reasons to believe that the fabric has changed.<br>\r
1046 <br>\r
1047 -s &lt;err1,err2,...&gt;<br>\r
1048 Suppress the errors listed in the comma separated list provided.<br>\r
1049 <br>\r
1050 -S &lt;switch_guid&gt;<br>\r
1051 Report results only for the switch specified. (hex format)<br>\r
1052 <br>\r
1053 -D &lt;direct_route&gt;<br>\r
1054 Report results only for the switch specified by the direct route<br>\r
1055 path.<br>\r
1056 <br>\r
1057 -d Include the optional transmit and receive data counters.<br>\r
1058 <br>\r
1059 -C &lt;ca_name&gt; use the specified ca_name for the search.<br>\r
1060 <br>\r
1061 -P &lt;ca_port&gt; use the specified ca_port for the search.<br>\r
1062 <br>\r
1063 AUTHOR<br>\r
1064 Ira Weiny &lt;weiny2@llnl.gov&gt;<br>\r
1065 <br>\r
1066 <br>\r
1067 OFED Jan 24, 2008 IBQUERYERRORS(8)</p>\r
1068 <p align="left"><br>\r
1069 <font color="#000000"><a href="#TOP">&lt;return-to-top&gt;</a></font></p>\r
1070 <h3 align="left">&nbsp;</h3>\r
1071 <h3 align="left"><a name="IBROUTE">IBROUTE</a>(8) OFED Diagnostics<br>\r
1072 &nbsp;</h3>\r
1073 <p align="left">NAME<br>\r
1074 ibroute - query InfiniBand switch forwarding tables<br>\r
1075 <br>\r
1076 <br>\r
1077 SYNOPSIS<br>\r
1078 ibroute [-d(ebug)] [-a(ll)] [-n(o_dests)] [-v(erbose)] [-D(irect)]<br>\r
1079 [-G(uid)] [-M(ulticast)] [-s smlid] [-C ca_name] [-P ca_port] [-t(ime-<br>\r
1080 out) timeout_ms] [-V(ersion)] [-h(elp)] [&lt;dest dr_path|lid|guid&gt;<br>\r
1081 [&lt;startlid&gt; [&lt;endlid&gt;]]]<br>\r
1082 <br>\r
1083 <br>\r
1084 DESCRIPTION<br>\r
1085 ibroute uses SMPs to display the forwarding tables (unicast (LinearFor-<br>\r
1086 wardingTable or LFT) or multicast (MulticastForwardingTable or MFT))<br>\r
1087 for the specified switch LID and the optional lid (mlid) range. The<br>\r
1088 default range is all valid entries in the range 1...FDBTop.<br>\r
1089 <br>\r
1090 <br>\r
1091 OPTIONS<br>\r
1092 -a, --all<br>\r
1093 show all lids in range, even invalid entries<br>\r
1094 <br>\r
1095 -n, --no_dests<br>\r
1096 do not try to resolve destinations<br>\r
1097 <br>\r
1098 -M, --Multicast<br>\r
1099 show multicast forwarding tables In this case, the range parame-<br>\r
1100 ters are specifying the mlid range.<br>\r
1101 <br>\r
1102 <br>\r
1103 COMMON OPTIONS<br>\r
1104 Most OFED diagnostics take the following common flags. The exact list<br>\r
1105 of supported flags per utility can be found in the usage message and<br>\r
1106 can be shown using the util_name -h syntax.<br>\r
1107 <br>\r
1108 # Debugging flags<br>\r
1109 <br>\r
1110 -d raise the IB debugging level.<br>\r
1111 May be used several times (-ddd or -d -d -d).<br>\r
1112 <br>\r
1113 -e show send and receive errors (timeouts and others)<br>\r
1114 <br>\r
1115 -h show the usage message<br>\r
1116 <br>\r
1117 -v increase the application verbosity level.<br>\r
1118 May be used several times (-vv or -v -v -v)<br>\r
1119 <br>\r
1120 -V show the version info.<br>\r
1121 <br>\r
1122 # Addressing flags<br>\r
1123 <br>\r
1124 -D use directed path address arguments. The path<br>\r
1125 is a comma separated list of out ports.<br>\r
1126 Examples:<br>\r
1127 &quot;0&quot; # self port<br>\r
1128 &quot;0,1,2,1,4&quot; # out via port 1, then 2, ...<br>\r
1129 <br>\r
1130 -G use GUID address argument. In most cases, it is the Port GUID.<br>\r
1131 Example:<br>\r
1132 &quot;0x08f1040023&quot;<br>\r
1133 <br>\r
1134 -s &lt;smlid&gt; use \92smlid\92 as the target lid for SM/SA queries.<br>\r
1135 <br>\r
1136 # Other common flags:<br>\r
1137 <br>\r
1138 -C &lt;ca_name&gt; use the specified ca_name.<br>\r
1139 <br>\r
1140 -P &lt;ca_port&gt; use the specified ca_port.<br>\r
1141 <br>\r
1142 -t &lt;timeout_ms&gt; override the default timeout for the solicited mads.<br>\r
1143 <br>\r
1144 Multiple CA/Multiple Port Support<br>\r
1145 <br>\r
1146 When no IB device or port is specified, the port to use is selected by<br>\r
1147 the following criteria:<br>\r
1148 <br>\r
1149 1. the first port that is ACTIVE.<br>\r
1150 <br>\r
1151 2. if not found, the first port that is UP (physical link up).<br>\r
1152 <br>\r
1153 If a port and/or CA name is specified, the user request is attempted to<br>\r
1154 be fulfilled, and will fail if it is not possible.<br>\r
1155 <br>\r
1156 <br>\r
1157 EXAMPLES<br>\r
1158 Unicast examples<br>\r
1159 <br>\r
1160 ibroute 4 # dump all lids with valid out ports of switch with lid 4<br>\r
1161 <br>\r
1162 ibroute -a 4 # same, but dump all lids, even with invalid out ports<br>\r
1163 <br>\r
1164 ibroute -n 4 # simple dump format - no destination resolution<br>\r
1165 <br>\r
1166 ibroute 4 10 # dump lids starting from 10 (up to FDBTop)<br>\r
1167 <br>\r
1168 ibroute 4 0x10 0x20 # dump lid range<br>\r
1169 <br>\r
1170 ibroute -G 0x08f1040023 # resolve switch by GUID<br>\r
1171 <br>\r
1172 ibroute -D 0,1 # resolve switch by direct path<br>\r
1173 <br>\r
1174 <br>\r
1175 Multicast examples<br>\r
1176 <br>\r
1177 ibroute -M 4 # dump all non empty mlids of switch with lid 4<br>\r
1178 <br>\r
1179 ibroute -M 4 0xc010 0xc020 # same, but with range<br>\r
1180 <br>\r
1181 ibroute -M -n 4 # simple dump format<br>\r
1182 <br>\r
1183 <br>\r
1184 SEE ALSO<br>\r
1185 ibtracert(8)<br>\r
1186 <br>\r
1187 AUTHOR<br>\r
1188 Hal Rosenstock &lt;halr@voltaire.com&gt;<br>\r
1189 <br>\r
1190 <br>\r
1191 OFED July 25, 2006 IBROUTE(8)</p>\r
1192 <p align="left"><br>\r
1193 <font color="#000000"><a href="#TOP">&lt;return-to-top&gt;</a></font><br>\r
1194 &nbsp;</p>\r
1195 <p align="left">&nbsp;</p>\r
1196 <BLOCKQUOTE></BLOCKQUOTE>\r
1197 <h3 align="left"><a name="ibv_devinfo"></a><br>\r
1198 ibv_devinfo - print CA (Channel Adapter) attributes</h3>\r
1199 <p align="left">usage: ibv_devinfo&nbsp; [options]<br>\r
1200 <br>\r
1201 Options:<br>\r
1202 &nbsp;&nbsp; -d, --ib-dev=&lt;dev&gt; use IB device &lt;dev&gt; (default: first device \r
1203 found)<br>\r
1204 &nbsp;&nbsp;&nbsp; -i, --ib-port=&lt;port&gt; use port &lt;port&gt; of IB device (default: \r
1205 all ports)<br>\r
1206 &nbsp;&nbsp;&nbsp; -l, --list print only the IB devices names<br>\r
1207 &nbsp;&nbsp;&nbsp; -v, --verbose print all the attributes of the IB device(s)<br>\r
1208 <br>\r
1209 <font color="#000000"><a href="#TOP">&lt;return-to-top&gt;</a></font><br>\r
1210 &nbsp;</p>\r
1211 <BLOCKQUOTE></BLOCKQUOTE>\r
1212 <h3 align="left"><a name="ibstat"></a><br>\r
1213 IBSTAT(8) OFED Diagnostics</h3>\r
1214 <p align="left">NAME<br>\r
1215 ibstat - query basic status of InfiniBand device(s)<br>\r
1216 <br>\r
1217 <br>\r
1218 SYNOPSIS<br>\r
1219 ibstat [-d(ebug)] [-l(ist_of_cas)] [-s(hort)] [-p(ort_list)] [-V(ersion)] [-h] &lt;ca_name&gt; \r
1220 [portnum]<br>\r
1221 <br>\r
1222 <br>\r
1223 DESCRIPTION<br>\r
1224 ibstat is a binary which displays basic information obtained from the<br>\r
1225 local IB driver. Output includes LID, SMLID, port state, link width<br>\r
1226 active, and port physical state.<br>\r
1227 <br>\r
1228 It is similar to the ibstatus utility but implemented as a binary<br>\r
1229 rather than a script. It has options to list CAs and/or ports and dis-<br>\r
1230 plays more information than ibstatus.<br>\r
1231 <br>\r
1232 <br>\r
1233 OPTIONS<br>\r
1234 -l, --list_of_cas<br>\r
1235 list all IB devices<br>\r
1236 <br>\r
1237 -s, --short<br>\r
1238 short output<br>\r
1239 <br>\r
1240 -p, --port_list<br>\r
1241 show port list<br>\r
1242 <br>\r
1243 ca_name<br>\r
1244 InfiniBand device name<br>\r
1245 <br>\r
1246 portnum<br>\r
1247 port number of InfiniBand device<br>\r
1248 <br>\r
1249 <br>\r
1250 COMMON OPTIONS<br>\r
1251 Most OFED diagnostics take the following common flags. The exact list<br>\r
1252 of supported flags per utility can be found in the usage message and<br>\r
1253 can be shown using the util_name -h syntax.<br>\r
1254 <br>\r
1255 # Debugging flags<br>\r
1256 <br>\r
1257 -d raise the IB debugging level.<br>\r
1258 May be used several times (-ddd or -d -d -d).<br>\r
1259 <br>\r
1260 -e show send and receive errors (timeouts and others)<br>\r
1261 <br>\r
1262 -h show the usage message<br>\r
1263 <br>\r
1264 -v increase the application verbosity level.<br>\r
1265 May be used several times (-vv or -v -v -v)<br>\r
1266 <br>\r
1267 -V show the version info.<br>\r
1268 <br>\r
1269 # Addressing flags<br>\r
1270 <br>\r
1271 -D use directed path address arguments. The path<br>\r
1272 is a comma separated list of out ports.<br>\r
1273 Examples:<br>\r
1274 &quot;0&quot; # self port<br>\r
1275 &quot;0,1,2,1,4&quot; # out via port 1, then 2, ...<br>\r
1276 <br>\r
1277 -G use GUID address argument. In most cases, it is the Port GUID.<br>\r
1278 Example:<br>\r
1279 &quot;0x08f1040023&quot;<br>\r
1280 <br>\r
1281 -s &lt;smlid&gt; use \92smlid\92 as the target lid for SM/SA queries.<br>\r
1282 <br>\r
1283 # Other common flags:<br>\r
1284 <br>\r
1285 -C &lt;ca_name&gt; use the specified ca_name.<br>\r
1286 <br>\r
1287 -P &lt;ca_port&gt; use the specified ca_port.<br>\r
1288 <br>\r
1289 -t &lt;timeout_ms&gt; override the default timeout for the solicited mads.<br>\r
1290 <br>\r
1291 Multiple CA/Multiple Port Support<br>\r
1292 <br>\r
1293 When no IB device or port is specified, the port to use is selected by<br>\r
1294 the following criteria:<br>\r
1295 <br>\r
1296 1. the first port that is ACTIVE.<br>\r
1297 <br>\r
1298 2. if not found, the first port that is UP (physical link up).<br>\r
1299 <br>\r
1300 If a port and/or CA name is specified, the user request is attempted to<br>\r
1301 be fulfilled, and will fail if it is not possible.<br>\r
1302 <br>\r
1303 <br>\r
1304 EXAMPLES<br>\r
1305 ibstat # display status of all ports on all IB devices<br>\r
1306 <br>\r
1307 ibstat -l # list all IB devices<br>\r
1308 <br>\r
1309 ibstat -p # show port guids<br>\r
1310 <br>\r
1311 ibstat ibv_device0 2 # show status of port 2 of \92hca0\92<br>\r
1312 <br>\r
1313 <br>\r
1314 SEE ALSO<br>\r
1315 ibstatus(8)<br>\r
1316 <br>\r
1317 <br>\r
1318 AUTHOR<br>\r
1319 Hal Rosenstock &lt;halr@voltaire.com&gt;<br>\r
1320 <br>\r
1321 <br>\r
1322 OFED July 25, 2006 IBSTAT(8)<br>\r
1323 <br>\r
1324 <font color="#000000"><a href="#TOP">&lt;return-to-top&gt;</a></font><br>\r
1325 &nbsp;</p>\r
1326 <p align="left">&nbsp;</p>\r
1327 <h3 align="left"><a name="IBSYSSTAT">IBSYSSTAT</a>(8) OFED Diagnostics<br>\r
1328 &nbsp;</h3>\r
1329 <p align="left">NAME<br>\r
1330 ibsysstat - system status on an InfiniBand address<br>\r
1331 <br>\r
1332 <br>\r
1333 SYNOPSIS<br>\r
1334 ibsysstat [-d(ebug)] [-e(rr_show)] [-v(erbose)] [-G(uid)] [-C ca_name]<br>\r
1335 [-P ca_port] [-s smlid] [-t(imeout) timeout_ms] [-V(ersion)] [-o oui]<br>\r
1336 [-S(erver)] [-h(elp)] &lt;dest lid | guid&gt; [&lt;op&gt;]<br>\r
1337 <br>\r
1338 <br>\r
1339 DESCRIPTION<br>\r
1340 ibsysstat uses vendor mads to validate connectivity between IB nodes<br>\r
1341 and obtain other information about the IB node. ibsysstat is run as<br>\r
1342 client/server. Default is to run as client.<br>\r
1343 <br>\r
1344 <br>\r
1345 OPTIONS<br>\r
1346 Current supported operations:<br>\r
1347 ping - verify connectivity to server (default)<br>\r
1348 host - obtain host information from server<br>\r
1349 cpu - obtain cpu information from server<br>\r
1350 <br>\r
1351 -o, --oui<br>\r
1352 use specified OUI number to multiplex vendor mads<br>\r
1353 <br>\r
1354 -S, --Server<br>\r
1355 start in server mode (do not return)<br>\r
1356 <br>\r
1357 <br>\r
1358 <br>\r
1359 COMMON OPTIONS<br>\r
1360 Most OFED diagnostics take the following common flags. The exact list<br>\r
1361 of supported flags per utility can be found in the usage message and<br>\r
1362 can be shown using the util_name -h syntax.<br>\r
1363 <br>\r
1364 # Debugging flags<br>\r
1365 <br>\r
1366 -d raise the IB debugging level.<br>\r
1367 May be used several times (-ddd or -d -d -d).<br>\r
1368 <br>\r
1369 -e show send and receive errors (timeouts and others)<br>\r
1370 <br>\r
1371 -h show the usage message<br>\r
1372 <br>\r
1373 -v increase the application verbosity level.<br>\r
1374 May be used several times (-vv or -v -v -v)<br>\r
1375 <br>\r
1376 -V show the version info.<br>\r
1377 <br>\r
1378 # Addressing flags<br>\r
1379 <br>\r
1380 -G use GUID address argument. In most cases, it is the Port GUID.<br>\r
1381 Example:<br>\r
1382 &quot;0x08f1040023&quot;<br>\r
1383 <br>\r
1384 -s &lt;smlid&gt; use \92smlid\92 as the target lid for SM/SA queries.<br>\r
1385 <br>\r
1386 # Other common flags:<br>\r
1387 <br>\r
1388 -C &lt;ca_name&gt; use the specified ca_name.<br>\r
1389 <br>\r
1390 -P &lt;ca_port&gt; use the specified ca_port.<br>\r
1391 <br>\r
1392 -t &lt;timeout_ms&gt; override the default timeout for the solicited mads.<br>\r
1393 <br>\r
1394 Multiple CA/Multiple Port Support<br>\r
1395 <br>\r
1396 When no IB device or port is specified, the port to use is selected by<br>\r
1397 the following criteria:<br>\r
1398 <br>\r
1399 1. the first port that is ACTIVE.<br>\r
1400 <br>\r
1401 2. if not found, the first port that is UP (physical link up).<br>\r
1402 <br>\r
1403 If a port and/or CA name is specified, the user request is attempted to<br>\r
1404 be fulfilled, and will fail if it is not possible.<br>\r
1405 <br>\r
1406 <br>\r
1407 AUTHOR<br>\r
1408 Hal Rosenstock&nbsp;&nbsp;&nbsp; &lt;halr@voltaire.com&gt;<br>\r
1409 <br>\r
1410 <br>\r
1411 OFED August 11, 2006 IBSYSSTAT(8)</p>\r
1412 <p align="left"><br>\r
1413 <a href="#TOP"><font color="#000000">&lt;return-to-top&gt;</font></a></p>\r
1414 <h3 align="left">&nbsp;</h3>\r
1415 <h3 align="left"><a name="IBTRACERT">IBTRACERT</a>(8) OFED Diagnostics</h3>\r
1416 <p align="left"><br>\r
1417 NAME<br>\r
1418 ibtracert- trace InfiniBand path<br>\r
1419 <br>\r
1420 <br>\r
1421 SYNOPSIS<br>\r
1422 ibtracert [-d(ebug)] [-v(erbose)] [-D(irect)] [-G(uids)] [-n(o_info)]<br>\r
1423 [-m mlid] [-s smlid] [-C ca_name] [-P ca_port] [-t(imeout) timeout_ms]<br>\r
1424 [-V(ersion)] [--node-name--map &lt;node-name-map&gt;] [-h(elp)] [&lt;dest<br>\r
1425 dr_path|lid|guid&gt; [&lt;startlid&gt; [&lt;endlid&gt;]]]<br>\r
1426 <br>\r
1427 <br>\r
1428 DESCRIPTION<br>\r
1429 ibtracert uses SMPs to trace the path from a source GID/LID to a desti-<br>\r
1430 nation GID/LID. Each hop along the path is displayed until the destina-<br>\r
1431 tion is reached or a hop does not respond. By using the -m option, mul-<br>\r
1432 ticast path tracing can be performed between source and destination<br>\r
1433 nodes.<br>\r
1434 <br>\r
1435 <br>\r
1436 OPTIONS<br>\r
1437 -n, --no_info<br>\r
1438 simple format; don\92t show additional information<br>\r
1439 <br>\r
1440 -m show the multicast trace of the specified mlid<br>\r
1441 <br>\r
1442 --node-name-map &lt;node-name-map&gt;<br>\r
1443 Specify a node name map. The node name map file maps GUIDs to<br>\r
1444 more user friendly names. See ibnetdiscover(8) for node name<br>\r
1445 map file format.<br>\r
1446 <br>\r
1447 <br>\r
1448 COMMON OPTIONS<br>\r
1449 Most OFED diagnostics take the following common flags. The exact list<br>\r
1450 of supported flags per utility can be found in the usage message and<br>\r
1451 can be shown using the util_name -h syntax.<br>\r
1452 <br>\r
1453 # Debugging flags<br>\r
1454 <br>\r
1455 -d raise the IB debugging level.<br>\r
1456 May be used several times (-ddd or -d -d -d).<br>\r
1457 <br>\r
1458 -h show the usage message<br>\r
1459 <br>\r
1460 -v increase the application verbosity level.<br>\r
1461 May be used several times (-vv or -v -v -v)<br>\r
1462 <br>\r
1463 -V show the version info.<br>\r
1464 <br>\r
1465 # Addressing flags<br>\r
1466 <br>\r
1467 -D use directed path address arguments. The path<br>\r
1468 is a comma separated list of out ports.<br>\r
1469 Examples:<br>\r
1470 &quot;0&quot; # self port<br>\r
1471 &quot;0,1,2,1,4&quot; # out via port 1, then 2, ...<br>\r
1472 <br>\r
1473 -G use GUID address argument. In most cases, it is the Port GUID.<br>\r
1474 Example:<br>\r
1475 &quot;0x08f1040023&quot;<br>\r
1476 <br>\r
1477 -s &lt;smlid&gt; use \92smlid\92 as the target lid for SM/SA queries.<br>\r
1478 <br>\r
1479 # Other common flags:<br>\r
1480 <br>\r
1481 -C &lt;ca_name&gt; use the specified ca_name.<br>\r
1482 <br>\r
1483 -P &lt;ca_port&gt; use the specified ca_port.<br>\r
1484 <br>\r
1485 -t &lt;timeout_ms&gt; override the default timeout for the solicited mads.<br>\r
1486 <br>\r
1487 Multiple CA/Multiple Port Support<br>\r
1488 <br>\r
1489 When no IB device or port is specified, the port to use is selected by<br>\r
1490 the following criteria:<br>\r
1491 <br>\r
1492 1. the first port that is ACTIVE.<br>\r
1493 <br>\r
1494 2. if not found, the first port that is UP (physical link up).<br>\r
1495 <br>\r
1496 If a port and/or CA name is specified, the user request is attempted to<br>\r
1497 be fulfilled, and will fail if it is not possible.<br>\r
1498 <br>\r
1499 <br>\r
1500 EXAMPLES<br>\r
1501 Unicast examples<br>\r
1502 <br>\r
1503 ibtracert 4 16 # show path between lids 4 and 16<br>\r
1504 <br>\r
1505 ibtracert -n 4 16 # same, but using simple output format<br>\r
1506 <br>\r
1507 ibtracert -G 0x8f1040396522d 0x002c9000100d051 # use guid addresses<br>\r
1508 <br>\r
1509 <br>\r
1510 Multicast example<br>\r
1511 <br>\r
1512 ibtracert -m 0xc000 4 16 # show multicast path of mlid 0xc000<br>\r
1513 between lids 4 and 16<br>\r
1514 <br>\r
1515 <br>\r
1516 SEE ALSO<br>\r
1517 ibroute(8)<br>\r
1518 <br>\r
1519 <br>\r
1520 AUTHOR<br>\r
1521 &nbsp;&nbsp;&nbsp; Hal Rosenstock&nbsp;&nbsp;&nbsp; &lt;<a href="mailto:halr@voltaire.com">halr@voltaire.com</a>&gt;<br>\r
1522 <br>\r
1523 &nbsp;&nbsp;&nbsp; Ira Weiny&nbsp;&nbsp;&nbsp; &lt;weiny2@llnl.gov&gt;<br>\r
1524 <br>\r
1525 OFED April 14, 2007 IBTRACERT(8)</p>\r
1526 <p align="left"><a href="#TOP"><font color="#000000">&lt;return-to-top&gt;</font></a></p>\r
1527 <h3 align="left">&nbsp;</h3>\r
1528 <h3 align="left"><a name="PERFQUERY">PERFQUERY</a>(8) OFED Diagnostics</h3>\r
1529 <p align="left"><br>\r
1530 NAME<br>\r
1531 perfquery - query InfiniBand port counters<br>\r
1532 <br>\r
1533 <br>\r
1534 SYNOPSIS<br>\r
1535 perfquery [-d(ebug)] [-G(uid)] [-x|--extended] [-X|--xmtsl]<br>\r
1536 [-S|--rcvsl] [-a(ll_ports)] [-l(oop_ports)] [-r(eset_after_read)]<br>\r
1537 [-R(eset_only)] [-C ca_name] [-P ca_port] [-t(imeout) timeout_ms]<br>\r
1538 [-V(ersion)] [-h(elp)] [&lt;lid|guid&gt; [[port] [reset_mask]]]<br>\r
1539 <br>\r
1540 <br>\r
1541 DESCRIPTION<br>\r
1542 perfquery uses PerfMgt GMPs to obtain the PortCounters (basic perfor-<br>\r
1543 mance and error counters), PortExtendedCounters, PortXmitDataSL, or<br>\r
1544 PortRcvDataSL from the PMA at the node/port specified. Optionally shows<br>\r
1545 aggregated counters for all ports of node. Also, optionally, reset<br>\r
1546 after read, or only reset counters.<br>\r
1547 <br>\r
1548 Note: In PortCounters, PortCountersExtended, PortXmitDataSL, and PortR-<br>\r
1549 cvDataSL, components that represent Data (e.g. PortXmitData and PortR-<br>\r
1550 cvData) indicate octets divided by 4 rather than just octets.<br>\r
1551 <br>\r
1552 Note: Inputting a port of 255 indicates an operation be performed on<br>\r
1553 all ports.<br>\r
1554 <br>\r
1555 <br>\r
1556 OPTIONS<br>\r
1557 -x, --extended<br>\r
1558 show extended port counters rather than (basic) port counters.<br>\r
1559 Note that extended port counters attribute is optional.<br>\r
1560 <br>\r
1561 -X, --xmtsl<br>\r
1562 show transmit data SL counter. This is an optional counter for<br>\r
1563 QoS.<br>\r
1564 <br>\r
1565 -S, --rcvsl<br>\r
1566 show receive data SL counter. This is an optional counter for<br>\r
1567 QoS.<br>\r
1568 <br>\r
1569 -a, --all_ports<br>\r
1570 show aggregated counters for all ports of the destination lid or<br>\r
1571 reset all counters for all ports. If the destination lid does<br>\r
1572 not support the AllPortSelect flag, all ports will be iterated<br>\r
1573 through to emulate AllPortSelect behavior.<br>\r
1574 <br>\r
1575 -l, --loop_ports<br>\r
1576 If all ports are selected by the user (either through the -a<br>\r
1577 option or port 255) iterate through each port rather than doing<br>\r
1578 than aggregate operation.<br>\r
1579 <br>\r
1580 -r, --reset_after_read<br>\r
1581 reset counters after read<br>\r
1582 <br>\r
1583 -R, --Reset_only<br>\r
1584 only reset counters<br>\r
1585 <br>\r
1586 <br>\r
1587 COMMON OPTIONS<br>\r
1588 Most OFED diagnostics take the following common flags. The exact list<br>\r
1589 of supported flags per utility can be found in the usage message and<br>\r
1590 can be shown using the util_name -h syntax.<br>\r
1591 <br>\r
1592 # Debugging flags<br>\r
1593 <br>\r
1594 -d raise the IB debugging level.<br>\r
1595 May be used several times (-ddd or -d -d -d).<br>\r
1596 <br>\r
1597 -e show send and receive errors (timeouts and others)<br>\r
1598 <br>\r
1599 -h show the usage message<br>\r
1600 <br>\r
1601 -v increase the application verbosity level.<br>\r
1602 May be used several times (-vv or -v -v -v)<br>\r
1603 <br>\r
1604 -V show the version info.<br>\r
1605 <br>\r
1606 # Addressing flags<br>\r
1607 <br>\r
1608 -G use GUID address argument. In most cases, it is the Port GUID.<br>\r
1609 Example:<br>\r
1610 &quot;0x08f1040023&quot;<br>\r
1611 <br>\r
1612 -s &lt;smlid&gt; use \92smlid\92 as the target lid for SM/SA queries.<br>\r
1613 <br>\r
1614 # Other common flags:<br>\r
1615 <br>\r
1616 -C &lt;ca_name&gt; use the specified ca_name.<br>\r
1617 <br>\r
1618 -P &lt;ca_port&gt; use the specified ca_port.<br>\r
1619 <br>\r
1620 -t &lt;timeout_ms&gt; override the default timeout for the solicited mads.<br>\r
1621 <br>\r
1622 Multiple CA/Multiple Port Support<br>\r
1623 <br>\r
1624 When no IB device or port is specified, the port to use is selected by<br>\r
1625 the following criteria:<br>\r
1626 <br>\r
1627 1. the first port that is ACTIVE.<br>\r
1628 <br>\r
1629 2. if not found, the first port that is UP (physical link up).<br>\r
1630 <br>\r
1631 If a port and/or CA name is specified, the user request is attempted to<br>\r
1632 be fulfilled, and will fail if it is not possible.<br>\r
1633 <br>\r
1634 <br>\r
1635 EXAMPLES<br>\r
1636 perfquery # read local port performance counters<br>\r
1637 <br>\r
1638 perfquery 32 1 # read performance counters from lid 32, port 1<br>\r
1639 <br>\r
1640 perfquery -x 32 1 # read extended performance counters from lid 32, port 1<br>\r
1641 <br>\r
1642 perfquery -a 32 # read perf counters from lid 32, all ports<br>\r
1643 <br>\r
1644 perfquery -r 32 1 # read performance counters and reset<br>\r
1645 <br>\r
1646 perfquery -x -r 32 1 # read extended performance counters and reset<br>\r
1647 <br>\r
1648 perfquery -R 0x20 1 # reset performance counters of port 1 only<br>\r
1649 <br>\r
1650 perfquery -x -R 0x20 1 # reset extended performance counters of port 1 only<br>\r
1651 <br>\r
1652 perfquery -R -a 32 # reset performance counters of all ports<br>\r
1653 <br>\r
1654 perfquery -R 32 2 0x0fff # reset only error counters of port 2<br>\r
1655 <br>\r
1656 perfquery -R 32 2 0xf000 # reset only non-error counters of port 2<br>\r
1657 <br>\r
1658 <br>\r
1659 AUTHOR<br>\r
1660 Hal Rosenstock&nbsp;&nbsp;&nbsp; &lt;halr@voltaire.com&gt;<br>\r
1661 <br>\r
1662 <br>\r
1663 OFED March 10, 2009 PERFQUERY(8)</p>\r
1664 <p align="left"><br>\r
1665 <a href="#TOP"><font color="#000000">&lt;return-to-top&gt;</font></a></p>\r
1666 <h3 align="left">&nbsp;</h3>\r
1667 <h3 align="left"><a name="SAQUERY">SAQUERY</a>(8) OFED Diagnostics</h3>\r
1668 <p align="left"><br>\r
1669 NAME<br>\r
1670 saquery - query InfiniBand subnet administration attributes<br>\r
1671 <br>\r
1672 <br>\r
1673 SYNOPSIS<br>\r
1674 saquery [-h] [-d] [-p] [-N] [--list | -D] [-S] [-I] [-L] [-l] [-G] [-O]<br>\r
1675 [-U] [-c] [-s] [-g] [-m] [-x] [-C ca_name] [-P ca_port] [--smkey val]<br>\r
1676 [-t(imeout) &lt;msec&gt;] [--src-to-dst &lt;src:dst&gt;] [--sgid-to-dgid<br>\r
1677 &lt;sgid-dgid&gt;] [--node-name-map &lt;node-name-map&gt;] [&lt;name&gt; | &lt;lid&gt; |<br>\r
1678 &lt;guid&gt;]<br>\r
1679 <br>\r
1680 <br>\r
1681 DESCRIPTION<br>\r
1682 saquery issues the selected SA query. Node records are queried by<br>\r
1683 default.<br>\r
1684 <br>\r
1685 <br>\r
1686 OPTIONS<br>\r
1687 -p get PathRecord info<br>\r
1688 <br>\r
1689 -N get NodeRecord info<br>\r
1690 <br>\r
1691 --list | -D<br>\r
1692 get NodeDescriptions of CAs only<br>\r
1693 <br>\r
1694 -S get ServiceRecord info<br>\r
1695 <br>\r
1696 -I get InformInfoRecord (subscription) info<br>\r
1697 <br>\r
1698 -L return the Lids of the name specified<br>\r
1699 <br>\r
1700 -l return the unique Lid of the name specified<br>\r
1701 <br>\r
1702 -G return the Guids of the name specified<br>\r
1703 <br>\r
1704 -O return the name for the Lid specified<br>\r
1705 <br>\r
1706 -U return the name for the Guid specified<br>\r
1707 <br>\r
1708 -c get the SA\92s class port info<br>\r
1709 <br>\r
1710 -s return the PortInfoRecords with isSM or isSMdisabled capability<br>\r
1711 mask bit on<br>\r
1712 <br>\r
1713 -g get multicast group info<br>\r
1714 <br>\r
1715 -m get multicast member info. If a group is specified, limit the<br>\r
1716 output to the group specified and print one line containing only<br>\r
1717 the GUID and node description for each entry. Example: saquery<br>\r
1718 -m 0xc000<br>\r
1719 <br>\r
1720 -x get LinkRecord info<br>\r
1721 <br>\r
1722 --src-to-dst<br>\r
1723 get a PathRecord for &lt;src:dst&gt; where src and dst are either node<br>\r
1724 names or LIDs<br>\r
1725 <br>\r
1726 --sgid-to-dgid<br>\r
1727 get a PathRecord for sgid to dgid where both GIDs are in an IPv6<br>\r
1728 format acceptable to inet_pton(3).<br>\r
1729 <br>\r
1730 -C &lt;ca_name&gt;<br>\r
1731 use the specified ca_name.<br>\r
1732 <br>\r
1733 -P &lt;ca_port&gt;<br>\r
1734 use the specified ca_port.<br>\r
1735 <br>\r
1736 --smkey &lt;val&gt;<br>\r
1737 use SM_Key value for the query. Will be used only with &quot;trusted&quot;<br>\r
1738 queries. If non-numeric value (like \92x\92) is specified then<br>\r
1739 saquery will prompt for a value.<br>\r
1740 <br>\r
1741 -t, -timeout &lt;msec&gt;<br>\r
1742 Specify SA query response timeout in milliseconds. Default is<br>\r
1743 100 milliseconds. You may want to use this option if IB_TIMEOUT<br>\r
1744 is indicated.<br>\r
1745 <br>\r
1746 --node-name-map &lt;node-name-map&gt;<br>\r
1747 Specify a node name map. The node name map file maps GUIDs to<br>\r
1748 more user friendly names. See ibnetdiscover(8) for node name<br>\r
1749 map file format. Only used with the -O and -U options.<br>\r
1750 <br>\r
1751 Supported query names (and aliases):<br>\r
1752 ClassPortInfo (CPI)<br>\r
1753 NodeRecord (NR) [lid]<br>\r
1754 PortInfoRecord (PIR) [[lid]/[port]]<br>\r
1755 SL2VLTableRecord (SL2VL) [[lid]/[in_port]/[out_port]]<br>\r
1756 PKeyTableRecord (PKTR) [[lid]/[port]/[block]]<br>\r
1757 VLArbitrationTableRecord (VLAR) [[lid]/[port]/[block]]<br>\r
1758 InformInfoRecord (IIR)<br>\r
1759 LinkRecord (LR) [[from_lid]/[from_port]] [[to_lid]/[to_port]]<br>\r
1760 ServiceRecord (SR)<br>\r
1761 PathRecord (PR)<br>\r
1762 MCMemberRecord (MCMR)<br>\r
1763 LFTRecord (LFTR) [[lid]/[block]]<br>\r
1764 MFTRecord (MFTR) [[mlid]/[position]/[block]]<br>\r
1765 <br>\r
1766 -d enable debugging<br>\r
1767 <br>\r
1768 -h show help<br>\r
1769 <br>\r
1770 <br>\r
1771 AUTHORS<br>\r
1772 Ira Weiny &lt;weiny2@llnl.gov&gt;<br>\r
1773 <br>\r
1774 Hal Rosenstock &lt;halr@voltaire.com&gt;<br>\r
1775 <br>\r
1776 <br>\r
1777 OFED October 19, 2008 SAQUERY(8)</p>\r
1778 <p align="left"><a href="#TOP"><font color="#000000">&lt;return-to-top&gt;</font></a></p>\r
1779 <p align="left">&nbsp;</p>\r
1780 <h3 align="left"><a name="SMINFO">SMINFO</a>(8) OFED Diagnostics</h3>\r
1781 <p align="left"><br>\r
1782 NAME<br>\r
1783 sminfo - query InfiniBand SMInfo attribute<br>\r
1784 <br>\r
1785 <br>\r
1786 SYNOPSIS<br>\r
1787 sminfo [-d(ebug)] [-e(rr_show)] -s state -p prio -a activity<br>\r
1788 [-D(irect)] [-G(uid)] [-C ca_name] [-P ca_port] [-t(imeout) time-<br>\r
1789 out_ms] [-V(ersion)] [-h(elp)] sm_lid | sm_dr_path [modifier]<br>\r
1790 <br>\r
1791 <br>\r
1792 DESCRIPTION<br>\r
1793 Optionally set and display the output of a sminfo query in human read-<br>\r
1794 able format. The target SM is the one listed in the local port info, or<br>\r
1795 the SM specified by the optional SM lid or by the SM direct routed<br>\r
1796 path.<br>\r
1797 <br>\r
1798 Note: using sminfo for any purposes other then simple query may be very<br>\r
1799 dangerous, and may result in a malfunction of the target SM.<br>\r
1800 <br>\r
1801 <br>\r
1802 OPTIONS<br>\r
1803 -s set SM state<br>\r
1804 0 - not active<br>\r
1805 1 - discovering<br>\r
1806 2 - standby<br>\r
1807 3 - master<br>\r
1808 <br>\r
1809 -p set priority (0-15)<br>\r
1810 <br>\r
1811 -a set activity count<br>\r
1812 <br>\r
1813 <br>\r
1814 COMMON OPTIONS<br>\r
1815 Most OFED diagnostics take the following common flags. The exact list<br>\r
1816 of supported flags per utility can be found in the usage message and<br>\r
1817 can be shown using the util_name -h syntax.<br>\r
1818 <br>\r
1819 # Debugging flags<br>\r
1820 <br>\r
1821 -d raise the IB debugging level.<br>\r
1822 May be used several times (-ddd or -d -d -d).<br>\r
1823 <br>\r
1824 -e show send and receive errors (timeouts and others)<br>\r
1825 <br>\r
1826 -h show the usage message<br>\r
1827 <br>\r
1828 -v increase the application verbosity level.<br>\r
1829 May be used several times (-vv or -v -v -v)<br>\r
1830 <br>\r
1831 -V show the version info.<br>\r
1832 <br>\r
1833 # Addressing flags<br>\r
1834 <br>\r
1835 -D use directed path address arguments. The path<br>\r
1836 is a comma separated list of out ports.<br>\r
1837 Examples:<br>\r
1838 &quot;0&quot; # self port<br>\r
1839 &quot;0,1,2,1,4&quot; # out via port 1, then 2, ...<br>\r
1840 <br>\r
1841 -G use GUID address argument. In most cases, it is the Port GUID.<br>\r
1842 Example:<br>\r
1843 &quot;0x08f1040023&quot;<br>\r
1844 <br>\r
1845 -s &lt;smlid&gt; use \92smlid\92 as the target lid for SM/SA queries.<br>\r
1846 <br>\r
1847 # Other common flags:<br>\r
1848 <br>\r
1849 -C &lt;ca_name&gt; use the specified ca_name.<br>\r
1850 <br>\r
1851 -P &lt;ca_port&gt; use the specified ca_port.<br>\r
1852 <br>\r
1853 -t &lt;timeout_ms&gt; override the default timeout for the solicited mads.<br>\r
1854 <br>\r
1855 Multiple CA/Multiple Port Support<br>\r
1856 <br>\r
1857 When no IB device or port is specified, the port to use is selected by<br>\r
1858 the following criteria:<br>\r
1859 <br>\r
1860 1. the first port that is ACTIVE.<br>\r
1861 <br>\r
1862 2. if not found, the first port that is UP (physical link up).<br>\r
1863 <br>\r
1864 If a port and/or CA name is specified, the user request is attempted to<br>\r
1865 be fulfilled, and will fail if it is not possible.<br>\r
1866 <br>\r
1867 <br>\r
1868 EXAMPLES<br>\r
1869 sminfo&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; # local port´s sminfo<br>\r
1870 <br>\r
1871 sminfo 32&nbsp;&nbsp;&nbsp;&nbsp; # show sminfo of lid 32<br>\r
1872 <br>\r
1873 sminfo -G 0x8f1040023&nbsp;&nbsp;&nbsp;&nbsp; # same but using guid address<br>\r
1874 <br>\r
1875 <br>\r
1876 SEE ALSO<br>\r
1877 smpdump(8)<br>\r
1878 <br>\r
1879 <br>\r
1880 AUTHOR<br>\r
1881 Hal Rosenstock&nbsp;&nbsp;&nbsp; &lt;halr@voltaire.com&gt;<br>\r
1882 <br>\r
1883 OFED July 25, 2006 SMINFO(8)</p>\r
1884 <p align="left"><br>\r
1885 <a href="#TOP"><font color="#000000">&lt;<b>return-to-top</b>&gt;</font></a></p>\r
1886 <h3 align="left">&nbsp;</h3>\r
1887 <h3 align="left"><a name="SMPDUMP">SMPDUMP</a>(8) OFED Diagnostics</h3>\r
1888 <p align="left"><br>\r
1889 NAME<br>\r
1890 smpdump - dump InfiniBand subnet management attributes<br>\r
1891 <br>\r
1892 <br>\r
1893 SYNOPSIS<br>\r
1894 smpdump [-s(ring)] [-D(irect)] [-C ca_name] [-P ca_port] [-t(imeout)<br>\r
1895 timeout_ms] [-V(ersion)] [-h(elp)] &lt;dlid|dr_path&gt; &lt;attr&gt; [mod]<br>\r
1896 <br>\r
1897 <br>\r
1898 DESCRIPTION<br>\r
1899 smpdump is a general purpose SMP utility which gets SM attributes from<br>\r
1900 a specified SMA. The result is dumped in hex by default.<br>\r
1901 <br>\r
1902 <br>\r
1903 OPTIONS<br>\r
1904 attr IBA attribute ID for SM attribute<br>\r
1905 <br>\r
1906 mod IBA modifier for SM attribute<br>\r
1907 <br>\r
1908 <br>\r
1909 COMMON OPTIONS<br>\r
1910 Most OFED diagnostics take the following common flags. The exact list<br>\r
1911 of supported flags per utility can be found in the usage message and<br>\r
1912 can be shown using the util_name -h syntax.<br>\r
1913 <br>\r
1914 # Debugging flags<br>\r
1915 <br>\r
1916 -d raise the IB debugging level.<br>\r
1917 May be used several times (-ddd or -d -d -d).<br>\r
1918 <br>\r
1919 -e show send and receive errors (timeouts and others)<br>\r
1920 <br>\r
1921 -h show the usage message<br>\r
1922 <br>\r
1923 -v increase the application verbosity level.<br>\r
1924 May be used several times (-vv or -v -v -v)<br>\r
1925 <br>\r
1926 -V show the version info.<br>\r
1927 <br>\r
1928 # Addressing flags<br>\r
1929 <br>\r
1930 -D use directed path address arguments. The path<br>\r
1931 is a comma separated list of out ports.<br>\r
1932 Examples:<br>\r
1933 &quot;0&quot; # self port<br>\r
1934 &quot;0,1,2,1,4&quot; # out via port 1, then 2, ...<br>\r
1935 <br>\r
1936 -G use GUID address argument. In most cases, it is the Port GUID.<br>\r
1937 Example:<br>\r
1938 &quot;0x08f1040023&quot;<br>\r
1939 <br>\r
1940 -s &lt;smlid&gt; use \92smlid\92 as the target lid for SM/SA queries.<br>\r
1941 <br>\r
1942 # Other common flags:<br>\r
1943 <br>\r
1944 -C &lt;ca_name&gt; use the specified ca_name.<br>\r
1945 <br>\r
1946 -P &lt;ca_port&gt; use the specified ca_port.<br>\r
1947 <br>\r
1948 -t &lt;timeout_ms&gt; override the default timeout for the solicited mads.<br>\r
1949 <br>\r
1950 Multiple CA/Multiple Port Support<br>\r
1951 <br>\r
1952 When no IB device or port is specified, the port to use is selected by<br>\r
1953 the following criteria:<br>\r
1954 <br>\r
1955 1. the first port that is ACTIVE.<br>\r
1956 <br>\r
1957 2. if not found, the first port that is UP (physical link up).<br>\r
1958 <br>\r
1959 If a port and/or CA name is specified, the user request is attempted to<br>\r
1960 be fulfilled, and will fail if it is not possible.<br>\r
1961 <br>\r
1962 <br>\r
1963 EXAMPLES<br>\r
1964 Direct Routed Examples<br>\r
1965 <br>\r
1966 smpdump -D 0,1,2,3,5 16 # NODE DESC<br>\r
1967 <br>\r
1968 smpdump -D 0,1,2 0x15 2 # PORT INFO, port 2<br>\r
1969 <br>\r
1970 LID Routed Examples<br>\r
1971 <br>\r
1972 smpdump 3 0x15 2 # PORT INFO, lid 3 port 2<br>\r
1973 <br>\r
1974 smpdump 0xa0 0x11 # NODE INFO, lid 0xa0<br>\r
1975 <br>\r
1976 <br>\r
1977 SEE ALSO<br>\r
1978 smpquery(8)<br>\r
1979 <br>\r
1980 <br>\r
1981 AUTHOR<br>\r
1982 Hal Rosenstock&nbsp;&nbsp;&nbsp; &lt;halr@voltaire.com&gt;<br>\r
1983 <br>\r
1984 <br>\r
1985 OFED July 25, 2006 SMPDUMP(8)</p>\r
1986 <p align="left"><br>\r
1987 <a href="#TOP"><font color="#000000">&lt;return-to-top&gt;</font></a></p>\r
1988 <h3 align="left">&nbsp;</h3>\r
1989 <h3 align="left"><a name="SMPQUERY">SMPQUERY</a>(8) OFED Diagnostics</h3>\r
1990 <p align="left"><br>\r
1991 NAME<br>\r
1992 smpquery - query InfiniBand subnet management attributes<br>\r
1993 <br>\r
1994 <br>\r
1995 SYNOPSIS<br>\r
1996 smpquery [-d(ebug)] [-e(rr_show)] [-v(erbose)] [-D(irect)] [-G(uid)]<br>\r
1997 [-C ca_name] [-P ca_port] [-t(imeout) timeout_ms] [--node-name-map<br>\r
1998 node-name-map] [-V(ersion)] [-h(elp)] &lt;op&gt; &lt;dest dr_path|lid|guid&gt; [op<br>\r
1999 params]<br>\r
2000 <br>\r
2001 <br>\r
2002 DESCRIPTION<br>\r
2003 smpquery allows a basic subset of standard SMP queries including the<br>\r
2004 following: node info, node description, switch info, port info. Fields<br>\r
2005 are displayed in human readable format.<br>\r
2006 <br>\r
2007 <br>\r
2008 OPTIONS<br>\r
2009 Current supported operations and their parameters:<br>\r
2010 nodeinfo &lt;addr&gt;<br>\r
2011 nodedesc &lt;addr&gt;<br>\r
2012 portinfo &lt;addr&gt; [&lt;portnum&gt;] # default port is zero<br>\r
2013 switchinfo &lt;addr&gt;<br>\r
2014 pkeys &lt;addr&gt; [&lt;portnum&gt;]<br>\r
2015 sl2vl &lt;addr&gt; [&lt;portnum&gt;]<br>\r
2016 vlarb &lt;addr&gt; [&lt;portnum&gt;]<br>\r
2017 guids &lt;addr&gt;<br>\r
2018 <br>\r
2019 <br>\r
2020 --node-name-map &lt;node-name-map&gt;<br>\r
2021 Specify a node name map. The node name map file maps GUIDs to<br>\r
2022 more user friendly names. See ibnetdiscover(8) for node name<br>\r
2023 map file format.<br>\r
2024 <br>\r
2025 <br>\r
2026 COMMON OPTIONS<br>\r
2027 Most OFED diagnostics take the following common flags. The exact list<br>\r
2028 of supported flags per utility can be found in the usage message and<br>\r
2029 can be shown using the util_name -h syntax.<br>\r
2030 <br>\r
2031 # Debugging flags<br>\r
2032 <br>\r
2033 -d raise the IB debugging level.<br>\r
2034 May be used several times (-ddd or -d -d -d).<br>\r
2035 <br>\r
2036 -e show send and receive errors (timeouts and others)<br>\r
2037 <br>\r
2038 -h show the usage message<br>\r
2039 <br>\r
2040 -v increase the application verbosity level.<br>\r
2041 May be used several times (-vv or -v -v -v)<br>\r
2042 <br>\r
2043 -V show the version info.<br>\r
2044 <br>\r
2045 # Addressing flags<br>\r
2046 <br>\r
2047 -D use directed path address arguments. The path<br>\r
2048 is a comma separated list of out ports.<br>\r
2049 Examples:<br>\r
2050 &quot;0&quot; # self port<br>\r
2051 &quot;0,1,2,1,4&quot; # out via port 1, then 2, ...<br>\r
2052 <br>\r
2053 -c use combined route address arguments. The<br>\r
2054 address is a combination of a LID and a direct route path.<br>\r
2055 The LID specified is the DLID and the local LID is used<br>\r
2056 as the DrSLID.<br>\r
2057 <br>\r
2058 -G use GUID address argument. In most cases, it is the Port GUID.<br>\r
2059 Example:<br>\r
2060 &quot;0x08f1040023&quot;<br>\r
2061 <br>\r
2062 -s &lt;smlid&gt; use \92smlid\92 as the target lid for SM/SA queries.<br>\r
2063 <br>\r
2064 # Other common flags:<br>\r
2065 <br>\r
2066 -C &lt;ca_name&gt; use the specified ca_name.<br>\r
2067 <br>\r
2068 -P &lt;ca_port&gt; use the specified ca_port.<br>\r
2069 <br>\r
2070 -t &lt;timeout_ms&gt; override the default timeout for the solicited mads.<br>\r
2071 <br>\r
2072 Multiple CA/Multiple Port Support<br>\r
2073 <br>\r
2074 When no IB device or port is specified, the port to use is selected by<br>\r
2075 the following criteria:<br>\r
2076 <br>\r
2077 1. the first port that is ACTIVE.<br>\r
2078 <br>\r
2079 2. if not found, the first port that is UP (physical link up).<br>\r
2080 <br>\r
2081 If a port and/or CA name is specified, the user request is attempted to<br>\r
2082 be fulfilled, and will fail if it is not possible.<br>\r
2083 <br>\r
2084 <br>\r
2085 EXAMPLES<br>\r
2086 smpquery portinfo 3 1 # portinfo by lid, with port modifier<br>\r
2087 <br>\r
2088 smpquery -G switchinfo 0x2C9000100D051 1 # switchinfo by guid<br>\r
2089 <br>\r
2090 smpquery -D nodeinfo 0 # nodeinfo by direct route<br>\r
2091 <br>\r
2092 smpquery -c nodeinfo 6 0,12 # nodeinfo by combined route<br>\r
2093 <br>\r
2094 <br>\r
2095 SEE ALSO<br>\r
2096 smpdump(8)<br>\r
2097 <br>\r
2098 <br>\r
2099 AUTHOR<br>\r
2100 Hal Rosenstock &lt;halr@voltaire.com&gt;<br>\r
2101 <br>\r
2102 <br>\r
2103 OFED March 14, 2007 SMPQUERY(8)</p>\r
2104 <p align="left"><a href="#TOP"><font color="#000000">&lt;<b><font size="4">return-to-top</font></b>&gt;</font></a></p>\r
2105 <h3 align="left">&nbsp;</h3>\r
2106 <h3 align="left"><a name="VENDSTAT">VENDSTAT</a>(8) OFED Diagnostics</h3>\r
2107 <p align="left">NAME<br>\r
2108 vendstat - query InfiniBand vendor specific functions<br>\r
2109 <br>\r
2110 <br>\r
2111 SYNOPSIS<br>\r
2112 vendstat [-d(ebug)] [-G(uid)] [-N] [-w] [-i] [-c &lt;num,num&gt;] [-C ca_name] [-P \r
2113 ca_port] [-t(imeout) timeout_ms] [-V(ersion)] [-h(elp)] &lt;lid|guid&gt;<br>\r
2114 <br>\r
2115 <br>\r
2116 DESCRIPTION<br>\r
2117 vendstat uses vendor specific MADs to access beyond the IB spec vendor<br>\r
2118 specific functionality. Currently, there is support for Mellanox InfiniSwitch-III \r
2119 (IS3) and InfiniSwitch-IV (IS4).<br>\r
2120 <br>\r
2121 <br>\r
2122 OPTIONS<br>\r
2123 -N show IS3 general information.<br>\r
2124 <br>\r
2125 -w show IS3 port xmit wait counters.<br>\r
2126 <br>\r
2127 -i show IS4 counter group info.<br>\r
2128 <br>\r
2129 -c &lt;num,num&gt;<br>\r
2130 configure IS4 counter groups.<br>\r
2131 <br>\r
2132 Configure IS4 counter groups 0 and 1. Such configuration is not<br>\r
2133 persistent across IS4 reboot. First number is for counter group<br>\r
2134 0 and second is for counter group 1.<br>\r
2135 <br>\r
2136 Group 0 counter config values:<br>\r
2137 0 - PortXmitDataSL0-7<br>\r
2138 1 - PortXmitDataSL8-15<br>\r
2139 2 - PortRcvDataSL0-7<br>\r
2140 <br>\r
2141 Group 1 counter config values:<br>\r
2142 1 - PortXmitDataSL8-15<br>\r
2143 2 - PortRcvDataSL0-7<br>\r
2144 8 - PortRcvDataSL8-15<br>\r
2145 <br>\r
2146 <br>\r
2147 COMMON OPTIONS<br>\r
2148 Most OFED diagnostics take the following common flags. The exact list<br>\r
2149 of supported flags per utility can be found in the usage message and<br>\r
2150 can be shown using the util_name -h syntax.<br>\r
2151 <br>\r
2152 # Debugging flags<br>\r
2153 <br>\r
2154 -d raise the IB debugging level.<br>\r
2155 May be used several times (-ddd or -d -d -d).<br>\r
2156 <br>\r
2157 -e show send and receive errors (timeouts and others)<br>\r
2158 <br>\r
2159 -h show the usage message<br>\r
2160 <br>\r
2161 -v increase the application verbosity level.<br>\r
2162 May be used several times (-vv or -v -v -v)<br>\r
2163 <br>\r
2164 -V show the version info.<br>\r
2165 <br>\r
2166 # Addressing flags<br>\r
2167 <br>\r
2168 -G use GUID address argument. In most cases, it is the Port GUID.<br>\r
2169 Example:<br>\r
2170 &quot;0x08f1040023&quot;<br>\r
2171 <br>\r
2172 -s &lt;smlid&gt; use \92smlid\92 as the target lid for SM/SA queries.<br>\r
2173 <br>\r
2174 # Other common flags:<br>\r
2175 <br>\r
2176 -C &lt;ca_name&gt; use the specified ca_name.<br>\r
2177 <br>\r
2178 -P &lt;ca_port&gt; use the specified ca_port.<br>\r
2179 <br>\r
2180 -t &lt;timeout_ms&gt; override the default timeout for the solicited mads.<br>\r
2181 <br>\r
2182 Multiple CA/Multiple Port Support<br>\r
2183 <br>\r
2184 When no IB device or port is specified, the port to use is selected by<br>\r
2185 the following criteria:<br>\r
2186 <br>\r
2187 1. the first port that is ACTIVE.<br>\r
2188 <br>\r
2189 2. if not found, the first port that is UP (physical link up).<br>\r
2190 <br>\r
2191 If a port and/or CA name is specified, the user request is attempted to<br>\r
2192 be fulfilled, and will fail if it is not possible.<br>\r
2193 <br>\r
2194 <br>\r
2195 EXAMPLES<br>\r
2196 vendstat -N 6 # read IS3 general information<br>\r
2197 <br>\r
2198 vendstat -w 6 # read IS3 port xmit wait counters<br>\r
2199 <br>\r
2200 vendstat -i 6 12 # read IS4 port 12 counter group info<br>\r
2201 <br>\r
2202 vendstat -c 0,1 6 12 # configure IS4 port 12 counter groups for PortXmitDataSL<br>\r
2203 <br>\r
2204 vendstat -c 2,8 6 12 # configure IS4 port 12 counter groups for PortRcvDataSL<br>\r
2205 <br>\r
2206 <br>\r
2207 AUTHOR<br>\r
2208 Hal Rosenstock&nbsp;&nbsp;&nbsp; &lt;halr@voltaire.com&gt;<br>\r
2209 <br>\r
2210 <br>\r
2211 OFED April 16, 2009 VENDSTAT(8)</p>\r
2212 <p align="left"><a href="#TOP"><font color="#000000">&lt;return-to-top&gt;</font></a><br>\r
2213 &nbsp;</p>\r
2214 <h3 align="left"><a name="iblimits"></a><br>\r
2215 ib_limits - Infiniband verbs tests</h3>\r
2216 <p align="left">Usage: ib_limits [options]</p>\r
2217 <blockquote>\r
2218         <p align="left">Options:<br>-m or --memory<br>&nbsp;&nbsp;&nbsp; Direct ib_limits to test memory registration<br>-c or --cq<br>&nbsp;&nbsp;&nbsp; Direct ib_limits to test CQ creation<br>-r or --resize_cq<br>&nbsp;&nbsp;&nbsp; direct ib_limits to test CQ resize<br>-q or --qp<br>&nbsp;&nbsp;&nbsp; Directs ib_limits to test QP creation<br>-v or --verbose<br>&nbsp;&nbsp;&nbsp; Enable verbosity level to debug console.<br>-h or --help<br>&nbsp;&nbsp;&nbsp; Display this usage info then exit.</p>\r
2219 </blockquote>\r
2220 <h4 align="left"><a href="#TOP"><font color="#000000">&lt;return-to-top&gt;</font></a></h4>\r
2221 <p align="left">&nbsp;</p>\r
2222 <h3 align="left"><a name="cmtest"></a><br>\r
2223 cmtest - Connection Manager Tests</h3>\r
2224 <p>Usage: cmtest [options]</p>\r
2225 <p>&nbsp;&nbsp;&nbsp; Options:</p>\r
2226 <blockquote>\r
2227         <p>&nbsp;-s --server This option directs cmtest to act as a Server<br>\r
2228 &nbsp;-l\r
2229         <lid>--local\r
2230         <lid>This option specifies the local endpoint.<br>\r
2231 &nbsp;-r\r
2232         <lid>--remote\r
2233         <lid>This option specifies the remote endpoint LID as a hex integer 0x; see \r
2234         vstat command for active port LID hex integer.<br>\r
2235 &nbsp;-c\r
2236         <number>--connect\r
2237         <number>This option specifies the number of connections to open. Default of \r
2238         1.<br>\r
2239 &nbsp;-m\r
2240         <bytes>--msize\r
2241         <bytes>This option specifies the byte size of each message. Default is 100 \r
2242         bytes.<br>\r
2243 &nbsp;-n\r
2244         <number>--nmsgs\r
2245         <number>This option specifies the number of messages to send at a time.<br>\r
2246 &nbsp;-p --permsg This option indicates if a separate buffer should be used per \r
2247         message. Default is one buffer for all messages.<br>\r
2248 &nbsp;-i\r
2249         <number>--iterate\r
2250         <number>This option specifies the number of times to loop through 'nmsgs'. \r
2251         Default of 1.<br>\r
2252 &nbsp;-v --verbose This option enables verbosity level to debug console.<br>\r
2253 &nbsp;-h --help Display this usage info then exit.</p>\r
2254 </blockquote>\r
2255 <h4 align="left"><a href="#TOP"><font color="#000000">&lt;return-to-top&gt;</font></a></h4>\r
2256 <p align="left">&nbsp;</p>\r
2257 <BLOCKQUOTE></BLOCKQUOTE>\r
2258 <h3 align="left"><a name="InfiniBand_Partition_Management">InfiniBand Partition \r
2259 Management</a></h3>\r
2260 <p align="left"><font face="Times New Roman">The part</font><font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">_man.exe \r
2261 application allows creating, deleting and viewing existing </span><span style="FONT-SIZE: 12pt">\r
2262 host partitions</span><span style="FONT-SIZE: 12pt">.</span></font></p>\r
2263 <p align="left">Usage : part_man.exe &lt;show|add|rem&gt; &lt;port_guid&gt; &lt;pkey1 pkey2 \r
2264 ...&gt;</p>\r
2265         <b><font face="Times New Roman" size="4">\r
2266         <span style="font-weight: bold">show - </span></font></b>\r
2267 <font face="Times New Roman" size="3">\r
2268         <span style="FONT-SIZE: 12pt">\96 shows existing partitions</span></font><p style="MARGIN-LEFT: 0.5in"><font face="Times New Roman" size="3">\r
2269         <span style="FONT-SIZE: 12pt">Expected results after execution <b>\r
2270         <span style="FONT-WEIGHT: bold">part_man.exe show</span></b></span></font></p>\r
2271         <p style="MARGIN-LEFT: 0.75in; TEXT-INDENT: -0.25in">\r
2272         <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">1.</span></font><font size="1"><span style="FONT-SIZE: 7pt">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\r
2273         </span></font>Output has a format<font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">&nbsp;</span></font></p>\r
2274         <p style="MARGIN-LEFT: 0.5in"><b><font face="Times New Roman" size="3">\r
2275         <span style="FONT-WEIGHT: bold; FONT-SIZE: 12pt">port_guid1&nbsp;&nbsp; pkey1&nbsp; pkey2&nbsp; \r
2276         pkey3&nbsp; pkey4&nbsp; pkey5&nbsp; pkey6&nbsp; pkey7&nbsp; pkey8</span></font></b></p>\r
2277         <p style="MARGIN-LEFT: 0.5in"><b><font face="Times New Roman" size="3">\r
2278         <span style="FONT-WEIGHT: bold; FONT-SIZE: 12pt">port_guid2&nbsp;&nbsp; \r
2279         pkey1&nbsp;&nbsp;pkey2&nbsp; pkey3&nbsp; pkey4&nbsp; pkey5&nbsp; pkey6&nbsp; pkey7&nbsp; pkey8</span></font></b></p>\r
2280         <p class="MsoNormal" style="MARGIN-LEFT: 0.5in">\r
2281         <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">where <b>\r
2282         <span style="FONT-WEIGHT: bold">port_guid</span></b> is a port guid in \r
2283         hexadecimal format, <b><span style="FONT-WEIGHT: bold">pkey</span></b> \96 \r
2284         values of partition key (in hex format) for this port.</span></font></p>\r
2285         <p class="MsoNormal" style="MARGIN-LEFT: 0.5in">\r
2286         <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">Default \r
2287         partition key (0xFFFF) is not shown and can not be created by the \r
2288         part_man.exe.</span></font></p>\r
2289 <p class="MsoNormal" style="MARGIN-LEFT: 0.5in">\r
2290         &nbsp;</p>\r
2291         <p class="MsoNormal" style="MARGIN-LEFT: 0.0in"><b>\r
2292         <font face="Times New Roman" size="4">\r
2293         <span style="FONT-WEIGHT: bold; ">add - </span></font></b>create new partition(s) \r
2294         on specified port </p>\r
2295         <p class="MsoNormal" style="MARGIN-LEFT: 0.5in"><b>\r
2296         <font face="Times New Roman" size="3">\r
2297         <span style="FONT-WEIGHT: bold; FONT-SIZE: 12pt">port_guid</span></font></b>&nbsp;\r
2298         <b><span style="FONT-WEIGHT: bold">add</span></b>&nbsp;&nbsp; &lt;<b><span style="FONT-WEIGHT: bold">port_guid</span></b>&gt; \r
2299         &nbsp;&lt;<b><span style="FONT-WEIGHT: bold">pkey1</span></b>&gt; &nbsp;&nbsp;&lt;<b><span style="FONT-WEIGHT: bold">pkey2</span></b>&gt; \r
2300         </p>\r
2301 <p class="MsoNormal" style="MARGIN-LEFT: 0.5in">creates new partition(s) on port specified by port_guid parameter (in \r
2302         hexadecimal format) and pkey \96 new partition key value in hexadecimal \r
2303         format (e.g. 0xABCD or ABCD).</p>\r
2304         <p class="MsoNormal" style="MARGIN-LEFT: 0.5in">\r
2305         <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">Port \r
2306         guid is taken form vstat output and has a following format:</span></font></p>\r
2307         <p class="MsoNormal" style="MARGIN-LEFT: 0.5in"><b>\r
2308         <font face="Times New Roman" size="3">\r
2309         <span style="FONT-WEIGHT: bold; FONT-SIZE: 12pt">XXXX:XXXX:XXXX:XXXX.</span></font></b></p>\r
2310         <p class="MsoNormal" style="MARGIN-LEFT: 0.5in">\r
2311         <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">Vstat \r
2312         prints node guid, so user has to add 1 to node guid value to obtain port \r
2313         guid. For example, if node guid is <b><span style="FONT-WEIGHT: bold">\r
2314         0008:f104:0397:7ccc</span></b>, port guid will be</span></font></p>\r
2315         <p class="MsoNormal" style="MARGIN-LEFT: 0.5in"><b>\r
2316         <font face="Times New Roman" size="3">\r
2317         <span style="FONT-WEIGHT: bold; FONT-SIZE: 12pt">0008:f104:0397:7ccd</span></font></b> \r
2318         \96 for the first port,</p>\r
2319         <p class="MsoNormal" style="MARGIN-LEFT: 0.5in"><b>\r
2320         <font face="Times New Roman" size="3">\r
2321         <span style="FONT-WEIGHT: bold; FONT-SIZE: 12pt">0008:f104:0397:7cce</span></font></b> \r
2322         \96 for the second port.</p>\r
2323         <p class="MsoNormal" style="MARGIN-LEFT: 0.5in">\r
2324         <font face="Courier New" color="green" size="2">\r
2325         <span style="FONT-SIZE: 10pt; COLOR: green; FONT-FAMILY: 'Courier New'">&nbsp;</span></font></p>\r
2326         <p class="MsoNormal" style="MARGIN-LEFT: 0.5in">\r
2327         <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">Expected \r
2328         results of execution <b><span style="FONT-WEIGHT: bold">part_man.exe add \r
2329         0x0D99:9703:04f1:0800 0xABCD</span></b></span></font></p>\r
2330         <p class="MsoNormal" style="MARGIN-LEFT: 0.75in; TEXT-INDENT: -0.25in">\r
2331         <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">1.</span></font><font size="1"><span style="FONT-SIZE: 7pt">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\r
2332         </span></font>part_man.exe output ends up with <b>\r
2333         <span style="FONT-WEIGHT: bold">\85Done </span></b>message.</p>\r
2334         <p class="MsoNormal" style="MARGIN-LEFT: 0.75in; TEXT-INDENT: -0.25in">\r
2335         <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">2.</span></font><font size="1"><span style="FONT-SIZE: 7pt">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\r
2336         </span></font>A new instance of a Network Adapter named \93OpenFabrics IPoIB \r
2337         Adapter Partition\94 will appear in Device manager \r
2338         window.&nbsp; <br>\r
2339         If the new adapter appears with yellow label, manual device driver installation is \r
2340         required.</p>\r
2341 <ul>\r
2342         <li>\r
2343         <p class="MsoNormal" style="MARGIN-LEFT: 0.75in; TEXT-INDENT: -0.25in">In \r
2344         the device manager view, right click \93OpenFabrics IPoIB Adapter Partition\94</p>\r
2345         </li>\r
2346         <li>\r
2347         <p class="MsoNormal" style="MARGIN-LEFT: 0.75in; TEXT-INDENT: -0.25in">\r
2348         select 'update driver' and follow the instructions.</p></li>\r
2349         <li>\r
2350         <p class="MsoNormal" style="MARGIN-LEFT: 0.75in; TEXT-INDENT: -0.25in">don't \r
2351         allow Windows Update to search the Internet</p></li>\r
2352         <li>\r
2353         <p class="MsoNormal" style="MARGIN-LEFT: 0.75in; TEXT-INDENT: -0.25in">\r
2354         select install software automatically.</p></li>\r
2355 </ul>\r
2356         <p class="MsoNormal" style="MARGIN-LEFT: 0.75in; TEXT-INDENT: -0.25in">\r
2357         <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">3.</span></font><font size="1"><span style="FONT-SIZE: 7pt">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\r
2358         </span></font>New adapter name ends with \93Partition\94, e.g. \93OpenFabrics IPoIB \r
2359         Adapter Partition\94.</p>\r
2360         <p class="MsoNormal" style="MARGIN-LEFT: 0.5in">\r
2361         <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">&nbsp;</span></font></p>\r
2362         <b>\r
2363         <font face="Times New Roman" size="4">\r
2364         <span style="FONT-WEIGHT: bold; ">rem </span></font></b>\r
2365         <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">\96 \r
2366         removes partition key on specified \r
2367         port.</span></font></p>\r
2368         <p class="MsoNormal" style="MARGIN-LEFT: 0.5in"><b>\r
2369         <font face="Times New Roman" size="3">\r
2370         <span style="FONT-WEIGHT: bold; FONT-SIZE: 12pt">part_man.exe rem &lt;port_guid&gt; \r
2371         &lt;pkey1&gt;&nbsp; &lt;pkey2&gt;</span></font></b></p>\r
2372         <p class="MsoNormal" style="MARGIN-LEFT: 0.5in">\r
2373         <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">\r
2374         Port_guid \96 in hexadecimal format (same as for <b>\r
2375         <span style="FONT-WEIGHT: bold">add</span></b> command), identifies port for \r
2376         operation. </span></font></p>\r
2377         <p class="MsoNormal" style="MARGIN-LEFT: 0.5in">\r
2378         <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">Expected \r
2379         results after execution <b><span style="FONT-WEIGHT: bold">part_man rem &lt;port_guid&gt; \r
2380         &nbsp;&lt;pkey&gt;</span></b></span></font></p>\r
2381         <p class="MsoNormal" style="MARGIN-LEFT: 0.75in; TEXT-INDENT: -0.25in">\r
2382         <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">1.</span></font><font size="1"><span style="FONT-SIZE: 7pt">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\r
2383         </span></font>Application prints <b><span style="FONT-WEIGHT: bold">\85Done\r
2384         </span></b>message.</p>\r
2385         <p class="MsoNormal" style="MARGIN-LEFT: 0.75in; TEXT-INDENT: -0.25in">\r
2386         <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">2.</span></font><font size="1"><span style="FONT-SIZE: 7pt">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\r
2387         </span></font>In device manager window IPoIB network adapter will disappear.</p>\r
2388         <p class="MsoNormal" style="MARGIN-LEFT: 0.75in; TEXT-INDENT: -0.25in">\r
2389         <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">3.</span></font><font size="1"><span style="FONT-SIZE: 7pt">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\r
2390         </span></font>Execution of&nbsp; <b><span style="FONT-WEIGHT: bold">part_man.exe \r
2391         show </span></b>will not show removed adapter.</p>\r
2392         <p class="MsoNormal" style="MARGIN-LEFT: 0.75in; TEXT-INDENT: -0.25in">&nbsp;</div>\r
2393         \r
2394 <p align="left"><b><a href="#TOP"><font color="#000000">&lt;return-to-top&gt;</font></a></b></p>\r
2395 <p align="left">&nbsp;</p>\r
2396 <h3 align="left"><a name="printip"></a><br>\r
2397 PrintIP - print ip adapters and their addresses</h3>\r
2398 <blockquote>\r
2399         <p align="left">PrintIP is used to print IP adapters and their addresses, or \r
2400         ARP (Address Resolution Protocol) and IP address.<br>\r
2401         <br>\r
2402         Usage:<br>\r
2403 &nbsp;&nbsp;&nbsp; printip &lt;print_ips&gt;<br>\r
2404 &nbsp;&nbsp;&nbsp; printip &lt;remoteip&gt; &lt;ip&gt;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
2405         (example printip remoteip 10.10.2.20)</p>\r
2406 </blockquote>\r
2407 <h3 align="left"><a href="#TOP"><font color="#000000">&lt;return-to-top&gt;</font></a></h3>\r
2408 <p align="left">&nbsp;</p>\r
2409 <h3 align="left">\r
2410 <br>\r
2411 <a name="vstat"></a><br>\r
2412 vstat - HCA Stats and Counters</h3>\r
2413 <blockquote>\r
2414         <p align="left">Display HCA (Host channel Adapter) attributes.</p>\r
2415         <p align="left">Usage: vstat [-v] [-c]<br>\r
2416 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; -v - verbose mode<br>\r
2417 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; -c - HCA error/statistic \r
2418         counters<br>\r
2419         <br>\r
2420         Includes Node GUID, Subnet Manager and port LIDs.</p>\r
2421 </blockquote>\r
2422 <h4 align="left"><a href="#TOP"><font color="#000000">&lt;return-to-top&gt;</font></a></h4>\r
2423 <p align="left">&nbsp;</p>\r
2424 <BLOCKQUOTE></BLOCKQUOTE>\r
2425 <h2 align="left"><a name="opensm"></a>Subnet Management with OpenSM version 3.3.3</h2>\r
2426 <hr>\r
2427 <p align="left">A single running process (opensm.exe) is required to configure \r
2428 and thus make an Infiniband subnet useable.&nbsp; For most cases, InfiniBand \r
2429 Subnet Management as a Windows service is sufficient to correctly configure most \r
2430 InfiniBand fabrics.</p>\r
2431 <p align="left">The Infiniband subnet management process (opensm) may exist on a \r
2432 Windows (WinOF) node or a Linux (OFED) node.<br>\r
2433 <br>\r
2434 Limit the number of OpenSM processes per IB fabric; one SM is sufficient \r
2435 although redundant SMs are supported. You do not need a Subnet Manager per \r
2436 node/system.</p>\r
2437 <h3>OpenIB Subnet Management as a Windows Service</h3>\r
2438 <p>InfiniBand subnet management (OpenSM), as a Windows service, is installed by default, although it is NOT \r
2439 started by default. There are two ways to enable the InfiniBand Subnet \r
2440 Management service.</p>\r
2441 <ol style="margin-bottom: 0in">\r
2442         <li>Reset the installed OpenSM service &quot;InfiniBand Subnet Management&quot; \r
2443         to start automatically; From a command window type 'services.msc'.<br>\r
2444         Locate the InfiniBand Subnet Management view and select the start option; \r
2445         additionally select the startup option 'Automatic' to start the OpenSM \r
2446         service on system startup.<br>&nbsp;</li>\r
2447         <li>Install OpenSM as a 'running' Windows service:<br>\r
2448         Select the OpenSM_service_Started install feature. \r
2449         Once the installation has completed, check the running InfiniBand Subnet \r
2450         Management service status via the Windows service manager (see #1).<br>\r
2451 &nbsp;</li>\r
2452         <li>Consult the OpenSM log file @ %windir%\temp\osm.log to see what \r
2453         OpenSM thinks is happening.<br>\r
2454 &nbsp;</li>\r
2455 </ol>\r
2456 <h3 align="left">InfiniBand Subnet Management from a command window</h3>
2457 <h3>SYNOPSIS</h3>
2458
2459 <B>opensm</B>
2460
2461 [--version]]
2462 [-F | --config &lt;file_name&gt;]
2463 [-c(reate-config) &lt;file_name&gt;]
2464 [-g(uid) &lt;GUID in hex&gt;]
2465 [-l(mc) &lt;LMC&gt;]
2466 [-p(riority) &lt;PRIORITY&gt;]
2467 [-smkey &lt;SM_Key&gt;]
2468 [--sm_sl &lt;SL number&gt;]
2469 [-r(eassign_lids)]
2470 [-R &lt;engine name(s)&gt; | --routing_engine &lt;engine name(s)&gt;]
2471 [--do_mesh_analysis]
2472 [--lash_start_vl &lt;vl number&gt;]
2473 [-A | --ucast_cache]
2474 [-z | --connect_roots]
2475 [-M &lt;file name&gt; | --lid_matrix_file &lt;file name&gt;]
2476 [-U &lt;file name&gt; | --lfts_file &lt;file name&gt;]
2477 [-S | --sadb_file &lt;file name&gt;]
2478 [-a | --root_guid_file &lt;path to file&gt;]
2479 [-u | --cn_guid_file &lt;path to file&gt;]
2480 [-G | --io_guid_file &lt;path to file&gt;]
2481 [-H | --max_reverse_hops &lt;max reverse hops allowed&gt;]
2482 [-X | --guid_routing_order_file &lt;path to file&gt;]
2483 [-m | --ids_guid_file &lt;path to file&gt;]
2484 [-o(nce)]
2485 [-s(weep) &lt;interval&gt;]
2486 [-t(imeout) &lt;milliseconds&gt;]
2487 [--retries &lt;number&gt;]
2488 [-maxsmps &lt;number&gt;]
2489 [-console [off | local | socket | loopback]]
2490 [-console-port &lt;port&gt;]
2491 [-i(gnore-guids) &lt;equalize-ignore-guids-file&gt;]
2492 [-w | --hop_weights_file &lt;path to file&gt;]
2493 [-f &lt;log file path&gt; | --log_file &lt;log file path&gt; ]
2494 [-L | --log_limit &lt;size in MB&gt;] [-e(rase_log_file)]
2495 [-P(config) &lt;partition config file&gt; ]
2496 [-N | --no_part_enforce]
2497 [-Q | --qos [-Y | --qos_policy_file &lt;file name&gt;]]
2498 [-y | --stay_on_fatal]
2499 [-B | --service --daemon]
2500 [-I | --inactive]
2501 [--perfmgr]
2502 [--perfmgr_sweep_time_s &lt;seconds&gt;]
2503 [--prefix_routes_file &lt;path&gt;]
2504 [--consolidate_ipv6_snm_req]
2505 [-v(erbose)] [-V] [-D &lt;flags&gt;] [-d(ebug) &lt;number&gt;]
2506 [-h(elp)] [-?]
2507 <h3>DESCRIPTION</h3>
2508
2509 <P>
2510
2511 opensm is an InfiniBand compliant Subnet Manager and Administration,
2512 and runs on top of WinOF.
2513
2514 opensm provides an implementation of an InfiniBand Subnet Manager and
2515 Administration. Such a software entity is required to run for in order
2516 to initialize the InfiniBand hardware (at least one per each
2517 InfiniBand subnet).
2518
2519 opensm also now contains an experimental version of a performance
2520 manager as well.
2521
2522 opensm defaults were designed to meet the common case usage on clusters with up to a few hundred nodes. Thus, in this default mode, opensm will scan the IB
2523 fabric, initialize it, and sweep occasionally for changes.
2524
2525 opensm attaches to a specific IB port on the local machine and configures only
2526 the fabric connected to it. (If the local machine has other IB ports,
2527 opensm will ignore the fabrics connected to those other ports). If no port is
2528 specified, it will select the first &quot;best&quot; available port.
2529
2530 opensm can present the available ports and prompt for a port number to attach \r
2531 to. By default, the run is logged to two files:%windir%\temp\osm.syslog and \r
2532 %windir%\temp\osm.log.
2533 The first file will register only general major events, whereas the second
2534 will include details of reported errors. All errors reported in this second
2535 file should be treated as indicators of IB fabric health issues.
2536 (Note that when a fatal and non-recoverable error occurs, opensm will exit.)
2537 Both log files should include the message &quot;SUBNET UP&quot; if opensm was able to
2538 setup the subnet correctly.<h3>OPTIONS</h3>
2539
2540
2541 <P>
2542
2543 <DL COMPACT>
2544 <DT><B>--version</B><DD>
2545 Prints OpenSM version and exits.
2546 <DT><B>-F</B>, <B>--config</B> &lt;config file&gt;<DD>
2547 The name of the OpenSM config file. When not specified
2548 <b>%ProgramFiles%\WinOF\OpenSM\opensm.conf</b> will be used (if exists).
2549 <DT><B>-c</B>, <B>--create-config</B> &lt;file name&gt;<DD>
2550 OpenSM will dump its configuration to the specified file and exit.
2551 This is a way to generate OpenSM configuration file template.
2552 <DT><B>-g</B>, <B>--guid</B> &lt;GUID in hex&gt;<DD>
2553 This option specifies the local port GUID value
2554 with which OpenSM should bind.  OpenSM may be
2555 bound to 1 port at a time.
2556 If GUID given is 0, OpenSM displays a list
2557 of possible port GUIDs and waits for user input.
2558 Without -g, OpenSM tries to use the default port.
2559 <DT><B>-l</B>, <B>--lmc</B> &lt;LMC value&gt;<DD>
2560 This option specifies the subnet's LMC value.
2561 The number of LIDs assigned to each port is 2^LMC.
2562 The LMC value must be in the range 0-7.
2563 LMC values &gt; 0 allow multiple paths between ports.
2564 LMC values &gt; 0 should only be used if the subnet
2565 topology actually provides multiple paths between
2566 ports, i.e. multiple interconnects between switches.
2567 Without -l, OpenSM defaults to LMC = 0, which allows
2568 one path between any two ports.
2569 <DT><B>-p</B>, <B>--priority</B> &lt;Priority value&gt;<DD>
2570 This option specifies the SM's PRIORITY.
2571 This will effect the handover cases, where master
2572 is chosen by priority and GUID.  Range goes from 0
2573 (default and lowest priority) to 15 (highest).
2574 <DT><B>-smkey</B> &lt;SM_Key value&gt;<DD>
2575 This option specifies the SM's SM_Key (64 bits).
2576 This will effect SM authentication.
2577 Note that OpenSM version 3.2.1 and below used the default value '1'
2578 in a host byte order, it is fixed now but you may need this option to
2579 interoperate with old OpenSM running on a little endian machine.
2580 <DT><B>--sm_sl</B> &lt;SL number&gt;<DD>
2581 This option sets the SL to use for communication with the SM/SA.
2582 Defaults to 0.
2583 <DT><B>-r</B>, <B>--reassign_lids</B><DD>
2584 This option causes OpenSM to reassign LIDs to all
2585 end nodes. Specifying -r on a running subnet
2586 may disrupt subnet traffic.
2587 Without -r, OpenSM attempts to preserve existing
2588 LID assignments resolving multiple use of same LID.
2589 <DT><B>-R</B>, <B>--routing_engine</B> &lt;Routing engine names&gt;<DD>
2590 This option chooses routing engine(s) to use instead of Min Hop
2591 algorithm (default).  Multiple routing engines can be specified
2592 separated by commas so that specific ordering of routing algorithms
2593 will be tried if earlier routing engines fail.
2594 Supported engines: minhop, updn, file, ftree, lash, dor
2595 <DT><B>--do_mesh_analysis</B><DD>
2596 This option enables additional analysis for the lash routing engine to
2597 precondition switch port assignments in regular cartesian meshes which
2598 may reduce the number of SLs required to give a deadlock free routing.
2599 <DT><B>--lash_start_vl</B> &lt;vl number&gt;<DD>
2600 This option sets the starting VL to use for the lash routing algorithm.
2601 Defaults to 0.
2602 <DT><B>-A</B>, <B>--ucast_cache</B><DD>
2603 This option enables unicast routing cache and prevents routing
2604 recalculation (which is a heavy task in a large cluster) when
2605 there was no topology change detected during the heavy sweep, or
2606 when the topology change does not require new routing calculation,
2607 e.g. when one or more CAs/RTRs/leaf switches going down, or one or
2608 more of these nodes coming back after being down.
2609 A very common case that is handled by the unicast routing cache
2610 is host reboot, which otherwise would cause two full routing
2611 recalculations: one when the host goes down, and the other when
2612 the host comes back online.
2613 <DT><B>-z</B>, <B>--connect_roots</B><DD>
2614 This option enforces a routing engine (currently up/down
2615 only) to make connectivity between root switches and in
2616 this way to be fully IBA complaint. In many cases this can
2617 violate &quot;pure&quot; deadlock free algorithm, so use it carefully.
2618 <DT><B>-M</B>, <B>--lid_matrix_file</B> &lt;file name&gt;<DD>
2619 This option specifies the name of the lid matrix dump file
2620 from where switch lid matrices (min hops tables will be
2621 loaded.
2622 <DT><B>-U</B>, <B>--lfts_file</B> &lt;file name&gt;<DD>
2623 This option specifies the name of the LFTs file
2624 from where switch forwarding tables will be loaded.
2625 <DT><B>-S</B>, <B>--sadb_file</B> &lt;file name&gt;<DD>
2626 This option specifies the name of the SA DB dump file
2627 from where SA database will be loaded.
2628 <DT><B>-a</B>, <B>--root_guid_file</B> &lt;file name&gt;<DD>
2629 Set the root nodes for the Up/Down or Fat-Tree routing
2630 algorithm to the guids provided in the given file (one to a line).
2631 <DT><B>-u</B>, <B>--cn_guid_file</B> &lt;file name&gt;<DD>
2632 Set the compute nodes for the Fat-Tree routing algorithm
2633 to the guids provided in the given file (one to a line).
2634 <DT><B>-G</B>, <B>--io_guid_file</B> &lt;file name&gt;<DD>
2635 Set the I/O nodes for the Fat-Tree routing algorithm
2636 to the guids provided in the given file (one to a line).
2637 I/O nodes are non-CN nodes allowed to use up to max_reverse_hops switches
2638 the wrong way around to improve connectivity.
2639 <DT><B>-H</B>, <B>--max_reverse_hops</B> &lt;file name&gt;<DD>
2640 Set the maximum number of reverse hops an I/O node is allowed
2641 to make. A reverse hop is the use of a switch the wrong way around.
2642 <DT><B>-m</B>, <B>--ids_guid_file</B> &lt;file name&gt;<DD>
2643 Name of the map file with set of the IDs which will be used
2644 by Up/Down routing algorithm instead of node GUIDs
2645 (format: &lt;guid&gt; &lt;id&gt; per line).
2646 <DT><B>-X</B>, <B>--guid_routing_order_file</B> &lt;file name&gt;<DD>
2647 Set the order port guids will be routed for the MinHop
2648 and Up/Down routing algorithms to the guids provided in the
2649 given file (one to a line).
2650 <DT><B>-o</B>, <B>--once</B><DD>
2651 This option causes OpenSM to configure the subnet
2652 once, then exit.  Ports remain in the ACTIVE state.
2653 <DT><B>-s</B>, <B>--sweep</B> &lt;interval value&gt;<DD>
2654 This option specifies the number of seconds between
2655 subnet sweeps.  Specifying -s 0 disables sweeping.
2656 Without -s, OpenSM defaults to a sweep interval of
2657 10 seconds.
2658 <DT><B>-t</B>, <B>--timeout</B> &lt;value&gt;<DD>
2659 This option specifies the time in milliseconds
2660 used for transaction timeouts.
2661 Specifying -t 0 disables timeouts.
2662 Without -t, OpenSM defaults to a timeout value of
2663 200 milliseconds.
2664 <DT><B>--retries</B> &lt;number&gt;<DD>
2665 This option specifies the number of retries used
2666 for transactions.
2667 Without --retries, OpenSM defaults to 3 retries
2668 for transactions.
2669 <DT><B>-maxsmps</B> &lt;number&gt;<DD>
2670 This option specifies the number of VL15 SMP MADs
2671 allowed on the wire at any one time.
2672 Specifying -maxsmps 0 allows unlimited outstanding
2673 SMPs.
2674 Without -maxsmps, OpenSM defaults to a maximum of
2675 4 outstanding SMPs.
2676 <DT><B>-console [off | local | socket | loopback]</B><DD>
2677 This option brings up the OpenSM console (default off).
2678 Note that the socket and loopback options will only be available
2679 if OpenSM was built with --enable-console-socket.
2680 <DT><B>-console-port</B> &lt;port&gt;<DD>
2681 Specify an alternate telnet port for the socket console (default 10000).
2682 Note that this option only appears if OpenSM was built with
2683 --enable-console-socket.
2684 <DT><B>-i</B>, <B>-ignore-guids</B> &lt;equalize-ignore-guids-file&gt;<DD>
2685 This option provides the means to define a set of ports
2686 (by node guid and port number) that will be ignored by the link load
2687 equalization algorithm.
2688 <DT><B>-w</B>, <B>--hop_weights_file</B> &lt;path to file&gt;<DD>
2689 This option provides weighting factors per port representing a hop cost in
2690 computing the lid matrix.  The file consists of lines containing a switch port
2691 GUID (specified as a 64 bit hex number, with leading 0x), output port number,
2692 and weighting factor.  Any port not listed in the file defaults to a weighting
2693 factor of 1.  Lines starting with # are comments.  Weights affect only the
2694 output route from the port, so many useful configurations will require weights
2695 to be specified in pairs.
2696 <DT><B>-x</B>, <B>--honor_guid2lid</B><DD>
2697 This option forces OpenSM to honor the guid2lid file,
2698 when it comes out of Standby state, if such file exists
2699 under OSM_CACHE_DIR, and is valid.
2700 By default, this is FALSE.
2701 <DT><B>-f</B>, <B>--log_file</B> &lt;file name&gt;<DD>
2702 This option defines the log to be the given file. By default, the log goes to <b>\r
2703 %windir%\temp\</b>osm.log.
2704 For the log to go to standard output use -f stdout.
2705 <DT><B>-L</B>, <B>--log_limit</B> &lt;size in MB&gt;<DD>
2706 This option defines maximal log file size in MB. When
2707 specified the log file will be truncated upon reaching
2708 this limit.
2709 <DT><B>-e</B>, <B>--erase_log_file</B><DD>
2710 This option will cause deletion of the log file
2711 (if it previously exists). By default, the log file
2712 is accumulative.
2713 <DT><B>-P</B>, <B>--Pconfig</B> &lt;partition config file&gt;<DD>
2714 This option defines the optional partition configuration file.
2715 The default name is <b>%ProgramFiles%\WinOF\OpenSM\partitions.conf</b>.
2716 <DT><B>--prefix_routes_file</B> &lt;file name&gt;<DD>
2717 Prefix routes control how the SA responds to path record queries for
2718 off-subnet DGIDs.  By default, the SA fails such queries. The
2719 <B>PREFIX ROUTES</B>
2720
2721 section below describes the format of the configuration file.
2722 The default path is <b>%ProgramFiles%\WinOF\OpenSM\prefix-routes.conf</b>.
2723 <DT><B>-Q</B>, <B>--qos</B><DD>
2724 This option enables QoS setup. It is disabled by default.
2725 <DT><B>-Y</B>, <B>--qos_policy_file</B> &lt;file name&gt;<DD>
2726 This option defines the optional QoS policy file. The default
2727 name is <b>%ProgramFiles%\WinOF\OpenSM\qos-policy.conf</b>. See
2728 QoS_management_in_OpenSM.txt in opensm doc for more information on
2729 configuring QoS policy via this file.
2730 <DT><B>-N</B>, <B>--no_part_enforce</B><DD>
2731 This option disables partition enforcement on switch external ports.
2732 <DT><B>-y</B>, <B>--stay_on_fatal</B><DD>
2733 This option will cause SM not to exit on fatal initialization
2734 issues: if SM discovers duplicated guids or a 12x link with
2735 lane reversal badly configured.
2736 By default, the SM will exit on these errors.
2737 <DT><B>-B</B>, <B>--service</B><DD>
2738 OpenSM will run in the background (without a console window) as a Windows system \r
2739 service (the preferred Windows mode).
2740 <DT><B>-I</B>, <B>--inactive</B><DD>
2741 Start SM in inactive rather than init SM state.  This
2742 option can be used in conjunction with the perfmgr so as to
2743 run a standalone performance manager without SM/SA.  However,
2744 this is NOT currently implemented in the performance manager.
2745 <DT><B>-perfmgr</B><DD>
2746 Enable the perfmgr.  Only takes effect if --enable-perfmgr was specified at
2747 configure time.  See performance-manager-HOWTO.txt in opensm doc for
2748 more information on running perfmgr.
2749 <DT><B>-perfmgr_sweep_time_s</B> &lt;seconds&gt;<DD>
2750 Specify the sweep time for the performance manager in seconds
2751 (default is 180 seconds).  Only takes
2752 effect if --enable-perfmgr was specified at configure time.
2753 <DT><B>--consolidate_ipv6_snm_req</B>
2754
2755 <DD>
2756 Consolidate IPv6 Solicited Node Multicast group join requests into one
2757 multicast group per MGID PKey.
2758 <DT><B>-v</B>, <B>--verbose</B><DD>
2759 This option increases the log verbosity level.
2760 The -v option may be specified multiple times
2761 to further increase the verbosity level.
2762 See the -D option for more information about
2763 log verbosity.
2764 <DT><B>-V</B><DD>
2765 This option sets the maximum verbosity level and
2766 forces log flushing.
2767 The -V option is equivalent to '-D 0xFF -d 2'.
2768 See the -D option for more information about
2769 log verbosity.
2770 <DT><B>-D</B> &lt;value&gt;<DD>
2771 This option sets the log verbosity level.
2772 A flags field must follow the -D option.
2773 A bit set/clear in the flags enables/disables a
2774 specific log level as follows:
2775
2776 <BR>&nbsp;BIT&nbsp;&nbsp;&nbsp;&nbsp;LOG&nbsp;LEVEL&nbsp;ENABLED
2777 <BR>&nbsp;----&nbsp;&nbsp;&nbsp;-----------------
2778 <BR>&nbsp;0x01&nbsp;-&nbsp;ERROR&nbsp;(error&nbsp;messages)
2779 <BR>&nbsp;0x02&nbsp;-&nbsp;INFO&nbsp;(basic&nbsp;messages,&nbsp;low&nbsp;volume)
2780 <BR>&nbsp;0x04&nbsp;-&nbsp;VERBOSE&nbsp;(interesting&nbsp;stuff,&nbsp;moderate&nbsp;volume)
2781 <BR>&nbsp;0x08&nbsp;-&nbsp;DEBUG&nbsp;(diagnostic,&nbsp;high&nbsp;volume)
2782 <BR>&nbsp;0x10&nbsp;-&nbsp;FUNCS&nbsp;(function&nbsp;entry/exit,&nbsp;very&nbsp;high&nbsp;volume)
2783 <BR>&nbsp;0x20&nbsp;-&nbsp;FRAMES&nbsp;(dumps&nbsp;all&nbsp;SMP&nbsp;and&nbsp;GMP&nbsp;frames)
2784 <BR>&nbsp;0x40&nbsp;-&nbsp;ROUTING&nbsp;(dump&nbsp;FDB&nbsp;routing&nbsp;information)
2785 <BR>&nbsp;0x80&nbsp;-&nbsp;currently&nbsp;unused.
2786
2787 Without -D, OpenSM defaults to ERROR + INFO (0x3).
2788 Specifying -D 0 disables all messages.
2789 Specifying -D 0xFF enables all messages (see -V).
2790 High verbosity levels may require increasing
2791 the transaction timeout with the -t option.
2792 <DT><B>-d</B>, <B>--debug</B> &lt;value&gt;<DD>
2793 This option specifies a debug option.
2794 These options are not normally needed.
2795 The number following -d selects the debug
2796 option to enable as follows:
2797
2798 <BR>&nbsp;OPT&nbsp;&nbsp;&nbsp;Description
2799 <BR>&nbsp;---&nbsp;&nbsp;&nbsp;&nbsp;-----------------
2800 <BR>&nbsp;-d0&nbsp;&nbsp;-&nbsp;Ignore&nbsp;other&nbsp;SM&nbsp;nodes
2801 <BR>&nbsp;-d1&nbsp;&nbsp;-&nbsp;Force&nbsp;single&nbsp;threaded&nbsp;dispatching
2802 <BR>&nbsp;-d2&nbsp;&nbsp;-&nbsp;Force&nbsp;log&nbsp;flushing&nbsp;after&nbsp;each&nbsp;log&nbsp;message
2803 <BR>&nbsp;-d3&nbsp;&nbsp;-&nbsp;Disable&nbsp;multicast&nbsp;support
2804 <DT><B>-h</B>, <B>--help</B><DD>
2805 Display this usage info then exit.
2806 <DT><B>-?</B><DD>
2807 Display this usage info then exit.
2808
2809 <br>\r
2810 &nbsp;</DL>
2811 <h3>ENVIRONMENT VARIABLES</h3>
2812
2813 <P>
2814
2815 The following environment variables control opensm behavior:<ul>\r
2816         <li>OSM_TMP_DIR - controls the directory in which the temporary files generated by
2817 opensm are created.<br>\r
2818         These files are: opensm-subnet.lst, opensm.fdbs, and
2819 opensm.mcfdbs. By default, this directory is %ProgramFiles%\WinOF\OpenSM\.</li>\r
2820         <li>OSM_CACHE_DIR - opensm stores certain data to the disk such that \r
2821         subsequent runs are consistent. The default directory used is %ProgramFiles%\WinOF\OpenSM\.
2822 The following file is included in it: <BR>&nbsp;guid2lid&nbsp;-&nbsp;stores&nbsp;the&nbsp;LID&nbsp;range&nbsp;assigned&nbsp;to&nbsp;each&nbsp;GUID<br>\r
2823 &nbsp;</li>\r
2824         </ul>\r
2825 <h3>NOTES</h3>
2826
2827 <P>
2828
2829 When opensm running as a windows service, if the opensm process receives a service control code of \r
2830 129, it starts a new heavy sweep as if a trap was received or a topology change was found.<P>
2831
2832 Also, service control code 128 can be used to trigger a reopen of %windir%\temp\osm.log for
2833 logrotate purposes.<br>\r
2834 &nbsp;<P>
2835
2836 Examples:<P>
2837
2838 &nbsp;&nbsp;&nbsp; sc.exe control OpenSM 128&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
2839 # will clear the contends of %windir%\temp\osm.log<br>\r
2840 &nbsp;&nbsp;&nbsp; sc.exe control OpenSM 129&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
2841 # start a new heavy sweep<P>
2842
2843 &nbsp;<h3>PARTITION CONFIGURATION</h3>
2844
2845 <P>
2846
2847 The default name of OpenSM partitions configuration file is
2848 <B>%ProgramFiles\WinOF\OpenSM\partitions.conf</B>. The default may be changed
2849 by using the --Pconfig (-P) option with OpenSM.
2850
2851 The default partition will be created by OpenSM unconditionally even
2852 when partition configuration file does not exist or cannot be accessed.
2853
2854 The default partition has P_Key value 0x7fff. OpenSM's port will always
2855 have full membership in default partition. All other end ports will have
2856 full membership if the partition configuration file is not found or cannot
2857 be accessed, or limited membership if the file exists and can be accessed
2858 but there is no rule for the Default partition.
2859
2860 Effectively, this amounts to the same as if one of the following rules
2861 below appear in the partition configuration file.
2862
2863 In the case of no rule for the Default partition:
2864
2865 Default=0x7fff : ALL=limited, SELF=full ;
2866
2867 In the case of no partition configuration file or file cannot be accessed:
2868
2869 Default=0x7fff : ALL=full ;
2870
2871
2872 File Format
2873
2874 Comments:
2875
2876 Line content followed after '#' character is comment and ignored by
2877 parser.
2878
2879 General file format:
2880
2881 &lt;Partition Definition&gt;:&lt;PortGUIDs list&gt; ;
2882
2883 Partition Definition:
2884
2885 [PartitionName][=PKey][,flag[=value]][,defmember=full|limited]
2886
2887 <BR>&nbsp;PartitionName&nbsp;-&nbsp;string,&nbsp;will&nbsp;be&nbsp;used&nbsp;with&nbsp;logging.&nbsp;When&nbsp;omitted
2888 <BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;empty&nbsp;string&nbsp;will&nbsp;be&nbsp;used.
2889 <BR>&nbsp;PKey&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;P_Key&nbsp;value&nbsp;for&nbsp;this&nbsp;partition.&nbsp;Only&nbsp;low&nbsp;15&nbsp;bits&nbsp;will
2890 <BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;be&nbsp;used.&nbsp;When&nbsp;omitted&nbsp;will&nbsp;be&nbsp;autogenerated.
2891 <BR>&nbsp;flag&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;used&nbsp;to&nbsp;indicate&nbsp;IPoIB&nbsp;capability&nbsp;of&nbsp;this&nbsp;partition.
2892 <BR>&nbsp;defmember=full|limited&nbsp;-&nbsp;specifies&nbsp;default&nbsp;membership&nbsp;for&nbsp;port&nbsp;guid
2893 <BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;list.&nbsp;Default&nbsp;is&nbsp;limited.
2894
2895 Currently recognized flags are:
2896
2897 <BR>&nbsp;ipoib&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;indicates&nbsp;that&nbsp;this&nbsp;partition&nbsp;may&nbsp;be&nbsp;used&nbsp;for&nbsp;IPoIB,&nbsp;as
2898 <BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;result&nbsp;IPoIB&nbsp;capable&nbsp;MC&nbsp;group&nbsp;will&nbsp;be&nbsp;created.
2899 <BR>&nbsp;rate=&lt;val&gt;&nbsp;&nbsp;-&nbsp;specifies&nbsp;rate&nbsp;for&nbsp;this&nbsp;IPoIB&nbsp;MC&nbsp;group
2900 <BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(default&nbsp;is&nbsp;3&nbsp;(10GBps))
2901 <BR>&nbsp;mtu=&lt;val&gt;&nbsp;&nbsp;&nbsp;-&nbsp;specifies&nbsp;MTU&nbsp;for&nbsp;this&nbsp;IPoIB&nbsp;MC&nbsp;group
2902 <BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(default&nbsp;is&nbsp;4&nbsp;(2048))
2903 <BR>&nbsp;sl=&lt;val&gt;&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;specifies&nbsp;SL&nbsp;for&nbsp;this&nbsp;IPoIB&nbsp;MC&nbsp;group
2904 <BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(default&nbsp;is&nbsp;0)
2905 <BR>&nbsp;scope=&lt;val&gt;&nbsp;-&nbsp;specifies&nbsp;scope&nbsp;for&nbsp;this&nbsp;IPoIB&nbsp;MC&nbsp;group
2906 <BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(default&nbsp;is&nbsp;2&nbsp;(link&nbsp;local)).&nbsp;&nbsp;Multiple&nbsp;scope&nbsp;settings
2907 <BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;are&nbsp;permitted&nbsp;for&nbsp;a&nbsp;partition.
2908
2909 Note that values for rate, mtu, and scope should be specified as
2910 defined in the IBTA specification (for example, mtu=4 for 2048).
2911
2912 PortGUIDs list:
2913
2914 <BR>&nbsp;PortGUID&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;GUID&nbsp;of&nbsp;partition&nbsp;member&nbsp;EndPort.&nbsp;Hexadecimal
2915 <BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;numbers&nbsp;should&nbsp;start&nbsp;from&nbsp;0x,&nbsp;decimal&nbsp;numbers
2916 <BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;are&nbsp;accepted&nbsp;too.
2917 <BR>&nbsp;full&nbsp;or&nbsp;limited&nbsp;&nbsp;-&nbsp;indicates&nbsp;full&nbsp;or&nbsp;limited&nbsp;membership&nbsp;for&nbsp;this
2918 <BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;port.&nbsp;&nbsp;When&nbsp;omitted&nbsp;(or&nbsp;unrecognized)&nbsp;limited
2919 <BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;membership&nbsp;is&nbsp;assumed.
2920
2921 There are two useful keywords for PortGUID definition:
2922
2923 <BR>&nbsp;-&nbsp;'ALL'&nbsp;means&nbsp;all&nbsp;end&nbsp;ports&nbsp;in&nbsp;this&nbsp;subnet.
2924 <BR>&nbsp;-&nbsp;'ALL_CAS'&nbsp;means&nbsp;all&nbsp;Channel&nbsp;Adapter&nbsp;end&nbsp;ports&nbsp;in&nbsp;this&nbsp;subnet.
2925 <BR>&nbsp;-&nbsp;'ALL_SWITCHES'&nbsp;means&nbsp;all&nbsp;Switch&nbsp;end&nbsp;ports&nbsp;in&nbsp;this&nbsp;subnet.
2926 <BR>&nbsp;-&nbsp;'ALL_ROUTERS'&nbsp;means&nbsp;all&nbsp;Router&nbsp;end&nbsp;ports&nbsp;in&nbsp;this&nbsp;subnet.
2927 <BR>&nbsp;-&nbsp;'SELF'&nbsp;means&nbsp;subnet&nbsp;manager's&nbsp;port.
2928
2929 Empty list means no ports in this partition.
2930
2931 Notes:
2932
2933 White space is permitted between delimiters ('=', ',',':',';').
2934
2935 The line can be wrapped after ':' followed after Partition Definition and
2936 between.
2937
2938 PartitionName does not need to be unique, PKey does need to be unique.
2939 If PKey is repeated then those partition configurations will be merged
2940 and first PartitionName will be used (see also next note).
2941
2942 It is possible to split partition configuration in more than one
2943 definition, but then PKey should be explicitly specified (otherwise
2944 different PKey values will be generated for those definitions).
2945
2946 Examples:
2947
2948 <BR>&nbsp;Default=0x7fff&nbsp;:&nbsp;ALL,&nbsp;SELF=full&nbsp;;
2949 <BR>&nbsp;Default=0x7fff&nbsp;:&nbsp;ALL,&nbsp;ALL_SWITCHES=full,&nbsp;SELF=full&nbsp;;
2950
2951 <BR>&nbsp;NewPartition&nbsp;,&nbsp;ipoib&nbsp;:&nbsp;0x123456=full,&nbsp;0x3456789034=limi,&nbsp;0x2134af2306&nbsp;;
2952
2953 <BR>&nbsp;YetAnotherOne&nbsp;=&nbsp;0x300&nbsp;:&nbsp;SELF=full&nbsp;;
2954 <BR>&nbsp;YetAnotherOne&nbsp;=&nbsp;0x300&nbsp;:&nbsp;ALL=limited&nbsp;;
2955
2956 <BR>&nbsp;ShareIO&nbsp;=&nbsp;0x80&nbsp;,&nbsp;defmember=full&nbsp;:&nbsp;0x123451,&nbsp;0x123452;
2957 <BR>&nbsp;#&nbsp;0x123453,&nbsp;0x123454&nbsp;will&nbsp;be&nbsp;limited
2958 <BR>&nbsp;ShareIO&nbsp;=&nbsp;0x80&nbsp;:&nbsp;0x123453,&nbsp;0x123454,&nbsp;0x123455=full;
2959 <BR>&nbsp;#&nbsp;0x123456,&nbsp;0x123457&nbsp;will&nbsp;be&nbsp;limited
2960 <BR>&nbsp;ShareIO&nbsp;=&nbsp;0x80&nbsp;:&nbsp;defmember=limited&nbsp;:&nbsp;0x123456,&nbsp;0x123457,&nbsp;0x123458=full;
2961 <BR>&nbsp;ShareIO&nbsp;=&nbsp;0x80&nbsp;,&nbsp;defmember=full&nbsp;:&nbsp;0x123459,&nbsp;0x12345a;
2962 <BR>&nbsp;ShareIO&nbsp;=&nbsp;0x80&nbsp;,&nbsp;defmember=full&nbsp;:&nbsp;0x12345b,&nbsp;0x12345c=limited,&nbsp;0x12345d;
2963
2964
2965 Note:
2966
2967 The following rule is equivalent to how OpenSM used to run prior to the
2968 partition manager:
2969
2970 <BR>&nbsp;Default=0x7fff,ipoib:ALL=full;
2971
2972 <A NAME="lbAI">&nbsp;</A>
2973 <h3>QOS CONFIGURATION</h3>
2974
2975 <P>
2976
2977 There are a set of QoS related low-level configuration parameters.
2978 All these parameter names are prefixed by &quot;qos_&quot; string. Here is a full
2979 list of these parameters:
2980
2981 <BR>&nbsp;qos_max_vls&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;The&nbsp;maximum&nbsp;number&nbsp;of&nbsp;VLs&nbsp;that&nbsp;will&nbsp;be&nbsp;on&nbsp;the&nbsp;subnet
2982 <BR>&nbsp;qos_high_limit&nbsp;-&nbsp;The&nbsp;limit&nbsp;of&nbsp;High&nbsp;Priority&nbsp;component&nbsp;of&nbsp;VL
2983 <BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Arbitration&nbsp;table&nbsp;(IBA&nbsp;7.6.9)
2984 <BR>&nbsp;qos_vlarb_low&nbsp;&nbsp;-&nbsp;Low&nbsp;priority&nbsp;VL&nbsp;Arbitration&nbsp;table&nbsp;(IBA&nbsp;7.6.9)
2985 <BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;template
2986 <BR>&nbsp;qos_vlarb_high&nbsp;-&nbsp;High&nbsp;priority&nbsp;VL&nbsp;Arbitration&nbsp;table&nbsp;(IBA&nbsp;7.6.9)
2987 <BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;template
2988 <BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Both&nbsp;VL&nbsp;arbitration&nbsp;templates&nbsp;are&nbsp;pairs&nbsp;of
2989 <BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;VL&nbsp;and&nbsp;weight
2990 <BR>&nbsp;qos_sl2vl&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;SL2VL&nbsp;Mapping&nbsp;table&nbsp;(IBA&nbsp;7.6.6)&nbsp;template.&nbsp;It&nbsp;is
2991 <BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;a&nbsp;list&nbsp;of&nbsp;VLs&nbsp;corresponding&nbsp;to&nbsp;SLs&nbsp;0-15&nbsp;(Note
2992 <BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;that&nbsp;VL15&nbsp;used&nbsp;here&nbsp;means&nbsp;drop&nbsp;this&nbsp;SL)
2993
2994 Typical default values (hard-coded in OpenSM initialization) are:
2995
2996 <BR>&nbsp;qos_max_vls&nbsp;15
2997 <BR>&nbsp;qos_high_limit&nbsp;0
2998 <BR>&nbsp;qos_vlarb_low&nbsp;0:0,1:4,2:4,3:4,4:4,5:4,6:4,7:4,8:4,9:4,10:4,11:4,12:4,13:4,14:4
2999 <BR>&nbsp;qos_vlarb_high&nbsp;0:4,1:0,2:0,3:0,4:0,5:0,6:0,7:0,8:0,9:0,10:0,11:0,12:0,13:0,14:0
3000 <BR>&nbsp;qos_sl2vl&nbsp;0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,7
3001
3002 The syntax is compatible with rest of OpenSM configuration options and
3003 values may be stored in OpenSM config file (cached options file).
3004
3005 In addition to the above, we may define separate QoS configuration
3006 parameters sets for various target types. As targets, we currently support
3007 CAs, routers, switch external ports, and switch's enhanced port 0. The
3008 names of such specialized parameters are prefixed by &quot;qos_&lt;type&gt;_&quot;
3009 string. Here is a full list of the currently supported sets:
3010
3011 <BR>&nbsp;qos_ca_&nbsp;&nbsp;-&nbsp;QoS&nbsp;configuration&nbsp;parameters&nbsp;set&nbsp;for&nbsp;CAs.
3012 <BR>&nbsp;qos_rtr_&nbsp;-&nbsp;parameters&nbsp;set&nbsp;for&nbsp;routers.
3013 <BR>&nbsp;qos_sw0_&nbsp;-&nbsp;parameters&nbsp;set&nbsp;for&nbsp;switches'&nbsp;port&nbsp;0.
3014 <BR>&nbsp;qos_swe_&nbsp;-&nbsp;parameters&nbsp;set&nbsp;for&nbsp;switches'&nbsp;external&nbsp;ports.
3015
3016 Examples:
3017 <BR>&nbsp;qos_sw0_max_vls=2
3018 <BR>&nbsp;qos_ca_sl2vl=0,1,2,3,5,5,5,12,12,0,
3019 <BR>&nbsp;qos_swe_high_limit=0
3020
3021 <A NAME="lbAJ">&nbsp;</A>
3022 <h3>PREFIX ROUTES</h3>
3023
3024 <P>
3025
3026 Prefix routes control how the SA responds to path record queries for
3027 off-subnet DGIDs.  By default, the SA fails such queries.
3028 Note that IBA does not specify how the SA should obtain off-subnet path
3029 record information.
3030 The prefix routes configuration is meant as a stop-gap until the
3031 specification is completed.
3032 <P>
3033
3034 Each line in the configuration file is a 64-bit prefix followed by a
3035 64-bit GUID, separated by white space.
3036 The GUID specifies the router port on the local subnet that will
3037 handle the prefix.
3038 Blank lines are ignored, as is anything between a <B>#</B> character
3039 and the end of the line.
3040 The prefix and GUID are both in hex, the leading 0x is optional.
3041 Either, or both, can be wild-carded by specifying an
3042 asterisk instead of an explicit prefix or GUID.
3043 <P>
3044
3045 When responding to a path record query for an off-subnet DGID,
3046 opensm searches for the first prefix match in the configuration file.
3047 Therefore, the order of the lines in the configuration file is important:
3048 a wild-carded prefix at the beginning of the configuration file renders
3049 all subsequent lines useless.
3050 If there is no match, then opensm fails the query.
3051 It is legal to repeat prefixes in the configuration file,
3052 opensm will return the path to the first available matching router.
3053 A configuration file with a single line where both prefix and GUID
3054 are wild-carded means that a path record query specifying any
3055 off-subnet DGID should return a path to the first available router.
3056 This configuration yields the same behavior formerly achieved by
3057 compiling opensm with -DROUTER_EXP which has been obsoleted.
3058
3059 <A NAME="lbAK">&nbsp;</A>
3060 <h3>ROUTING</h3>
3061
3062 <P>
3063
3064 OpenSM now offers five routing engines:
3065
3066 1.  Min Hop Algorithm - based on the minimum hops to each node where the
3067 path length is optimized.
3068
3069 2.  UPDN Unicast routing algorithm - also based on the minimum hops to each
3070 node, but it is constrained to ranking rules. This algorithm should be chosen
3071 if the subnet is not a pure Fat Tree, and deadlock may occur due to a
3072 loop in the subnet.
3073
3074 3.  Fat Tree Unicast routing algorithm - this algorithm optimizes routing
3075 for congestion-free &quot;shift&quot; communication pattern.
3076 It should be chosen if a subnet is a symmetrical or almost symmetrical
3077 fat-tree of various types, not just K-ary-N-Trees: non-constant K, not
3078 fully staffed, any Constant Bisectional Bandwidth (CBB) ratio.
3079 Similar to UPDN, Fat Tree routing is constrained to ranking rules.
3080
3081 4. LASH unicast routing algorithm - uses Infiniband virtual layers
3082 (SL) to provide deadlock-free shortest-path routing while also
3083 distributing the paths between layers. LASH is an alternative
3084 deadlock-free topology-agnostic routing algorithm to the non-minimal
3085 UPDN algorithm avoiding the use of a potentially congested root node.
3086
3087 5. DOR Unicast routing algorithm - based on the Min Hop algorithm, but
3088 avoids port equalization except for redundant links between the same
3089 two switches.  This provides deadlock free routes for hypercubes when
3090 the fabric is cabled as a hypercube and for meshes when cabled as a
3091 mesh (see details below).
3092
3093 OpenSM also supports a file method which
3094 can load routes from a table. See 'Modular Routing Engine' for more
3095 information on this.
3096
3097 The basic routing algorithm is comprised of two stages:
3098
3099 1. MinHop matrix calculation
3100 <BR>&nbsp;&nbsp;&nbsp;How&nbsp;many&nbsp;hops&nbsp;are&nbsp;required&nbsp;to&nbsp;get&nbsp;from&nbsp;each&nbsp;port&nbsp;to&nbsp;each&nbsp;LID&nbsp;?
3101 <BR>&nbsp;&nbsp;&nbsp;The&nbsp;algorithm&nbsp;to&nbsp;fill&nbsp;these&nbsp;tables&nbsp;is&nbsp;different&nbsp;if&nbsp;you&nbsp;run&nbsp;standard
3102 (min hop) or Up/Down.
3103 <BR>&nbsp;&nbsp;&nbsp;For&nbsp;standard&nbsp;routing,&nbsp;a&nbsp;&quot;relaxation&quot;&nbsp;algorithm&nbsp;is&nbsp;used&nbsp;to&nbsp;propagate
3104 min hop from every destination LID through neighbor switches
3105 <BR>&nbsp;&nbsp;&nbsp;For&nbsp;Up/Down&nbsp;routing,&nbsp;a&nbsp;BFS&nbsp;from&nbsp;every&nbsp;target&nbsp;is&nbsp;used.&nbsp;The&nbsp;BFS&nbsp;tracks&nbsp;link
3106 direction (up or down) and avoid steps that will perform up after a down
3107 step was used.
3108
3109 2. Once MinHop matrices exist, each switch is visited and for each target LID a
3110 decision is made as to what port should be used to get to that LID.
3111 <BR>&nbsp;&nbsp;&nbsp;This&nbsp;step&nbsp;is&nbsp;common&nbsp;to&nbsp;standard&nbsp;and&nbsp;Up/Down&nbsp;routing.&nbsp;Each&nbsp;port&nbsp;has&nbsp;a
3112 counter counting the number of target LIDs going through it.
3113 <BR>&nbsp;&nbsp;&nbsp;When&nbsp;there&nbsp;are&nbsp;multiple&nbsp;alternative&nbsp;ports&nbsp;with&nbsp;same&nbsp;MinHop&nbsp;to&nbsp;a&nbsp;LID,
3114 the one with less previously assigned ports is selected.
3115 <BR>&nbsp;&nbsp;&nbsp;If&nbsp;LMC&nbsp;&gt;&nbsp;0,&nbsp;more&nbsp;checks&nbsp;are&nbsp;added:&nbsp;Within&nbsp;each&nbsp;group&nbsp;of&nbsp;LIDs&nbsp;assigned&nbsp;to
3116 same target port,
3117 <BR>&nbsp;&nbsp;&nbsp;a.&nbsp;use&nbsp;only&nbsp;ports&nbsp;which&nbsp;have&nbsp;same&nbsp;MinHop
3118 <BR>&nbsp;&nbsp;&nbsp;b.&nbsp;first&nbsp;prefer&nbsp;the&nbsp;ones&nbsp;that&nbsp;go&nbsp;to&nbsp;different&nbsp;systemImageGuid&nbsp;(then
3119 the previous LID of the same LMC group)
3120 <BR>&nbsp;&nbsp;&nbsp;c.&nbsp;if&nbsp;none&nbsp;-&nbsp;prefer&nbsp;those&nbsp;which&nbsp;go&nbsp;through&nbsp;another&nbsp;NodeGuid
3121 <BR>&nbsp;&nbsp;&nbsp;d.&nbsp;fall&nbsp;back&nbsp;to&nbsp;the&nbsp;number&nbsp;of&nbsp;paths&nbsp;method&nbsp;(if&nbsp;all&nbsp;go&nbsp;to&nbsp;same&nbsp;node).
3122
3123 Effect of Topology Changes
3124
3125 OpenSM will preserve existing routing in any case where there is no change in
3126 the fabric switches unless the -r (--reassign_lids) option is specified.
3127
3128 -r
3129 <BR>
3130
3131 --reassign_lids
3132 <BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This&nbsp;option&nbsp;causes&nbsp;OpenSM&nbsp;to&nbsp;reassign&nbsp;LIDs&nbsp;to&nbsp;all
3133 <BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;end&nbsp;nodes.&nbsp;Specifying&nbsp;-r&nbsp;on&nbsp;a&nbsp;running&nbsp;subnet
3134 <BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;may&nbsp;disrupt&nbsp;subnet&nbsp;traffic.
3135 <BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Without&nbsp;-r,&nbsp;OpenSM&nbsp;attempts&nbsp;to&nbsp;preserve&nbsp;existing
3136 <BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;LID&nbsp;assignments&nbsp;resolving&nbsp;multiple&nbsp;use&nbsp;of&nbsp;same&nbsp;LID.
3137
3138 If a link is added or removed, OpenSM does not recalculate
3139 the routes that do not have to change. A route has to change
3140 if the port is no longer UP or no longer the MinHop. When routing changes
3141 are performed, the same algorithm for balancing the routes is invoked.
3142
3143 In the case of using the file based routing, any topology changes are
3144 currently ignored The 'file' routing engine just loads the LFTs from the file
3145 specified, with no reaction to real topology. Obviously, this will not be able
3146 to recheck LIDs (by GUID) for disconnected nodes, and LFTs for non-existent
3147 switches will be skipped. Multicast is not affected by 'file' routing engine
3148 (this uses min hop tables).
3149
3150
3151 Min Hop Algorithm
3152
3153 The Min Hop algorithm is invoked by default if no routing algorithm is
3154 specified.  It can also be invoked by specifying '-R minhop'.
3155
3156 The Min Hop algorithm is divided into two stages: computation of
3157 min-hop tables on every switch and LFT output port assignment. Link
3158 subscription is also equalized with the ability to override based on
3159 port GUID. The latter is supplied by:
3160
3161 -i &lt;equalize-ignore-guids-file&gt;
3162 <BR>
3163
3164 -ignore-guids &lt;equalize-ignore-guids-file&gt;
3165 <BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This&nbsp;option&nbsp;provides&nbsp;the&nbsp;means&nbsp;to&nbsp;define&nbsp;a&nbsp;set&nbsp;of&nbsp;ports
3166 <BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(by&nbsp;guid)&nbsp;that&nbsp;will&nbsp;be&nbsp;ignored&nbsp;by&nbsp;the&nbsp;link&nbsp;load
3167 <BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;equalization&nbsp;algorithm.&nbsp;Note&nbsp;that&nbsp;only&nbsp;endports&nbsp;(CA,
3168 <BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;switch&nbsp;port&nbsp;0,&nbsp;and&nbsp;router&nbsp;ports)&nbsp;and&nbsp;not&nbsp;switch&nbsp;external
3169 <BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ports&nbsp;are&nbsp;supported.
3170
3171 LMC awareness routes based on (remote) system or switch basis.
3172
3173
3174 Purpose of UPDN Algorithm
3175
3176 The UPDN algorithm is designed to prevent deadlocks from occurring in loops
3177 of the subnet. A loop-deadlock is a situation in which it is no longer
3178 possible to send data between any two hosts connected through the loop. As
3179 such, the UPDN routing algorithm should be used if the subnet is not a pure
3180 Fat Tree, and one of its loops may experience a deadlock (due, for example,
3181 to high pressure).
3182
3183 The UPDN algorithm is based on the following main stages:
3184
3185 1.  Auto-detect root nodes - based on the CA hop length from any switch in
3186 the subnet, a statistical histogram is built for each switch (hop num vs
3187 number of occurrences). If the histogram reflects a specific column (higher
3188 than others) for a certain node, then it is marked as a root node. Since
3189 the algorithm is statistical, it may not find any root nodes. The list of
3190 the root nodes found by this auto-detect stage is used by the ranking
3191 process stage.
3192
3193 <BR>&nbsp;&nbsp;&nbsp;&nbsp;Note&nbsp;1:&nbsp;The&nbsp;user&nbsp;can&nbsp;override&nbsp;the&nbsp;node&nbsp;list&nbsp;manually.
3194 <BR>&nbsp;&nbsp;&nbsp;&nbsp;Note&nbsp;2:&nbsp;If&nbsp;this&nbsp;stage&nbsp;cannot&nbsp;find&nbsp;any&nbsp;root&nbsp;nodes,&nbsp;and&nbsp;the&nbsp;user&nbsp;did
3195 <BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;not&nbsp;specify&nbsp;a&nbsp;guid&nbsp;list&nbsp;file,&nbsp;OpenSM&nbsp;defaults&nbsp;back&nbsp;to&nbsp;the
3196 <BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Min&nbsp;Hop&nbsp;routing&nbsp;algorithm.
3197
3198 2.  Ranking process - All root switch nodes (found in stage 1) are assigned
3199 a rank of 0. Using the BFS algorithm, the rest of the switch nodes in the
3200 subnet are ranked incrementally. This ranking aids in the process of enforcing
3201 rules that ensure loop-free paths.
3202
3203 3.  Min Hop Table setting - after ranking is done, a BFS algorithm is run from
3204 each (CA or switch) node in the subnet. During the BFS process, the FDB table
3205 of each switch node traversed by BFS is updated, in reference to the starting
3206 node, based on the ranking rules and guid values.
3207
3208 At the end of the process, the updated FDB tables ensure loop-free paths
3209 through the subnet.
3210
3211 Note: Up/Down routing does not allow LID routing communication between
3212 switches that are located inside spine &quot;switch systems&quot;.
3213 The reason is that there is no way to allow a LID route between them
3214 that does not break the Up/Down rule.
3215 One ramification of this is that you cannot run SM on switches other
3216 than the leaf switches of the fabric.
3217
3218
3219 UPDN Algorithm Usage
3220
3221 Activation through OpenSM
3222
3223 Use '-R updn' option (instead of old '-u') to activate the UPDN algorithm.
3224 Use '-a &lt;root_guid_file&gt;' for adding an UPDN guid file that contains the
3225 root nodes for ranking.
3226 If the `-a' option is not used, OpenSM uses its auto-detect root nodes
3227 algorithm.
3228
3229 Notes on the guid list file:
3230
3231 1.   A valid guid file specifies one guid in each line. Lines with an invalid
3232 format will be discarded.
3233 <BR>
3234
3235 2.   The user should specify the root switch guids. However, it is also
3236 possible to specify CA guids; OpenSM will use the guid of the switch (if
3237 it exists) that connects the CA to the subnet as a root node.
3238
3239
3240 Fat-tree Routing Algorithm
3241
3242 The fat-tree algorithm optimizes routing for &quot;shift&quot; communication pattern.
3243 It should be chosen if a subnet is a symmetrical or almost symmetrical
3244 fat-tree of various types.
3245 It supports not just K-ary-N-Trees, by handling for non-constant K,
3246 cases where not all leafs (CAs) are present, any CBB ratio.
3247 As in UPDN, fat-tree also prevents credit-loop-deadlocks.
3248
3249 If the root guid file is not provided ('-a' or '--root_guid_file' options),
3250 the topology has to be pure fat-tree that complies with the following rules:
3251 <BR>&nbsp;&nbsp;-&nbsp;Tree&nbsp;rank&nbsp;should&nbsp;be&nbsp;between&nbsp;two&nbsp;and&nbsp;eight&nbsp;(inclusively)
3252 <BR>&nbsp;&nbsp;-&nbsp;Switches&nbsp;of&nbsp;the&nbsp;same&nbsp;rank&nbsp;should&nbsp;have&nbsp;the&nbsp;same&nbsp;number
3253 <BR>&nbsp;&nbsp;&nbsp;&nbsp;of&nbsp;UP-going&nbsp;port&nbsp;groups*,&nbsp;unless&nbsp;they&nbsp;are&nbsp;root&nbsp;switches,
3254 <BR>&nbsp;&nbsp;&nbsp;&nbsp;in&nbsp;which&nbsp;case&nbsp;the&nbsp;shouldn't&nbsp;have&nbsp;UP-going&nbsp;ports&nbsp;at&nbsp;all.
3255 <BR>&nbsp;&nbsp;-&nbsp;Switches&nbsp;of&nbsp;the&nbsp;same&nbsp;rank&nbsp;should&nbsp;have&nbsp;the&nbsp;same&nbsp;number
3256 <BR>&nbsp;&nbsp;&nbsp;&nbsp;of&nbsp;DOWN-going&nbsp;port&nbsp;groups,&nbsp;unless&nbsp;they&nbsp;are&nbsp;leaf&nbsp;switches.
3257 <BR>&nbsp;&nbsp;-&nbsp;Switches&nbsp;of&nbsp;the&nbsp;same&nbsp;rank&nbsp;should&nbsp;have&nbsp;the&nbsp;same&nbsp;number
3258 <BR>&nbsp;&nbsp;&nbsp;&nbsp;of&nbsp;ports&nbsp;in&nbsp;each&nbsp;UP-going&nbsp;port&nbsp;group.
3259 <BR>&nbsp;&nbsp;-&nbsp;Switches&nbsp;of&nbsp;the&nbsp;same&nbsp;rank&nbsp;should&nbsp;have&nbsp;the&nbsp;same&nbsp;number
3260 <BR>&nbsp;&nbsp;&nbsp;&nbsp;of&nbsp;ports&nbsp;in&nbsp;each&nbsp;DOWN-going&nbsp;port&nbsp;group.
3261 <BR>&nbsp;&nbsp;-&nbsp;All&nbsp;the&nbsp;CAs&nbsp;have&nbsp;to&nbsp;be&nbsp;at&nbsp;the&nbsp;same&nbsp;tree&nbsp;level&nbsp;(rank).
3262
3263 If the root guid file is provided, the topology doesn't have to be pure
3264 fat-tree, and it should only comply with the following rules:
3265 <BR>&nbsp;&nbsp;-&nbsp;Tree&nbsp;rank&nbsp;should&nbsp;be&nbsp;between&nbsp;two&nbsp;and&nbsp;eight&nbsp;(inclusively)
3266 <BR>&nbsp;&nbsp;-&nbsp;All&nbsp;the&nbsp;Compute&nbsp;Nodes**&nbsp;have&nbsp;to&nbsp;be&nbsp;at&nbsp;the&nbsp;same&nbsp;tree&nbsp;level&nbsp;(rank).
3267 <BR>&nbsp;&nbsp;&nbsp;&nbsp;Note&nbsp;that&nbsp;non-compute&nbsp;node&nbsp;CAs&nbsp;are&nbsp;allowed&nbsp;here&nbsp;to&nbsp;be&nbsp;at&nbsp;different
3268 <BR>&nbsp;&nbsp;&nbsp;&nbsp;tree&nbsp;ranks.
3269
3270 * ports that are connected to the same remote switch are referenced as
3271 'port group'.
3272
3273 ** list of compute nodes (CNs) can be specified by '-u' or '--cn_guid_file'
3274 OpenSM options.
3275
3276 Topologies that do not comply cause a fallback to min hop routing.
3277 Note that this can also occur on link failures which cause the topology
3278 to no longer be &quot;pure&quot; fat-tree.
3279
3280 Note that although fat-tree algorithm supports trees with non-integer CBB
3281 ratio, the routing will not be as balanced as in case of integer CBB ratio.
3282 In addition to this, although the algorithm allows leaf switches to have any
3283 number of CAs, the closer the tree is to be fully populated, the more
3284 effective the &quot;shift&quot; communication pattern will be.
3285 In general, even if the root list is provided, the closer the topology to a
3286 pure and symmetrical fat-tree, the more optimal the routing will be.
3287
3288 The algorithm also dumps compute node ordering file (opensm-ftree-ca-order.dump)
3289 in the same directory where the OpenSM log resides. This ordering file provides
3290 the CN order that may be used to create efficient communication pattern, that
3291 will match the routing tables.
3292
3293 Routing between non-CN nodes
3294
3295 The use of the cn_guid_file option allows non-CN nodes to be located on different levels in the fat tree.
3296 In such case, it is not guaranteed that the Fat Tree algorithm will route between two non-CN nodes.
3297 To solve this problem, a list of non-CN nodes can be specified by '-G' or '--io_guid_file' option.
3298 Theses nodes will be allowed to use switches the wrong way round a specific number of times (specified by '-H' or '--max_reverse_hops'.
3299 With the proper max_reverse_hops and io_guid_file values, you can ensure full connectivity in the Fat Tree.
3300
3301 Please note that using max_reverse_hops creates routes that use the switch in a counter-stream way.
3302 This option should never be used to connect nodes with high bandwidth traffic between them ! It should only be used
3303 to allow connectivity for HA purposes or similar.
3304 Also having routes the other way around can in theory cause credit loops.
3305
3306 Use these options with extreme care !
3307
3308 Activation through OpenSM
3309
3310 Use '-R ftree' option to activate the fat-tree algorithm.
3311 Use '-a &lt;root_guid_file&gt;' to provide root nodes for ranking. If the `-a' option
3312 is not used, routing algorithm will detect roots automatically.
3313 Use '-u &lt;root_cn_file&gt;' to provide the list of compute nodes. If the `-u' option
3314 is not used, all the CAs are considered as compute nodes.
3315
3316 Note: LMC &gt; 0 is not supported by fat-tree routing. If this is
3317 specified, the default routing algorithm is invoked instead.
3318
3319
3320 LASH Routing Algorithm
3321
3322 LASH is an acronym for LAyered SHortest Path Routing. It is a
3323 deterministic shortest path routing algorithm that enables topology
3324 agnostic deadlock-free routing within communication networks.
3325
3326 When computing the routing function, LASH analyzes the network
3327 topology for the shortest-path routes between all pairs of sources /
3328 destinations and groups these paths into virtual layers in such a way
3329 as to avoid deadlock.
3330
3331 Note LASH analyzes routes and ensures deadlock freedom between switch
3332 pairs. The link from HCA between and switch does not need virtual
3333 layers as deadlock will not arise between switch and HCA.
3334
3335 In more detail, the algorithm works as follows:
3336
3337 1) LASH determines the shortest-path between all pairs of source /
3338 destination switches. Note, LASH ensures the same SL is used for all
3339 SRC/DST - DST/SRC pairs and there is no guarantee that the return
3340 path for a given DST/SRC will be the reverse of the route SRC/DST.
3341
3342 2) LASH then begins an SL assignment process where a route is assigned
3343 to a layer (SL) if the addition of that route does not cause deadlock
3344 within that layer. This is achieved by maintaining and analysing a
3345 channel dependency graph for each layer. Once the potential addition
3346 of a path could lead to deadlock, LASH opens a new layer and continues
3347 the process.
3348
3349 3) Once this stage has been completed, it is highly likely that the
3350 first layers processed will contain more paths than the latter ones.
3351 To better balance the use of layers, LASH moves paths from one layer
3352 to another so that the number of paths in each layer averages out.
3353
3354 Note, the implementation of LASH in opensm attempts to use as few layers
3355 as possible. This number can be less than the number of actual layers
3356 available.
3357
3358 In general LASH is a very flexible algorithm. It can, for example,
3359 reduce to Dimension Order Routing in certain topologies, it is topology
3360 agnostic and fares well in the face of faults.
3361
3362 It has been shown that for both regular and irregular topologies, LASH
3363 outperforms Up/Down. The reason for this is that LASH distributes the
3364 traffic more evenly through a network, avoiding the bottleneck issues
3365 related to a root node and always routes shortest-path.
3366
3367 The algorithm was developed by Simula Research Laboratory.
3368
3369
3370 Use '-R lash -Q ' option to activate the LASH algorithm.
3371
3372 Note: QoS support has to be turned on in order that SL/VL mappings are
3373 used.
3374
3375 Note: LMC &gt; 0 is not supported by the LASH routing. If this is
3376 specified, the default routing algorithm is invoked instead.
3377
3378 For open regular cartesian meshes the DOR algorithm is the ideal
3379 routing algorithm. For toroidal meshes on the other hand there
3380 are routing loops that can cause deadlocks. LASH can be used to
3381 route these cases. The performance of LASH can be improved by
3382 preconditioning the mesh in cases where there are multiple links
3383 connecting switches and also in cases where the switches are not
3384 cabled consistently. An option exists for LASH to do this. To
3385 invoke this use '-R lash -Q --do_mesh_analysis'. This will
3386 add an additional phase that analyses the mesh to try to determine
3387 the dimension and size of a mesh. If it determines that the mesh
3388 looks like an open or closed cartesian mesh it reorders the ports
3389 in dimension order before the rest of the LASH algorithm runs.
3390
3391 DOR Routing Algorithm
3392
3393 The Dimension Order Routing algorithm is based on the Min Hop
3394 algorithm and so uses shortest paths.  Instead of spreading traffic
3395 out across different paths with the same shortest distance, it chooses
3396 among the available shortest paths based on an ordering of dimensions.
3397 Each port must be consistently cabled to represent a hypercube
3398 dimension or a mesh dimension.  Paths are grown from a destination
3399 back to a source using the lowest dimension (port) of available paths
3400 at each step.  This provides the ordering necessary to avoid deadlock.
3401 When there are multiple links between any two switches, they still
3402 represent only one dimension and traffic is balanced across them
3403 unless port equalization is turned off.  In the case of hypercubes,
3404 the same port must be used throughout the fabric to represent the
3405 hypercube dimension and match on both ends of the cable.  In the case
3406 of meshes, the dimension should consistently use the same pair of
3407 ports, one port on one end of the cable, and the other port on the
3408 other end, continuing along the mesh dimension.
3409
3410 Use '-R dor' option to activate the DOR algorithm.
3411
3412
3413 Routing References
3414
3415 To learn more about deadlock-free routing, see the article
3416 &quot;Deadlock Free Message Routing in Multiprocessor Interconnection Networks&quot;
3417 by William J Dally and Charles L Seitz (1985).
3418
3419 To learn more about the up/down algorithm, see the article
3420 &quot;Effective Strategy to Compute Forwarding Tables for InfiniBand Networks&quot;
3421 by Jose Carlos Sancho, Antonio Robles, and Jose Duato at the
3422 Universidad Politecnica de Valencia.
3423
3424 To learn more about LASH and the flexibility behind it, the requirement
3425 for layers, performance comparisons to other algorithms, see the
3426 following articles:
3427
3428 &quot;Layered Routing in Irregular Networks&quot;, Lysne et al, IEEE
3429 Transactions on Parallel and Distributed Systems, VOL.16, No12,
3430 December 2005.
3431
3432 &quot;Routing for the ASI Fabric Manager&quot;, Solheim et al. IEEE
3433 Communications Magazine, Vol.44, No.7, July 2006.
3434
3435 &quot;Layered Shortest Path (LASH) Routing in Irregular System Area
3436 Networks&quot;, Skeie et al. IEEE Computer Society Communication
3437 Architecture for Clusters 2002.
3438
3439
3440 Modular Routine Engine
3441
3442 Modular routing engine structure allows for the ease of
3443 &quot;plugging&quot; new routing modules.
3444
3445 Currently, only unicast callbacks are supported. Multicast
3446 can be added later.
3447
3448 One existing routing module is up-down &quot;updn&quot;, which may be
3449 activated with '-R updn' option (instead of old '-u').
3450
3451 General usage is:
3452 $ opensm -R 'module-name'
3453
3454 There is also a trivial routing module which is able
3455 to load LFT tables from a file.
3456
3457 Main features:
3458
3459 <BR>&nbsp;-&nbsp;this&nbsp;will&nbsp;load&nbsp;switch&nbsp;LFTs&nbsp;and/or&nbsp;LID&nbsp;matrices&nbsp;(min&nbsp;hops&nbsp;tables)
3460 <BR>&nbsp;-&nbsp;this&nbsp;will&nbsp;load&nbsp;switch&nbsp;LFTs&nbsp;according&nbsp;to&nbsp;the&nbsp;path&nbsp;entries&nbsp;introduced
3461 <BR>&nbsp;&nbsp;&nbsp;in&nbsp;the&nbsp;file
3462 <BR>&nbsp;-&nbsp;no&nbsp;additional&nbsp;checks&nbsp;will&nbsp;be&nbsp;performed&nbsp;(such&nbsp;as&nbsp;&quot;is&nbsp;port&nbsp;connected&quot;,
3463 <BR>&nbsp;&nbsp;&nbsp;etc.)
3464 <BR>&nbsp;-&nbsp;in&nbsp;case&nbsp;when&nbsp;fabric&nbsp;LIDs&nbsp;were&nbsp;changed&nbsp;this&nbsp;will&nbsp;try&nbsp;to&nbsp;reconstruct
3465 <BR>&nbsp;&nbsp;&nbsp;LFTs&nbsp;correctly&nbsp;if&nbsp;endport&nbsp;GUIDs&nbsp;are&nbsp;represented&nbsp;in&nbsp;the&nbsp;file
3466 <BR>&nbsp;&nbsp;&nbsp;(in&nbsp;order&nbsp;to&nbsp;disable&nbsp;this,&nbsp;GUIDs&nbsp;may&nbsp;be&nbsp;removed&nbsp;from&nbsp;the&nbsp;file
3467 <BR>&nbsp;&nbsp;&nbsp;&nbsp;or&nbsp;zeroed)
3468
3469 The file format is compatible with output of 'ibroute' util and for
3470 whole fabric can be generated with dump_lfts.sh script.
3471
3472 To activate file based routing module, use:
3473
3474 <BR>&nbsp;&nbsp;opensm&nbsp;-R&nbsp;file&nbsp;-U&nbsp;\path\to\lfts_file
3475
3476 If the lfts_file is not found or is in error, the default routing
3477 algorithm is utilized.
3478
3479 The ability to dump switch lid matrices (aka min hops tables) to file and
3480 later to load these is also supported.
3481
3482 The usage is similar to unicast forwarding tables loading from a lfts
3483 file (introduced by 'file' routing engine), but new lid matrix file
3484 name should be specified by -M or --lid_matrix_file option. For example:
3485
3486 <BR>&nbsp;&nbsp;opensm&nbsp;-R&nbsp;file&nbsp;-M&nbsp;./opensm-lid-matrix.dump
3487
3488 The dump file is named 'opensm-lid-matrix.dump' and will be generated
3489 in standard opensm dump directory (/var/log by default) when
3490 OSM_LOG_ROUTING logging flag is set.
3491
3492 When routing engine 'file' is activated, but the lfts file is not specified
3493 or not cannot be open default lid matrix algorithm will be used.
3494
3495 There is also a switch forwarding tables dumper which generates
3496 a file compatible with dump_lfts.sh output. This file can be used
3497 as input for forwarding tables loading by 'file' routing engine.
3498 Both or one of options -U and -M can be specified together with '-R file'.
3499
3500 <A NAME="lbAL">&nbsp;</A>
3501 <h3>FILES</h3>
3502
3503 <DL COMPACT>
3504 <DT><B>%ProgramFiles\WinOF\OpenSM\opensm.conf</B>
3505
3506 <DD>
3507 default OpenSM config file.
3508
3509 <DT><B>%ProgramFiles\WinOF\OpenSM\ib-node-name-map.conf</B><DD>
3510 default node name map file.  See ibnetdiscover for more information on format.
3511
3512 <DT><B>%ProgramFiles\WinOF\OpenSM\partitions.conf</B>
3513
3514 <DD>
3515 default partition config file
3516
3517 <DT><B>%ProgramFiles\WinOF\OpenSM\qos-policy.conf</B>
3518
3519 <DD>
3520 default QOS policy config file
3521
3522 <DT><B>%ProgramFiles\WinOF\OpenSM\prefix-routes.conf</B>
3523
3524 <DD>
3525 default prefix routes file.
3526
3527 </DL>
3528 <h3>AUTHORS</h3>
3529
3530 <DL COMPACT>
3531 <DT>Hal Rosenstock<DD>
3532 &lt;<I><A HREF="mailto:hal.rosenstock@gmail.com">hal.rosenstock@gmail.com</A></I>&gt;
3533
3534 <DT>Sasha Khapyorsky<DD>
3535 &lt;<I><A HREF="mailto:sashak@voltaire.com">sashak@voltaire.com</A></I>&gt;
3536
3537 <DT>Eitan Zahavi<DD>
3538 &lt;<I><A HREF="mailto:eitan@mellanox.co.il">eitan@mellanox.co.il</A></I>&gt;
3539
3540 <DT>Yevgeny Kliteynik<DD>
3541 &lt;<I><A HREF="mailto:kliteyn@mellanox.co.il">kliteyn@mellanox.co.il</A></I>&gt;
3542
3543 <DT>Thomas Sodring<DD>
3544 &lt;<I><A HREF="mailto:tsodring@simula.no">tsodring@simula.no</A></I>&gt;
3545
3546 <DT>Ira Weiny<DD>
3547 &lt;<I><A HREF="mailto:weiny2@llnl.gov">weiny2@llnl.gov</A></I>&gt;
3548
3549 <DT>Stan Smith<DD>
3550 &lt;<a href="mailto:weiny2@llnl.gov"><i>stan.smith</i></a><I><A HREF="mailto:weiny2@llnl.gov">@intel.com</A></I>&gt;</DL>
3551
3552 <h4 align="left"><a href="#TOP"><font color="#000000">&lt;return-to-top&gt;</font></a></h4>\r
3553 <h3 align="left">&nbsp;</h3>\r
3554 <h2 align="left"><a name="osmtest"></a><br>\r
3555 Osmtest - Subnet Management Tests</h2>\r
3556 <p align="left">osmtest - InfiniBand subnet manager and administration (SM/SA) \r
3557 test program<br>\r
3558 <br>\r
3559 osmtest currently can not \r
3560 run on the same HCA port which OpenSM is currently using.</p>\r
3561         <h3>SYNOPSIS</h3>\r
3562         <b>osmtest</b> [-f(low) &lt;c|a|v|s|e|f|m|q|t&gt;] [-w(ait) &lt;trap_wait_time&gt;] [-d(ebug) \r
3563         &lt;number&gt;] [-m(ax_lid) &lt;LID in hex&gt;] [-g(uid)[=]&lt;GUID in hex&gt;] [-p(ort)] [-i(nventory) \r
3564         &lt;filename&gt;] [-s(tress)] [-M(ulticast_Mode)] [-t(imeout) &lt;milliseconds&gt;] [-l \r
3565         | --log_file] [-v] [-vf &lt;flags&gt;] [-h(elp)] <a name="lbAD">&nbsp;</a> \r
3566         <h3>DESCRIPTION</h3>\r
3567         <p>osmtest is a test program to validate InfiniBand subnet manager and \r
3568         administration (SM/SA). Default is to run all flows with the exception of \r
3569         the QoS flow. osmtest provides a test suite for opensm. osmtest has the \r
3570         following capabilities and testing flows: It creates an inventory file of \r
3571         all available Nodes, Ports, and PathRecords, including all their fields. It \r
3572         verifies the existing inventory, with all the object fields, and matches it \r
3573         to a pre-saved one. A Multicast Compliancy test. An Event Forwarding test. A \r
3574         Service Record registration test. An RMPP stress test. A Small SA Queries \r
3575         stress test. It is recommended that after installing opensm, the user should \r
3576         run &quot;osmtest -f c&quot; to generate the inventory file, and immediately \r
3577         afterwards run &quot;osmtest -f a&quot; to test OpenSM. Another recommendation for \r
3578         osmtest usage is to create the inventory when the IB fabric is stable, and \r
3579         occasionally run &quot;osmtest -v&quot; to verify that nothing has changed.\r
3580         <a name="lbAE">&nbsp;</a> </p>\r
3581         <h3>OPTIONS</h3>\r
3582         <dl compact>\r
3583                 <dt><b>-f</b>, <b>--flow</b> </dt>\r
3584                 <dd>This option directs osmtest to run a specific flow: <br>\r
3585                 &nbsp;FLOW&nbsp;&nbsp;DESCRIPTION <br>\r
3586                 &nbsp;c&nbsp;=&nbsp;create&nbsp;an&nbsp;inventory&nbsp;file&nbsp;with&nbsp;all&nbsp;nodes,&nbsp;ports&nbsp;and&nbsp;paths <br>\r
3587                 &nbsp;a&nbsp;=&nbsp;run&nbsp;all&nbsp;validation&nbsp;tests&nbsp;(expecting&nbsp;an&nbsp;input&nbsp;inventory) <br>\r
3588                 &nbsp;v&nbsp;=&nbsp;only&nbsp;validate&nbsp;the&nbsp;given&nbsp;inventory&nbsp;file <br>\r
3589                 &nbsp;s&nbsp;=&nbsp;run&nbsp;service&nbsp;registration,&nbsp;deregistration,&nbsp;and&nbsp;lease&nbsp;test <br>\r
3590                 &nbsp;e&nbsp;=&nbsp;run&nbsp;event&nbsp;forwarding&nbsp;test <br>\r
3591                 &nbsp;f&nbsp;=&nbsp;flood&nbsp;the&nbsp;SA&nbsp;with&nbsp;queries&nbsp;according&nbsp;to&nbsp;the&nbsp;stress&nbsp;mode <br>\r
3592                 &nbsp;m&nbsp;=&nbsp;multicast&nbsp;flow <br>\r
3593                 &nbsp;q&nbsp;=&nbsp;QoS&nbsp;info:&nbsp;dump&nbsp;VLArb&nbsp;and&nbsp;SLtoVL&nbsp;tables <br>\r
3594                 &nbsp;t&nbsp;=&nbsp;run&nbsp;trap&nbsp;64/65&nbsp;flow&nbsp;(this&nbsp;flow&nbsp;requires&nbsp;running&nbsp;of&nbsp;external&nbsp;tool)\r
3595                 <br>\r
3596                 &nbsp;(default&nbsp;is&nbsp;all&nbsp;flows&nbsp;except&nbsp;QoS) \r
3597                 </dd>\r
3598                 <dt><b>-w</b>, <b>--wait</b> </dt>\r
3599                 <dd>This option specifies the wait time for trap 64/65 in seconds It is \r
3600                 used only when running -f t - the trap 64/65 flow (default to 10 sec) \r
3601                 </dd>\r
3602                 <dt><b>-d</b>, <b>--debug</b> </dt>\r
3603                 <dd>This option specifies a debug option. These options are not normally \r
3604                 needed. The number following -d selects the debug option to enable as \r
3605                 follows: <br>\r
3606                 &nbsp;OPT&nbsp;&nbsp;&nbsp;Description <br>\r
3607                 &nbsp;---&nbsp;&nbsp;&nbsp;&nbsp;----------------- <br>\r
3608                 &nbsp;-d0&nbsp;&nbsp;-&nbsp;Ignore&nbsp;other&nbsp;SM&nbsp;nodes <br>\r
3609                 &nbsp;-d1&nbsp;&nbsp;-&nbsp;Force&nbsp;single&nbsp;threaded&nbsp;dispatching <br>\r
3610                 &nbsp;-d2&nbsp;&nbsp;-&nbsp;Force&nbsp;log&nbsp;flushing&nbsp;after&nbsp;each&nbsp;log&nbsp;message <br>\r
3611                 &nbsp;-d3&nbsp;&nbsp;-&nbsp;Disable&nbsp;multicast&nbsp;support \r
3612                 </dd>\r
3613                 <dt><b>-m</b>, <b>--max_lid</b> </dt>\r
3614                 <dd>This option specifies the maximal LID number to be searched for \r
3615                 during inventory file build (default to 100) \r
3616                 </dd>\r
3617                 <dt><b>-g</b>, <b>--guid</b> </dt>\r
3618                 <dd>This option specifies the local port GUID value with which OpenSM \r
3619                 should bind. OpenSM may be bound to 1 port at a time. If GUID given is \r
3620                 0, OpenSM displays a list of possible port GUIDs and waits for user \r
3621                 input. Without -g, OpenSM trys to use the default port. \r
3622                 </dd>\r
3623                 <dt><b>-p</b>, <b>--port</b> </dt>\r
3624                 <dd>This option displays a menu of possible local port GUID values with \r
3625                 which osmtest could bind \r
3626                 </dd>\r
3627                 <dt><b>-i</b>, <b>--inventory</b> </dt>\r
3628                 <dd>This option specifies the name of the inventory file Normally, \r
3629                 osmtest expects to find an inventory file, which osmtest uses to \r
3630                 validate real-time information received from the SA during testing If -i \r
3631                 is not specified, osmtest defaults to the file 'osmtest.dat' See -c \r
3632                 option for related information \r
3633                 </dd>\r
3634                 <dt><b>-s</b>, <b>--stress</b> </dt>\r
3635                 <dd>This option runs the specified stress test instead of the normal \r
3636                 test suite Stress test options are as follows: <br>\r
3637                 &nbsp;OPT&nbsp;&nbsp;&nbsp;&nbsp;Description <br>\r
3638                 &nbsp;---&nbsp;&nbsp;&nbsp;&nbsp;----------------- <br>\r
3639                 &nbsp;-s1&nbsp;&nbsp;-&nbsp;Single-MAD&nbsp;(RMPP)&nbsp;response&nbsp;SA&nbsp;queries <br>\r
3640                 &nbsp;-s2&nbsp;&nbsp;-&nbsp;Multi-MAD&nbsp;(RMPP)&nbsp;response&nbsp;SA&nbsp;queries <br>\r
3641                 &nbsp;-s3&nbsp;&nbsp;-&nbsp;Multi-MAD&nbsp;(RMPP)&nbsp;Path&nbsp;Record&nbsp;SA&nbsp;queries <br>\r
3642                 &nbsp;-s4&nbsp;&nbsp;-&nbsp;Single-MAD&nbsp;(non&nbsp;RMPP)&nbsp;get&nbsp;Path&nbsp;Record&nbsp;SA&nbsp;queries Without -s, \r
3643                 stress testing is not performed \r
3644                 </dd>\r
3645                 <dt><b>-M</b>, <b>--Multicast_Mode</b> </dt>\r
3646                 <dd>This option specify length of Multicast test: <br>\r
3647                 &nbsp;OPT&nbsp;&nbsp;&nbsp;&nbsp;Description <br>\r
3648                 &nbsp;---&nbsp;&nbsp;&nbsp;&nbsp;----------------- <br>\r
3649                 &nbsp;-M1&nbsp;&nbsp;-&nbsp;Short&nbsp;Multicast&nbsp;Flow&nbsp;(default)&nbsp;-&nbsp;single&nbsp;mode <br>\r
3650                 &nbsp;-M2&nbsp;&nbsp;-&nbsp;Short&nbsp;Multicast&nbsp;Flow&nbsp;-&nbsp;multiple&nbsp;mode <br>\r
3651                 &nbsp;-M3&nbsp;&nbsp;-&nbsp;Long&nbsp;Multicast&nbsp;Flow&nbsp;-&nbsp;single&nbsp;mode <br>\r
3652                 &nbsp;-M4&nbsp;&nbsp;-&nbsp;Long&nbsp;Multicast&nbsp;Flow&nbsp;-&nbsp;multiple&nbsp;mode Single mode - Osmtest is \r
3653                 tested alone, with no other apps that interact with OpenSM MC Multiple \r
3654                 mode - Could be run with other apps using MC with OpenSM. Without -M, \r
3655                 default flow testing is performed \r
3656                 </dd>\r
3657                 <dt><b>-t</b>, <b>--timeout</b> </dt>\r
3658                 <dd>This option specifies the time in milliseconds used for transaction \r
3659                 timeouts. Specifying -t 0 disables timeouts. Without -t, OpenSM defaults \r
3660                 to a timeout value of 200 milliseconds. \r
3661                 </dd>\r
3662                 <dt><b>-l</b>, <b>--log_file</b> </dt>\r
3663                 <dd>This option defines the log to be the given file. By default the log \r
3664                 goes to stdout. \r
3665                 </dd>\r
3666                 <dt><b>-v</b>, <b>--verbose</b> </dt>\r
3667                 <dd>This option increases the log verbosity level. The -v option may be \r
3668                 specified multiple times to further increase the verbosity level. See \r
3669                 the -vf option for more information about. log verbosity. \r