opaextractlids(8)

🌸 opaextractlids β€” the IFSFFCLIRG manual page, but make it cute πŸ’–

okay bestie, welcome to opaextractlids(8) πŸ’… this is a lil tool from the IFSFFCLIRG man page family, and honestly? she's a baddie. let's get into it.


✨ NAME ✨

opaextractlids

She produces a CSV file listing all or some of the LIDs in the fabric. No cap.

And the tea: opaextractlids is a front end to the opareport tool. The output from this tool can be imported into a spreadsheet or parsed by other scripts. it's giving "hand it off to your spreadsheet bestie" energy fr fr πŸ“Šβœ¨


πŸ¦‹ SYNTAX πŸ¦‹

opaextractlids [opareport  options]

πŸŽ€ OPTIONS πŸŽ€

  • --help β€” Produces full help text. she's helpful like that 🫢
  • opareport options β€” The following options are passed to opareport. This subset is considered typical and useful for this command. And listen β€” by design, the tool ignores the -o/--output report option. not me being like "where's the output flag" 😭 she just ignores it. periodt.
    • -h/--hfi hfi β€” Specifies the HFI, numbered 1..n. Using 0 specifies that the -p port port is a system-wide port number. Default is 0.
    • -p/--port port β€” Specifies the port, numbered 1..n. Using 0 specifies the first active port. Default is 0.
    • -X/--infile snapshot_input β€” Generates a report using the data in the snapshot_input file. snapshot_input must have been generated during a previous -o snapshot run. When used, the -s, -i, -C, and -a options are ignored. '-' may be used as the snapshot_input to specify stdin. πŸ‘‘ yes she eats from stdin too.
    • -F/--focus point β€” Specifies the focus area for report. Used for all reports except route to limit scope of report. Refer to Point Syntax for details.

🌈 the -h and -p options permit a variety of selections 🌈

this is the part where you mix and match, and it's honestly iconic:

  • -h 0 β€” First active port in system (Default).
  • -h 0 -p 0 β€” First active port in system.
  • -h x β€” First active port on HFI x.
  • -h x -p 0 β€” First active port on HFI x.
  • -h 0 -p y β€” Port y within system (no matter which ports are active).
  • -h x -p y β€” HFI x, port y.

πŸ’œ Point Syntax πŸ’œ

okay this is the big one, the main character section, the -F focus menu. every single one of these is a vibe. buckle up bestie 🧚

  • gid:value β€” value is numeric port GID of form: subnet:guid.
  • lid:value β€” value is numeric LID.
  • lid:value:node β€” value is numeric LID, selects entire node with given LID.
  • lid:value:port:value2 β€” value is numeric LID of node, value2 is port number.
  • portguid:value β€” value is numeric port GUID.
  • nodeguid:value β€” value is numeric node GUID.
  • nodeguid:value1:port:value2 β€” value1 is numeric node GUID, value2 is port number.
  • iocguid:value β€” value is numeric IOC GUID.
  • iocguid:value1:port:value2 β€” value1 is numeric IOC GUID, value2 is port number.
  • systemguid:value β€” value is numeric system image GUID.
  • systemguid:value1:port:value2 β€” value1 is the numeric system image GUID, value2 is port number.
  • ioc:value β€” value is IOC Profile ID String (IOC Name).
  • ioc:value1:port:value2 β€” value1 is IOC Profile ID String (IOC Name), value2 is port number.
  • iocpat:value β€” value is glob pattern for IOC Profile ID String (IOC Name).
  • iocpat:value1:port:value2 β€” value1 is glob pattern for IOC Profile ID String (IOC Name), value2 is port number.
  • ioctype:value β€” value is IOC type (SRP or OTHER).
  • ioctype:value1:port:value2 β€” value1 is IOC type (SRP or OTHER); value2 is port number.
  • node:value β€” value is node description (node name).
  • node:value1:port:value2 β€” value1 is node description (node name), value2 is port number.
  • 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.
  • 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.
  • nodetype:value β€” value is node type (SW or FI).
  • nodetype:value1:port:value2 β€” value1 is node type (SW or FI), value2 is port number.
  • rate:value β€” value is string for rate (25g, 50g, 75g, 100g), omits switch mgmt port 0.
  • portstate:value β€” value is a string for state (down, init, armed, active, notactive, initarmed).
  • portphysstate:value β€” value is a string for PHYs state (polling, disabled, training, linkup, recovery, offline, test)
  • mtucap:value β€” value is MTU size (2048, 4096, 8192, 10240), omits switch mgmt port 0.
  • labelpat:value β€” value is glob pattern for cable label.
  • lengthpat:value β€” value is glob pattern for cable length.
  • cabledetpat:value β€” value is glob pattern for cable details.
  • cabinflenpat:value β€” value is glob pattern for cable info length.
  • cabinfvendnamepat:value β€” value is glob pattern for cable info vendor name.
  • cabinfvendpnpat:value β€” value is glob pattern for cable info vendor part number.
  • cabinfvendrevpat:value β€” value is glob pattern for cable info vendor revision.
  • cabinfvendsnpat:value β€” value is glob pattern for cable info vendor serial number.
  • cabinftype:value β€” value is either optical, passive_copper, active_copper, or unknown.
  • linkdetpat:value β€” value is glob pattern for link details.
  • portdetpat:value β€” value is glob pattern for port details.
  • sm β€” Specifies the master subnet manager (SM). πŸ‘‘ the master. the moment.
  • smdetpat:value β€” value is glob pattern for SM details.
  • route:point1:point2 β€” Specifies all ports along the routes between the two given points.
  • led:value β€” value is either on or off for LED port beacon. ✨ the lights, bestie
  • linkqual:value β€” Specifies the ports with a link quality equal to value.
  • linkqualLE:value β€” Specifies the ports with a link quality less than or equal to value.
  • linkqualGE:value β€” Specifies the ports with a link quality greater than or equal to value.
  • 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 ⭐

she's a demo girlie, let's go 🫢

# List all the lids in the fabric:

opaextractlids
# List all the lids of end-nodes:

opaextractlids -F "nodetype:FI"
# List all the lids on the 2nd HFI's fabric of a multi-plane fabric:

opaextractlids -h 2

πŸ’€ reminder bestie: -o/--output is ignored by design. don't fight it. she's not gonna output where you tell her to. it's her whole thing.
🌸 also: -h 0 is the default, -p 0 is the default, and -X makes -s, -i, -C, and -a completely ignored. just so we're clear, no surprises, fr fr.

πŸ’– the sign-off πŸ’–

this page is opaextractlids(8) from the IFSFFCLIRG (Man Page) collection, and the copyright tea is: Copyright(C) 2015-2019 Intel Corporation. that's it, that's the whole legacy. ate and left no crumbs πŸŽ€πŸ¦‹βœ¨

go forth and extract those LIDs, bestie. you got this. πŸ’…πŸŒˆπŸ‘‘