Search the docs

Admin CLI Command: nvmeof-config

NVMe-oF actions use the nvmeof-config command and its options. The command is designed to enable users to do multiple tasks at once, for example, adding an enclosure and connecting to certain subsystems, or connecting to some subsystems while disconnecting from others.

Usage: nvmeof-config [options]

Command:

nvmeof-config --help

Expected output:

Usage: nvmeof-config [options]
Configure and view NVMe-oF enclosures and configurations

  Options:
    --connect-all        Connect all targets of the specified NVMe-oF enclosure
    --connect-nqn        Subsystem NQN(s) to connect
    --ctrl-loss-tmo      Number of seconds to wait for a controller to reconnect
                         before giving up (-1 retries indefinitely)
    --disconnect-all     Disconnect all targets of the specified NVMe-oF
                         enclosure
    --disconnect-nqn     Subsystem NQN(s) to disconnect
    --dsx-id             The ID of the DSX node when adding an NVMe-oF enclosure
    --dsx-internal-id    The internal ID the DSX when adding an NVMe-oF
                         enclosure
    --dsx-name           The name of the DSX node when adding an NVMe-oF
                         enclosure
    --enclosure-add      Add an NVMe-oF enclosure to a DSX
    --enclosure-id       UUID of enclosure to operate on
    --enclosure-name     The name of the enclosure to be operated on
    --enclosure-remove   Remove an NVMe-oF enclosure by name or Id
    --full               Print extra information for each element
    --help               Display this help and exit
    --io-policy          Controller I/O policy. Possible values: ROUND_ROBIN |
                         NUMA | QUEUE_DEPTH.
    --io-queue-pairs     Number of request/completion queue pairs
    --list               List all NVMe-oF enclosures across all DSXs
    --queue-depth        Maximum number of I/O queue entries
    --target             The target(s) and optionally port and transport type
                         when adding or updating an enclosure
                         Examples:
                         --target 10.10.1.1
                         --target nvme1.local
                         --target 10.10.1.1,8009
                         --target nvme2.local,1234,TCP
    --target-port        Network target port
    --transport          Network transport type. Possible values: TCP | RDMA.

Examples

--target 10.10.1.1

--target nvme1.local

--target 10.10.1.1,8009

--target nvme2.local,1234,TCP