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