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

   1 .\" Man page generated from reStructuredText.
   2 .
   3 .TH IBADDR 8 "" "" "OpenIB Diagnostics"
   4 .SH NAME
   5 IBADDR \- query InfiniBand address(es)
   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 SYNOPSIS
  34 .sp
  35 ibaddr [options]
  36 .SH DESCRIPTION
  37 .sp
  38 Display the lid (and range) as well as the GID address of the
  39 port specified (by DR path, lid, or GUID) or the local port by default.
  40 .sp
  41 Note: this utility can be used as simple address resolver.
  42 .SH OPTIONS
  43 .sp
  44 \fB\-\-gid_show, \-g\fP
  45 show gid address only
  46 .sp
  47 \fB\-\-lid_show, \-l\fP
  48 show lid range only
  49 .sp
  50 \fB\-\-Lid_show, \-L\fP
  51 show lid range (in decimal) only
  52 .SS Addressing Flags
  53 .\" Define the common option -D for Directed routes
  54 .
  55 .sp
  56 \fB\-D, \-\-Direct\fP     The address specified is a directed route
  57 .INDENT 0.0
  58 .INDENT 3.5
  59 .sp
  60 .nf
  61 .ft C
  62 Examples:
  63    [options] \-D [options] "0"          # self port
  64    [options] \-D [options] "0,1,2,1,4"  # out via port 1, then 2, ...
  65
  66    (Note the second number in the path specified must match the port being
  67    used.  This can be specified using the port selection flag \(aq\-P\(aq or the
  68    port found through the automatic selection process.)
  69 .ft P
  70 .fi
  71 .UNINDENT
  72 .UNINDENT
  73 .\" Define the common option -G
  74 .
  75 .sp
  76 \fB\-G, \-\-Guid\fP     The address specified is a Port GUID
  77 .\" Define the common option -s
  78 .
  79 .sp
  80 \fB\-s, \-\-sm_port <smlid>\fP     use \(aqsmlid\(aq as the target lid for SA queries.
  81 .SS Debugging flags
  82 .\" Define the common option -d
  83 .
  84 .INDENT 0.0
  85 .TP
  86 .B \-d
  87 raise the IB debugging level.
  88 May be used several times (\-ddd or \-d \-d \-d).
  89 .UNINDENT
  90 .\" Define the common option -e
  91 .
  92 .INDENT 0.0
  93 .TP
  94 .B \-e
  95 show send and receive errors (timeouts and others)
  96 .UNINDENT
  97 .\" Define the common option -h
  98 .
  99 .sp
 100 \fB\-h, \-\-help\fP      show the usage message
 101 .\" Define the common option -v
 102 .
 103 .INDENT 0.0
 104 .TP
 105 .B \fB\-v, \-\-verbose\fP
 106 increase the application verbosity level.
 107 May be used several times (\-vv or \-v \-v \-v)
 108 .UNINDENT
 109 .\" Define the common option -V
 110 .
 111 .sp
 112 \fB\-V, \-\-version\fP     show the version info.
 113 .SS Port Selection flags
 114 .\" Define the common option -C
 115 .
 116 .sp
 117 \fB\-C, \-\-Ca <ca_name>\fP    use the specified ca_name.
 118 .\" Define the common option -P
 119 .
 120 .sp
 121 \fB\-P, \-\-Port <ca_port>\fP    use the specified ca_port.
 122 .\" Explanation of local port selection
 123 .
 124 .SS Local port Selection
 125 .sp
 126 Multiple port/Multiple CA support: when no IB device or port is specified
 127 (see the "local umad parameters" below), the libibumad library
 128 selects the port to use by the following criteria:
 129 .INDENT 0.0
 130 .INDENT 3.5
 131 .INDENT 0.0
 132 .IP 1. 3
 133 the first port that is ACTIVE.
 134 .IP 2. 3
 135 if not found, the first port that is UP (physical link up).
 136 .UNINDENT
 137 .sp
 138 If a port and/or CA name is specified, the libibumad library attempts
 139 to fulfill the user request, and will fail if it is not possible.
 140 .sp
 141 For example:
 142 .INDENT 0.0
 143 .INDENT 3.5
 144 .sp
 145 .nf
 146 .ft C
 147 ibaddr                 # use the first port (criteria #1 above)
 148 ibaddr \-C mthca1       # pick the best port from "mthca1" only.
 149 ibaddr \-P 2            # use the second (active/up) port from the first available IB device.
 150 ibaddr \-C mthca0 \-P 2  # use the specified port only.
 151 .ft P
 152 .fi
 153 .UNINDENT
 154 .UNINDENT
 155 .UNINDENT
 156 .UNINDENT
 157 .SS Configuration flags
 158 .\" Define the common option -y
 159 .
 160 .INDENT 0.0
 161 .TP
 162 .B \fB\-y, \-\-m_key <key>\fP
 163 use the specified M_key for requests. If non\-numeric value (like \(aqx\(aq)
 164 is specified then a value will be prompted for.
 165 .UNINDENT
 166 .\" Define the common option -t
 167 .
 168 .sp
 169 \fB\-t, \-\-timeout <timeout_ms>\fP override the default timeout for the solicited mads.
 170 .\" Define the common option -z
 171 .
 172 .sp
 173 \fB\-\-config, \-z  <config_file>\fP Specify alternate config file.
 174 .INDENT 0.0
 175 .INDENT 3.5
 176 Default: /etc/infiniband-diags/ibdiag.conf
 177 .UNINDENT
 178 .UNINDENT
 179 .SH FILES
 180 .\" Common text for the config file
 181 .
 182 .SS CONFIG FILE
 183 .sp
 184 /etc/infiniband-diags/ibdiag.conf
 185 .sp
 186 A global config file is provided to set some of the common options for all
 187 tools.  See supplied config file for details.
 188 .SH EXAMPLES
 189 .INDENT 0.0
 190 .INDENT 3.5
 191 .sp
 192 .nf
 193 .ft C
 194 ibaddr                  # local port\e\(aqs address
 195 ibaddr 32               # show lid range and gid of lid 32
 196 ibaddr \-G 0x8f1040023   # same but using guid address
 197 ibaddr \-l 32            # show lid range only
 198 ibaddr \-L 32            # show decimal lid range only
 199 ibaddr \-g 32            # show gid address only
 200 .ft P
 201 .fi
 202 .UNINDENT
 203 .UNINDENT
 204 .SH SEE ALSO
 205 .sp
 206 \fBibroute (8), ibtracert (8)\fP
 207 .SH AUTHOR
 208 .INDENT 0.0
 209 .TP
 210 .B Hal Rosenstock
 211 < \fI\%halr@voltaire.com\fP >
 212 .UNINDENT
 213 .\" Generated by docutils manpage writer.
 214 .