opareports (8) - Linux Man Pages

NAME

opareports

(All) opareports is a front end to opareport that provides many of the same options and capabilities. It can also run a report against multiple fabrics or subnets (for example, local host HFI ports). opareports can use an input file to augment the reports using additional details from the topology_input file.

Syntax

opareports [-t portsfile] [-p ports] [-T topology_input] [opareport arguments]

Options

--help
Produces full help text.
-t portsfile
File with list of local HFI ports used to access fabric for analysis. Default is /etc/sysconfig/opa/ports file.
-p ports
List of local HFI ports used to access fabric for counter clear. Default is first active port. The first HFI in the system is 1. The first port on an HFI is 1.

Uses the format hfi:port, for example:

0:0 First active port in system.

0:y Port y within system.

x:0 First active port on HFI x.

x:y HFI x, port y.

-T topology_input
Name of a topology input file to use. The filename may have %P as a marker which is replaced with the hfi:port being operated on, such as 0:0 or 1:2. The default filename is specified by FF_TOPOLOGY_FILE as /etc/sysconfig/opa/topology.%P.xml. If -T NONE is specified, no topology input file is used.
opareport arguments
Any of the other opareport arguments. The -h and -X options are not available. Note that the meaning of -p is different for opareports than opareport. When run against multiple fabrics, the -x and -o snapshot options are not available.

NOTE: When run against multiple fabrics, the -F option is applied to all fabrics. See opareport for more information.

Example

opareports opareports -p '1:1 2:1'

Environment Variables

The following environment variables are also used by this command:

PORTS
List of ports, used in absence of -t and -p.
PORTS_FILE
File containing list of ports, used in absence of -t and -p.
FF_TOPOLOGY_FILE
File containing topology_input (may have %P marker in filename), used in absence of -T.

Details

For simple fabrics, the Intel(R) Omni-Path Fabric Suite FastFabric Toolset host is connected to a single fabric. By default, the first active port on the FastFabric Toolset host is used to analyze the fabric.

However, in more complex fabrics, the FastFabric Toolset host may be connected to more than one fabric or subnet. In this case, you can specify the ports or HFIs to use with one of the following methods:

On the command line using the -p option.
In a file specified using the -t option.
Through the environment variables PORTS or PORTS_FILE.
Using the ports_file configuration option in /etc/sysconfig/opa/opafastfabric.conf.

If the specified port does not exist or is empty, the first active port on the local system is used. In more complex configurations, you must specify the exact ports to use for all fabrics to be analyzed.

You can specify the topology_input file to be used with one of the following methods:

On the command line using the -T option.
In a file specified through the environment variable FF_TOPOLOGY_FILE.
Using the ff_topology_file configuration option in opafastfabric.conf.

If the specified file does not exist, no topology_input file is used. Alternately the filename can be specified as NONE to prevent use of an input file.