'\" t
.\" Title: nvme-id-ns
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot
.\" Date: 08/05/2024
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-ID\-NS" "1" "08/05/2024" "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-ns \- Send NVMe Identify List Namespaces, return result and structure
.SH "SYNOPSIS"
.sp
.nf
\fInvme list\-ns\fR [\-\-namespace\-id= | \-n ]
[\-\-csi= | \-y ]
[\-\-all | \-a]
[\-\-output\-format= | \-o ] [\-\-verbose | \-v]
[\-\-timeout= | \-t ]
.fi
.SH "DESCRIPTION"
.sp
For the NVMe device given, sends an identify command for namespace list and provides the result and returned structure\&.
.sp
The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. If the starting namespace in the list always begins with 0 unless the \*(Aq\-\-namespace\-id\*(Aq option is given to override\&.
.sp
On success, the namespace array is printed for each index and nsid for a valid nsid\&.
.SH "OPTIONS"
.PP
\-n , \-\-namespace\-id=
.RS 4
Retrieve the identify list structure starting with the given nsid\&.
.RE
.PP
\-y , \-\-csi=
.RS 4
If this value is given, retrieve the identify list structure associated with the specified I/O command set\&.
.RE
.PP
\-a, \-\-all
.RS 4
Retrieve the identify list structure for all namespaces in the subsystem, whether attached or inactive\&.
.RE
.PP
\-o , \-\-output\-format=
.RS 4
Set the reporting format to
\fInormal\fR,
\fIjson\fR
or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
.PP
\-v, \-\-verbose
.RS 4
Increase the information detail in the output\&.
.RE
.PP
\-t , \-\-timeout=
.RS 4
Override default timeout value\&. In milliseconds\&.
.RE
.SH "EXAMPLES"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Print the namespaces present for zoned command set in JSON format
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme list\-ns /dev/nvme0 \-y 2 \-a \-o json
.fi
.if n \{\
.RE
.\}
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Print the namespaces present for NVM Command Set in normal format
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme list\-ns /dev/nvme0
.fi
.if n \{\
.RE
.\}
.RE
.SH "NVME"
.sp
Part of the nvme\-user suite