nvme-list-subsys(1)
===================

NAME
----
nvme-list-subsys - List all NVMe subsystems

SYNOPSIS
--------
[verse]
'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
-------

include::global-options.txt[]

EXAMPLES
--------
[verse]
root@host# 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

[verse]
root@host# 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
