opafequery

(All) Used for testing or debugging performance administration (PA) operations to the Fabric Executive (FE). This tool performs custom PA client/server queries. The output formats and arguments are very similar to opapaquery.

Syntax

opafequery [-v] [-a ipAddr | -h hostName] [-E] [-T paramsfile] -o type 
[SA options | PA options]

General Options

--help

Produces full help text.

-v/--verbose

Specifies the verbose output.

-a/--ipAddr ipAddr

Specifies the IP address of node running the FE.

This options supports IPv4 and IPv6 addresses with port number; for example, 127.0.0.1:3245 or [::1]:3245.

-h/--hostName hostName

Specifies the host name of node running the FE.

This option supports host name with port number; for example, localhost:3245.

-o/--output output

Specifies the output type. See SA Output Types and PA Output Types for details.

-E/--feEsm ESMName

Specifies the ESM FE name.

-T/--sslParmsFile filename

Specifies the SSL/TLS parameters XML file. Default = /etc/opa/opaff.xml

SA Specific Options

-I/--IB

Issues query in legacy InfiniBand* format.

-l/--lid lid

Queries a specific LID.

-k/--pkey pkey

Queries a specific pkey.

-i/--vfindex vfindex

Queries a specific vfindex.

-S/--serviceId serviceId

Queries a specific service ID.

-L/--SL SL

Queries by service level.

-t/--type type

Queries by node type.

-s/--sysguid guid

Queries by system image GUID.

-n/--nodeguid guid

Queries by node GUID.

-p/--portguid guid

Queries by port GUID.

-u/--portgid gid

Queries by port GID.

-m/--mcgid gid

Queries by multicast GID.

-d/--desc name

Queries by node name/description.

-P/--guidpair 'guid guid'

Queries by a pair of port GUIDs.

-G/--gidpair 'gid gid'

Queries by a pair of GIDs.

-B/--guidlist 'sguid ...;dguid ...'

Queries by a list of port GUIDs.

-A/--gidlist 'sgid ...;dgid ...'

Queries by a list of GIDs.

-x/--sourcegid gid

Specifies a source GID for certain queries.

PA Specific Options

-g/--groupName groupName

Queries by group name for groupInfo.

-l/--lid lid

Queries by LID of node for portCounters.

-N/--portNumber

Queries by port number for portCounters.

-f/--delta

Queries by delta flag for portCounters. Values include: 0 or 1.

-j/--begin date_time

Obtains portCounters over an interval beginning at date_time.

date_time may be a time entered as HH:MM[:SS] or date as mm/dd/YYYY, dd.mm.YYYY, YYYY-mm-dd or date followed by time; for example, "2016-07-04 14:40". Relative times are taken as "x [second|minute|hour|day](s) ago.

-q/--end date_time

Obtains portCounters over an interval ending at date_time.

date_time may be a time entered as HH:MM[:SS] or date as mm/dd/YYYY, dd.mm.YYYY, YYYY-mm-dd or date followed by time; for example, "2016-07-04 14:40". Relative times are taken as "x [second|minute|hour|day](s) ago.

-U/--userCntrs

Queries by user-controlled counters flag for portCounters.

-e/--select

Specifies the 32-bit select flag for clearing port counters select bits. 0 is least significant (rightmost).

Bit descriptions are listed below in the order "mask - bit - location":

  • 0x80000000 - 31 - Transmit Data (XmitData)

  • 0x40000000 - 30 - Receive Data (RcvData)

  • 0x20000000 - 29 - Transmit Packets (XmitPkts)

  • 0x10000000 - 28 - Receive Packets (RcvPkts)

  • 0x08000000 - 27 - Multicast Transmit Packets (MulticastXmitPkts)

  • 0x04000000 - 26 - Multicast Receive Packets (MulticastRcvPkts)

  • 0x02000000 - 25 - Transmit Wait (XmitWait)

  • 0x01000000 - 24 - Congestion Discards (CongDiscards)

  • 0x00800000 - 23 - Receive FECN (RcvFECN)

  • 0x00400000 - 22 - Receive BECN (RcvBECN)

  • 0x00200000 - 21 - Transmit Time Congestion (XmitTimeCong)

  • 0x00100000 - 20 - Transmit Time Wasted BW (XmitWastedBW)

  • 0x00080000 - 19 - Transmit Time Wait Data (XmitWaitData)

  • 0x00040000 - 18 - Receive Bubble (RcvBubble)

  • 0x00020000 - 17 - Mark FECN (MarkFECN)

  • 0x00010000 - 16 - Receive Constraint Errors (RcvConstraintErrors)

  • 0x00008000 - 15 - Receive Switch Relay (RcvSwitchRelayErrors)

  • 0x00004000 - 14 - Transmit Discards (XmitDiscards)

  • 0x00002000 - 13 - Transmit Constraint Errors (XmitConstraintErrors)

  • 0x00001000 - 12 - Receive Remote Physical Errors (RcvRemotePhysicalErrors)

  • 0x00000800 - 11 - Local Link Integrity (LocalLinkIntegrityErrors)

  • 0x00000400 - 10 - Receive Errors (RcvErrors)

  • 0x00000200 - 9 - Excessive Buffer Overrun (ExcessiveBufferOverruns)

  • 0x00000100 - 8 - FM Configuration Errors (FMConfigErrors)

  • 0x00000080 - 7 - Link Error Recovery (LinkErrorRecovery)

  • 0x00000040 - 6 - Link Error Downed (LinkDowned)

  • 0x00000020 - 5 - Uncorrectable Errors (UncorrectableErrors)

-c/--focus focus

Specifies the focus select value for getting focus ports. Values include:

utilhigh

Sorted by utilization - highest first.

pktrate

Sorted by packet rate - highest first.

utillow

Sorted by utilization - lowest first.

integrity

Sorted by integrity category - highest first.

congestion

Sorted by congestion category - highest first.

smacongesion

Sorted by SMA congestion category - highest first.

bubbles

Sorted by bubble category - highest first.

security

Sorted by security category - highest first.

routing

Sorted by routing category - highest first.

-w/--start

Specifies the start of window for focus ports - should always be 0.

-r/--range range

Specifies the size of window for focus ports list.

-b/--imgNum

Specifies the 64-bit image number. May be used with groupInfo, groupConfig, portCounters (delta) outputs.

-O/--imgOff

Specifies the image offset. May be used with groupInfo, groupConfig, portCounters (delta) outputs.

-y/--imgTime

Specifies the image time. May be used with imageinfo, groupInfo, groupInfo, groupConfig, freezeImage, focusPorts, vfInfo, vfConfig, and vfFocusPorts . Will return closest image within image interval if possible. See --begin/--end above for format.

-F/--moveImgNum

Specifies the 64-bit image number. Used with moveFreeze output to move a freeze image.

-M/--moveImgOff ImgOff

Specifies the image offset. May be used with moveFreeze output to move a freeze image.

-V/--vfName

Queries by VF name for vfInfo.

SA Output Types

Output types include:

saclassPortInfo

Specifies the class port info.

systemguid

Lists the system image GUIDs.

nodeguid

Lists the node GUIDs.

portguid

Lists the port GUIDs.

lid

Lists the LIDs.

desc

Lists the node descriptions/names.

path

Lists the path records.

node

Lists the node records.

portinfo

Lists the port info records.

sminfo

Lists the SM info records.

swinfo

Lists the switch info records.

link

Lists the link records.

scsc

Lists the SC to SC mapping table records.

slsc

Lists the SL to SC mapping table records.

scsl

Lists the SC to SL mapping table records.

scvlt

Lists the SC to VLt table records.

scvlnt

Lists the SC to VLnt table records.

vlarb

Lists the VL arbitration table records.

pkey

Lists the PKey table records.

service

Lists the service records.

mcmember

Lists the multicast member records.

inform

Lists the inform info records.

linfdb

Lists the switch linear forwarding database (FDB) records.

mcfdb

Lists the switch multicast FDB records.

trace

Lists the trace records.

vfinfo

Lists the vFabrics.

vfinfocsv

Lists the vFabrics in CSV format.

vfinfocsv2

Lists the vFabrics in CSV format with enums.

fabricinfo

Provides a summary of fabric devices.

quarantine

Lists the quarantined nodes.

conginfo

Lists the Congestion Info Records.

swcongset

Lists the Switch Congestion Settings.

hficongset

Lists the HFI Congestion Settings.

hficongcon

Lists the HFI Congestion Control Settings.

bfrctrl

Lists the buffer control tables.

cableinfo

Lists the Cable Info records.

portgroup

Lists the AR Port Group records.

portgroupfdb

Lists the AR Port Group FWD records.

PA Output Types

Output types include:

paclassPortInfo

Specifies the class port info.

groupList

Lists the PA groups.

groupInfo

Provides a summary statistics of a PA group. Requires -g option for groupName.

groupConfig

Specifies the configuration of a PA group. Requires -g option for groupName.

portCounters

Specifies the port counters of fabric port. Requires -l lid and -N port options. Optionally, use the -f delta option.

clrPortCounters

Clears port counters of fabric port. Requires -l lid, -N port, and -e select options.

clrAllPortCounters

Clears all port counters in fabric.

pmConfig

Retrieves PM configuration information.

freezeImage

Creates freeze frame for image ID. Requires -b imgNum.

releaseImage

Releases freeze frame for image ID. Requires -b imgNum.

renewImage

Renews lease for freeze frame for image ID. Requires -b imgNum.

moveFreeze

Moves freeze frame from image ID to new image ID. Requires -b imgNum and -F moveImgNum.

focusPorts

Gets sorted list of ports using utilization or error values (from group buckets).

imageInfo

Gets information about a PA image (timestamps and other details). Requires -b imgNum.

vfList

Lists the virtual fabrics.

vfInfo

Provides a summary statistics of a virtual fabric. Requires -V vfName option.

vfConfig

Specifies the configuration of a virtual fabric. Requires -V vfName option.

vfPortCounters

Specifies the port counters of fabric port. Requires -V vfName, -l lid, and -N port options. Optionally, use the -f delta option.

vfFocusPorts

Gets sorted list of virtual fabric ports usingutilization or error values (from VF buckets). Requires -V vfName option.

clrVfPortCounters

Clears VF port counters of fabric port. Requires -l lid, -N port, -e select, and -V vfName options.

Examples

opafequery -o saclassPortInfo 
opafequery -h stewie -o paclassPortInfo 
opafequery -a 172.21.2.155  -o saclassPortInfo 
opafequery -o groupList 
opafequery -o groupInfo -g All 
opafequery -o groupConfig -g All 
opafequery -h stewie -o groupInfo -g All 
opafequery -a 172.21.2.155 -o groupInfo -g All 
opafequery -o portCounters -l 1 -N 1 -d 1 
opafequery -o portCounters -l 1 -N 1 -d 1 -e 0x20000000d02 -O 1 
opafequery -o pmConfig 
opafequery -o freezeImage 0x20000000d02 
opafequery -o releaseImage -b 0xd01 
opafequery -o renewImage -b 0xd01 
opafequery -o moveFreeze -b 0xd01 -m 0x20000000d02 -M -2
opafequery -o focusPorts -g All -f 0x00030001 -w 0 -r 20
opafequery -o imageInfo -b 0x20000000d02