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

   1 .\" Man page generated from reStructuredText.
   2 .
   3 .TH SMPQUERY 8 "" "" "Open IB Diagnostics"
   4 .SH NAME
   5 SMPQUERY \-
   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 INFINIBAND SUBNET MANAGEMENT ATTRIBUTES
  34 .SS SYNOPSIS
  35 .sp
  36 smpquery [options] <op> <dest dr_path|lid|guid> [op params]
  37 .SS DESCRIPTION
  38 .sp
  39 smpquery allows a basic subset of standard SMP queries including the following:
  40 node info, node description, switch info, port info. Fields are displayed in
  41 human readable format.
  42 .SS OPTIONS
  43 .sp
  44 Current supported operations (case insensitive) and their parameters:
  45 .INDENT 0.0
  46 .INDENT 3.5
  47 .sp
  48 .nf
  49 .ft C
  50 Nodeinfo (NI) <addr>
  51
  52 Nodedesc (ND) <addr>
  53
  54 Portinfo (PI) <addr> [<portnum>]     # default port is zero
  55
  56 PortInfoExtended (PIE) <addr> [<portnum>]
  57
  58 Switchinfo (SI) <addr>
  59
  60 PKeyTable (PKeys) <addr> [<portnum>]
  61
  62 SL2VLTable (SL2VL) <addr> [<portnum>]
  63
  64 VLArbitration (VLArb) <addr> [<portnum>]
  65
  66 GUIDInfo (GI) <addr>
  67
  68 MlnxExtPortInfo (MEPI) <addr> [<portnum>]  # default port is zero
  69 .ft P
  70 .fi
  71 .UNINDENT
  72 .UNINDENT
  73 .INDENT 0.0
  74 .TP
  75 .B \fB\-c, \-\-combined\fP
  76 Use Combined route address argument \fB<lid> <DR_Path>\fP
  77 .TP
  78 .B \fB\-x, \-\-extended\fP
  79 Set SMSupportsExtendedSpeeds bit 31 in AttributeModifier
  80 (only impacts PortInfo queries).
  81 .UNINDENT
  82 .\" Define the common option -K
  83 .
  84 .INDENT 0.0
  85 .TP
  86 .B \fB\-K, \-\-show_keys\fP
  87 show security keys (mkey, smkey, etc.) associated with the request.
  88 .UNINDENT
  89 .SS Addressing Flags
  90 .\" Define the common option -D for Directed routes
  91 .
  92 .sp
  93 \fB\-D, \-\-Direct\fP     The address specified is a directed route
  94 .INDENT 0.0
  95 .INDENT 3.5
  96 .sp
  97 .nf
  98 .ft C
  99 Examples:
 100    [options] \-D [options] "0"          # self port
 101    [options] \-D [options] "0,1,2,1,4"  # out via port 1, then 2, ...
 102
 103    (Note the second number in the path specified must match the port being
 104    used.  This can be specified using the port selection flag \(aq\-P\(aq or the
 105    port found through the automatic selection process.)
 106 .ft P
 107 .fi
 108 .UNINDENT
 109 .UNINDENT
 110 .\" Define the common option -G
 111 .
 112 .sp
 113 \fB\-G, \-\-Guid\fP     The address specified is a Port GUID
 114 .\" Define the common option -L
 115 .
 116 .sp
 117 \fB\-L, \-\-Lid\fP   The address specified is a LID
 118 .\" Define the common option -s
 119 .
 120 .sp
 121 \fB\-s, \-\-sm_port <smlid>\fP     use \(aqsmlid\(aq as the target lid for SA queries.
 122 .SS Port Selection flags
 123 .\" Define the common option -C
 124 .
 125 .sp
 126 \fB\-C, \-\-Ca <ca_name>\fP    use the specified ca_name.
 127 .\" Define the common option -P
 128 .
 129 .sp
 130 \fB\-P, \-\-Port <ca_port>\fP    use the specified ca_port.
 131 .\" Explanation of local port selection
 132 .
 133 .SS Local port Selection
 134 .sp
 135 Multiple port/Multiple CA support: when no IB device or port is specified
 136 (see the "local umad parameters" below), the libibumad library
 137 selects the port to use by the following criteria:
 138 .INDENT 0.0
 139 .INDENT 3.5
 140 .INDENT 0.0
 141 .IP 1. 3
 142 the first port that is ACTIVE.
 143 .IP 2. 3
 144 if not found, the first port that is UP (physical link up).
 145 .UNINDENT
 146 .sp
 147 If a port and/or CA name is specified, the libibumad library attempts
 148 to fulfill the user request, and will fail if it is not possible.
 149 .sp
 150 For example:
 151 .INDENT 0.0
 152 .INDENT 3.5
 153 .sp
 154 .nf
 155 .ft C
 156 ibaddr                 # use the first port (criteria #1 above)
 157 ibaddr \-C mthca1       # pick the best port from "mthca1" only.
 158 ibaddr \-P 2            # use the second (active/up) port from the first available IB device.
 159 ibaddr \-C mthca0 \-P 2  # use the specified port only.
 160 .ft P
 161 .fi
 162 .UNINDENT
 163 .UNINDENT
 164 .UNINDENT
 165 .UNINDENT
 166 .SS Debugging flags
 167 .\" Define the common option -d
 168 .
 169 .INDENT 0.0
 170 .TP
 171 .B \-d
 172 raise the IB debugging level.
 173 May be used several times (\-ddd or \-d \-d \-d).
 174 .UNINDENT
 175 .\" Define the common option -e
 176 .
 177 .INDENT 0.0
 178 .TP
 179 .B \-e
 180 show send and receive errors (timeouts and others)
 181 .UNINDENT
 182 .\" Define the common option -h
 183 .
 184 .sp
 185 \fB\-h, \-\-help\fP      show the usage message
 186 .\" Define the common option -v
 187 .
 188 .INDENT 0.0
 189 .TP
 190 .B \fB\-v, \-\-verbose\fP
 191 increase the application verbosity level.
 192 May be used several times (\-vv or \-v \-v \-v)
 193 .UNINDENT
 194 .\" Define the common option -V
 195 .
 196 .sp
 197 \fB\-V, \-\-version\fP     show the version info.
 198 .SS Configuration flags
 199 .\" Define the common option -t
 200 .
 201 .sp
 202 \fB\-t, \-\-timeout <timeout_ms>\fP override the default timeout for the solicited mads.
 203 .\" Define the common option --node-name-map
 204 .
 205 .sp
 206 \fB\-\-node\-name\-map <node\-name\-map>\fP Specify a node name map.
 207 .INDENT 0.0
 208 .INDENT 3.5
 209 This file maps GUIDs to more user friendly names.  See FILES section.
 210 .UNINDENT
 211 .UNINDENT
 212 .\" Define the common option -y
 213 .
 214 .INDENT 0.0
 215 .TP
 216 .B \fB\-y, \-\-m_key <key>\fP
 217 use the specified M_key for requests. If non\-numeric value (like \(aqx\(aq)
 218 is specified then a value will be prompted for.
 219 .UNINDENT
 220 .\" Define the common option -z
 221 .
 222 .sp
 223 \fB\-\-config, \-z  <config_file>\fP Specify alternate config file.
 224 .INDENT 0.0
 225 .INDENT 3.5
 226 Default: /etc/infiniband-diags/ibdiag.conf
 227 .UNINDENT
 228 .UNINDENT
 229 .SS FILES
 230 .\" Common text for the config file
 231 .
 232 .SS CONFIG FILE
 233 .sp
 234 /etc/infiniband-diags/ibdiag.conf
 235 .sp
 236 A global config file is provided to set some of the common options for all
 237 tools.  See supplied config file for details.
 238 .\" Common text to describe the node name map file.
 239 .
 240 .SS NODE NAME MAP FILE FORMAT
 241 .sp
 242 The node name map is used to specify user friendly names for nodes in the
 243 output.  GUIDs are used to perform the lookup.
 244 .sp
 245 This functionality is provided by the opensm\-libs package.  See \fBopensm(8)\fP
 246 for the file location for your installation.
 247 .sp
 248 \fBGenerically:\fP
 249 .INDENT 0.0
 250 .INDENT 3.5
 251 .sp
 252 .nf
 253 .ft C
 254 # comment
 255 <guid> "<name>"
 256 .ft P
 257 .fi
 258 .UNINDENT
 259 .UNINDENT
 260 .sp
 261 \fBExample:\fP
 262 .INDENT 0.0
 263 .INDENT 3.5
 264 .sp
 265 .nf
 266 .ft C
 267 # IB1
 268 # Line cards
 269 0x0008f104003f125c "IB1 (Rack 11 slot 1   ) ISR9288/ISR9096 Voltaire sLB\-24D"
 270 0x0008f104003f125d "IB1 (Rack 11 slot 1   ) ISR9288/ISR9096 Voltaire sLB\-24D"
 271 0x0008f104003f10d2 "IB1 (Rack 11 slot 2   ) ISR9288/ISR9096 Voltaire sLB\-24D"
 272 0x0008f104003f10d3 "IB1 (Rack 11 slot 2   ) ISR9288/ISR9096 Voltaire sLB\-24D"
 273 0x0008f104003f10bf "IB1 (Rack 11 slot 12  ) ISR9288/ISR9096 Voltaire sLB\-24D"
 274
 275 # Spines
 276 0x0008f10400400e2d "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB\-12D"
 277 0x0008f10400400e2e "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB\-12D"
 278 0x0008f10400400e2f "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB\-12D"
 279 0x0008f10400400e31 "IB1 (Rack 11 spine 2   ) ISR9288 Voltaire sFB\-12D"
 280 0x0008f10400400e32 "IB1 (Rack 11 spine 2   ) ISR9288 Voltaire sFB\-12D"
 281
 282 # GUID   Node Name
 283 0x0008f10400411a08 "SW1  (Rack  3) ISR9024 Voltaire 9024D"
 284 0x0008f10400411a28 "SW2  (Rack  3) ISR9024 Voltaire 9024D"
 285 0x0008f10400411a34 "SW3  (Rack  3) ISR9024 Voltaire 9024D"
 286 0x0008f104004119d0 "SW4  (Rack  3) ISR9024 Voltaire 9024D"
 287 .ft P
 288 .fi
 289 .UNINDENT
 290 .UNINDENT
 291 .SS EXAMPLES
 292 .INDENT 0.0
 293 .TP
 294 .B ::
 295 smpquery portinfo 3 1                     # portinfo by lid, with port modifier
 296 smpquery \-G switchinfo 0x2C9000100D051 1  # switchinfo by guid
 297 smpquery \-D nodeinfo 0                    # nodeinfo by direct route
 298 smpquery \-c nodeinfo 6 0,12               # nodeinfo by combined route
 299 .UNINDENT
 300 .SS SEE ALSO
 301 .sp
 302 smpdump (8)
 303 .SS AUTHOR
 304 .INDENT 0.0
 305 .TP
 306 .B Hal Rosenstock
 307 < \fI\%hal@mellanox.com\fP >
 308 .UNINDENT
 309 .\" Generated by docutils manpage writer.
 310 .