1SAQUERY(8) Open IB Diagnostics SAQUERY(8)
2
6 SAQUERY -
7
9 SYNOPSIS
10 saquery [options] [<name> | <lid> | <guid>]
11 DESCRIPTION
13 saquery issues the selected SA query. Node records are queried by
14 default.
15 OPTIONS
17 -p get PathRecord info
18 -N get NodeRecord info
20 -D, --list
22 get NodeDescriptions of CAs only
23 -S get ServiceRecord info
25 -I get InformInfoRecord (subscription) info
27 -L return the Lids of the name specified
29 -l return the unique Lid of the name specified
31 -G return the Guids of the name specified
33 -O return the name for the Lid specified
35 -U return the name for the Guid specified
37 -c get the SA's class port info
39 -s return the PortInfoRecords with isSM or isSMdisabled capability
41 mask bit on
42 -g get multicast group info
44 -m get multicast member info. If a group is specified, limit the
46 output to the group specified and print one line containing only
47 the GUID and node description for each entry. Example: saquery
48 -m 0xc000
49 -x get LinkRecord info
51 --src-to-dst <src:dst>
53 get a PathRecord for <src:dst> where src and dst are either node
54 names or LIDs
55 --sgid-to-dgid <sgid:dgid>
57 get a PathRecord for sgid to dgid where both GIDs are in an IPv6
58 format acceptable to inet_pton (3)
59 --smkey <val>
61 use SM_Key value for the query. Will be used only with "trusted"
62 queries. If non-numeric value (like 'x') is specified then
63 saquery will prompt for a value. Default (when not specified
64 here or in /etc/infiniband-diags/ibdiag.conf) is to use SM_Key
65 == 0 (or "untrusted")
66 -K, --show_keys
68 show security keys (mkey, smkey, etc.) associated with the
69 request.
70 --slid <lid> Source LID (PathRecord)
72 --dlid <lid> Destination LID (PathRecord)
74 --mlid <lid> Multicast LID (MCMemberRecord)
76 --sgid <gid> Source GID (IPv6 format) (PathRecord)
78 --dgid <gid> Destination GID (IPv6 format) (PathRecord)
80 --gid <gid> Port GID (MCMemberRecord)
82 --mgid <gid> Multicast GID (MCMemberRecord)
84 --reversible Reversible path (PathRecord)
86 --numb_path Number of paths (PathRecord)
88 --pkey P_Key (PathRecord, MCMemberRecord). If non-numeric value (like
90 'x')
91 is specified then saquery will prompt for a value
92 --qos_class QoS Class (PathRecord)
94 --sl Service level (PathRecord, MCMemberRecord)
96 --mtu MTU and selector (PathRecord, MCMemberRecord)
98 --rate Rate and selector (PathRecord, MCMemberRecord)
100 --pkt_lifetime Packet lifetime and selector (PathRecord, MCMember‐
102 Record)
103 --qkey Q_Key (MCMemberRecord). If non-numeric value (like 'x') is spec‐
105 ified
106 then saquery will prompt for a value
107 --tclass Traffic Class (PathRecord, MCMemberRecord)
109 --flow_label Flow Label (PathRecord, MCMemberRecord)
111 --hop_limit Hop limit (PathRecord, MCMemberRecord)
113 --scope Scope (MCMemberRecord)
115 --join_state Join state (MCMemberRecord)
117 --proxy_join Proxy join (MCMemberRecord)
119 --service_id ServiceID (PathRecord)
121 Supported query names (and aliases):
123 ClassPortInfo (CPI)
125 NodeRecord (NR) [lid]
126 PortInfoRecord (PIR) [[lid]/[port]/[options]]
127 SL2VLTableRecord (SL2VL) [[lid]/[in_port]/[out_port]]
128 PKeyTableRecord (PKTR) [[lid]/[port]/[block]]
129 VLArbitrationTableRecord (VLAR) [[lid]/[port]/[block]]
130 InformInfoRecord (IIR)
131 LinkRecord (LR) [[from_lid]/[from_port]] [[to_lid]/[to_port]]
132 ServiceRecord (SR)
133 PathRecord (PR)
134 MCMemberRecord (MCMR)
135 LFTRecord (LFTR) [[lid]/[block]]
136 MFTRecord (MFTR) [[mlid]/[position]/[block]]
137 GUIDInfoRecord (GIR) [[lid]/[block]]
138 SwitchInfoRecord (SWIR) [lid]
139 SMInfoRecord (SMIR) [lid]
140 Port Selection flags
142 -C, --Ca <ca_name> use the specified ca_name.
143 -P, --Port <ca_port> use the specified ca_port.
145 Local port Selection
147 Multiple port/Multiple CA support: when no IB device or port is speci‐
148 fied (see the "local umad parameters" below), the libibumad library
149 selects the port to use by the following criteria:
150 1. the first port that is ACTIVE.
152 2. if not found, the first port that is UP (physical link up).
154 If a port and/or CA name is specified, the libibumad library
156 attempts to fulfill the user request, and will fail if it is not
157 possible.
158 For example:
160 ibaddr # use the first port (criteria #1 above)
162 ibaddr -C mthca1 # pick the best port from "mthca1" only.
163 ibaddr -P 2 # use the second (active/up) port from the first available IB device.
164 ibaddr -C mthca0 -P 2 # use the specified port only.
165 Debugging flags
167 -d raise the IB debugging level. May be used several times (-ddd
168 or -d -d -d).
169 -e show send and receive errors (timeouts and others)
171 -h, --help show the usage message
173 -v, --verbose
175 increase the application verbosity level. May be used several
176 times (-vv or -v -v -v)
177 -V, --version show the version info.
179 Configuration flags
181 -t, --timeout <timeout_ms> override the default timeout for the
182 solicited mads.
183 --outstanding_smps, -o <val>
185 Specify the number of outstanding SMP's which should be issued
186 during the scan
187 Default: 2
189 --node-name-map <node-name-map> Specify a node name map.
191 This file maps GUIDs to more user friendly names. See FILES sec‐
192 tion.
193 --config, -z <config_file> Specify alternate config file.
195 Default: /etc/infiniband-diags/ibdiag.conf
196 COMMON FILES
198 CONFIG FILE
199 /etc/infiniband-diags/ibdiag.conf
200 A global config file is provided to set some of the common options for
202 all tools. See supplied config file for details.
203 NODE NAME MAP FILE FORMAT
205 The node name map is used to specify user friendly names for nodes in
206 the output. GUIDs are used to perform the lookup.
207 This functionality is provided by the opensm-libs package. See
209 opensm(8) for the file location for your installation.
210 Generically:
212 # comment
214 <guid> "<name>"
215 Example:
217 # IB1
219 # Line cards
220 0x0008f104003f125c "IB1 (Rack 11 slot 1 ) ISR9288/ISR9096 Voltaire sLB-24D"
221 0x0008f104003f125d "IB1 (Rack 11 slot 1 ) ISR9288/ISR9096 Voltaire sLB-24D"
222 0x0008f104003f10d2 "IB1 (Rack 11 slot 2 ) ISR9288/ISR9096 Voltaire sLB-24D"
223 0x0008f104003f10d3 "IB1 (Rack 11 slot 2 ) ISR9288/ISR9096 Voltaire sLB-24D"
224 0x0008f104003f10bf "IB1 (Rack 11 slot 12 ) ISR9288/ISR9096 Voltaire sLB-24D"
225 # Spines
227 0x0008f10400400e2d "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB-12D"
228 0x0008f10400400e2e "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB-12D"
229 0x0008f10400400e2f "IB1 (Rack 11 spine 1 ) ISR9288 Voltaire sFB-12D"
230 0x0008f10400400e31 "IB1 (Rack 11 spine 2 ) ISR9288 Voltaire sFB-12D"
231 0x0008f10400400e32 "IB1 (Rack 11 spine 2 ) ISR9288 Voltaire sFB-12D"
232 # GUID Node Name
234 0x0008f10400411a08 "SW1 (Rack 3) ISR9024 Voltaire 9024D"
235 0x0008f10400411a28 "SW2 (Rack 3) ISR9024 Voltaire 9024D"
236 0x0008f10400411a34 "SW3 (Rack 3) ISR9024 Voltaire 9024D"
237 0x0008f104004119d0 "SW4 (Rack 3) ISR9024 Voltaire 9024D"
238 DEPENDENCIES
240 OpenSM (or other running SM/SA), libosmcomp, libibumad, libibmad
241 AUTHORS
243 Ira Weiny
244 < ira.weiny@intel.com >
245 Hal Rosenstock
247 < halr@mellanox.com >
248 SAQUERY(8)