NAME¶

(All) Performs various queries of the performance management (PM)/performance administration (PA) agent and provides details about fabric performance. Refer to the Intel(R) Omni-Path Fabric Suite Fabric Manager User Guide

for a description of the operation and client services of the PM/PA.

By default, opapaquery queries the most recent data. However, if an image number (imgNum) and/or image offset (imgOff) is provided, the query returns previous sweep data. Queries that access previous sweep data return with the absolute image number representing that data, and therefore have an image offset of zero.

opapaquery's operation is dependent on an Intel(R) Omni-Path Fabric Suite Fabric Manager version 6.0 or greater running as master SM/PM in the fabric.

By default, opapaquery uses the first active port on the local system. However, if the Fabric Management Node is connected to more than one fabric (for example, a subnet), the HFI and port may be specified to select the fabric whose PA is to be queried.

Syntax¶

Options¶

-v/--verbose

Specifies the verbose output.

-h/--hfi hfi

Specifies the HFI, numbered 1..n. Using 0 specifies that the -p port port is a system-wide port number. Default is 0.

-b/--oob address

Specifies Out-of-Band address of node running the FE. Can be either hostname, IPv4, or IPv6 address. Default is "127.0.0.1".

-p/--port port

Specifies the port.

-x/--source-gid src_gid

Specifies the source GID of the local GID. (This is required for most Path and Trace Record Queries when Out-of-Band.)

-E/--feEsm

Specifies the ESM FE.

-T/--ssl-params file

Specifies the SSL/TLS parameters XML file. Default is /etc/opa/opamgt_tls.xml.

-o/--output type

Specifies the output type. Default is groupList. See Output Types

-g/--groupName groupName

Specifies the group name for groupInfo query.

-l/--lid lid

Specifies the LID of the node.

-P/--portNumber portNumber

Specifies the port number within the node.

--timeout

Specifies the timeout (response wait time) in ms. Default is 1000 ms.

-G/--nodeGuid

Specifies the GUID of the node.

-D/--nodeDesc

Specifies the description of the node.

-d/--delta delta

Specifies the delta flag for portCounters query - 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.

-s/--select select

Specifies the 32-bit select flag for clearing port counters.

Select bits for clrPortCounters. 0 is the least significant bit (rightmost). The clrPortCounters bit descriptions are listed in the order "mask - bit - location" below:

Select bits for clrVfPortCounters. 0 is the least significant bit (rightmost). The clrVfPortCounters bit descriptions are listed in the order "mask - bit - location" below:

-f/--focus focus

Specifies the focus select value for getting focus ports. focus select values are:

-S/--start 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.

-Q/--tuple

Specifies a tuple that identifies a focus select value, comparator and argument in the form select: comparator:argument. Up to 8 tuples may be specified as: -Q s1:c1:a1 -Q s2:c2:a2 ... -Q s8:c8:a8

Valid focus select values are: utilization, pktrate, integrity, congestion, smacongestion, bubbles, security and routing.

Valid comparator values are: GT, GE, LT, LE

Valid arguments are: Any 64-bit value in hexadecimal or decimal.

When specifying more than one tuple, a logical operator -Z/--operator must also be specified.

-Z/--operator

Specifies a logical operator used to join the results of the specified tuples.

and - Specifies a port is returned if it meets all of the tuple filter criteria.

or - Specifies a port is returned if it meets one or more of the tuple filter criteria.

-n/--imgNum imgNum

Specifies the 64-bit image number.

-O/--imgOff imgOff

Specifies the image offset.

-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.

-m/--moveImgNum moveImgNum

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

-M/--moveImgOff moveImgOff

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

-V/--vfName vfName

Specifies the VF name for vfInfo query.

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

-h 0

First active port in system (Default).

-h 0 -p 0

First active port in system.

-h x

First active port on HFI x.

-h x -p 0

First active port on HFI x.

-h 0 -p y

Port y within system (no matter which ports are active).

-h x -p y

HFI x, port y.

Output Types¶

classPortInfo

Specifies the class port info.

groupList

Specifies the list of PA groups.

groupInfo

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

groupConfig

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

groupNodeInfo

Specifies the node information of a PA group. Requires -g option for groupName. Options -l lid, -G nodeGuid and -D nodeDesc are optional.

groupLinkInfo

Specifies the link Information of a PA group. Requires -g option for groupName. Options -l lid and -P port are optional. Note that -P 255 specifies all ports. Option -P port without -l lid is ignored.

portCounters

Specifies the port counters of fabric port. Requires -l lid and -P port options. -d delta is optional.

clrPortCounters

Clears port counters of fabric port. Requires -l lid and -P port, and -s select options.

clrAllPortCounters

Clears all port counters in fabric.

pmConfig

Retrieves PM configuration information.

freezeImage

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

releaseImage

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

renewImage

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

moveFreeze

Moves freeze frame from image ID to new image ID. Requires -n imgNum and -m moveImgNum.

focusPorts

Gets sorted list of ports using utilization or error values (from group buckets). Requires -g groupname, -f focus, -S start, -r range.

imageInfo

Gets configuration of a PA image (timestamps, etc.). Requires -n imgNum.

vfList

Specifies the list of virtual fabrics.

vfInfo

Specifies the summary statistics of a virtual fabric. Requires -V option for vfName.

vfConfig

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

vfPortCounters

Specifies the port counters of fabric port. Requires -V vfName, -l lid and -P port options, -d delta is optional.

vfFocusPorts

Gets sorted list of virtual fabric ports using utilization or error values (from VF buckets). Requires -V vfname, -f focus, -S start, -r range.

clrVfPortCounters

Clears VF port counters of fabric port. Requires -l lid, -P port, -s select, and -V vfname options.

Examples¶