diff options
Diffstat (limited to 'Documentation/nvme-list-subsys.txt')
-rw-r--r-- | Documentation/nvme-list-subsys.txt | 89 |
1 files changed, 89 insertions, 0 deletions
diff --git a/Documentation/nvme-list-subsys.txt b/Documentation/nvme-list-subsys.txt new file mode 100644 index 0000000..a5d2d48 --- /dev/null +++ b/Documentation/nvme-list-subsys.txt @@ -0,0 +1,89 @@ +nvme-list-subsys(1) +=================== + +NAME +---- +nvme-list-subsys - List all NVMe subsystems + +SYNOPSIS +-------- +[verse] +'nvme list-subsys' <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v] + +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 +------- +-o <fmt>:: +--output-format=<fmt>:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-v:: +--verbose:: + Increase the information detail in the output. + +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" + }, + { + "Name" : "nvme1", + "Transport" : "rdma", + "Address" : "traddr=1.1.1.3,trsvcid=4420,host_traddr=1.1.1.2" + } + ] + }, + { + "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" + }, + { + "Name" : "nvme3", + "Transport" : "rdma", + "Address" : "traddr=1.1.1.3,trsvcid=4420,host_traddr=1.1.1.1" + } + ] + } + ] +} + +NVME +---- +Part of the nvme-user suite |