opalinkanalysis(8)

💖 opalinkanalysis(8) — the link-analysis glow-up 💖

okay so bestie, welcome to opalinkanalysis(8), living in the IFSFFCLIRG man page family. She's a switch-side girlie, and she encapsulates the capabilities for link analysis. But that's not all — she also includes cable and fabric topology verification capabilities. Obsessed.

Here's the tea: this tool is built on top of opareport (and its analysis capabilities), and accepts the same syntax for input topology and snapshot files. So if you already know opareport, you already know her language. iykyk.

And in addition to being able to run assorted opareport link analysis reports and generate human-readable output, she also analyzes the results and appends a concise summary of issues found to the FF_RESULT_DIR/punchlist.csv file. Not her doing the most — she's just built different. ✨

🌸 Syntax 🌸

opalinkanalysis [-U] [-t  portsfile] [-p  ports]  [-T  topology_input]

[-X  snapshot_input] [-x  snapshot_suffix] [-c  file] reports ...

🎀 Options 🎀

• --help — produces full help text. she's helpful, she's giving customer service 💅
• -U — omits unexpected devices and links in punchlist file from verify reports. bye to the randoms 💀
• -t portsfile — specifies the file with list of local HFI ports used to access fabric(s) for analysis. Default is /etc/opa/ports.
• -p ports — specifies the list of local HFI ports used to access fabrics for analysis.

Default is first active port. The first HFI in the system is 1. The first port on an HFI is 1. Uses the format hfi:port, for example:

• 0:0 — First active port in system.
• 0:y — Port y within system.
• x:0 — First active port on HFI x.
• x:y — HFI x, port y.

• -T topology_input — specifies the name of a topology input file to use. Any %P markers in this filename are replaced with the hfi:port being operated on (such as 0:0 or 1:2). Default is /etc/opa/topology.%P.xml. If NONE is specified, does not use any topology_input files. See opareport for more information on topology_input files.
• -X snapshot_input — performs analysis using data in snapshot_input. snapshot_input must have been generated via a previous opareport -o snapshot run. If an errors report is specified, snapshot must have been generated with the opareport -s option. When this option is used, only one port may be specified to select a topology_input file (unless -T specified). When this option is used, clearerrors and clearhwerrors reports are not permitted. 🚫

heads up bestie: those two reports are literally not allowed with -X. no cap.

• -x snapshot_suffix — creates a snapshot file per selected port. The files are created in FF_RESULT_DIR with names of the form: snapshotSUFFIX. HFI:PORT.xml.
• -c file — specifies the error thresholds configuration file. The default is /etc/opa/opamon.si.conf.
• reports — supports the following reports:
  • errors — specifies link error analysis.
  • slowlinks — specifies links running slower than expected. 🐌
  • misconfiglinks — specifies links configured to run slower than supported.
  • misconnlinks — specifies links connected with mismatched speed potential.
  • all — includes all reports above. (errors, slowlinks, misconfiglinks, and misconnlinks) — the whole squad 🫶
  • verifylinks — verifies links against topology input.
  • verifyextlinks — verifies links against topology input. Limits analysis to links external to systems.
  • verifyfilinks — verifies links against topology input. Limits analysis to FI links.
  • verifyislinks — verifies links against topology input. Limits analysis to inter-switch links.
  • verifyextislinks — verifies links against topology input. Limits analysis to inter-switch links external to systems.
  • verifyfis — verifies FIs against topology input.
  • verifysws — verifies switches against topology input.
  • verifynodes — verifies FIs and switches against topology input.
  • verifysms — verifies SMs against topology input.
  • verifyall — verifies links, FIs, switches, and SMs against topology input. the full audit, she's thorough 👑
  • clearerrors — clears error counters, uses PM if available.
  • clearhwerrors — clears hardware error counters, bypasses PM.
  • clear — includes clearerrors and clearhwerrors.

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

🦋 Examples 🦋

opalinkanalysis errors

opalinkanalysis errors clearerrors

opalinkanalysis -p '1:1 1:2 2:1 2:2'

🌈 Environment Variables 🌈

The following environment variables are also used by this command:

• PORTS — List of ports, used in absence of -t and -p.
• PORTS_FILE — File containing list of ports, used in absence of -t and -p.
• FF_TOPOLOGY_FILE — File containing topology_input, used in absence of -T.

one last vibe check: that punchlist.csv in FF_RESULT_DIR is where the receipts live. she writes them whether you asked or not 💅

Copyright(C) 2015-2019 Intel Corporation — and the manual itself is opalinkanalysis(8) from the IFSFFCLIRG (Man Page) set. mwah, go slay your fabric bestie 🎀✨💖