table of contents
| ethextractstat(8) | EFSFFCLIRG (Man Page) | ethextractstat(8) |
NAME¶
ethextractstat
Performs an error analysis of a fabric and provides augmented information from a topology_file. The report provides cable information as well as symbol error counts.
ethextractstat generates a detailed ethreport errors report that also has a topology file (see ethreport for more information about topology files). The report is piped to ethxmlextract which extracts values for Link, Cable and Port. (The port element names are context-sensitive.) Note that ethxmlextract generates two extraction records for each link (one for each port on the link); therefore, ethextractstat merges the two records into a single record and removes redundant link and cable information.
ethextractstat contains a while read loop that reads the CSV line-by-line, uses cut to remove redundant information, and outputs the data on a common line.
Syntax¶
ethextractstat topology_file [ethreport options]
Options¶
- --help
-
Produces full help text.
- topology_file
-
Specifies topology_file to use.
- ethreport options
-
The following options are passed to ethreport. This subset is considered typical and useful for this command. By design, the tool ignores -o/--output report option.
-X/--infile snapshot_input Generates a report using the data in the snapshot_input file. snapshot_input must have been generated during a previous -o snapshot run. '-' may be used as the snapshot_input to specify stdin.
-c/--config file Specifies the error thresholds configuration file. Default is /etc/eth-tools/ethmon.conf file.
-E/--eth config_file Specifies the Intel Ethernet configuration file. Default is /etc/eth-tools/mgt_config.xml file.
-p plane Name of the enabled plane defined in Mgt config file, default is the first enabled plane.
-L/--limit Limits operation to exact specified focus with -F for port error counters check (-o errors). Normally, the neighbor of each selected port is also checked. Does not affect other reports.
-F/--focus point Specifies the focus area for report. Used to limit scope of report. Refer to Point Syntax for details.
Point Syntax¶
- ifid:value
-
value is numeric ifid.
- ifid:value:node
-
value is numeric ifid, selects node with given ifid.
- ifid:value:port:value2
-
value is numeric ifid of node, value2 is port number.
- ifid:value:portid:value2
-
value is numeric ifid of node, value2 is port id.
- mgmtifaddr:value
-
value is numeric port mgmtifaddr.
- ifaddr:value
-
value is numeric node ifaddr.
- ifaddr:value1:port:value2
-
value1 is numeric node ifaddr, value2 is port number.
- ifaddr:value1:portid:value2
-
value1 is numeric node ifaddr, value2 is port id.
- chassisid:value
-
value is numeric chassisid.
- chassisid:value1:port:value2
-
value1 is numeric chassisid, value2 is port number.
- chassisid:value1:portid:value2
-
value1 is numeric chassisid, value2 is port id.
- node:value
-
value is node description (node name).
- node:value1:port:value2
-
value1 is node description (node name), value2 is port number.
- node:value1:portid:value2
-
value1 is node description (node name), value2 is port id.
- nodepat:value
-
value is glob pattern for node description (node name).
- nodepat:value1:port:value2
-
value1 is the glob pattern for the node description (node name), value2 is port number.
- nodepat:value1:portid:value2
-
value1 is the glob pattern for the node description (node name), value2 is port id.
- nodedetpat:value
-
value is glob pattern for node details.
- nodedetpat:value1:port:value2
-
value1 is the glob pattern for the node details, value2 is port number.
- nodedetpat:value1:portid:value2
-
value1 is the glob pattern for the node details, value2 is port id.
- nodetype:value
-
value is node type (SW or NIC).
- nodetype:value1:port:value2
-
value1 is node type (SW or NIC), value2 is port number.
- nodetype:value1:portid:value2
-
value1 is node type (SW or NIC), value2 is port id.
- rate:value
-
value is string for rate (25g, 50g, 75g, 100g), omits switch mgmt port 0.
- portstate:value
-
value is a string for state (up, down, testing, unknown, dormant, notactive).
- portphysstate:value
-
value is a string for PHYs state (other, unknown, operational, standby, shutdown, reset)
- mtucap:value
-
value is MTU size (maximum size 65535), omits switch mgmt port 0.
- linkdetpat:value
-
value is glob pattern for link details.
- portdetpat:value
-
value is glob pattern for port details.
- nodepatfile:FILENAME
-
Specifies the name of file with the list of nodepats or node descriptions.
- nodepairpatfile:FILENAME
-
Specifies the name of file with the list of node pairs, separated by a colon.
- ldr
-
Specifies the ports with a non-zero link down reason or neighbor link down reason.
- ldr:value
-
Specifies the ports with a link down reason or neighbor link down reason equal to value.
The portion of the script that calls ethreport and ethxmlextract follows:
ethreport -x -Q -d 10 -o errors -T "$@" | ethxmlextract -H -d \; \
-e Link:id -e Rate -e LinkDetails -e CableLength -e CableLabel \
-e CableDetails -e Port.NodeDesc -e Port.PortNum -e Port.PortId
Examples¶
ethextractstat topology_file
ethextractstat topology_file -c my_ethmon.conf
| Intel Corporation | Copyright(C) 2020-2022 |