247 lines
5.3 KiB
Groff
247 lines
5.3 KiB
Groff
'\" t
|
|
.\" Title: nvme-dir-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\-DIR\-SEND" "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-dir-send \- Issue a directive send command, returns applicable results
|
|
.SH "SYNOPSIS"
|
|
.sp
|
|
.nf
|
|
\fInvme dir\-send\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
|
|
[\-\-data\-len=<data\-len> | \-l <data\-len>]
|
|
[\-\-dir\-type=<dtype> | \-D <dtype>]
|
|
[\-\-dir\-spec=<dspec> | \-S <dspec>]
|
|
[\-\-dir\-oper=<doper> | \-O <doper>]
|
|
[\-\-endir=<endir> | \-e <endir>]
|
|
[\-\-target\-dir=<tdir> | \-T <tdir>]
|
|
[\-\-human\-readable | \-H] [\-\-raw\-binary | \-b]
|
|
[\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
|
|
[\-\-timeout=<timeout> | \-t <timeout>]
|
|
.fi
|
|
.SH "DESCRIPTION"
|
|
.sp
|
|
Submits an NVMe Directive Send admin command and returns the applicable results\&. This may be the combination of directive type, and operation, as well as target directive and its enable/disable status of the operation, if specific operation needs it\&.
|
|
.sp
|
|
The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&.
|
|
.sp
|
|
On success, the returned directive\(cqs parameter structure (if applicable) is returned in one of several ways depending on the option flags; the structure may parsed by the program and printed in a readable format if it is a known structure, displayed in hex, or the raw buffer may be printed to stdout for another program to parse\&.
|
|
.SH "OPTIONS"
|
|
.PP
|
|
\-n <nsid>, \-\-namespace\-id=<nsid>
|
|
.RS 4
|
|
Retrieve the feature for the given nsid\&. This is optional and most features do not use this value\&.
|
|
.RE
|
|
.PP
|
|
\-D <dtype>, \-\-dir\-type=<dtype>
|
|
.RS 4
|
|
Directive type
|
|
.RE
|
|
.PP
|
|
\-S <dspec>, \-\-dir\-spec=<dspec>
|
|
.RS 4
|
|
Directive specific
|
|
.RE
|
|
.PP
|
|
\-O <doper>, \-\-dir\-oper=<doper>
|
|
.RS 4
|
|
Directive operation
|
|
.RE
|
|
.PP
|
|
\-T <tdir>, \-\-target\-dir=<nsr>
|
|
.RS 4
|
|
Target directive of the operation
|
|
.RE
|
|
.PP
|
|
\-e <endir>, \-\-endir=<endir>
|
|
.RS 4
|
|
Target directive enable(1) or disable (0) operation
|
|
.TS
|
|
allbox tab(:);
|
|
lt lt
|
|
lt lt
|
|
lt lt
|
|
lt lt
|
|
lt lt
|
|
lt lt.
|
|
T{
|
|
Select
|
|
T}:T{
|
|
Description
|
|
T}
|
|
T{
|
|
0
|
|
T}:T{
|
|
Current
|
|
T}
|
|
T{
|
|
1
|
|
T}:T{
|
|
Default
|
|
T}
|
|
T{
|
|
2
|
|
T}:T{
|
|
Saved
|
|
T}
|
|
T{
|
|
3
|
|
T}:T{
|
|
Supported capabilities
|
|
T}
|
|
T{
|
|
4\(en7
|
|
T}:T{
|
|
Reserved
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
.RE
|
|
.PP
|
|
\-l <data\-len>, \-\-data\-len=<data\-len>
|
|
.RS 4
|
|
The data length for the buffer returned for this feature\&. Most known features do not use this value\&. The exception is LBA Range Type
|
|
.RE
|
|
.PP
|
|
\-b, \-\-raw\-binary
|
|
.RS 4
|
|
Print the raw receive buffer to stdout if the command returns a structure\&.
|
|
.RE
|
|
.PP
|
|
\-H, \-\-human\-readable
|
|
.RS 4
|
|
Print the decoded receive buffer to stdout if the command returns a structure\&.
|
|
.RE
|
|
.PP
|
|
\-o <fmt>, \-\-output\-format=<fmt>
|
|
.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>, \-\-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
|
|
.\}
|
|
Enable streams directive :
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
# nvme dir\-send /dev/nvme0n1 \-\-dir\-type 0 \-\-dir\-oper 1 \-\-target\-dir 1 \-\-endir 1
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
Disable streams directive :
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
# nvme dir\-send /dev/nvme0n1 \-\-dir\-type 0 \-\-dir\-oper 1 \-\-target\-dir 1 \-\-endir 0
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
Release all allocated streams resource :
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
# nvme dir\-send /dev/nvme0n1 \-\-dir\-type 1 \-\-dir\-oper 2
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
Release stream ID 3 :
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
# nvme dir\-send /dev/nvme0 \-\-dir\-type 1 \-\-dir\-oper 1 \-\-dir\-spec 3
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.sp
|
|
It is probably a bad idea to not redirect stdout when using this mode\&.
|
|
.RE
|
|
.SH "NVME"
|
|
.sp
|
|
Part of the nvme\-user suite
|