saquery(8)

1SAQUERY(8)                    Open IB Diagnostics                   SAQUERY(8)
2
3
4

NAME

6       saquery - query InfiniBand subnet administration attributes
7

SYNOPSIS

9       saquery [options] [<name> | <lid> | <guid>]
10

DESCRIPTION

12       saquery  issues  the selected SA query. Node records are queried by de‐
13       fault.
14

OPTIONS

16       -p     get PathRecord info
17
18       -N     get NodeRecord info
19
20       -D, --list
21              get NodeDescriptions of CAs only
22
23       -S     get ServiceRecord info
24
25       -I     get InformInfoRecord (subscription) info
26
27       -L     return the Lids of the name specified
28
29       -l     return the unique Lid of the name specified
30
31       -G     return the Guids of the name specified
32
33       -O     return the name for the Lid specified
34
35       -U     return the name for the Guid specified
36
37       -c     get the SA's class port info
38
39       -s     return the PortInfoRecords with isSM or isSMdisabled  capability
40              mask bit on
41
42       -g     get multicast group info
43
44       -m     get  multicast  member info.  If a group is specified, limit the
45              output to the group specified and print one line containing only
46              the  GUID  and node description for each entry. Example: saquery
47              -m 0xc000
48
49       -x     get LinkRecord info
50
51       --src-to-dst <src:dst>
52              get a PathRecord for <src:dst> where src and dst are either node
53              names or LIDs
54
55       --sgid-to-dgid <sgid:dgid>
56              get a PathRecord for sgid to dgid where both GIDs are in an IPv6
57              format acceptable to inet_pton (3)
58
59       --smkey <val>
60              use SM_Key value for the query. Will be used only with "trusted"
61              queries.   If non-numeric value (like 'x') is specified then sa‐
62              query will prompt for a value.  Default (when not specified here
63              or  in  /etc/infiniband-diags/ibdiag.conf) is to use SM_Key == 0
64              (or "untrusted")
65
66       -K, --show_keys
67              show security keys (mkey, smkey, etc.) associated with  the  re‐
68              quest.
69
70       --slid <lid> Source LID (PathRecord)
71
72       --dlid <lid> Destination LID (PathRecord)
73
74       --mlid <lid> Multicast LID (MCMemberRecord)
75
76       --sgid <gid> Source GID (IPv6 format) (PathRecord)
77
78       --dgid <gid> Destination GID (IPv6 format) (PathRecord)
79
80       --gid <gid> Port GID (MCMemberRecord)
81
82       --mgid <gid> Multicast GID (MCMemberRecord)
83
84       --reversible Reversible path (PathRecord)
85
86       --numb_path Number of paths (PathRecord)
87
88       --pkey  P_Key  (PathRecord, MCMemberRecord). If non-numeric value (like
89       'x')
90              is specified then saquery will prompt for a value
91
92       --qos_class QoS Class (PathRecord)
93
94       --sl Service level (PathRecord, MCMemberRecord)
95
96       --mtu MTU and selector (PathRecord, MCMemberRecord)
97
98       --rate Rate and selector (PathRecord, MCMemberRecord)
99
100       --pkt_lifetime Packet  lifetime  and  selector  (PathRecord,  MCMember‐
101       Record)
102
103       --qkey Q_Key (MCMemberRecord). If non-numeric value (like 'x') is spec‐
104       ified
105              then saquery will prompt for a value
106
107       --tclass Traffic Class (PathRecord, MCMemberRecord)
108
109       --flow_label Flow Label (PathRecord, MCMemberRecord)
110
111       --hop_limit Hop limit (PathRecord, MCMemberRecord)
112
113       --scope Scope (MCMemberRecord)
114
115       --join_state Join state (MCMemberRecord)
116
117       --proxy_join Proxy join (MCMemberRecord)
118
119       --service_id ServiceID (PathRecord)
120
121       Supported query names (and aliases):
122
123          ClassPortInfo (CPI)
124          NodeRecord (NR) [lid]
125          PortInfoRecord (PIR) [[lid]/[port]/[options]]
126          SL2VLTableRecord (SL2VL) [[lid]/[in_port]/[out_port]]
127          PKeyTableRecord (PKTR) [[lid]/[port]/[block]]
128          VLArbitrationTableRecord (VLAR) [[lid]/[port]/[block]]
129          InformInfoRecord (IIR)
130          LinkRecord (LR) [[from_lid]/[from_port]] [[to_lid]/[to_port]]
131          ServiceRecord (SR)
132          PathRecord (PR)
133          MCMemberRecord (MCMR)
134          LFTRecord (LFTR) [[lid]/[block]]
135          MFTRecord (MFTR) [[mlid]/[position]/[block]]
136          GUIDInfoRecord (GIR) [[lid]/[block]]
137          SwitchInfoRecord (SWIR) [lid]
138          SMInfoRecord (SMIR) [lid]
139
140   Port Selection flags
141       -C, --Ca <ca_name>    use the specified ca_name.
142
143       -P, --Port <ca_port>    use the specified ca_port.
144
145   Local port Selection
146       Multiple port/Multiple CA support: when no IB device or port is  speci‐
147       fied (see the "local umad parameters" below), the libibumad library se‐
148       lects the port to use by the following criteria:
149
150          1. the first port that is ACTIVE.
151
152          2. if not found, the first port that is UP (physical link up).
153
154          If a port and/or CA name is specified,  the  libibumad  library  at‐
155          tempts  to fulfill the user request, and will fail if it is not pos‐
156          sible.
157
158          For example:
159
160              ibaddr                 # use the first port (criteria #1 above)
161              ibaddr -C mthca1       # pick the best port from "mthca1" only.
162              ibaddr -P 2            # use the second (active/up) port from the first available IB device.
163              ibaddr -C mthca0 -P 2  # use the specified port only.
164
165   Debugging flags
166       -d     raise the IB debugging level.  May be used several  times  (-ddd
167              or -d -d -d).
168
169       -e     show send and receive errors (timeouts and others)
170
171       -h, --help      show the usage message
172
173       -v, --verbose
174              increase  the  application verbosity level.  May be used several
175              times (-vv or -v -v -v)
176
177       -V, --version     show the version info.
178
179   Configuration flags
180       -t, --timeout <timeout_ms> override the default  timeout  for  the  so‐
181       licited mads.
182
183       --outstanding_smps, -o <val>
184              Specify  the  number of outstanding SMP's which should be issued
185              during the scan
186
187              Default: 2
188
189       --node-name-map <node-name-map> Specify a node name map.
190          This file maps GUIDs to more user friendly names.   See  FILES  sec‐
191          tion.
192
193       --config, -z  <config_file> Specify alternate config file.
194          Default: /etc/infiniband-diags/ibdiag.conf
195

COMMON FILES

197   CONFIG FILE
198       /etc/infiniband-diags/ibdiag.conf
199
200       A  global config file is provided to set some of the common options for
201       all tools.  See supplied config file for details.
202
203   NODE NAME MAP FILE FORMAT
204       The node name map is used to specify user friendly names for  nodes  in
205       the output.  GUIDs are used to perform the lookup.
206
207       This  functionality  is  provided  by  the  opensm-libs  package.   See
208       opensm(8) for the file location for your installation.
209
210       Generically:
211
212          # comment
213          <guid> "<name>"
214
215       Example:
216
217          # IB1
218          # Line cards
219          0x0008f104003f125c "IB1 (Rack 11 slot 1   ) ISR9288/ISR9096 Voltaire sLB-24D"
220          0x0008f104003f125d "IB1 (Rack 11 slot 1   ) ISR9288/ISR9096 Voltaire sLB-24D"
221          0x0008f104003f10d2 "IB1 (Rack 11 slot 2   ) ISR9288/ISR9096 Voltaire sLB-24D"
222          0x0008f104003f10d3 "IB1 (Rack 11 slot 2   ) ISR9288/ISR9096 Voltaire sLB-24D"
223          0x0008f104003f10bf "IB1 (Rack 11 slot 12  ) ISR9288/ISR9096 Voltaire sLB-24D"
224
225          # Spines
226          0x0008f10400400e2d "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB-12D"
227          0x0008f10400400e2e "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB-12D"
228          0x0008f10400400e2f "IB1 (Rack 11 spine 1   ) ISR9288 Voltaire sFB-12D"
229          0x0008f10400400e31 "IB1 (Rack 11 spine 2   ) ISR9288 Voltaire sFB-12D"
230          0x0008f10400400e32 "IB1 (Rack 11 spine 2   ) ISR9288 Voltaire sFB-12D"
231
232          # GUID   Node Name
233          0x0008f10400411a08 "SW1  (Rack  3) ISR9024 Voltaire 9024D"
234          0x0008f10400411a28 "SW2  (Rack  3) ISR9024 Voltaire 9024D"
235          0x0008f10400411a34 "SW3  (Rack  3) ISR9024 Voltaire 9024D"
236          0x0008f104004119d0 "SW4  (Rack  3) ISR9024 Voltaire 9024D"
237

DEPENDENCIES

239       OpenSM (or other running SM/SA), libosmcomp, libibumad, libibmad
240

AUTHORS

242       Ira Weiny
243              < ira.weiny@intel.com >
244
245       Hal Rosenstock
246              < halr@mellanox.com >
247
248
249
250
251                                  2017-08-21                        SAQUERY(8)