1OSMTEST(8) OpenIB Management OSMTEST(8)
2
6 osmtest - InfiniBand subnet manager and administration (SM/SA) test
7 program
8
11 osmtest [-f(low) <c|a|v|s|e|f|m|q|t>] [-w(ait) <trap_wait_time>]
12 [-d(ebug) <number>] [-m(ax_lid) <LID in hex>] [-g(uid)[=]<GUID in hex>]
13 [-p(ort)] [-i(nventory) <filename>] [-s(tress)] [-M(ulticast_Mode)]
14 [-t(imeout) <milliseconds>] [-l | --log_file] [-v] [-vf <flags>]
15 [-h(elp)]
16
19 osmtest is a test program to validate InfiniBand subnet manager and
20 administration (SM/SA).
21 Default is to run all flows with the exception of the QoS flow.
23 osmtest provides a test suite for opensm.
25 osmtest has the following capabilities and testing flows:
27 It creates an inventory file of all available Nodes, Ports, and
29 PathRecords, including all their fields. It verifies the existing
30 inventory, with all the object fields, and matches it to a pre-saved
31 one. A Multicast Compliancy test. An Event Forwarding test. A Ser‐
32 vice Record registration test. An RMPP stress test. A Small SA
33 Queries stress test.
34 It is recommended that after installing opensm, the user should run
36 "osmtest -f c" to generate the inventory file, and immediately after‐
37 wards run "osmtest -f a" to test OpenSM.
38 Another recommendation for osmtest usage is to create the inventory
40 when the IB fabric is stable, and occasionally run "osmtest -v" to ver‐
41 ify that nothing has changed.
42
45 -f, --flow
46 This option directs osmtest to run a specific flow:
47 FLOW DESCRIPTION
48 c = create an inventory file with all nodes, ports and paths
49 a = run all validation tests (expecting an input inventory)
50 v = only validate the given inventory file
51 s = run service registration, deregistration, and lease test
52 e = run event forwarding test
53 f = flood the SA with queries according to the stress mode
54 m = multicast flow
55 q = QoS info: dump VLArb and SLtoVL tables
56 t = run trap 64/65 flow (this flow requires running of external
57 tool)
58 (default is all flows except QoS)
59 -w, --wait
61 This option specifies the wait time for trap 64/65 in seconds It
62 is used only when running -f t - the trap 64/65 flow (default to
63 10 sec)
64 -d, --debug
66 This option specifies a debug option. These options are not
67 normally needed. The number following -d selects the debug
68 option to enable as follows:
69 OPT Description
71 --- -----------------
72 -d0 - Ignore other SM nodes
73 -d1 - Force single threaded dispatching
74 -d2 - Force log flushing after each log message
75 -d3 - Disable multicast support
76 -d4 - Use full world path record queries
77 -m, --max_lid
79 This option specifies the maximal LID number to be searched for
80 during inventory file build (default to 100)
81 -g, --guid
83 This option specifies the local port GUID value with which
84 OpenSM should bind. OpenSM may be bound to 1 port at a time.
85 If GUID given is 0, OpenSM displays a list of possible port
86 GUIDs and waits for user input. Without -g, OpenSM trys to use
87 the default port.
88 -p, --port
90 This option displays a menu of possible local port GUID values
91 with which osmtest could bind
92 -i, --inventory
94 This option specifies the name of the inventory file. Normally,
95 osmtest expects to find an inventory file, which osmtest uses to
96 validate real-time information received from the SA during test‐
97 ing If -i is not specified, osmtest defaults to the file
98 ´osmtest.dat´ See -f c option for related information
99 -s, --stress
101 This option runs the specified stress test instead of the normal
102 test suite Stress test options are as follows:
103 OPT Description
105 --- -----------------
106 -s1 - Single-MAD (RMPP) response SA queries
107 -s2 - Multi-MAD (RMPP) response SA queries
108 -s3 - Multi-MAD (RMPP) Path Record SA queries
109 -s4 - Single-MAD (non RMPP) get Path Record SA queries
110 Without -s, stress testing is not performed
112 -M, --Multicast_Mode
114 This option specify length of Multicast test:
115 OPT Description
117 --- -----------------
118 -M1 - Short Multicast Flow (default) - single mode
119 -M2 - Short Multicast Flow - multiple mode
120 -M3 - Long Multicast Flow - single mode
121 -M4 - Long Multicast Flow - multiple mode
122 Single mode - Osmtest is tested alone, with no other apps that
124 interact with OpenSM MC
125 Multiple mode - Could be run with other apps using MC with
127 OpenSM. Without -M, default flow testing is performed
128 -t, --timeout
130 This option specifies the time in milliseconds used for transac‐
131 tion timeouts. Specifying -t 0 disables timeouts. Without -t,
132 OpenSM defaults to a timeout value of 200 milliseconds.
133 -l, --log_file
135 This option defines the log to be the given file. By default
136 the log goes to stdout.
137 -v, --verbose
139 This option increases the log verbosity level. The -v option
140 may be specified multiple times to further increase the ver‐
141 bosity level. See the -vf option for more information about.
142 log verbosity.
143 -V This option sets the maximum verbosity level and forces log
145 flushing. The -V is equivalent to '-vf 0xFF -d 2'. See the -vf
146 option for more information about. log verbosity.
147 -vf This option sets the log verbosity level. A flags field must
149 follow the -D option. A bit set/clear in the flags enables/dis‐
150 ables a specific log level as follows:
151 BIT LOG LEVEL ENABLED
153 ---- -----------------
154 0x01 - ERROR (error messages)
155 0x02 - INFO (basic messages, low volume)
156 0x04 - VERBOSE (interesting stuff, moderate volume)
157 0x08 - DEBUG (diagnostic, high volume)
158 0x10 - FUNCS (function entry/exit, very high volume)
159 0x20 - FRAMES (dumps all SMP and GMP frames)
160 0x40 - ROUTING (dump FDB routing information)
161 0x80 - currently unused.
162 Without -vf, osmtest defaults to ERROR + INFO (0x3) Specifying
164 -vf 0 disables all messages Specifying -vf 0xFF enables all mes‐
165 sages (see -V) High verbosity levels may require increasing the
166 transaction timeout with the -t option
167 -h, --help
169 Display this usage info then exit.
170
173 Hal Rosenstock
174 <hal.rosenstock@gmail.com>
175 Eitan Zahavi
177 <eitan@mellanox.co.il>
178OpenIB March 9, 2013 OSMTEST(8)