ethextracterror(8)

✨ NAME ✨

ethextracterror — bestie, it makes a CSV file listing all (or just some) of the per port errors chillin' in your current fabric. 💅

It's a front end to the ethreport tool, so like, it's not doing the heavy lifting itself, it's just the cute face. The output can be imported into a spreadsheet or parsed by other scripts — whatever your heart desires. And hey, it also works as a sample for building your own custom per port reports. DIY queen energy. 👑

💫 Syntax 💫

ethextracterror [ethreport  options]

🎀 Options 🎀

• --help — spills the full help text, all of it, no gatekeeping.

🦋 ethreport options 🦋

These get passed through to ethreport. The set below is the "typical and useful" subset for this command, iykyk. And heads up: by design, this tool just ignores the -o/--output report option. It said no thank you, not today. 🙈

• -X/--infile snapshot_input — makes a report using the data inside the snapshot_input file. That file has to have been generated during a previous -o snapshot run, no shortcuts. You can pass '-' as the snapshot_input to mean stdin. 🍓
• -T/--topology topology_input — uses the topology_input file to augment and verify fabric info. When you use it, various reports can get augmented with info that just isn't available electronically. '-' may be used to specify stdin. ✨
• -E/--eth config_file — specifies the Ethernet management configuration file. Default is the /etc/eth-tools/mgt_config.xml file.
• -p plane — specifies the name of the enabled plane defined in the Mgt config file. Default is the first enabled plane.
• -F/--focus point — specifies the focus area for the report. Used to limit the scope of the report. Refer to Point Syntax for details. 👀

🌸 Point Syntax 🌸

Okay so this is the part where you tell it exactly where to look. Slay.

• ifid:value — value is a numeric ifid.
• ifid:value:node — value is a numeric ifid; selects the node with the given ifid.
• ifid:value:port:value2 — value is the numeric ifid of a node, value2 is a port number.
• ifid:value:portid:value2 — value is the numeric ifid of a node, value2 is a port id.
• mgmtifaddr:value — value is a numeric port mgmtifaddr.
• ifaddr:value — value is a numeric node ifaddr.
• ifaddr:value1:port:value2 — value1 is a numeric node ifaddr, value2 is a port number.
• ifaddr:value1:portid:value2 — value1 is a numeric node ifaddr, value2 is a port id.
• chassisid:value — value is a numeric chassisid.
• chassisid:value1:port:value2 — value1 is a numeric chassisid, value2 is a port number.
• chassisid:value1:portid:value2 — value1 is a numeric chassisid, value2 is a port id.
• node:value — value is a node description (node name).
• node:value1:port:value2 — value1 is a node description (node name), value2 is a port number.
• node:value1:portid:value2 — value1 is a node description (node name), value2 is a port id.
• nodepat:value — value is a glob pattern for node description (node name).
• nodepat:value1:port:value2 — value1 is the glob pattern for the node description (node name), value2 is a port number.
• nodepat:value1:portid:value2 — value1 is the glob pattern for the node description (node name), value2 is a port id.
• nodedetpat:value — value is a glob pattern for node details.
• nodedetpat:value1:port:value2 — value1 is the glob pattern for the node details, value2 is a port number.
• nodedetpat:value1:portid:value2 — value1 is the glob pattern for the node details, value2 is a port id.
• nodetype:value — value is a node type (SW or NIC).
• nodetype:value1:port:value2 — value1 is a node type (SW or NIC), value2 is a port number.
• nodetype:value1:portid:value2 — value1 is a node type (SW or NIC), value2 is a port id.
• rate:value — value is a string for rate (25g, 50g, 75g, 100g), and it 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), and it omits switch mgmt port 0.
• linkdetpat:value — value is a glob pattern for link details.
• portdetpat:value — value is a glob pattern for port details.
• nodepatfile:FILENAME — specifies the name of the file with the list of nodepats or node descriptions.
• nodepairpatfile:FILENAME — specifies the name of the 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.

🔥 Examples 🔥

List all the link errors in the fabric:

ethextracterror

List all the link errors related to a switch named "coresw1":

ethextracterror -F "node:coresw1"

List all the link errors for end-nodes:

ethextracterror -F "nodetype:NIC"

Copyright(C) 2020-2024 Intel Corporation

EFSFFCLIRG (Man Page) — that's the manual name btw, and that copyright is Intel's, 2020 through 2024, so give credit where it's due. 🫶 Go read the errors, bestie. 💖