MSTCONFIG(1)

📦
version 4.37.0_1.1 · 3 versions
, in centos-stream 10, centos-stream 9, debian trixie, fedora 43, fedora 44, nixos 26.05, nixpkgs unstable, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

Welcome to MSTCONFIG(1), bestie! 💖 It's a User Commands moment, and the star is mstconfig — the tool that sets or queries non-volatile configurable options for Mellanox HCAs. ✨

💖 NAME 💖

mstconfig — set or query non-volatile configurable options for Mellanox HCAs. Periodt. 💅

🦋 DESCRIPTION 🦋

Okay so the original page is doing a whole nested-manual thing inside DESCRIPTION, and we're keeping every crumb. It starts with:

NAME mstconfig

SYNOPSIS

mstconfig [Options] <Commands> [Parameters]

DESCRIPTION: Allows the user to change some of the device configurations without having to create and burn a new firmware. 🔥

OPTIONS: ...and then the actual OPTIONS section rolls in right after, like "not me being recursive." 🙈

So fr fr, the main character energy here is: you can change some device configurations without creating and burning a whole new firmware. No cap. 💫

🌸 OPTIONS 🌸

  • -d|--dev <device> — perform operation for a specified MST device. 🖥️
  • -b|--db <filename> — use a specific database file. 🗂️
  • -f|--file <conf_file> — raw configuration file. 📄
  • -h|--help — display help message. 🆘
  • -v|--version — display version info. 🏷️
  • -e|--enable_verbosity — show default and current configurations. 👀
  • -y|--yes — answer yes in prompt. ✅
  • -a|--all_attrs — show all attributes in the XML template. 🌟
  • -p|--private_key — pem file for private key. 🔐
  • -u|--key_uuid — keypair uuid. 🔑

🎀 COMMANDS 🎀

  • clear_semaphore — clear the tool semaphore. 🧹
  • i[show_confs] — display information about all configurations. 📊
  • q[uery] — query supported configurations. 🔍
  • r[eset] — reset all configurations to their default value. ♻️
  • s[et] — set configurations to a specific device. 🎯
  • set_raw — set raw configuration file.(only Connect-IB/Connect-X4/LX.) 🧪
  • backup — backup configurations to a file (only Connect-IB/Connect-X4/LX.). Use set_raw command to restore file. 💾
  • gen_tlvs_file — Generate List of all TLVs. TLVs output file name must be specified. (*) 📝
  • g[en_xml_template] — Generate XML template. TLVs input file name and XML output file name must be specified. (*) 🧬
  • xml2raw — Generate Raw file from XML file. XML input file name and raw output file name must be specified. (*) 🔄
  • raw2xml — Generate XML file from Raw file. raw input file name and XML output file name must be specified. (*) 🔁
  • xml2bin — Generate Bin file from XML file. XML input file name and bin output file name must be specified. (*) 📦
  • create_conf — Generate Configuration file from XML file. XML input file name and bin output file name must be specified. (*) 🛠️
  • apply — Apply a Configuration file. bin input file name must be specified. (*) 🚀
(*) These commands do not require MST device 💀

To show supported configurations by device type, run show_confs command. 👑

Examples, because we love a little demo moment:

  • To query configurations:
mstconfig -d 04:00.0 query
  • To set configuration:
mstconfig -d 04:00.0 set SRIOV_EN=1 NUM_OF_VFS=16 WOL_MAGIC_EN_P1=1
  • To set raw configuration:
mstconfig -d 05:00.0 -f conf_file set_raw
  • To reset configuration:
mstconfig -d 04:00.0 reset

Supported devices: 4th Generation devices: ConnectX3, ConnectX3-Pro (FW 2.31.5000 and above). 5th Generation devices: ConnectIB, ConnectX4, ConnectX4-LX, ConnectX5. 🌈

Note: query device to view supported configurations by Firmware. 📌

👑 SEE ALSO 👑

This page came from mstflint, dated March 2020, and it's the MSTCONFIG(1) manual. Stay configurable, bestie 🫶💖

📦 where this page comes from