mlxconfig – Changing Device Configuration Tool

NVIDIA ConnectX-5 Adapter Cards Firmware Release Notes v16.35.3502 LTS

The mlxconfig tool allows the user to change some of the device configurations without reburning the firmware. The configuration is also kept after reset.

By default, mlxconfig shows the configurations that will be loaded in the next boot.

For 5th generation devices, it is also possible to query the default configurations and the configurations that are used by the current running firmware.

  • OFED/WinOF driver to be installed and enabled (for ConnectX-3 and ConnectX-3 Pro)

  • Access to the device through the PCI interface (pciconf/pci_cr)

  • For the adapter cards below, the following firmware versions are required:

    • ConnectX®-3/ConnectX-3 Pro: v2.31.5000 or above

    • Connect-IB®: v10.10.6000 or above

  • Supported devices:

    • Adapter cards: ConnectX-3/ConnectX-3 Pro/Connect-IB/ConnectX-4/ConnectX-4 Lx/ConnectX-5/ConnectX-5 Ex/ConnectX-6/ConnectX-6 Dx/ConnectX-6 Lx/NVIDIA BlueField®/NVIDIA BlueField-2

    • Switches: Switch-IB/Switch-IB 2/Spectrum™/Spectrum-2/Spectrum-3/Quantum

  • Changing device configurations enabled.

Warning

For changes after a successful configuration to take effect, reboot the system.

Copy
Copied!
            

# mlxconfig [Options] <commands> [Parameters]

where:

-a|--all_attrs

Show all attributes in the XML template

-d|--dev <device>

Performs operation for a specified mst device

-b|--db <filename>

Use a specific database file.

-f|--file <conf.file>

Raw configuration file

-y|--yes

Answers yes in prompt

-e|-enable_verbosity

Show default and current configurations. Note: For 5th generation (Group II) devices, the --enable_verbosity option works with ConnectX-4 firmware v12.14.0016 and above for querying the default configurations, and with ConnectX-4 firmware v12.17.1010 and above for querying the current configurations.

-v|--version

Displays version info

-h|--help

Displays help message

-p|--private_key

pem file for private key

-u|--key_uuid

keypair uuid

-eng|--openssl_engine

OpenSSL engine name

-k|--open_ssl_key_id

OpenSSL key identifier

q[uery]

Queries the supported configurations. Note: Query command will query a single device if a device is specified. Otherwise, it will query all devices on the machine.

s[et]

Sets configurations to a specific device

set_raw

Sets raw configuration file (5th generation/Group II devices only)

get_raw

Gets raw configuration file (5th generation/Group II devices only)

i[show_confs]

Display information about all configurations

clear_semaphore

Clear the tool’s semaphore

r[eset]

Resets configurations to their default value

backup

Backs up configurations to a file (only 5th generation (Group II) devices). Use set_raw command to restore file.

gen_tlvs_file

Generate a List of all TLVs. TLVs output file name must be specified

g[en_xml_template]

Generate an XML template. TLVs input file name and XML output file name must be specified

xml2raw

Generate a Raw file from an XML file. XML input file name and raw output file name must be specified

raw2xml

Generate an XML file from a Raw file. raw input file name and XML output file name must be specified

xml2bin

Generate binary configuration dump 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, that was created with create_conf command. bin input file name must be specified.

-t|--device_type <switch/hca/linkx>

Specify the device type.

-s|--session_id

Specify the session id for token keep alive session.

-st|--session_time

Specify session time for token keep alive session.

-tkn|--token_type

Specify token type.

challenge_request

Send a token challenge request to the device. Token type must be specified.

remote_token_keep_alive

Start a remote token session for a specified time. session id must be specified.

token_supported

Query which tokens are supported.

query_token_session

Query the status of a token session.

end_token_session

End an active token session.

© Copyright 2023, NVIDIA. Last updated on Dec 28, 2023.