contrib/ofed/management/opensm/man/osmtest.8

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