opagenswitches(8)

💅 opagenswitches — okay bestie, let's talk switches

So this is opagenswitches, a section 8 (admin-y, system-level, main character) command from the IFSFFCLIRG man page crew. And what does it do? It looks at the fabric that's live right now and spits out a list of Externally Managed switches — formatted exactly how the /etc/opa/switches file wants it. Like, it's literally doing your homework for you. 🎀

✨ NAME ✨

opagenswitches — analyzes the present fabric and produces a list of Externally Managed switches in the required format for the /etc/opa/switches file.

🌸 SYNTAX 🌸

opagenswitches [-t portsfile] [-p ports] [-R] [-L switches_file]
[-o output_file] [-T topology_file] [-X snapshot_file] [-s] [-v level]
[-K]

🦋 OPTIONS 🦋

• --help — gives you the full help text, the whole thing, no skimping. 👑
• -t portsfile — tells it which file holds the list of local HFI ports it should use to reach the fabric(s) for analysis. Default is the /etc/opa/ports file.
• -p ports — the list of local HFI ports used to access the fabrics for counter clear. Default is the first active port. Heads up: the first HFI in the system is 1, and the first port on an HFI is 1. It uses the format hfi:port, like so:
  • 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.
• -R — does not attempt to get routes for computation of distance. Skipping that step, periodt.
• -s — updates/resolves switch names using topology XML data. ✨
• -L switches_file — names a pre-existing switches_file to use as input alongside a topology file. When you pass it, that file gets used instead of switches data grabbed from the actual fabric. The updated switches data goes out to stdout (which, fyi, is common to all opagenswitches operations). Note: this does not generate switches data. And you must also use the -s option with it.
• -o output_file — writes switches data to output_file. Default is stdout.
• -T topology_file — specifies the topology_file to use. It may contain '%P'. You must also use -s.

Link data in the topology file gets compared to actual fabric link data (which comes from opareport -o links or opareport -X snapshot -o links). That data also gets matched to a list of switch node GUIDs, and from that the switch NodeDesc values are generated. Then the list is applied to the switches data to update the NodeDesc values. The comparison of topology link data against actual fabric link data starts with the host names. The host names in the actual fabric have to match the ones in the topology file or the comparison won't succeed. That said, the comparison logic does allow for some mismatches — which could be from swapped or missing cables, no cap. Switch NodeDesc values get matched to GUIDs based on which switch has the greater number of matching links. 🧚

• -X snapshot_file — uses snapshot_file XML for fabric link information. May contain '%P'. You must also use -s.
• -v level — sets the verbose level. Default is 0. The values are:
  • 0 — No output.
  • 1 — Progress output.
  • 2 — Reserved.
  • 4 — Time stamps.
  • 8 — Reserved.
• -K — does not clean temporary files. Those temp files are CSV format and hold lists of links used while the script was running. Normally you don't need them after execution, but keeping them means you can inspect or process them later. 🙈

💜 ENVIRONMENT VARIABLES 💜

These environment variables are also used by this command:

• PORTS — list of ports, used when -t and -p aren't given.
• PORTS_FILE — file containing the list of ports, used when -t and -p aren't given.
• FF_TOPOLOGY_FILE — file containing topology XML data, used when -T isn't given.

🌈 EXAMPLES 🌈

opagenswitches

opagenswitches -p '1:1 2:1'

opagenswitches -o switches

opagenswitches -s -o switches

opagenswitches -L switches -s -o switches

opagenswitches -s -T topology.%P.xml

opagenswitches -L switches -s -T topology.%P.xml -X snapshot.%P.xml

And that's the whole vibe check, bestie 🫶 This little legend lives in the IFSFFCLIRG (Man Page) collection, and the copyright belongs to Copyright(C) 2015-2019 Intel Corporation. Slay, go generate those switches. 💖✨