Blame Documentation/nvme-list-subsys.txt

Packit Service b7b338
nvme-list-subsys(1)
Packit Service b7b338
===================
Packit Service b7b338
Packit Service b7b338
NAME
Packit Service b7b338
----
Packit Service b7b338
nvme-list-subsys - List all NVMe subsystems
Packit Service b7b338
Packit Service b7b338
SYNOPSIS
Packit Service b7b338
--------
Packit Service b7b338
[verse]
Packit Service b7b338
'nvme list-subsys' [-o <fmt> | --output-format=<fmt>] <device>
Packit Service b7b338
Packit Service b7b338
DESCRIPTION
Packit Service b7b338
-----------
Packit Service b7b338
Scan the sysfs tree for NVM Express subsystems and return the controllers
Packit Service b7b338
for those subsystems as well as some pertinent information about them.
Packit Service b7b338
If a device is given, print out only the values for the controllers
Packit Service b7b338
and subsystems leading to the device.
Packit Service b7b338
Packit Service b7b338
OPTIONS
Packit Service b7b338
-------
Packit Service b7b338
-o <format>::
Packit Service b7b338
--output-format=<format>::
Packit Service b7b338
	Set the reporting format to 'normal' or 'json'. Only one output
Packit Service b7b338
	format can be used at a time.
Packit Service b7b338
Packit Service b7b338
EXAMPLES
Packit Service b7b338
--------
Packit Service b7b338
[verse]
Packit Service b7b338
root@host# nvme list-subsys
Packit Service b7b338
nvme-subsys0 - NQN=nvmf-test
Packit Service b7b338
\
Packit Service b7b338
 +- nvme0 rdma traddr=1.1.1.3 trsvcid=4420 host_traddr=1.1.1.1
Packit Service b7b338
 +- nvme1 rdma traddr=1.1.1.3 trsvcid=4420 host_traddr=1.1.1.2
Packit Service b7b338
nvme-subsys1 - NQN=nvmf-test2
Packit Service b7b338
\
Packit Service b7b338
 +- nvme2 rdma traddr=1.1.1.3 trsvcid=4420 host_traddr=1.1.1.2
Packit Service b7b338
 +- nvme3 rdma traddr=1.1.1.3 trsvcid=4420 host_traddr=1.1.1.1
Packit Service b7b338
Packit Service b7b338
[verse]
Packit Service b7b338
root@host# nvme list-subsys -o json
Packit Service b7b338
{
Packit Service b7b338
  "Subsystems" : [
Packit Service b7b338
    {
Packit Service b7b338
      "Name" : "nvme-subsys0",
Packit Service b7b338
      "NQN" : "nvmf-test"
Packit Service b7b338
    },
Packit Service b7b338
    {
Packit Service b7b338
      "Paths" : [
Packit Service b7b338
        {
Packit Service b7b338
          "Name" : "nvme0",
Packit Service b7b338
          "Transport" : "rdma",
Packit Service b7b338
          "Address" : "traddr=1.1.1.3 trsvcid=4420 host_traddr=1.1.1.1"
Packit Service b7b338
        },
Packit Service b7b338
        {
Packit Service b7b338
          "Name" : "nvme1",
Packit Service b7b338
          "Transport" : "rdma",
Packit Service b7b338
          "Address" : "traddr=1.1.1.3 trsvcid=4420 host_traddr=1.1.1.2"
Packit Service b7b338
        }
Packit Service b7b338
      ]
Packit Service b7b338
    },
Packit Service b7b338
    {
Packit Service b7b338
      "Name" : "nvme-subsys1",
Packit Service b7b338
      "NQN" : "nvmf-test2"
Packit Service b7b338
    },
Packit Service b7b338
    {
Packit Service b7b338
      "Paths" : [
Packit Service b7b338
        {
Packit Service b7b338
          "Name" : "nvme2",
Packit Service b7b338
          "Transport" : "rdma",
Packit Service b7b338
          "Address" : "traddr=1.1.1.3 trsvcid=4420 host_traddr=1.1.1.2"
Packit Service b7b338
        },
Packit Service b7b338
        {
Packit Service b7b338
          "Name" : "nvme3",
Packit Service b7b338
          "Transport" : "rdma",
Packit Service b7b338
          "Address" : "traddr=1.1.1.3 trsvcid=4420 host_traddr=1.1.1.1"
Packit Service b7b338
        }
Packit Service b7b338
      ]
Packit Service b7b338
    }
Packit Service b7b338
  ]
Packit Service b7b338
}
Packit Service b7b338
Packit Service b7b338
NVME
Packit Service b7b338
----
Packit Service b7b338
Part of the nvme-user suite