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

   1 .\" Man page generated from reStructuredText.
   2 .
   3 .TH SAQUERY 8 "" "" "Open IB Diagnostics"
   4 .SH NAME
   5 SAQUERY \-
   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 ADMINISTRATION ATTRIBUTES
  34 .SS SYNOPSIS
  35 .sp
  36 saquery [options] [<name> | <lid> | <guid>]
  37 .SS DESCRIPTION
  38 .sp
  39 saquery issues the selected SA query. Node records are queried by default.
  40 .SS OPTIONS
  41 .INDENT 0.0
  42 .TP
  43 .B \fB\-p\fP
  44 get PathRecord info
  45 .TP
  46 .B \fB\-N\fP
  47 get NodeRecord info
  48 .TP
  49 .B \fB\-D, \-\-list\fP
  50 get NodeDescriptions of CAs only
  51 .TP
  52 .B \fB\-S\fP
  53 get ServiceRecord info
  54 .TP
  55 .B \fB\-I\fP
  56 get InformInfoRecord (subscription) info
  57 .TP
  58 .B \fB\-L\fP
  59 return the Lids of the name specified
  60 .TP
  61 .B \fB\-l\fP
  62 return the unique Lid of the name specified
  63 .TP
  64 .B \fB\-G\fP
  65 return the Guids of the name specified
  66 .TP
  67 .B \fB\-O\fP
  68 return the name for the Lid specified
  69 .TP
  70 .B \fB\-U\fP
  71 return the name for the Guid specified
  72 .TP
  73 .B \fB\-c\fP
  74 get the SA\(aqs class port info
  75 .TP
  76 .B \fB\-s\fP
  77 return the PortInfoRecords with isSM or isSMdisabled capability mask bit on
  78 .TP
  79 .B \fB\-g\fP
  80 get multicast group info
  81 .TP
  82 .B \fB\-m\fP
  83 get multicast member info.  If a group is specified, limit the output
  84 to the group specified and print one line containing only the GUID and
  85 node description for each entry. Example: saquery \-m 0xc000
  86 .TP
  87 .B \fB\-x\fP
  88 get LinkRecord info
  89 .TP
  90 .B \fB\-\-src\-to\-dst <src:dst>\fP
  91 get a PathRecord for <src:dst>
  92 where src and dst are either node names or LIDs
  93 .TP
  94 .B \fB\-\-sgid\-to\-dgid <sgid:dgid>\fP
  95 get a PathRecord for \fBsgid\fP to \fBdgid\fP
  96 where both GIDs are in an IPv6 format acceptable to \fBinet_pton (3)\fP
  97 .TP
  98 .B \fB\-\-smkey <val>\fP
  99 use SM_Key value for the query. Will be used only with "trusted"
 100 queries.  If non\-numeric value (like \(aqx\(aq) is specified then saquery
 101 will prompt for a value.
 102 Default (when not specified here or in
 103 /etc/infiniband-diags/ibdiag.conf) is to use SM_Key == 0 (or
 104 "untrusted")
 105 .TP
 106 .B \fB\-\-sa-dgid <gid>\fP
 107 Set the destination GID (in IPv6 format) of the SA in the GRH of the request.
 108 Either the actual SM GID or the SA well known GID (0::2) can be used to include
 109 in the GRH of the SA queries.
 110 .UNINDENT
 111 .\" Define the common option -K
 112 .
 113 .INDENT 0.0
 114 .TP
 115 .B \fB\-K, \-\-show_keys\fP
 116 show security keys (mkey, smkey, etc.) associated with the request.
 117 .UNINDENT
 118 .sp
 119 \fB\-\-slid <lid>\fP Source LID (PathRecord)
 120 .sp
 121 \fB\-\-dlid <lid>\fP Destination LID (PathRecord)
 122 .sp
 123 \fB\-\-mlid <lid>\fP Multicast LID (MCMemberRecord)
 124 .sp
 125 \fB\-\-sgid <gid>\fP Source GID (IPv6 format) (PathRecord)
 126 .sp
 127 \fB\-\-dgid <gid>\fP Destination GID (IPv6 format) (PathRecord)
 128 .sp
 129 \fB\-\-gid <gid>\fP Port GID (MCMemberRecord)
 130 .sp
 131 \fB\-\-mgid <gid>\fP Multicast GID (MCMemberRecord)
 132 .sp
 133 \fB\-\-reversible\fP Reversible path (PathRecord)
 134 .sp
 135 \fB\-\-numb_path\fP Number of paths (PathRecord)
 136 .INDENT 0.0
 137 .TP
 138 .B \fB\-\-pkey\fP P_Key (PathRecord, MCMemberRecord). If non\-numeric value (like \(aqx\(aq)
 139 is specified then saquery will prompt for a value
 140 .UNINDENT
 141 .sp
 142 \fB\-\-qos_class\fP QoS Class (PathRecord)
 143 .sp
 144 \fB\-\-sl\fP Service level (PathRecord, MCMemberRecord)
 145 .sp
 146 \fB\-\-mtu\fP MTU and selector (PathRecord, MCMemberRecord)
 147 .sp
 148 \fB\-\-rate\fP Rate and selector (PathRecord, MCMemberRecord)
 149 .sp
 150 \fB\-\-pkt_lifetime\fP Packet lifetime and selector (PathRecord, MCMemberRecord)
 151 .INDENT 0.0
 152 .TP
 153 .B \fB\-\-qkey\fP Q_Key (MCMemberRecord). If non\-numeric value (like \(aqx\(aq) is specified
 154 then saquery will prompt for a value
 155 .UNINDENT
 156 .sp
 157 \fB\-\-tclass\fP Traffic Class (PathRecord, MCMemberRecord)
 158 .sp
 159 \fB\-\-flow_label\fP Flow Label (PathRecord, MCMemberRecord)
 160 .sp
 161 \fB\-\-hop_limit\fP Hop limit (PathRecord, MCMemberRecord)
 162 .sp
 163 \fB\-\-scope\fP Scope (MCMemberRecord)
 164 .sp
 165 \fB\-\-join_state\fP Join state (MCMemberRecord)
 166 .sp
 167 \fB\-\-proxy_join\fP Proxy join (MCMemberRecord)
 168 .sp
 169 \fB\-\-service_id\fP ServiceID (PathRecord)
 170 .sp
 171 Supported query names (and aliases):
 172 .INDENT 0.0
 173 .INDENT 3.5
 174 .sp
 175 .nf
 176 .ft C
 177 ClassPortInfo (CPI)
 178 NodeRecord (NR) [lid]
 179 PortInfoRecord (PIR) [[lid]/[port]/[options]]
 180 SL2VLTableRecord (SL2VL) [[lid]/[in_port]/[out_port]]
 181 PKeyTableRecord (PKTR) [[lid]/[port]/[block]]
 182 VLArbitrationTableRecord (VLAR) [[lid]/[port]/[block]]
 183 InformInfoRecord (IIR)
 184 LinkRecord (LR) [[from_lid]/[from_port]] [[to_lid]/[to_port]]
 185 ServiceRecord (SR)
 186 PathRecord (PR)
 187 MCMemberRecord (MCMR)
 188 LFTRecord (LFTR) [[lid]/[block]]
 189 MFTRecord (MFTR) [[mlid]/[position]/[block]]
 190 GUIDInfoRecord (GIR) [[lid]/[block]]
 191 SwitchInfoRecord (SWIR) [lid]
 192 SMInfoRecord (SMIR) [lid]
 193 .ft P
 194 .fi
 195 .UNINDENT
 196 .UNINDENT
 197 .SS Port Selection flags
 198 .\" Define the common option -C
 199 .
 200 .sp
 201 \fB\-C, \-\-Ca <ca_name>\fP    use the specified ca_name.
 202 .\" Define the common option -P
 203 .
 204 .sp
 205 \fB\-P, \-\-Port <ca_port>\fP    use the specified ca_port.
 206 .\" Explanation of local port selection
 207 .
 208 .SS Local port Selection
 209 .sp
 210 Multiple port/Multiple CA support: when no IB device or port is specified
 211 (see the "local umad parameters" below), the libibumad library
 212 selects the port to use by the following criteria:
 213 .INDENT 0.0
 214 .INDENT 3.5
 215 .INDENT 0.0
 216 .IP 1. 3
 217 the first port that is ACTIVE.
 218 .IP 2. 3
 219 if not found, the first port that is UP (physical link up).
 220 .UNINDENT
 221 .sp
 222 If a port and/or CA name is specified, the libibumad library attempts
 223 to fulfill the user request, and will fail if it is not possible.
 224 .sp
 225 For example:
 226 .INDENT 0.0
 227 .INDENT 3.5
 228 .sp
 229 .nf
 230 .ft C
 231 ibaddr                 # use the first port (criteria #1 above)
 232 ibaddr \-C mthca1       # pick the best port from "mthca1" only.
 233 ibaddr \-P 2            # use the second (active/up) port from the first available IB device.
 234 ibaddr \-C mthca0 \-P 2  # use the specified port only.
 235 .ft P
 236 .fi
 237 .UNINDENT
 238 .UNINDENT
 239 .UNINDENT
 240 .UNINDENT
 241 .SS Debugging flags
 242 .\" Define the common option -d
 243 .
 244 .INDENT 0.0
 245 .TP
 246 .B \-d
 247 raise the IB debugging level.
 248 May be used several times (\-ddd or \-d \-d \-d).
 249 .UNINDENT
 250 .\" Define the common option -e
 251 .
 252 .INDENT 0.0
 253 .TP
 254 .B \-e
 255 show send and receive errors (timeouts and others)
 256 .UNINDENT
 257 .\" Define the common option -h
 258 .
 259 .sp
 260 \fB\-h, \-\-help\fP      show the usage message
 261 .\" Define the common option -v
 262 .
 263 .INDENT 0.0
 264 .TP
 265 .B \fB\-v, \-\-verbose\fP
 266 increase the application verbosity level.
 267 May be used several times (\-vv or \-v \-v \-v)
 268 .UNINDENT
 269 .\" Define the common option -V
 270 .
 271 .sp
 272 \fB\-V, \-\-version\fP     show the version info.
 273 .SS Configuration flags
 274 .\" Define the common option -t
 275 .
 276 .sp
 277 \fB\-t, \-\-timeout <timeout_ms>\fP override the default timeout for the solicited mads.
 278 .\" Define the common option -z
 279 .
 280 .INDENT 0.0
 281 .TP
 282 .B \fB\-\-outstanding_smps, \-o <val>\fP
 283 Specify the number of outstanding SMP\(aqs which should be issued during the scan
 284 .sp
 285 Default: 2
 286 .UNINDENT
 287 .\" Define the common option --node-name-map
 288 .
 289 .sp
 290 \fB\-\-node\-name\-map <node\-name\-map>\fP Specify a node name map.
 291 .INDENT 0.0
 292 .INDENT 3.5
 293 This file maps GUIDs to more user friendly names.  See FILES section.
 294 .UNINDENT
 295 .UNINDENT
 296 .\" Define the common option -z
 297 .
 298 .sp
 299 \fB\-\-config, \-z  <config_file>\fP Specify alternate config file.
 300 .INDENT 0.0
 301 .INDENT 3.5
 302 Default: /etc/infiniband-diags/ibdiag.conf
 303 .UNINDENT
 304 .UNINDENT
 305 .SS COMMON FILES
 306 .\" Common text for the config file
 307 .
 308 .SS CONFIG FILE
 309 .sp
 310 /etc/infiniband-diags/ibdiag.conf
 311 .sp
 312 A global config file is provided to set some of the common options for all
 313 tools.  See supplied config file for details.
 314 .\" Common text to describe the node name map file.
 315 .
 316 .SS NODE NAME MAP FILE FORMAT
 317 .sp
 318 The node name map is used to specify user friendly names for nodes in the
 319 output.  GUIDs are used to perform the lookup.
 320 .sp
 321 This functionality is provided by the opensm\-libs package.  See \fBopensm(8)\fP
 322 for the file location for your installation.
 323 .sp
 324 \fBGenerically:\fP
 325 .INDENT 0.0
 326 .INDENT 3.5
 327 .sp
 328 .nf
 329 .ft C
 330 # comment
 331 <guid> "<name>"
 332 .ft P
 333 .fi
 334 .UNINDENT
 335 .UNINDENT
 336 .sp
 337 \fBExample:\fP
 338 .INDENT 0.0
 339 .INDENT 3.5
 340 .sp
 341 .nf
 342 .ft C
 343 # IB1
 344 # Line cards
 345 0x0008f104003f125c "IB1 (Rack 11 slot 1   ) ISR9288/ISR9096 Voltaire sLB\-24D"
 346 0x0008f104003f125d "IB1 (Rack 11 slot 1   ) ISR9288/ISR9096 Voltaire sLB\-24D"
 347 0x0008f104003f10d2 "IB1 (Rack 11 slot 2   ) ISR9288/ISR9096 Voltaire sLB\-24D"
 348 0x0008f104003f10d3 "IB1 (Rack 11 slot 2   ) ISR9288/ISR9096 Voltaire sLB\-24D"
 349 0x0008f104003f10bf "IB1 (Rack 11 slot 12  ) ISR9288/ISR9096 Voltaire sLB\-24D"
 350
 351 # Spines
 352 0x0008f10400400e2d "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB\-12D"
 353 0x0008f10400400e2e "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB\-12D"
 354 0x0008f10400400e2f "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB\-12D"
 355 0x0008f10400400e31 "IB1 (Rack 11 spine 2   ) ISR9288 Voltaire sFB\-12D"
 356 0x0008f10400400e32 "IB1 (Rack 11 spine 2   ) ISR9288 Voltaire sFB\-12D"
 357
 358 # GUID   Node Name
 359 0x0008f10400411a08 "SW1  (Rack  3) ISR9024 Voltaire 9024D"
 360 0x0008f10400411a28 "SW2  (Rack  3) ISR9024 Voltaire 9024D"
 361 0x0008f10400411a34 "SW3  (Rack  3) ISR9024 Voltaire 9024D"
 362 0x0008f104004119d0 "SW4  (Rack  3) ISR9024 Voltaire 9024D"
 363 .ft P
 364 .fi
 365 .UNINDENT
 366 .UNINDENT
 367 .SS DEPENDENCIES
 368 .sp
 369 OpenSM (or other running SM/SA), libosmcomp, libibumad, libibmad
 370 .SS AUTHORS
 371 .INDENT 0.0
 372 .TP
 373 .B Ira Weiny
 374 < \fI\%ira.weiny@intel.com\fP >
 375 .TP
 376 .B Hal Rosenstock
 377 < \fI\%halr@mellanox.com\fP >
 378 .UNINDENT
 379 .\" Generated by docutils manpage writer.
 380 .