DOKK / manpages / debian 10 / opa-fastfabric / opareports.8.en
opareports(8) Master map: IFSFFCLIRG (Man Page) opareports(8)

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.

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

Produces full help text.
Specifies the file with list of local HFI ports used to access fabric for analysis. Default is /etc/opa/ports file.
Specifies the 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.

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.
Options are passed to opareport.

Specifies any of the other opareport arguments listed below (see opareport Options ):
opareport [-v][-q] [-h hfi] [-p port] [--timeout]
[-o report][-d detail] [-P|-H] [-N] [-x]
[-X snapshot_input][-T topology_input] [-s] [-r] [-V]
[-i seconds][-b date_time] [-e date_time] [-C] [-a]
[-m] [-M] [-A][-c file] [-L] [-F point] [-S point]
[-D point] [-Q]

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.

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

The following environment variables are also used by this command:

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

For reference:

Produces full help text.

Returns verbose output.

Disables progress reports.

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

Specifies the port, numbered 1..n. Using 0 specifies the first active port. Default is 0.

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

Specifies the report type for output. Refer to opareport Report Types for details.

Specifies the level of detail 0-n for output. Default is 2.

Only includes data persistent across reboots.

Only includes permanent hardware data.

Omits node and IOC names.

Produces output in XML.

Generates a report using the data in the snapshot_input file. snapshot_input must have been generated during a previous -o snapshot run. When used, the -s, -i, -C, and -a options are ignored. '-' may be used as the snapshot_input to specify stdin.

Uses topology_input file to augment and verify fabric information. When used, various reports can be augmented with information not available electronically (such as cable labels). '-' may be used to specify stdin.

Gets performance statistics for all ports.

Obtains performance statistics over interval seconds. Clears all statistics, waits interval seconds, then generates report. Implies -s option.

Obtains past performance stats over an interval beginning at date_time. Implies -s option. 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.

Obtains past performance stats over an interval ending at date_time. Implies -s option.

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.
Clears performance statistics for all ports. Only statistics with error thresholds are cleared. A clear occurs after generating the report.

Clears all performance statistics for all ports.

Accesses fabric information directly from SMA.

Accesses performance statistics using direct PMA.

Gets PortInfo for down switch ports. Uses direct SMA to get this data. If used with -M, also gets PMA stats for down switch ports.

Specifies the error thresholds configuration file. Default is /etc/opa/opamon.conf file.

Limits operation to exact specified focus with -F for port error counters check (-o errors) and port counters clear (-C or -i). Normally, the neighbor of each selected port is also checked/cleared. Does not affect other reports.

Specifies the focus area for report.

Limits output to reflect a subsection of the fabric. May not work with all reports. (For example, route, mcgroups, and the verify* reports may ignore the option or not generate useful results.)
Specifies the source for trace route. Default is local port.

Specifies the destination for trace route.

Excludes focus description from report.

For reference:

Gets routing tables for all switches.

Gets the P-Key tables for all nodes and the QoS VL-related tables for all ports.

For reference:

Summary of all systems and SMs in fabric.

Brief summary of all systems and SMs in fabric.

Summary of all node types and SMs in fabric.

Brief summary of all node types and SMs in fabric.

Summary of all IO units in the fabric.

Summary of all LIDs in the fabric.

Summary of all links.

Summary of links external to systems.

Summary of links to FIs.

Summary of inter-switch links.

Summary of inter-switch links external to systems.

Summary of links running slower than expected.

Summary of links configured to run slower than supported, includes slowlinks.

Summary of links connected with mismatched speed potential, includes slowconfiglinks.

Summary of links configured to run slower than supported.

Summary of links connected with mismatched speed potential.

Summary of links whose errors exceed counts in the configuration file.

Summary of ports not connected to the fabric.

Summary of linear forwarding data base (FDB) for each switch.

Summary of multicast FDB for each switch in the fabric.

Summary of multicast groups.

When used in conjunction with -d, the following report details are possible:

  • -d0 : Shows the number of multicast groups
  • -d1 : Shows a list of multicast groups
  • -d2 : Shows a list of members per multicast group

This report can be used with option -X.
Summary of ports referenced in linear FDB for each switch, broken down by NodeType of DLID.

Summary of number of FI to FI paths routed through each switch port.

Analysis of number of FI to FI paths routed through each switch port for a FAT tree.

Summary of adaptive routing port groups for each switch.

Summary of quarantined nodes.

Validates all routes in the fabric.

Validates all routes in the fabric using SLSC, SCSC, and SCVL tables.

Validates all port groups in the fabric.

Validates topology configuration of the fabric to identify any existing credit loops.

Validates topology configuration of the fabric including SLSC, SCSC, and SCVL tables to identify any existing credit loops.

Validates multicast routes of the fabric to identify loops in multicast forwarding tables and detect MFT-multicast membership inconsistencies.

Summary of virtual fabric (vFabric) information.

Summary of vFabric membership information.

Summary of DeviceGroup membership information.

Compares fabric (or snapshot) FIs to supplied topology and identifies differences and omissions.

Compares fabric (or snapshot) switches to supplied topology and identifies differences and omissions.

Returns verifyfis and verifysws reports.

Compares fabric (or snapshot) SMs to supplied topology and identifies differences and omissions.

Compares fabric (or snapshot) links to supplied topology and identifies differences and omissions.

Compares fabric (or snapshot) links to supplied topology and identifies differences and omissions. Limits analysis to links external to systems.

Compares fabric (or snapshot) links to supplied topology and identify differences and omissions. Limits analysis to links to FIs.

Compares fabric (or snapshot) links to supplied topology and identify differences and omissions. Limits analysis to inter-switch links.

Compares fabric (or snapshot) links to supplied topology and identify differences and omissions. Limits analysis to inter-switch links external to systems.

Returns verifyfis, verifysws, verifysms, and verifylinks reports.

Returns comps, nodes, ious, links, extlinks, slowconnlinks, and errors reports.

Traces route between -S and -D points.

Reports Buffer Control Tables for all ports.

Outputs snapshot of the fabric state for later use as snapshot_input. This implies -x. May not be combined with other reports. When selected, -F, -P, -H, and -N options are ignored.

Outputs the topology of the fabric for later use as topology_input. This implies -x. May not be combined with other reports. Use with detail level 3 or more to get Port element under Node in output xml.

No report, useful to clear statistics.

For reference:

value is numeric port GID of form: subnet:guid.

value is numeric LID.

value is numeric LID, selects entire node with given LID.

value is numeric LID of node, value2 is port number.

value is numeric port GUID.

value is numeric node GUID.

value1 is numeric node GUID, value2 is port number.

value is numeric IOC GUID.

value1 is numeric IOC GUID, value2 is port number.

value is numeric system image GUID.

value1 is the numeric system image GUID, value2 is port number.

value is IOC Profile ID String (IOC Name).

value1 is IOC Profile ID String (IOC Name), value2 is port number.

value is glob pattern for IOC Profile ID String (IOC Name).

value1 is glob pattern for IOC Profile ID String (IOC Name), value2 is port number.

value is IOC type (SRP or OTHER).

value1 is IOC type (SRP or OTHER); value2 is port number.

value is node description (node name).

value1 is node description (node name), value2 is port number.

value is glob pattern for node description (node name).

value1 is the glob pattern for the node description (node name), value2 is port number.

value is glob pattern for node details.

value1 is the glob pattern for the node details, value2 is port number.

value is node type (SW, FI, or RT).

value1 is node type (SW, FI, or RT), value2 is port number.

value is string for rate (25g, 50g, 75g, 100g), omits switch mgmt port 0.

value is a string for state (down, init, armed, active, notactive, initarmed).

value is a string for PHYs state (polling, disabled, training, linkup, recovery, offline, test)

value is MTU size (2048, 4096, 8192, 10240), omits switch mgmt port 0.

value is glob pattern for cable label.

value is glob pattern for cable length.

value is glob pattern for cable details.

value is glob pattern for cable info length.

value is glob pattern for cable info vendor name.

value is glob pattern for cable info vendor part number.

value is glob pattern for cable info vendor revision.

value is glob pattern for cable info vendor serial number.

value is either optical, passive_copper, active_copper, or unknown.

value is glob pattern for link details.

value is glob pattern for port details.

Specifies the master subnet manager (SM).

value is glob pattern for SM details.

Specifies all ports along the routes between the two given points.

value is either on or off for LED port beacon.

Specifies the ports with a link quality equal to value.

Specifies the ports with a link quality less than or equal to value.

Specifies the ports with a link quality greater than or equal to value.

For reference:

opareport can generate hundreds of different reports. Commonly generated reports include the following:opareport -o comps -d 3
opareport -o errors -o slowlinks
opareport -o nodes -F portguid:0x00117500a000447b
opareport -o nodes -F nodeguid:0x001175009800447b:port:1
opareport -o nodes -F nodeguid:0x001175009800447b
opareport -o nodes -F 'node:duster hfi1_0'
opareport -o nodes -F 'node:duster hfi1_0:port:1'
opareport -o nodes -F 'nodepat:d*'
opareport -o nodes -F 'nodepat:d*:port:1'
opareport -o nodes -F 'nodedetpat:compute*'
opareport -o nodes -F 'nodedetpat:compute*:port:1'
opareport -o nodes -F nodetype:FI
opareport -o nodes -F nodetype:FI:port:1
opareport -o nodes -F lid:1
opareport -o nodes -F led:on opareport -o nodes -F led:off opareport -o nodes -F lid:1:node
opareport -o nodes -F lid:1:port:2
opareport -o nodes -F gid:0xfe80000000000000:0x00117500a000447b
opareport -o nodes -F systemguid:0x001175009800447b
opareport -o nodes -F systemguid:0x001175009800447b:port:1
opareport -o nodes -F iocguid:0x00117501300001e0
opareport -o nodes -F iocguid:0x00117501300001e0:port:2
opareport -o nodes -F 'ioc:Chassis 0x001175005000010C, Slot 2, IOC 1'
opareport -o nodes -F 'ioc:Chassis 0x001175005000010C, Slot 2, IOC 1:port:2'
opareport -o nodes -F 'iocpat:*Slot 2*'
opareport -o nodes -F 'iocpat:*Slot 2*:port:2'
opareport -o nodes -F ioctype:SRP opareport -o nodes -F ioctype:SRP:port:2
opareport -o extlinks -F rate:100g
opareport -o extlinks -F portstate:armed
opareport -o extlinks -F portphysstate:linkup
opareport -o extlinks -F 'labelpat:S1345*'
opareport -o extlinks -F 'lengthpat:11m'
opareport -o extlinks -F 'cabledetpat:*hitachi*'
opareport -o extlinks -F 'linkdetpat:*core ISL*'
opareport -o extlinks -F 'portdetpat:*mgmt*'
opareport -o links -F mtucap:2048
opareport -o nodes -F sm
opareport -o nodes -F 'smdetpat:primary*'
opareport -o nodes -F 'route:node:duster hfi1_0:node:cuda hfi1_0'
opareport -o nodes -F 'route:node:duster hfi1_0:port:1:node:cuda hfi1_0:port:2'
opareport -s -o snapshot > file
opareport -o topology > topology.xml
opareport -o errors -X file
opareport -s --begin "2 days ago"
opareport -s --begin "12:30" --end "14:00"

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

Intel Corporation Copyright(C) 2015-2018