1
0
Fork 0
nvme-cli/Documentation/nvme-list-ns.txt
Daniel Baumann d6fd2fdea9
Merging upstream version 1.14.
Signed-off-by: Daniel Baumann <daniel@debian.org>
2025-02-16 11:31:10 +01:00

50 lines
1.2 KiB
Text

nvme-id-ns(1)
=============
NAME
----
nvme-list-ns - Send NVMe Identify List Namespaces, return result and structure
SYNOPSIS
--------
[verse]
'nvme list-ns' <device> [--namespace-id=<nsid> | -n <nsid>]
[--csi=<command_set_identifier> | -y <command_set_identifier>]
[--all | -a]
DESCRIPTION
-----------
For the NVMe device given, sends an identify command for namespace list
and provides the result and returned structure.
The <device> 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
`'--namespace-id'` option is given to override.
On success, the namespace array is printed for each index and nsid for
a valid nsid.
OPTIONS
-------
-n <nsid>::
--namespace-id=<nsid>::
Retrieve the identify list structure starting with the given nsid.
-y <command_set_identifier>::
--csi=<command_set_identifier>::
If this value is given, retrieve the identify list structure associated
with the speicified I/O command set.
-a::
--all::
Retrieve the identify list structure for all namespaces in the
subsystem, whether attached or inactive.
EXAMPLES
--------
No examples yet.
NVME
----
Part of the nvme-user suite