1opapaquery(8) Master map: IFSFFCLIRG (Man Page) opapaquery(8)
3
7 opapaquery
8 (All) Performs various queries of the performance management (PM)/per‐
12 formance administration (PA) agent and provides details about fabric
13 performance. Refer to the Intel(R) Omni-Path Fabric Suite Fabric Man‐
14 ager User Guide
15 for a description of the operation and client services of the PM/PA.
17 By default, opapaquery queries the most recent data. However, if an
19 image number (imgNum) and/or image offset (imgOff) is provided, the
20 query returns previous sweep data. Queries that access previous sweep
21 data return with the absolute image number representing that data, and
22 therefore have an image offset of zero.
23 opapaquery's operation is dependent on an Intel(R) Omni-Path Fabric
25 Suite Fabric Manager version 6.0 or greater running as master SM/PM in
26 the fabric.
27 By default, opapaquery uses the first active port on the local system.
29 However, if the Fabric Management Node is connected to more than one
30 fabric (for example, a subnet), the HFI and port may be specified to
31 select the fabric whose PA is to be queried.
32
34 opapaquery [-v] [-h hfi|-b addr] [-p port] [-x gid] [-E]
35 [-T ssl_params] -o type [-g groupName] [-l nodeLid] [-P portNumber]
36 [-G nodeGuid] [-D nodeDesc] [-d delta] [-j date_time][-q date_time]
37 [-U] [-s select] [-f focus] [-S start] [-r range] [-n imgNum]
38 [-O imgOff] [-y imgTime] [-m moveImgNum] [-M moveImgOff] [-V vfName]
39
41 -v/--verbose
42 Specifies the verbose output.
43 -h/--hfi hfi
46 Specifies the HFI, numbered 1..n. Using 0 specifies that the
47 -p port port is a system-wide port number. (Default is 0.)
48 -b/--oob address
51 Specifies Out-of-Band address of node running the FE. Can be
52 either hostname, IPv4, or IPv6 address. (Default is
53 "127.0.0.1")
54 -p/--port port
57 Specifies the port.
58 · In-band: Numbered 1...n. Using 0 specifies the first
61 active port. (Default is 0.)
62 · Out-of-band: Port FE is listening on. (Default is
64 3245.)
65 -x/--source-gid src_gid
70 Specifies the source GID of the local GID. (This is required
71 for most Path and Trace Record Queries when Out-of-Band.)
72 -E/--feEsm
75 Specifies the ESM FE.
76 -T/--ssl-params file
79 Specifies the SSL/TLS parameters XML file. (Default is
80 /etc/opa/opamgt_tls.xml)
81 -o/--output type
84 Specifies the output type, default is groupList. See Output
85 Types
86 -g/--groupName groupName
89 Specifies the group name for groupInfo query.
90 -l/--lid lid
93 Specifies the LID of the node.
94 -P/--portNumber portNumber
97 Specifies the port number.
98 -G/--nodeGuid
101 Specifies the GUID of the node.
102 -D/--nodeDesc
105 Specifies the description of the node.
106 -d/--delta delta
109 Specifies the delta flag for portCounters query - 0 or 1.
110 -j / --begin date_time
113 Obtains portCounters over an interval beginning at date_time.
114 date_time may be a time entered as HH:MM[:SS] or date as
115 mm/dd/YYYY, dd.mm.YYYY, YYYY-mm-dd or date followed by time;
116 for example, "2016-07-04 14:40". Relative times are taken as
117 "x [second|minute|hour|day](s) ago.
118 -q / --end date_time
121 Obtains portCounters over an interval ending at date_time.
122 date_time may be a time entered as HH:MM[:SS] or date as
123 mm/dd/YYYY, dd.mm.YYYY, YYYY-mm-dd or date followed by time;
124 for example, "2016-07-04 14:40". Relative times are taken as
125 "x [second|minute|hour|day](s) ago.
126 -U / --userCntrs
129 Queries by user-controlled counters flag for portCounters.
130 -s/--select select
133 Specifies the 32-bit select flag for clearing port counters.
134 Select bits for clrPortCounters. 0 is the least significant
137 bit (rightmost). The clrPortCounters bit descriptions are
138 listed in the order "mask - bit - location" below:
139 · 0x80000000 - 31 - Transmit Data (XmitData)
142 · 0x40000000 - 30 - Receive Data (RcvData)
145 · 0x20000000 - 29 - Transmit Packets (XmitPkts)
148 · 0x10000000 - 28 - Receive Packets (RcvPkts)
151 · 0x08000000 - 27 - Multicast Transmit Packets (Multi‐
154 castXmitPkts)
155 · 0x04000000 - 26 - Multicast Receive Packets (Multicas‐
158 tRcvPkts)
159 · 0x02000000 - 25 - Transmit Wait (XmitWait)
162 · 0x01000000 - 24 - Congestion Discards (CongDiscards)
165 · 0x00800000 - 23 - Receive FECN (RcvFECN)
168 · 0x00400000 - 22 - Receive BECN (RcvBECN)
171 · 0x00200000 - 21 - Transmit Time Congestion (XmitTime‐
174 Cong)
175 · 0x00100000 - 20 - Transmit Time Wasted BW (XmitWast‐
178 edBW)
179 · 0x00080000 - 19 - Transmit Time Wait Data (XmitWait‐
182 Data)
183 · 0x00040000 - 18 - Receive Bubble (RcvBubble)
186 · 0x00020000 - 17 - Mark FECN (MarkFECN)
189 · 0x00010000 - 16 - Receive Constraint Errors (RcvCon‐
192 straintErrors)
193 · 0x00008000 - 15 - Receive Switch Relay (RcvSwitchRe‐
196 layErrors)
197 · 0x00004000 - 14 - Transmit Discards (XmitDiscards)
200 · 0x00002000 - 13 - Transmit Constraint Errors (XmitCon‐
203 straintErrors)
204 · 0x00001000 - 12 - Receive Remote Physical Errors
207 (RcvRemotePhysicalErrors)
208 · 0x00000800 - 11 - Local Link Integrity (LocalLinkIn‐
211 tegrityErrors)
212 · 0x00000400 - 10 - Receive Errors (RcvErrors)
215 · 0x00000200 - 9 - Excessive Buffer Overrun (Excessive‐
218 BufferOverruns)
219 · 0x00000100 - 8 - FM Configuration Errors (FMConfigEr‐
222 rors)
223 · 0x00000080 - 7 - Link Error Recovery (LinkErrorRecov‐
226 ery)
227 · 0x00000040 - 6 - Link Error Downed (LinkDowned)
230 · 0x00000020 - 5 - Uncorrectable Errors (Uncor‐
233 rectableErrors)
234 Select bits for clrVfPortCounters. 0 is the least significant
239 bit (rightmost). The clrVfPortCounters bit descriptions are
240 listed in the order "mask - bit - location" below:
241 · 0x80000000 - 31 - VL Transmit Data (VLXmitData)
244 · 0x40000000 - 30 - VL Receive Data (VLRcvData)
247 · 0x20000000 - 29 - VL Transmit Packets (VLXmitPkts)
250 · 0x10000000 - 28 - VL Receive Packets (VLRcvPkts)
253 · 0x08000000 - 27 - VL Transmit Discards (VLXmitDis‐
256 cards)
257 · 0x04000000 - 26 - VL Congestion Discards (VLCongDis‐
260 cards)
261 · 0x02000000 - 25 - VL Transmit Wait (VLXmitWait)
264 · 0x01000000 - 24 - VL Receive FECN (VLRcvFECN)
267 · 0x00800000 - 23 - VL Receive BECN (VLRcvBECN)
270 · 0x00400000 - 22 - VL Transmit Time Congestion (VLXmit‐
273 TimeCong)
274 · 0x00200000 - 21 - VL Transmit Wasted BW (VLXmitWast‐
277 edBW)
278 · 0x00100000 - 20 - VL Transmit Wait Data (VLXmitWait‐
281 Data)
282 · 0x00080000 - 19 - VL Receive Bubble (VLRcvBubble)
285 · 0x00040000 - 18 - VL Mark FECN (VLMarkFECN)
288 · Bits 17-0 reserved
291 -f/--focus focus
296 Specifies the focus select value for getting focus ports.
297 focus select values are:
298 unexpclrport
302 Lists unexpectedly cleared ports - LID ordered.
303 norespport
309 Lists no response ports - LID ordered.
310 skippedport
316 Lists skipped ports - LID ordered.
317 utilhigh Sorted by utilization - highest first.
323 pktrate Sorted by packet rate - highest first.
329 utillow Sorted by utilization - lowest first.
335 integrity Sorted by integrity category - highest first.
341 congestion
347 Sorted by congestion category - highest first.
348 smacongestion
354 Sorted by SMA congestion category - highest first.
355 bubbles Sorted by bubble category - highest first.
361 security Sorted by security category - highest first.
366 routing Sorted by routing category - highest first.
372 -S/--start start
376 Specifies the start of window for focus ports, should always
377 be 0.
378 -r/--range range
381 Specifies the size of window for focus ports list.
382 -Q/--tuple
385 Specifies a tuple that identifies a focus select value, com‐
386 parator and argument in the form select: comparator:argument.
387 Up to 8 tuples may be specified as: -Q s1:c1:a1 -Q s2:c2:a2
388 ... -Q s8:c8:a8
389 Valid focus select values are: utilization, pktrate,
392 integrity, congestion, smacongestion, bubbles, security and
393 routing.
394 Valid comparator values are: GT, GE, LT, LE
396 Valid arguments are: Any 64-bit value in hexadecimal or deci‐
398 mal.
399 When specifying more than one tuple, a logical operator
401 -Z/--operator must also be specified.
402 -Z/--operator
404 Specifies a logical operator used to join the results of the
405 specified tuples.
406 and - Specifies a port is returned if it meets all of the
409 tuple filter criteria.
410 or - Specifies a port is returned if it meets one or more of
412 the tuple filter criteria.
413 -n/--imgNum imgNum
415 Specifies the 64-bit image number.
416 -O/--imgOff imgOff
419 Specifies the image offset.
420 -y / --imgTime
423 Specifies the image time. May be used with imageinfo,
424 groupInfo, groupInfo, groupConfig, freezeImage, focusPorts,
425 vfInfo, vfConfig, and vfFocusPorts. Will return closest image
426 within image interval if possible. See --begin/--end above
427 for format.
428 -m/--moveImgNum moveImgNum
431 Specifies the 64-bit image number. Used with moveFreeze to
432 move a freeze image.
433 -M/--moveImgOff moveImgOff
436 Specifies the image offset. Can be used with moveFreeze to
437 move a freeze image.
438 -V/--vfName vfName
441 Specifies the VF name for vfInfo query.
442
446 -h 0 First active port in system (default).
447 -h 0 -p 0 First active port in system.
450 -h x First active port on HFI x.
453 -h x -p 0 First active port on HFI x.
456 -h 0 -p y Port y within system (no matter which ports are active).
459 -h x -p y HFI x, port y.
462
465 classPortInfo
466 Specifies the class port info.
467 groupList Specifies the list of PA groups.
470 groupInfo Specifies the summary statistics of a PA group. Requires -g
473 option for groupName.
474 groupConfig
477 Specifies the configuration of a PA group. Requires -g option
478 for groupName.
479 groupNodeInfo
482 Specifies the node information of a PA group. Requires -g
483 option for groupName. Options -l lid, -G nodeGuid and -D nod‐
484 eDesc are optional.
485 groupLinkInfo
488 Specifies the link Information of a PA group. Requires -g
489 option for groupName. Options -l lid and -P port are
490 optional. Note that -P 255 specifies all ports.
491 portCounters
494 Specifies the port counters of fabric port. Requires -l lid
495 and -P port options. -d delta is optional.
496 clrPortCounters
499 Clears port counters of fabric port. Requires -l lid and -P
500 port, and -s select options.
501 clrAllPortCounters
504 Clears all port counters in fabric.
505 pmConfig Retrieves PM configuration information.
508 freezeImage
511 Creates freeze frame for image ID. Requires -n imgNum.
512 releaseImage
515 Releases freeze frame for image ID. Requires -n imgNum.
516 renewImage
519 Renews lease for freeze frame for image ID. Requires -n
520 imgNum.
521 moveFreeze
524 Moves freeze frame from image ID to new image ID. Requires -n
525 imgNum and -m moveImgNum.
526 focusPorts
529 Gets sorted list of ports using utilization or error values
530 (from group buckets). Requires -g groupname, -f focus, -S
531 start, -r range.
532 imageInfo Gets configuration of a PA image (timestamps, etc.). Requires
535 -n imgNum.
536 vfList Specifies the list of virtual fabrics.
539 vfInfo Specifies the summary statistics of a virtual fabric.
542 Requires -V option for vfName.
543 vfConfig Specifies the configuration of a virtual fabric. Requires -V
546 option for vfName.
547 vfPortCounters
550 Specifies the port counters of fabric port. Requires -V
551 vfName, -l lid and -P port options, -d delta is optional.
552 vfFocusPorts
555 Gets sorted list of virtual fabric ports using utilization or
556 error values (from VF buckets). Requires -V vfname, -f focus,
557 -S start, -r range.
558 clrVfPortCounters
561 Clears VF port counters of fabric port. Requires -l lid, -P
562 port, -s select, and -V vfname options.
563
566 opapaquery -o classPortInfo
567 opapaquery -o groupList
568 opapaquery -o groupInfo -g All
569 opapaquery -o groupConfig -g All
570 opapaquery -o groupNodeInfo -g All -G <nodeGuid>
571 opapaquery -o groupNodeInfo -g All -D <nodeDesc>
572 opapaquery -o groupNodeInfo -g All -l 1
573 opapaquery -o groupNodeInfo -g All -l 1 -G <nodeGuid>
574 opapaquery -o groupLinkInfo -g All
575 opapaquery -o groupLinkInfo -g All -l 1 -P 1
576 opapaquery -o groupLinkInfo -g All -l 1 -P 255
577 opapaquery -o portCounters -l 1 -P 1 -d 1
578 opapaquery -o portCounters -l 1 -P 1 -d 1 -n 0x20000000d02 -O 1
579 opapaquery -o portCounters -l 1 -P 1 -d 1 -j 13:30 -q 14:20
580 opapaquery -o clrPortCounters -l 1 -P 1 -s 0xC0000000
581 (clears XmitData & RcvData)
582 opapaquery -o clrAllPortCounters -s 0xC0000000
583 (clears XmitData & RcvData on all ports)
584 opapaquery -o pmConfig
585 opapaquery -o freezeImage -n 0x20000000d02
586 opapaquery -o releaseImage -n 0xd01
587 opapaquery -o renewImage -n 0xd01
588 opapaquery -o moveFreeze -n 0xd01 -m 0x20000000d02 -M -2
589 opapaquery -o focusPorts -g All -f integrity -S 0 -r 20
590 opapaquery -o focusPorts -g All -S 0 -r 20 -Z AND -Q integrity:ge:20 -Q
591 bubbles:lt:10
592 opapaquery -o focusPorts -g All -f skippedport -S 0 -r 20
593 opapaquery -o imageInfo -n 0x20000000d02
594 opapaquery -o imageInfo -y "1 hour ago"
595 opapaquery -o vfList
596 opapaquery -o vfInfo -V Default
597 opapaquery -o vfConfig -V Default
598 opapaquery -o vfPortCounters -l 1 -P 1 -d 1 -V Default
599 opapaquery -o clrVfPortCounters -l 1 -P 1 -s 0xC0000000 -V Default
600 (clears VLXmitData & VLRcvData)
601 opapaquery -o vfFocusPorts -V Default -f integrity -S 0 -r 20
602Copyright(C) 2015-2018 Intel Corporation opapaquery(8)