136 lines
3.6 KiB
Groff
136 lines
3.6 KiB
Groff
'\" t
|
|
.\" Title: nvme-zns-zone-mgmt-send
|
|
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
|
|
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
|
|
.\" Date: 10/31/2024
|
|
.\" Manual: NVMe Manual
|
|
.\" Source: NVMe
|
|
.\" Language: English
|
|
.\"
|
|
.TH "NVME\-ZNS\-ZONE\-MGM" "1" "10/31/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-zns-zone-mgmt-send \- Zone Management Send command
|
|
.SH "SYNOPSIS"
|
|
.sp
|
|
.nf
|
|
\fInvme zns zone\-mgmt\-send\fR <device> [\-\-namespace\-id=<NUM> | \-n <NUM>]
|
|
[\-\-start\-lba=<IONUM>, \-s <IONUM>] [\-\-zsaso, \-o]
|
|
[\-\-select\-all, \-a] [\-\-zsa=<NUM>, \-z <NUM>]
|
|
[\-\-data\-len=<IONUM>, \-l <IONUM>]
|
|
[\-\-data=<FILE>, \-d <FILE>]
|
|
[\-\-timeout=<timeout> | \-t <timeout>]
|
|
.fi
|
|
.SH "DESCRIPTION"
|
|
.sp
|
|
For the NVMe device given, issues the Zone Management Send command with the requested send action\&. If the send requires additional data, you may specify the data length\&. If data is required, the input will default to stdin\&. Alternatively, the data may come from a file that can be specified\&.
|
|
.SH "OPTIONS"
|
|
.PP
|
|
\-n <NUM>, \-\-namespace\-id=<NUM>
|
|
.RS 4
|
|
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\&.
|
|
.RE
|
|
.PP
|
|
\-s <lba>, \-\-start\-lba=<lba>
|
|
.RS 4
|
|
The starting LBA of the zone to manage send\&.
|
|
.RE
|
|
.PP
|
|
\-l <NUM>, \-\-data\-len=<NUM>
|
|
.RS 4
|
|
Send data buffer length
|
|
.RE
|
|
.PP
|
|
\-o, \-\-zsaso
|
|
.RS 4
|
|
Zone Send Action Specific Option
|
|
.RE
|
|
.PP
|
|
\-a, \-\-select\-all
|
|
.RS 4
|
|
Send command to all zones
|
|
.RE
|
|
.PP
|
|
\-z <NUM>, \-\-zsa=<NUM>
|
|
.RS 4
|
|
Zone send action\&.
|
|
.RE
|
|
.PP
|
|
\-l <IONUM>, \-\-data\-len=<IONUM>
|
|
.RS 4
|
|
Buffer length if data required
|
|
.RE
|
|
.PP
|
|
\-d <FILE>, \-\-data=<FILE>
|
|
.RS 4
|
|
Optional file for data (default stdin)
|
|
.RE
|
|
.PP
|
|
\-t <timeout>, \-\-timeout=<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
|
|
.\}
|
|
Send a zone management command with action set to 1 (close zone) to namespace 1\(cqs first zone:
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
# nvme zns zone\-mgmt\-send /dev/nvme0 \-n 1 \-s 0 \-z 1
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
Write "hello world" into the zone descriptor for namespace 1\(cqs first zone (requires device supports a large enough zone extended data)
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
# echo "hello world" | nvme zns zone\-mgmt\-send /dev/nvme0 \-n 1 \-s 0 \-z 0x10
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.RE
|
|
.SH "NVME"
|
|
.sp
|
|
Part of nvme\-cli
|