Skip to main content

Cornelis Technical Documentation

Name

opasaquery — Performs various queries of the subnet manager/subnet agent and provides detailed fabric information.

Syntax

opasaquery [-v] [-I] [-h hfi|-b addr] [-p port] [--timeout] [-x src_gid] [-T ssl_params] [-l lid] [-t nodetype] [-s guid] [-n guid] [-g guid] [-k pkey] [-i vfIndex] [-S serviceId] [-L sl] [-u gid] [-m gid] [-d desc_name] [-D dg_name] [-P 'guid guid'] [-G 'gid gid'] [-H 'mask'] [-o type]

Description

opareport and opareports from OPX Software can provide a more powerful tool. In some cases, opasaquery is preferred, especially when dealing with virtual fabrics, service records, and multicast.

By default, opasaquery uses the first active port on the local system. However, if the node is connected to more than one fabric (for example, a subnet), the SuperNIC and port may be specified to select the fabric whose SA is to be queried.

Options

--help

Produces full help text.

-v/--verbose

Returns verbose output. A second invocation activates openib debugging, a third invocation activates libibumad debugging.

-I/--IB

Issues query in legacy InfiniBand format.

-h/--hfi hfi

Specifies the SuperNIC, 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.

  • In-band: Numbered 1..n. Using 0 specifies first active port. Default is 0.

  • Out-of-band: Port FE is listening on. Default is 3245.

--timeout

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

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

-T/--ssl-params file

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

-l/--lid lid

Queries a specific LID.

-t/--type node_type

Queries by node type. See Node Types for details.

-s/--sysguid guid

Queries by system image GUID.

-n/--nodeguid guid

Queries by node GUID.

-g/--portguid guid

Queries by port GUID.

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

-u/--portgid gid

Queries by port GID. See GIDs for details.

-m/--mcgid gid

Queries by multicast GID for switches. See GIDs for details.

-d/--desc name

Queries by node name/description.

-D/--dgname name

Queries by device group name/description

-P/--guidpair 'guid guid'

Queries by a pair of port GUIDs.

-G/--gidpair 'gid gid'

Queries by a pair of GIDs. See GIDs for details.

-H mask

Queries by link condition. The following shows Mask: Condition.

  • 0x1: slowlinks

  • 0x2: misconfiglinks

  • 0x3: misconnlinks

-o type

Output type for query. Default is node. See Node Types for details.

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

-h 0

First active port in the system (Default).

-h 0 -p 0

First active port in the system.

-h x

First active port on SuperNIC x.

-h x -p 0

First active port on SuperNIC x.

-h 0 -p y

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

-h x -p y

SuperNIC x, port y.

Node Types

fi

Fabric Interface

sw

Switch

GIDs

Specifies a 64-bit subnet and 64-bit interface ID in the form:

subnet:interface

Note

In the following example, the GID corresponds to a PortGID. In this case, the interface ID coincides with the lower 64-bits of the GUID of the card. The interface ID will be different if the GID is a multicast GID (MGID). See opafm.xml for MGID examples.

0xfe80000000000000:0x00117500a0000380

Output Types

Default is node.

classportinfo

Specifies the classportinfo of the SA.

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.

scvlr

Lists the SC to VLr table records.

scvlnt

Lists the SC to VLnt table records.

sitscvlt

Lists the Sit to SC to VLt table records.

vlarb

Lists the VL arbitration table records.

bwarb

Lists the BW 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.

hierfdb

Lists the switch hierarchical FDB records.

hiercont

Lists the switch hierarchical control records.

hiertabsel

Lists the switch hierarchical table select records.

hieroverride

Lists the switch hierarchical override records.

hierboverride

Lists the switch hierarchical BCAM override 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

Specifies the summary of fabric devices.

quarantine

Lists the quarantined nodes.

conginfo

Lists the Congestion Info Records.

swcongset

Lists the Switch Congestion Settings.

hficongcrtlexch

Lists the SuperNIC congestion control exchange.

swcongexch

Lists the switch congestion exchange settings.

swtelemexch

Lists the switch telemetry exchange settings.

swportcong

Lists the Switch Port Congestion Settings.

hficongset

Lists the SuperNIC Congestion Settings.

hficongcon

Lists the SuperNIC 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.

dglist

Lists the Device Group Names.

dgmember

Lists the Device Group records.

dtree

Lists the Device Tree records.

swcost

Lists the switch cost records.

The vfinfocsv and vfinfocsv2 output formats are designed to make it easier to script vfinfo queries. One line is output per vFabric of the form:

name:index:pkey:sl:mtu:rate:optionflag::mcastSl

The only difference between these two formats is how the MTU and rate are output. vfinfocsv outputs MTU and rate in human/text readable format. vfinfocsv2 outputs MTU and rate as enumerations defined for the SMA protocol. The opagetvf command is based on this capability of opasaquery. For more information, see opagetvf.

Example

opasaquery -o desc -t fi

Notes

The following list shows the input (assorted query by options) and outputs (-o) that are permitted or not permitted.

None
-o permitted

systemguid, nodeguid, portguid, lid, desc, path, node, portinfo, sminfo, swinfo, link, vlarb, pkey, service, mcmember, inform, linfdb, mcfdb, vfinfo, vfinfocsv, vfinfocsv2, scsc, slsc, scvlt, scnlmt, linfdb, classportinfo, fabricinfo, quarantine, conginfo, swcongset, swportcong, hficongset, hficongcon, bfrctl, cableinfo, portgroup, portgroupfdb, dglist, dgmember, dtree

-o not permitted

trace

-t nodetype
-o permitted

systemguid, nodeguid, portguid, lid, desc, node, dglist, dgmember, dtree

-o not permitted

portinfo, sminfo, swinfo, vlarb, pkey, service, mcmember, inform, linfdb, mcfdb, trace, vfinfo, vfinfocsv, vfinfocsv2

-l lid
-o permitted

systemguid, nodeguid, portguid, lid, desc, path, node, portinfo, swinfo, slvl, vlarb, pkey, mcmember, linfdb, mcfdb, dgmember, dtree

-o not permitted

sminfo, link, inform, service, trace, vfinfo, vfinfocsv, vfinfocsv2, dglist

-k pkey
-o permitted

mcmember, path, vfinfo, vfinfocsv, vfinfocsv2

-o not permitted

systemimageguid, nodeguid, portguid, lid, desc, node, portinfo, sminfo, swinfo, link, vlarb, pkey, service, mcmember, inform, linfdb, mcfdb, dglist, dgmember, dtree

-i vfindex
-o permitted

vfinfo, vfinfocsv, vfinfocsv2

-o not permitted

systemimageguid, nodeguid, portguid, lid, desc, node, portinfo, sminfo, swinfo, link, vlarb, pkey, service, mcmember, inform, linfdb, mcfdb, dglist, dgmember, dtree

-s system_image_guid
-o permitted

systemguid, nodeguid, portguid, lid, desc, node

-o not permitted

portinfo, sminfo, swinfo, link, vlarb, pkey, service, mcmember, inform, linfdb, mcfdb, trace, vfinfo, vfinfocsv, vfinfocsv2, dglist, dgmember, dtree

-n node_guid
-o permitted

systemguid, nodeguid, portguid, lid, desc, node

-o not permitted

portinfo, sminfo, swinfo, link, vlarb, pkey, service, mcmember, inform, linfdb, mcfdb, trace, vfinfo, vfinfocsv, vfinfocsv2, dglist, dgmember, dtree

-g port_guid
-o permitted

systemguid, nodeguid, portguid, lid, desc, path, node, trace, dgmember

-o not permitted

portinfo, sminfo, swinfo, link, vlarb, pkey, linfdb, mcfdb, vfinfo, vfinfocsv, vfinfocsv2, dglist, dtree, service, mcmember, inform

-u port_gid
-o permitted

path, service, mcmember, inform, trace

-o not permitted

systemguid, nodeguid, portguid, lid, desc, node, portinfo, sminfo, swinfo, link, vlarb, pkey, linfdb, mcfdb, vfinfo, vfinfocsv, vfinfocsv2, dglist, dgmember, dtree

-m multicast_gid
-o permitted

mcmember, vfinfo, vfinfocsv, vfinfocsv2

-o not permitted

systemguid, nodeguid, portguid, lid, desc, path, node, portinfo, sminfo, swinfo, link, vlarb, pkey, service, inform, linfdb, mcfdb, trace, dglist, dgmember, dtree

-d node_description
-o permitted

systemguid, nodeguid, portguid, lid, desc, node, dgmember

-o not permitted

trace, dglist, dtree

-D dg_name
-o permitted

dgmember

-o not permitted

systemguid, nodeguid, portguid, lid, desc, path, node, portinfo, sminfo, swinfo, link, vlarb, pkey, service, inform, linfdb, mcfdb, trace, dglist, dtree

-P port_guid_pair
-o permitted

path, trace

-o not permitted

systemguid, nodeguid, portguid, lid, desc, node, portinfo, sminfo, swinfo, link, vlarb, pkey, service, mcmember, inform, linfdb, mcfdb, dglist, dgmember, dtree

-S serviceId
-o permitted

path, vfinfo, vfinfocsv, vfinfocsv2, service

-o not permitted

systemimageguid, nodeguid, portguid, lid, desc, node, portinfo, sminfo, swinfo, link, vlarb, pkey, mcmember, inform, linfdb, mcfdb, dglist, dgmember, dtree

-L SL
-o permitted

path, vfinfo, vfinfocsv, vfinfocsv2

-o not permitted

systemimageguid, nodeguid, portguid, lid, desc, node, portinfo, sminfo, swinfo, link, vlarb, pkey, service, mcmember, inform, linfdb, mcfdb, dglist, dgmember, dtree

-G gid_pair
-o permitted

path, trace

-o not permitted

systemguid, nodeguid, portguid, lid, desc, node, portinfo, sminfo, swinfo, link, vlarb, pkey, service, mcmember, inform, linfdb, mcfdb, dglist, dgmember, dtree

Example

opasaquery -o desc -t fi

Subnet Administrator/Administration

Fabric Executive - This is an Omni-Path component that provides out-of-band access to the Fabric Manager.

Group Identifier - This is a unique identifier assigned to a group of users on a system, allowing them to access files and directories with common permissions.

Secure Socket Layer - This is a protocol for establishing secure links between networked computers

Transport Layer Security - This cryptographic protocol is designed to provide communications security over a computer network.

Local Identifier - This is a 24-bit address local to a subnet that is assigned to end nodes by the subnet manager, providing additional features related to routing algorithms.

Globally Unique Identifier - This is a 128-bit text string generated when a unique reference number is needed to identify a component (for example, hardware, software, node) on a computer or network.

Partition Key - This is a unique ID assigned to an InfiniBand or vFabric partition.

Subnet Manager or Subnet Management

Service Channel

Service Level

Adaptive Routing (also called Dynamic Routing) - This technique uses algorithms to send data packets along the best routes, reading and responding to changes in network topology.

Subnet Management Agent