Skip to main content

Cornelis Technical Documentation

Name

opareports — The front end to opareport that provides many of the same options and capabilities.

Syntax

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

Description

opareports can run a report against multiple fabrics or subnets (for example, local host SuperNIC ports). It can use an input file to augment the reports using additional details from the topology_input file.

Options

--help

Produces full help text.

-t portsfile

Specifies the file with the list of local SuperNIC ports used to access fabric for analysis. Default is /etc/opa/ports file.

-p ports

Specifies the list of local SuperNIC ports used to access fabric(s) for analysis. Default is the first active port. Specified as HFI:port as follows:

Note

The first port on a SuperNIC is 1.

0:0

First active port in the system.

0:y

Port y within the system.

x:0

First active port on SuperNIC x.

x:y

SuperNIC x, port y.

-T topology_input

Specifies the 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/opa/topology.%P.xml. If -T NONE is specified, no topology input file is used.

opareport arguments

Options are passed to opareport. See

for the full set of options.

Note

When using opareport arguments, regard the following:

  • The -h and -X options are not available.

  • The meaning of -p is different for opareports than opareport.

  • When run against multiple fabrics, the -x and -o snapshot options are not available.

  • When run against multiple fabrics, the -F option is applied to all fabrics.

Examples

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

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 the 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 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 SuperNICs 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/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. Alternatively the filename can be specified as NONE to prevent the use of an input file.