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

   1 .\" Man page generated from reStructuredText.
   2 .
   3 .TH IBSTAT 8 "" "" "Open IB Diagnostics"
   4 .SH NAME
   5 IBSTAT \-
   6 .
   7 .nr rst2man-indent-level 0
   8 .
   9 .de1 rstReportMargin
  10 \\$1 \\n[an-margin]
  11 level \\n[rst2man-indent-level]
  12 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  13 -
  14 \\n[rst2man-indent0]
  15 \\n[rst2man-indent1]
  16 \\n[rst2man-indent2]
  17 ..
  18 .de1 INDENT
  19 .\" .rstReportMargin pre:
  20 . RS \\$1
  21 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  22 . nr rst2man-indent-level +1
  23 .\" .rstReportMargin post:
  24 ..
  25 .de UNINDENT
  26 . RE
  27 .\" indent \\n[an-margin]
  28 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  29 .nr rst2man-indent-level -1
  30 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  31 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  32 ..
  33 .SH QUERY BASIC STATUS OF INFINIBAND DEVICE(S)
  34 .SS SYNOPSIS
  35 .sp
  36 ibstat [options] <ca_name> [portnum]
  37 .SS DESCRIPTION
  38 .sp
  39 ibstat is a binary which displays basic information obtained from the local
  40 IB driver. Output includes LID, SMLID, port state, link width active, and port
  41 physical state.
  42 .sp
  43 It is similar to the ibstatus utility but implemented as a binary rather
  44 than a script. It has options to list CAs and/or ports and displays more
  45 information than ibstatus.
  46 .SS OPTIONS
  47 .INDENT 0.0
  48 .TP
  49 .B \fB\-l, \-\-list_of_cas\fP
  50 list all IB devices
  51 .TP
  52 .B \fB\-s, \-\-short\fP
  53 short output
  54 .TP
  55 .B \fB\-p, \-\-port_list\fP
  56 show port list
  57 .TP
  58 .B \fBca_name\fP
  59 InfiniBand device name
  60 .TP
  61 .B \fBportnum\fP
  62 port number of InfiniBand device
  63 .UNINDENT
  64 .SS Debugging flags
  65 .\" Define the common option -d
  66 .
  67 .INDENT 0.0
  68 .TP
  69 .B \-d
  70 raise the IB debugging level.
  71 May be used several times (\-ddd or \-d \-d \-d).
  72 .UNINDENT
  73 .\" Define the common option -h
  74 .
  75 .sp
  76 \fB\-h, \-\-help\fP      show the usage message
  77 .\" Define the common option -v
  78 .
  79 .INDENT 0.0
  80 .TP
  81 .B \fB\-v, \-\-verbose\fP
  82 increase the application verbosity level.
  83 May be used several times (\-vv or \-v \-v \-v)
  84 .UNINDENT
  85 .\" Define the common option -V
  86 .
  87 .sp
  88 \fB\-V, \-\-version\fP     show the version info.
  89 .SS Configuration flags
  90 .\" Define the common option -z
  91 .
  92 .sp
  93 \fB\-\-config, \-z  <config_file>\fP Specify alternate config file.
  94 .INDENT 0.0
  95 .INDENT 3.5
  96 Default: /etc/infiniband-diags/ibdiag.conf
  97 .UNINDENT
  98 .UNINDENT
  99 .SS EXAMPLES
 100 .INDENT 0.0
 101 .TP
 102 .B ::
 103 ibstat            # display status of all ports on all IB devices
 104 ibstat \-l         # list all IB devices
 105 ibstat \-p         # show port guids
 106 ibstat mthca0 2   # show status of port 2 of \(aqmthca0\(aq
 107 .UNINDENT
 108 .SS SEE ALSO
 109 .sp
 110 ibstatus (8)
 111 .SS AUTHOR
 112 .INDENT 0.0
 113 .TP
 114 .B Hal Rosenstock
 115 < \fI\%halr@voltaire.com\fP >
 116 .UNINDENT
 117 .\" Generated by docutils manpage writer.
 118 .