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

   1 .TH IBSTAT 8 "July 25, 2006" "OpenIB" "OpenIB Diagnostics"
   2
   3 .SH NAME
   4 ibstat \- query basic status of InfiniBand device(s)
   5
   6 .SH SYNOPSIS
   7 .B ibstat
   8 [\-d(ebug)] [\-l(ist_of_cas)] [\-s(hort)] [\-p(ort_list)] [\-V(ersion)] [\-h] <ca_name> [portnum]
   9
  10 .SH DESCRIPTION
  11 .PP
  12 ibstat is a binary which displays basic information obtained from the local
  13 IB driver. Output includes LID, SMLID, port state, link width active, and port
  14 physical state.
  15
  16 It is similar to the ibstatus utility but implemented as a binary rather
  17 than a script. It has options to list CAs and/or ports and displays more
  18 information than ibstatus.
  19
  20 .SH OPTIONS
  21
  22 .PP
  23 .TP
  24 \fB\-l\fR, \fB\-\-list_of_cas\fR
  25 list all IB devices
  26 .TP
  27 \fB\-s\fR, \fB\-\-short\fR
  28 short output
  29 .TP
  30 \fB\-p\fR, \fB\-\-port_list\fR
  31 show port list
  32 .TP
  33 ca_name
  34 InfiniBand device name
  35 .TP
  36 portnum
  37 port number of InfiniBand device
  38
  39 .SH COMMON OPTIONS
  40
  41 Most OpenIB diagnostics take the following common flags. The exact list of
  42 supported flags per utility can be found in the usage message and can be shown
  43 using the util_name -h syntax.
  44
  45 # Debugging flags
  46 .PP
  47 \-d      raise the IB debugging level.
  48         May be used several times (-ddd or -d -d -d).
  49 .PP
  50 \-e      show send and receive errors (timeouts and others)
  51 .PP
  52 \-h      show the usage message
  53 .PP
  54 \-v      increase the application verbosity level.
  55         May be used several times (-vv or -v -v -v)
  56 .PP
  57 \-V      show the version info.
  58
  59 # Addressing flags
  60 .PP
  61 \-D      use directed path address arguments. The path
  62         is a comma separated list of out ports.
  63         Examples:
  64         "0"             # self port
  65         "0,1,2,1,4"     # out via port 1, then 2, ...
  66 .PP
  67 \-G      use GUID address argument. In most cases, it is the Port GUID.
  68         Example:
  69         "0x08f1040023"
  70 .PP
  71 \-s <smlid>      use 'smlid' as the target lid for SM/SA queries.
  72
  73 # Other common flags:
  74 .PP
  75 \-C <ca_name>    use the specified ca_name.
  76 .PP
  77 \-P <ca_port>    use the specified ca_port.
  78 .PP
  79 \-t <timeout_ms> override the default timeout for the solicited mads.
  80
  81 Multiple CA/Multiple Port Support
  82
  83 When no IB device or port is specified, the port to use is selected
  84 by the following criteria:
  85 .PP
  86 1. the first port that is ACTIVE.
  87 .PP
  88 2. if not found, the first port that is UP (physical link up).
  89
  90 If a port and/or CA name is specified, the user request is
  91 attempted to be fulfilled, and will fail if it is not possible.
  92
  93 .SH EXAMPLES
  94
  95 .PP
  96 ibstat            # display status of all ports on all IB devices
  97 .PP
  98 ibstat -l         # list all IB devices
  99 .PP
 100 ibstat -p         # show port guids
 101 .PP
 102 ibstat mthca0 2   # show status of port 2 of 'mthca0'
 103
 104 .SH SEE ALSO
 105 .BR ibstatus (8)
 106
 107 .SH AUTHOR
 108 .TP
 109 Hal Rosenstock
 110 .RI < halr@voltaire.com >