nvme-list-subsys(1)

NAME

nvme-list-subsys - List all NVMe subsystems

SYNOPSIS

nvme [<global-options>] list-subsys <device>

DESCRIPTION

Scan the sysfs tree for NVM Express subsystems and return the controllers for those subsystems as well as some pertinent information about them. If a device is given, print out only the values for the controllers and subsystems leading to the device.

OPTIONS

GLOBAL OPTIONS

The following options are defined at the top-level nvme command and are available to this subcommand:

--dry-run

Print the command that would be executed, but do not actually execute it.

--no-ioctl-probing

Disable probing for 64-bit IOCTL support.

--no-retries

Disable retry logic on transient errors.

-o <fmt>, --output-format=<fmt>

Set the reporting format to normal, tabular, 'json, or binary. Only one output format may be used at a time.

--output-format-version=<version>

Select the output format version. Version 1 uses the original field naming, while version 2 (default) provides more consistent and script-friendly field names. Other versions are rejected.

--quiet

Suppress informational messages. Errors are still reported, and --quiet cancels any --verbose for the library log level.

--set-options=<key=value>[,<key=value>...]

Set libnvme library options for this invocation. Supported keys are force-4k, mi-probe-enabled, test-base-dir and test-sysfs-dir.

--timeout=<ms>

Set the timeout for the command in milliseconds. infinite or -1 waits without a time limit (0xffffffff).

-v, --verbose

Increase the level of detail in the output. May be specified multiple times to further increase verbosity.

These options can also be set as machine-wide defaults in nvme-cli.conf(5). A command-line flag always overrides the file.

EXAMPLES

root@host[1]# nvme list-subsys
nvme-subsys0 - NQN=nvmf-test
\
 +- nvme0 rdma traddr=1.1.1.3,trsvcid=4420,host_traddr=1.1.1.1
 +- nvme1 rdma traddr=1.1.1.3,trsvcid=4420,host_traddr=1.1.1.2
nvme-subsys1 - NQN=nvmf-test2
\
 +- nvme2 rdma traddr=1.1.1.3,trsvcid=4420,host_traddr=1.1.1.2
 +- nvme3 rdma traddr=1.1.1.3,trsvcid=4420,host_traddr=1.1.1.1

root@host[1]# nvme list-subsys -o json
{
  "Subsystems" : [
    {
      "Name" : "nvme-subsys0",
      "NQN" : "nvmf-test"
    },
    {
      "Paths" : [
        {
          "Name" : "nvme0",
          "Transport" : "rdma",
          "Address" : "traddr=1.1.1.3,trsvcid=4420,host_traddr=1.1.1.1",
          "AddressDetails" : {
            "traddr" : "1.1.1.3",
            "host_traddr" : "1.1.1.1",
            "trsvcid" : "4420"
          }
        },
        {
          "Name" : "nvme1",
          "Transport" : "rdma",
          "Address" : "traddr=1.1.1.3,trsvcid=4420,host_traddr=1.1.1.2",
          "AddressDetails" : {
            "traddr" : "1.1.1.3",
            "host_traddr" : "1.1.1.2",
            "trsvcid" : "4420"
          }
        }
      ]
    },
    {
      "Name" : "nvme-subsys1",
      "NQN" : "nvmf-test2"
    },
    {
      "Paths" : [
        {
          "Name" : "nvme2",
          "Transport" : "rdma",
          "Address" : "traddr=1.1.1.3,trsvcid=4420,host_traddr=1.1.1.2",
          "AddressDetails" : {
            "traddr" : "1.1.1.3",
            "host_traddr" : "1.1.1.2",
            "trsvcid" : "4420"
          }
        },
        {
          "Name" : "nvme3",
          "Transport" : "rdma",
          "Address" : "traddr=1.1.1.3,trsvcid=4420,host_traddr=1.1.1.1",
          "AddressDetails" : {
            "traddr" : "1.1.1.3",
            "host_traddr" : "1.1.1.1",
            "trsvcid" : "4420"
          }
        }
      ]
    }
  ]
}

NVME

Part of the nvme-user suite

NOTES

1.

root@host

mailto:root@host