1 .\" Man page generated from reStructuredText.
3 .TH SAQUERY 8 "" "" "Open IB Diagnostics"
7 .nr rst2man-indent-level 0
11 level \\n[rst2man-indent-level]
12 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
19 .\" .rstReportMargin pre:
21 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
22 . nr rst2man-indent-level +1
23 .\" .rstReportMargin post:
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
33 .SH QUERY INFINIBAND SUBNET ADMINISTRATION ATTRIBUTES
36 saquery [options] [<name> | <lid> | <guid>]
39 saquery issues the selected SA query. Node records are queried by default.
49 .B \fB\-D, \-\-list\fP
50 get NodeDescriptions of CAs only
53 get ServiceRecord info
56 get InformInfoRecord (subscription) info
59 return the Lids of the name specified
62 return the unique Lid of the name specified
65 return the Guids of the name specified
68 return the name for the Lid specified
71 return the name for the Guid specified
74 get the SA\(aqs class port info
77 return the PortInfoRecords with isSM or isSMdisabled capability mask bit on
80 get multicast group info
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
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
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
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
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.
111 .\" Define the common option -K
115 .B \fB\-K, \-\-show_keys\fP
116 show security keys (mkey, smkey, etc.) associated with the request.
119 \fB\-\-slid <lid>\fP Source LID (PathRecord)
121 \fB\-\-dlid <lid>\fP Destination LID (PathRecord)
123 \fB\-\-mlid <lid>\fP Multicast LID (MCMemberRecord)
125 \fB\-\-sgid <gid>\fP Source GID (IPv6 format) (PathRecord)
127 \fB\-\-dgid <gid>\fP Destination GID (IPv6 format) (PathRecord)
129 \fB\-\-gid <gid>\fP Port GID (MCMemberRecord)
131 \fB\-\-mgid <gid>\fP Multicast GID (MCMemberRecord)
133 \fB\-\-reversible\fP Reversible path (PathRecord)
135 \fB\-\-numb_path\fP Number of paths (PathRecord)
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
142 \fB\-\-qos_class\fP QoS Class (PathRecord)
144 \fB\-\-sl\fP Service level (PathRecord, MCMemberRecord)
146 \fB\-\-mtu\fP MTU and selector (PathRecord, MCMemberRecord)
148 \fB\-\-rate\fP Rate and selector (PathRecord, MCMemberRecord)
150 \fB\-\-pkt_lifetime\fP Packet lifetime and selector (PathRecord, MCMemberRecord)
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
157 \fB\-\-tclass\fP Traffic Class (PathRecord, MCMemberRecord)
159 \fB\-\-flow_label\fP Flow Label (PathRecord, MCMemberRecord)
161 \fB\-\-hop_limit\fP Hop limit (PathRecord, MCMemberRecord)
163 \fB\-\-scope\fP Scope (MCMemberRecord)
165 \fB\-\-join_state\fP Join state (MCMemberRecord)
167 \fB\-\-proxy_join\fP Proxy join (MCMemberRecord)
169 \fB\-\-service_id\fP ServiceID (PathRecord)
171 Supported query names (and aliases):
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]]
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]
197 .SS Port Selection flags
198 .\" Define the common option -C
201 \fB\-C, \-\-Ca <ca_name>\fP use the specified ca_name.
202 .\" Define the common option -P
205 \fB\-P, \-\-Port <ca_port>\fP use the specified ca_port.
206 .\" Explanation of local port selection
208 .SS Local port Selection
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:
217 the first port that is ACTIVE.
219 if not found, the first port that is UP (physical link up).
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.
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.
242 .\" Define the common option -d
247 raise the IB debugging level.
248 May be used several times (\-ddd or \-d \-d \-d).
250 .\" Define the common option -e
255 show send and receive errors (timeouts and others)
257 .\" Define the common option -h
260 \fB\-h, \-\-help\fP show the usage message
261 .\" Define the common option -v
265 .B \fB\-v, \-\-verbose\fP
266 increase the application verbosity level.
267 May be used several times (\-vv or \-v \-v \-v)
269 .\" Define the common option -V
272 \fB\-V, \-\-version\fP show the version info.
273 .SS Configuration flags
274 .\" Define the common option -t
277 \fB\-t, \-\-timeout <timeout_ms>\fP override the default timeout for the solicited mads.
278 .\" Define the common option -z
282 .B \fB\-\-outstanding_smps, \-o <val>\fP
283 Specify the number of outstanding SMP\(aqs which should be issued during the scan
287 .\" Define the common option --node-name-map
290 \fB\-\-node\-name\-map <node\-name\-map>\fP Specify a node name map.
293 This file maps GUIDs to more user friendly names. See FILES section.
296 .\" Define the common option -z
299 \fB\-\-config, \-z <config_file>\fP Specify alternate config file.
302 Default: /etc/infiniband-diags/ibdiag.conf
306 .\" Common text for the config file
310 /etc/infiniband-diags/ibdiag.conf
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.
316 .SS NODE NAME MAP FILE FORMAT
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.
321 This functionality is provided by the opensm\-libs package. See \fBopensm(8)\fP
322 for the file location for your installation.
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"
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"
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"
369 OpenSM (or other running SM/SA), libosmcomp, libibumad, libibmad
374 < \fI\%ira.weiny@intel.com\fP >
377 < \fI\%halr@mellanox.com\fP >
379 .\" Generated by docutils manpage writer.