contrib/ofed/management/infiniband-diags/man/vendstat.8

   1 .TH VENDSTAT 8 "February 15, 2007" "OpenIB" "OpenIB Diagnostics"
   2
   3 .SH NAME
   4 vendstat \- query InfiniBand vendor specific functions
   5
   6 .SH SYNOPSIS
   7 .B vendstat
   8 [\-d(ebug)] [\-G(uid)] [\-N] [\-w] [\-C ca_name] [\-P ca_port] [\-t(imeout) timeout_ms] [\-V(ersion)] [\-h(elp)] <lid|guid>
   9
  10 .SH DESCRIPTION
  11 .PP
  12 vendstat uses vendor specific MADs to access beyond the IB spec
  13 vendor specific functionality. Currently, there is support only for
  14 Mellanox InfiniSwitch-III (IS3).
  15
  16 .SH OPTIONS
  17
  18 .PP
  19 .TP
  20 \fB\-N\fR
  21 show IS3 general information.
  22 .TP
  23 \fB\-w\fR
  24 show IS3 port xmit wait counters.
  25
  26 .SH COMMON OPTIONS
  27
  28 Most OpenIB diagnostics take the following common flags. The exact list of
  29 supported flags per utility can be found in the usage message and can be shown
  30 using the util_name -h syntax.
  31
  32 # Debugging flags
  33 .PP
  34 \-d      raise the IB debugging level.
  35         May be used several times (-ddd or -d -d -d).
  36 .PP
  37 \-e      show send and receive errors (timeouts and others)
  38 .PP
  39 \-h      show the usage message
  40 .PP
  41 \-v      increase the application verbosity level.
  42         May be used several times (-vv or -v -v -v)
  43 .PP
  44 \-V      show the version info.
  45
  46 # Addressing flags
  47 .PP
  48 \-G      use GUID address argument. In most cases, it is the Port GUID.
  49         Example:
  50         "0x08f1040023"
  51 .PP
  52 \-s <smlid>      use 'smlid' as the target lid for SM/SA queries.
  53
  54 # Other common flags:
  55 .PP
  56 \-C <ca_name>    use the specified ca_name.
  57 .PP
  58 \-P <ca_port>    use the specified ca_port.
  59 .PP
  60 \-t <timeout_ms> override the default timeout for the solicited mads.
  61
  62 Multiple CA/Multiple Port Support
  63
  64 When no IB device or port is specified, the port to use is selected
  65 by the following criteria:
  66 .PP
  67 1. the first port that is ACTIVE.
  68 .PP
  69 2. if not found, the first port that is UP (physical link up).
  70
  71 If a port and/or CA name is specified, the user request is
  72 attempted to be fulfilled, and will fail if it is not possible.
  73
  74 .SH EXAMPLES
  75
  76 .PP
  77 vendstat -N 6           # read IS3 general information
  78 .PP
  79 vendstat -w 6           # read IS3 port xmit wait counters
  80
  81 .SH AUTHOR
  82 .TP
  83 Hal Rosenstock
  84 .RI < halr@voltaire.com >