opafequery (8) - Linux Man Pages

NAME

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
Produce this help text.

-v / --verbose
Verbose output.
-a / --ipAddr ipAddr
IP address of node running the FE.
-h / --hostName hostName
Host name of node running the FE.
-o / --output output
Output type. See SA Output Types and PA Output Types for details.
-E / --feEsm ESMName
ESM FE name.
-T / --sslParmsFile filename
SSL/TLS parameters XML file. Default = /etc/sysconfig/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
Group name for groupInfo query.
-l / --lid lid
LID of node for portCounters query.
-N / --portNumber
Port number for portCounters query.
-f / --delta
Delta flag for portCounters query. Values include: 0 or 1.
-U / --userCntrs
User-controlled counters flag for portCounters query.
-e / --select
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

0x40000000 - 30 - Receive Data

0x20000000 - 29 - Transmit Packets

0x10000000 - 28 - Receive Packets

0x08000000 - 27 - Multicast Transmit Packets

0x04000000 - 26 - Multicast Receive Packets

0x02000000 - 25 - Transmit Wait

0x01000000 - 24 - Congestion Discards

0x00800000 - 23 - Receive FECN

0x00400000 - 22 - Receive BECN

0x00200000 - 21 - Transmit Time Cong.

0x00100000 - 20 - Transmit Time Wasted BW

0x00080000 - 19 - Transmit Time Wait Data

0x00040000 - 18 - Receive Bubble

0x00020000 - 17 - Mark FECN

0x00010000 - 16 - Receive Constraint Errors

0x00008000 - 15 - Receive Switch Relay

0x00004000 - 14 - Transmit Discards

0x00002000 - 13 - Transmit Constraint Errors

0x00001000 - 12 - Receive Remote Phys. Errors

0x00000800 - 11 - Local Link Integrity

0x00000400 - 10 - Receive Errors

0x00000200 - 9 - Exc. Buffer Overrun

0x00000100 - 8 - FM Configuration Errors

0x00000080 - 7 - Link Error Recovery

0x00000040 - 6 - Link Error Downed

0x00000020 - 5 - Uncorrectable Errors

-c / --focus focus
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 errors - highest first.

congestion Sorted by congestion errors - highest first.

smacongesion Sorted by SMA congestion errors - highest first.

bubbles Sorted by bubble errors - highest first.

security Sorted by security errors - highest first.

routing Sorted by routing errors - highest first.

-w / --start
Start of window for focus ports - should always be 0.
-r / --range range
Size of window for focus ports list.
-b / --imgNum
64-bit image number. May be used with groupInfo, groupConfig, portCounters (delta) outputs.
-O / --imgOff
Image offset. May be used with groupInfo, groupConfig, portCounters (delta) outputs.
-F / --moveImgNum
64-bit image number. Used with moveFreeze output to move a freeze image.
-M / --moveImgOff ImgOff
Image offset. May be used with moveFreeze output to move a freeze image.
-V / --vfName
VF name for vfInfo query.

SA Output Types

Output types include:

saclassPortInfo
Class port info.
systemguid
List of system image GUIDs.
nodeguid
List of node GUIDs.
portguid
List of port GUIDs.
lid
List of LIDs.
desc
List of node descriptions/names.
path
List of path records.
node
List of node records.
portinfo
List of port info records.
sminfo
List of SM info records.
swinfo
List of switch info records.
link
List of link records.
scsc
List of SC to SC mapping table records.
slsc
List of SL to SC mapping table records.
scsl
List of SC to SL mapping table records.
scvlt
List of SC to VLt table records.
scvlnt
List of SC to VLnt table records.
vlarb
List of VL arbitration table records.
pkey
List of PKey table records.
service
List of service records.
mcmember
List of multicast member records.
inform
List of inform info records.
linfdb
List of switch linear forwarding database (FDB) records.
mcfdb
List of switch multicast FDB records.
trace
List of trace records.
vfinfo
List of vFabrics.
vfinfocsv
List of vFabrics in CSV format.
vfinfocsv2
List of vFabrics in CSV format with enums.
fabricinfo
Summary of fabric devices.
quarantine
List of quarantined nodes.
conginfo
List of Congestion Info Records.
swcongset
List of Switch Congestion Settings.
hficongset
List of HFI Congestion Settings.
hficongcon
List of HFI Congestion Control Settings.
bfrctrl
List of buffer control tables.
cableinfo
List of Cable Info records.
portgroup
List of AR Port Group records.
portgroupfdb
List of AR Port Group FWD records.

PA Output Types

paclassPortInfo
Class port info.
groupList
List of PA groups.
groupInfo
Summary statistics of a PA group. Requires -g option for groupName.
groupConfig
Configuration of a PA group. Requires -g option for groupName.
portCounters
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#8217#160; imgNum.
moveFreeze
Moves freeze frame from image ID to new image ID. Requires -b#8217#160; 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
List of virtual fabrics.
vfInfo
Summary statistics of a virtual fabric. Requires -V vfName option.
vfConfig
Configuration of a virtual fabric. Requires -V vfName option.
vfPortCounters
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