ethextractifids(8)

💖 ethextractifids 💖

okay bestie, so ethextractifids is a whole vibe — it spits out a CSV file listing all or some of the ifids in the fabric. that's it, that's the job. 🎀

and the tea? it's a front end to the ethreport tool. so like, it's not doing the heavy lifting itself, it's just being cute and re-wrapping ethreport for you. the output can get imported into a spreadsheet 📊 or parsed by other scripts 🧚 — flexible queen behavior honestly.

✨ Syntax ✨

ethextractifids [ethreport  options]

🌸 Options 🌸

• --help — produces full help text. the classic. 🫶

💅 ethreport options

so the following options get passed to ethreport. this little subset is what's considered typical and useful for this command. and lowkey important: by design, the tool ignores -o/--output report option. so don't come for it, it's intentional. periodt. 💀

• -X/--infile _snapshot_input_ — generates a report using the data in the _snapshot_input_ file. and no cap, _snapshot_input_ must have been generated during a previous -o snapshot run. you can also use - as the _snapshot_input_ to specify stdin. 👑
• -E/--eth _config_file_ — specifies the Ethernet management configuration file. default is the /etc/eth-tools/mgt_config.xml file. it's giving defaults are a love language. 💜
• -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 (it's right below, don't worry bestie). 🔍

🦋 Point Syntax 🦋

this is the menu, bb. pick your fighter:

• 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_.

🎀 Examples 🎀

list all the ifids in the fabric — the "just show me everything" era:

# List all the ifids in the fabric:

ethextractifids

list all the ifids of end-nodes — the "I'm being specific today" era:

# List all the ifids of end-nodes:

ethextractifids -F "nodetype:NIC"

ngl bestie, these commands are literally copy-paste-able. slay. 💅

okay and the little sign-off at the bottom, the legal girlypop moment: this page is Copyright(C) 2020-2024 Intel Corporation, and it's from the EFSFFCLIRG (Man Page) set — it lives as ethextractifids(8). 🫶 stan a documented tool. 💖✨