How to Report all the Nodes and Links in a Command-Line Interface in the Intel® Ethernet Fabric Suite

Documentation

Product Information & Documentation

000088353

11/15/2021

How do I use ethreport tools to list all the system components working in the Intel® Ethernet Fabric Suite (Intel® EFS)?

The ethreport command provides powerful fabric analysis and reporting capabilities. Must be run on a host connected to the Intel® Ethernet Fabric Suite with the Intel® Ethernet Fabric Suite FastFabric Toolset installed.

ethreport can generate hundreds of different reports. Commonly generated reports include the following:

ethreport -o comps -d 3
ethreport -o errors -o slowlinks
ethreport -o nodes -F mgmtifaddr:0x00066a00a000447b
ethreport -o nodes -F ifaddr:0x001175019800447b:port:1
ethreport -o nodes -F ifaddr:0x001175019800447b
ethreport -o nodes -F 'node:duster-eth2'
ethreport -o nodes -F 'node:duster-eth2:port:1'
ethreport -o nodes -F 'nodepat:d*'
ethreport -o nodes -F 'nodepat:d*:port:1'
ethreport -o nodes -F 'nodedetpat:compute*'
ethreport -o nodes -F 'nodedetpat:compute*:port:1'
ethreport -o nodes -F nodetype:NIC
ethreport -o nodes -F nodetype:NIC:port:1
ethreport -o nodes -F ifid:1
ethreport -o nodes -F ifid:1:node
ethreport -o nodes -F ifid:1:port:2
ethreport -o nodes -F chassisid:0x001175019800447b
ethreport -o nodes -F chassisid:0x001175019800447b:port:1
ethreport -o extlinks -F rate:100g
ethreport -o extlinks -F portstate:up
ethreport -o extlinks -F portphysstate:operational
ethreport -o extlinks -F 'portdetpat:*mgmt*'
ethreport -o links -F mtucap:2048
ethreport -o snapshot > file
ethreport -o topology > topology.xml
ethreport -o errors -X file

ethreport can be run with no options at all. In this mode it provides a brief list of the nodes in the fabric, the brnodes report.

A sample of an ethreport for a small fabric follows:

# ethreport
Getting All Node Records...
Done Getting All Fabric Records
Node Type Brief Summary
4 Connected NICs in Fabric:
IfAddr Type Name
 Port IfID PortId MgmtIfAddr Speed
0x00006805caa382c0 NIC coyote-ens785f0
 1 0xa86501 6805caa382c0 0x00006805caa382c0 100Gb
0x00006805caa382d0 NIC goblin-ens785f0
 1 0xa86502 6805caa382d0 0x00006805caa382d0 100Gb
0x00006805caa38370 NIC ogre-ens785f0
 1 0xa86504 6805caa38370 0x00006805caa38370 100Gb
0x00006805caa383c8 NIC duster-ens785f0
 1 0xa86503 6805caa383c8 0x00006805caa383c8 100Gb
1 Connected Switches in Fabric:
IfAddr Type Name
 Port IfID PortId MgmtIfAddr Speed
0x0000fcbd6762d279 SW edge1
 0 0x7f9f6c 0x0000fcbd6762d279 None
 1 Ethernet1/1 100Gb
 2 Ethernet2/1 100Gb
 3 Ethernet3/1 100Gb
 4 Ethernet4/1 100Gb
 5 Ethernet5/1 100Gb
 6 Ethernet6/1 100Gb
 7 Ethernet7/1 100Gb
 8 Ethernet8/1 100Gb
 67 Management1 <100Gb

Each ethreport allows for various levels of detail. Increasing detail is shown as further indentation of the additional information. The -d option to ethreport controls the detail level. The default is 2. Values from 0-n are permitted. The maximum detail per report varies, but most have less than five detail levels.

Note

Several report types can include port counters if both the counters are available (via the use of the stats flag or input from a snapshot file) and a high enough detail level is used. Usually a detail level between 5 and 8 is high enough to include per-port counters in report outputs. Some reports such as errors or the use of flags such as -F linkqual already imply the use of -d 8.

For example, when the previous report is run at detail level 0, the output is as follows:

# ethreport -d 0
Getting All Fabric Records...
Done Getting All Fabric Records
Node Type Brief Summary
4 Connected NICs in Fabric
1 Connected Switches in Fabric

A summary of fabric components is shown in the following example. This report is very similar to ethfabricinfo. At the next level of detail, the report has more detail:

# ethreport -d 1
Getting All Fabric Records...
Done Getting All Fabric Records
Node Type Brief Summary
4 Connected NICs in Fabric:
IfAddr Type Name
0x00006805caa38370 NIC ogre-eth2
0x00006805caa382d0 NIC goblin-eth2
0x00006805caa382c0 NIC coyote-eth2
0x00006805caa383c8 NIC duster-eth2
1 Connected Switches in Fabric:
IfAddr Type Name
0x0000fcbd6762d279 SW edge1

The previous examples were all performed with a single report: the brnodes (Brief Nodes) report. This is just one of the many topology reports that ethreport can generate.

Other reports summarize the present state of the fabric. Use these reports to analyze the configuration of the fabric and verify that the installation is consistent with the desired design and configuration.

You can find them and all other command-line information in the Intel® Ethernet Fabric Suite FastFabric User Guide.

How do I use ethextractlink tools to list all the system links working in the Intel® Ethernet Fabric Suite?

The ethextractlink command produces a CSV file listing all or some of the links in the fabric. ethextractlink is a front end to the ethreport tool. The output from this tool can be imported into a spreadsheet or parsed by other scripts.

Syntax: ethextractlink [ethreport options]

Examples:

# List all the links in the fabric:
ethextractlink
# List all the links to a switch named "coresw1":
ethextractlink -F "node:coresw1"
# List all the links to end-nodes:
ethextractlink -F "nodetype:NIC"

 

Related topic
Download Packages and User Guides for Intel® Ethernet Fabric Suite (Intel® EFS)