From 5b7ddc4bd2dcdde201ffa2681ede9a0a029bad96 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Fri, 2 Jul 2021 22:47:46 +0200 Subject: Adding upstream version 1.14. Signed-off-by: Daniel Baumann --- Documentation/nvme-zns-id-ns.txt | 62 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 Documentation/nvme-zns-id-ns.txt (limited to 'Documentation/nvme-zns-id-ns.txt') diff --git a/Documentation/nvme-zns-id-ns.txt b/Documentation/nvme-zns-id-ns.txt new file mode 100644 index 0000000..a95d975 --- /dev/null +++ b/Documentation/nvme-zns-id-ns.txt @@ -0,0 +1,62 @@ +nvme-zns-id-ns(1) +================= + +NAME +---- +nvme-zns-id-ns - Send NVMe Zoned Command Set Identify Controller, return + result and structure + +SYNOPSIS +-------- +[verse] +'nvme zns id-ns' [--namespace-id= | -n ] + [-o | --output-format=] + [-v | --verbose] + +DESCRIPTION +----------- +For the NVMe device given, sends the zoned command set's identify namepsace +command and provides the result and returned structure. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). + +On success, the data structure returned by the device will be decoded and +displayed in one of several ways. + +OPTIONS +------- +-n :: +--namespace-id=:: + Use the provided namespace id for the command. If not provided, the + namespace id of the block device will be used. If the command is issued + to a non-block device, the parameter is required. + +-v:: +--verbose:: + Increase the information detail in the output. + +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json', or + 'binary'. Only one output format can be used at a time. + +EXAMPLES +-------- +* Has the program interpret the returned buffer and display the known +fields in a human readable format: ++ +------------ +# nvme zns id-ns /dev/nvme0 -n 1 +------------ ++ + +* Show the output in json format with extra details ++ +------------ +# nvme zns id-ns /dev/nvme0 -o json -v +------------ + +NVME +---- +Part of nvme-cli -- cgit v1.2.3