126 lines
3.4 KiB
Groff
126 lines
3.4 KiB
Groff
'\" t
|
|
.\" Title: nvme-list-subsys
|
|
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
|
|
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
|
|
.\" Date: 04/24/2020
|
|
.\" Manual: NVMe Manual
|
|
.\" Source: NVMe
|
|
.\" Language: English
|
|
.\"
|
|
.TH "NVME\-LIST\-SUBSYS" "1" "04/24/2020" "NVMe" "NVMe Manual"
|
|
.\" -----------------------------------------------------------------
|
|
.\" * Define some portability stuff
|
|
.\" -----------------------------------------------------------------
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.\" http://bugs.debian.org/507673
|
|
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\" -----------------------------------------------------------------
|
|
.\" * set default formatting
|
|
.\" -----------------------------------------------------------------
|
|
.\" disable hyphenation
|
|
.nh
|
|
.\" disable justification (adjust text to left margin only)
|
|
.ad l
|
|
.\" -----------------------------------------------------------------
|
|
.\" * MAIN CONTENT STARTS HERE *
|
|
.\" -----------------------------------------------------------------
|
|
.SH "NAME"
|
|
nvme-list-subsys \- List all NVMe subsystems
|
|
.SH "SYNOPSIS"
|
|
.sp
|
|
.nf
|
|
\fInvme list\-subsys\fR [\-o <fmt> | \-\-output\-format=<fmt>] <device>
|
|
.fi
|
|
.SH "DESCRIPTION"
|
|
.sp
|
|
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\&.
|
|
.SH "OPTIONS"
|
|
.PP
|
|
\-o <format>, \-\-output\-format=<format>
|
|
.RS 4
|
|
Set the reporting format to
|
|
\fInormal\fR
|
|
or
|
|
\fIjson\fR\&. Only one output format can be used at a time\&.
|
|
.RE
|
|
.SH "EXAMPLES"
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
\m[blue]\fBroot@host\fR\m[]\&\s-2\u[1]\d\s+2# nvme list\-subsys
|
|
nvme\-subsys0 \- NQN=nvmf\-test
|
|
\e
|
|
+\- 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
|
|
\e
|
|
+\- 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
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
\m[blue]\fBroot@host\fR\m[]\&\s-2\u[1]\d\s+2# 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"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.SH "NVME"
|
|
.sp
|
|
Part of the nvme\-user suite
|
|
.SH "NOTES"
|
|
.IP " 1." 4
|
|
root@host
|
|
.RS 4
|
|
\%mailto:root@host
|
|
.RE
|