ethlinkanalysis(8)

✨ NAME ✨

ethlinkanalysis — bestie, this is the manual page for it, straight out of the EFSFFCLIRG docs 💖

Okay so picture this: ethlinkanalysis is the whole entire package for link analysis. It also does cable and fabric topology verification — like, it checks that your cables and your fabric are actually doing what they said they'd do 🎀

Here's the tea: this tool is built on top of ethreport and its analysis superpowers, and it takes the exact same syntax for input topology and snapshot files. So if you already know ethreport, you're basically home 🫶

And then — because it's an overachiever — besides running assorted ethreport link analysis reports and generating human-readable output, it also reads the results, figures out what's wrong, and appends a concise summary of issues found to the FF_RESULT_DIR/punchlist.csv file. Iconic behavior, no cap 👑

🦋 Syntax 🦋

ethlinkanalysis [-U] [-T  topology_inputs] [-X  snapshot_input] [-x
snapshot_suffix]

[-c  file] [-E  file] [-p  planes] [-f  host_files]  reports ...

🌸 Options 🌸

• --help — gives you the full help text, every last word of it 💅
• -U — skips the unexpected devices and links in the punchlist file when you're running verify reports. Like, not today to the surprises 🙈
• -T topology_inputs — names of the topology input filenames, separated by a space. For the full lore on topology_input files, go read ethreport 📚
• -X snapshot_input — does the analysis using the data sitting in snapshot_input. Heads up tho: snapshot_input has to have been generated by a previous ethreport -o snapshot run, otherwise it's giving nothing 🫠
• -x snapshot_suffix — makes a snapshot file for each selected plane. They land in FF_RESULT_DIR with names shaped like this: snapshotSUFFIX.<plane_name>.xml ✨
• -c file — points to the error thresholds configuration file. The default is /etc/eth-tools/ethmon.si.conf 🍓
• -E file — the Ethernet Mgt configuration file. Default is /etc/eth-tools/mgt_config.xml 💜
• -p planes — fabric planes, separated by a space. Default is the first enabled plane defined in the config file. And if you pass the value 'ALL', it uses all enabled planes 🌈
• -f host_files — hosts files, separated by a space. This one overrides the HostsFiles defined in the Mgt config file for the corresponding planes. Pass the value 'DEFAULT' and it'll use the HostFile defined in the Mgt config file for the corresponding plane 🧚
• reports — this is where you tell it what to actually do. It supports the following reports:
  • errors — specifies link error analysis.
  • slowlinks — specifies links that are running slower than expected 😭
  • misconfiglinks — specifies links that are configured to run slower than they're supported to run.
  • misconnlinks — specifies links that are connected with mismatched speed potential 💀
  • all — includes the reports errors, slowlinks, misconfiglinks, and misconnlinks. The whole squad, together 🫶
  • verifylinks — verifies links against topology input.
  • verifyextlinks — verifies links against topology input. Limits the analysis to links external to systems.
  • verifyniclinks — verifies links against topology input. Limits the analysis to NIC links.
  • verifyislinks — verifies links against topology input. Limits the analysis to inter-switch links.
  • verifyextislinks — verifies links against topology input. Limits the analysis to inter-switch links external to systems.
  • verifynics — verifies NICs against topology input.
  • verifysws — verifies switches against topology input.
  • verifynodes — verifies NICs and switches against topology input.
  • verifyall — verifies links, NICs, and switches against topology input. Literally all of it 👑

A punchlist of bad links also gets appended to the file: FF_RESULT_DIR/punchlist.csv

⚠️ Real talk: that punchlist file is where all the messy links get named and shamed. It's appended to, not rewritten, so check it before you assume it's fresh 👀

💅 Examples 💅

ethlinkanalysis errors

ethlinkanalysis slowlinks

ethlinkanalysis -p 'p1 p2' -f 'hosts1 DEFAULT' errors

And that's the whole page, bestie — go forth and analyze those links 💖✨

Copyright(C) 2020-2024 Intel Corporation — this page is ethlinkanalysis(8), from the EFSFFCLIRG (Man Page) family, and it said what it said. Slay 🎀