opaportconfig(1)

✨ opaportconfig ✨

okay so bestie, welcome to opaportconfig from the IFSFFCLIRG manual πŸ’– this one's a Host or Switch tool and it controls the configuration and state of a specified Intel(R) Omni-Path Host Fabric Interface (HFI) port β€” either on the local host or on a remote switch 🌸

NOTE: bestie this tool is designed for expert users only πŸ’… non-expert users should use other tools such as opaenableports, opadisableports and opaportinfo for basic functionality. no gatekeeping, just saying iykyk 🫢

πŸŽ€ Syntax πŸŽ€

opaportconfig [-l  lid [-m  dest_port]] [-h  hfi] [-p  port] [-r  secs]
[-z]

[-S  state] [-P  physstate] [-s  speed] [-w  width] [-c  LTPCRC] [-v]
[-x]
[-L  lid] [< sub command>]

πŸ’… Options πŸ’…

  • --help β€” produces full help text. literally the whole thing, go off πŸ‘‘
  • -l lid β€” specifies the destination LID. default is local port πŸ¦‹
  • -m dest_port β€” specifies the destination port. default is port with given LID. used to access switch ports πŸ”₯
  • -h hfi β€” specifies the HFI to send through/to. default is first HFI ✨
  • -p port β€” specifies the port to send through/to. default is first port 🌸
  • sub command β€” specifies one of the following choices πŸ‘‡
    • enable β€” enables port 🫢
    • disable β€” disables port πŸ™ˆ
    • bounce β€” bounces port 😭
NOTE: bouncing remote ports may cause timeouts. not a vibe, be careful πŸ’€
  • ledon β€” turns port LED on ⭐
  • ledoff β€” turns port LED off 🌈

βš™οΈ Configuration Options βš™οΈ

  • -r secs β€” repeats to keep the port down for the specified amount of seconds ⏳
  • -S state β€” specifies the new state. default is 0 πŸ’œ
    • 0 β€” No-op.
    • 1 β€” Down.
    • 2 β€” Initiate.
    • 3 β€” Armed.
    • 4 β€” Active.
  • -P physstate β€” specifies the new physical state. default is 0 πŸ¦‹
NOTE: all transitions are valid. periodt ✨
  • 0 β€” No-op.
  • 2 β€” Polling.
  • 3 β€” Disabled.
  • 11 β€” Phy-Test. Current physstate must be disabled.
  • -s speed β€” specifies the new link speeds enabled. default is 0. to enable multiple speeds, use the sum of the desired speeds πŸ”₯
    • 0 β€” No-op.
    • 2 β€” 0x0002 - 25 Gb/s.
  • -w width β€” specifies the new link widths enabled. default is 0. to enable multiple widths, use sum of desired widths 🌸
    • 0 β€” No-op.
    • 1 β€” 0x01 - 1x.
    • 2 β€” 0x02 - 2x.
    • 4 β€” 0x04 - 3x.
    • 8 β€” 0x08 - 4x.
  • -c LTPCRC β€” specifies the new LTP CRCs enabled. default is 0. to enable multiple LTP CRCs, use sum of desired LTP CRCs πŸ’–
    • 0 β€” No-op.
    • 1 β€” 0x1 - 14-bit LTP CRC mode.
    • 2 β€” 0x2 - 16-bit LTP CRC mode.
    • 4 β€” 0x4 - 48-bit LTP CRC mode.
    • 8 β€” 0x8 - 12/16 bits per lane LTP CRC mode.

🫢 -h and -p options permit a variety of selections 🫢

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

πŸ” Debug Options πŸ”

  • -v β€” verbose output. additional invocations turn on debugging, openib debugging, and libibumad debugging πŸ›
  • -z β€” does not get port information first; clears most port attributes πŸ’€
  • -L lid β€” sets PortInfo.LID = lid. πŸŽ€

🌟 Examples 🌟

opaportconfig -w 1
opaportconfig -p 1 -h 2 -w 3

πŸ“– Description πŸ“–

Port configuration is transient in nature bestie 😭 if the given host is rebooted or its Intel(R) Omni-Path Fabric Stack is restarted, the port reverts to its default configuration and state. typically, the default state is to have the port enabled with all speeds and widths supported by the given HFI port πŸ¦‹

To access switch ports using this command, the -l and -m options must be given πŸ’… the -l option specifies the lid of switch port 0 (the logical management port for the switch) and -m specifies the actual switch port to access πŸ”₯

NOTE: the /etc/init.d/opaportconfig script is provided as an example of changing port speed every time the server boots. this script can be edited, then scheduled, using chkconfig to control link settings on any set of HFI ports πŸŽ€
CAUTION: when using this command to disable or reconfigure switch ports, if the final port in the path between the Fabric Management Node and the switch is disabled or fails to come online, then opaenableports is not able to reenable it 😭 in this case, the switch CLI and/or a switch reboot may be needed to correct the situation. be so careful fr fr πŸ’€

and that's the whole page bestie 🫢 this gem is copyright Copyright(C) 2015-2019 Intel Corporation, and it lives in the IFSFFCLIRG (Man Page) manual πŸ’– slay, go configure some ports responsibly βœ¨πŸ‘‘πŸ’