1
2opapmaquery(1)         Master map: IFSFFCLIRG (Man Page)        opapmaquery(1)
3
4
5

NAME

7       opapmaquery
8
9
10
11       (All)  Performs  individual  PMA  queries against a specific LID. It is
12       very useful in displaying port runtime information.
13

Syntax

15       opapmaquery [-v] [-s sl] [-l lid] [-h hfi] [-p port] [-o otype]
16       [-m port] [-n mask] [-e mask] [-w mask]
17
18

Options

20       --help    Produces full help text.
21
22
23       -v        Specifies the verbose output. Can be specified more than once
24                 for additional openib debugging and libibumad debugging.
25
26
27       -s sl     Specifies different service level. Default is SM SL.
28
29
30       -l lid    Specifies the destination LID. Default is local port.
31
32
33       -h/--hfi hfi
34                 Specifies  the HFI, numbered 1..n. Using 0 specifies that the
35                 -p port port is a system-wide port number. (Default is 0.)
36
37
38       -p/--port port
39                 Specifies the port, numbered  1..n.  Using  0  specifies  the
40                 first active port. (Default is 0.)
41
42
43       -o otype  Specifies the output type. Default is getportstatus. Refer to
44                 otype options vary by report for supported options.
45
46
47                 Valid output types are:
48
49
50
51                 classportinfo
52                           Specifies the class of port info.
53
54
55
56
57
58                 getportstatus
59                           Specifies the  list  of  port  counters.  Supported
60                           options:
61
62
63                           [-m port] [-w vl mask]
64
65
66
67
68
69
70                 clearportstatus
71                           Clears the port counters. Supported options:
72
73
74                           [-n port mask] [-e counter mask] [-w vl mask]
75
76
77
78
79
80
81                 getdatacounters
82                           Specifies  the  list  of  data  counters. Supported
83                           options:
84
85
86                           [-n port mask] [-w vl mask]
87
88
89
90
91
92
93                 geterrorcounters
94                           Specifies the list  of  error  counters.  Supported
95                           options:
96
97
98                           [-n port mask] [-w vl mask]
99
100
101
102
103
104
105                 geterrorinfo
106                           Specifies   the   list  of  error  info.  Supported
107                           options:
108
109
110                           [-n port mask]
111
112
113
114
115
116
117                 clearerrorinfo
118                           Clears the error info. Supported options:
119
120
121                           [-n port mask] [-e counter mask]
122
123
124
125
126

-h and -p options permit a variety of selections:

128       -h 0      First active port in system (default).
129
130
131       -h 0 -p 0 First active port in system.
132
133
134       -h x      First active port on HFI x.
135
136
137       -h x -p 0 First active port on HFI x.
138
139
140       -h 0 -p y Port y within system (no matter which ports are active).
141
142
143       -h x -p y HFI x, port y.
144
145
146

otype options vary by report

148       -m port   Specifies the port  in  destination  device  to  query/clear.
149                 Required when using -l option for all but -o classportinfo.
150
151
152       -n mask   Specifies the port mask, in hexadecimal. Bits represent ports
153                 63-0. For example: 0x2 for port 1, 0x6 for ports 1, 2.
154
155
156       -e mask   Specifies the counter/error select mask, in hexadecimal.  The
157                 following  lists  "Mask - Bit - Location for Counters". Where
158                 applicable, location  "for  Error  Info"  is  presented.  The
159                 default is all bits set (0xffffffe0).
160
161
162
163                 ·      0x80000000  -  31 - Transmit Data (XmitData) For Error
164                        Info: Receive Error Info
165
166
167                 ·      0x40000000 - 30 - Receive  Data  (RcvData)  For  Error
168                        Info: Excessive Buffer Overrun
169
170
171                 ·      0x20000000  -  29  -  Transmit  Packets (XmitPkts) For
172                        Error Info: Transmit Const Error Info
173
174
175                 ·      0x10000000 - 28 - Receive Packets (RcvPkts) For  Error
176                        Info: Receive Const Error Info
177
178
179                 ·      0x08000000  -  27 - Multicast Transmit Packets (Multi‐
180                        castXmitPkts) For Error  Info:  Receive  Switch  Relay
181                        Error Info
182
183
184                 ·      0x04000000 - 26 - Multicast Receive Packets (Multicas‐
185                        tRcvPkts) For Error Info: Uncorrectable Error Info
186
187
188                 ·      0x02000000 - 25 - Transmit Wait (XmitWait)  For  Error
189                        Info: FM Configuration Error Info
190
191
192                 ·      0x01000000 - 24 - Congestion Discards (CongDiscards)
193
194
195                 ·      0x00800000 - 23 - Receive FECN (RcvFECN)
196
197
198                 ·      0x00400000 - 22 - Receive BECN (RcvBECN)
199
200
201                 ·      0x00200000  - 21 - Transmit Time Congestion (XmitTime‐
202                        Cong)
203
204
205                 ·      0x00100000 - 20 - Transmit Time Wasted  BW  (XmitWast‐
206                        edBW)
207
208
209                 ·      0x00080000  -  19 - Transmit Time Wait Data (XmitWait‐
210                        Data)
211
212
213                 ·      0x00040000 - 18 - Receive Bubble (RcvBubble)
214
215
216                 ·      0x00020000 - 17 - Mark FECN (MarkFECN)
217
218
219                 ·      0x00010000 - 16 - Receive Constraint  Errors  (RcvCon‐
220                        straintErrors)
221
222
223                 ·      0x00008000  -  15 - Receive Switch Relay (RcvSwitchRe‐
224                        layErrors)
225
226
227                 ·      0x00004000 - 14 - Transmit Discards (XmitDiscards)
228
229
230                 ·      0x00002000 - 13 - Transmit Constraint Errors (XmitCon‐
231                        straintErrors)
232
233
234                 ·      0x00001000  -  12  -  Receive  Remote  Physical Errors
235                        (RcvRemotePhysicalErrors)
236
237
238                 ·      0x00000800 - 11 - Local Link  Integrity  (LocalLinkIn‐
239                        tegrityErrors)
240
241
242                 ·      0x00000400 - 10 - Receive Errors (RcvErrors)
243
244
245                 ·      0x00000200  - 9 - Excessive Buffer Overrun (Excessive‐
246                        BufferOverruns)
247
248
249                 ·      0x00000100 - 8 - FM Configuration Errors  (FMConfigEr‐
250                        rors)
251
252
253                 ·      0x00000080  - 7 - Link Error Recovery (LinkErrorRecov‐
254                        ery)
255
256
257                 ·      0x00000040 - 6 - Link Error Downed (LinkDowned)
258
259
260                 ·      0x00000020  -  5  -   Uncorrectable   Errors   (Uncor‐
261                        rectableErrors)
262
263
264
265
266       -w mask   Specifies  the Virtual Lane Select Mask, in hexadecimal. Bits
267                 represent VL number 31-0. For example, 0x1 for VL 0, 0x3  for
268                 VL 0,1. Default is none.
269
270

Examples

272       opapmaquery -o classportinfo
273
274       opapmaquery -o getportstatus
275       # get data and error counts, local port
276
277       opapmaquery -o getdatacounters -n 0x2
278       # get data counts, local port 1
279
280       opapmaquery -o geterrorcounters -n 0x2
281       # get error counts, local port 1
282
283       opapmaquery -o clearportstatus -n 0x2
284       # clear all counters local port 1
285
286       opapmaquery -o geterrorinfo -n 0x2
287       # get error info for local port 1
288
289       opapmaquery -o clearerrorinfo -n 0x2
290       # clear all error info, local port 1
291       opapmaquery -o getdatacounters -l 6 -n 0x7e -w 0x1
292       #  for device at LID 6, get data counters on ports 1-6, inclusive of VL
293       0 data
294
295       opapmaquery -o clearportstatus -l 6 -n 0x2 -e 0x1ffff
296       # for device at LID 6, on port 1, clear only error counters
297
298       opapmaquery -o clearerrorinfo -l 6 -n 0x2 -e 0x04000000
299       # for device at LID 6, on ports 1, clear uncorrectable error info
300
301
302
303Copyright(C) 2015-2018         Intel Corporation                opapmaquery(1)
Impressum