summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-io-mgmt-recv.1
blob: 076220a6a2e0db0e1950b0342bfb58ac89222963 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
'\" t
.\"     Title: nvme-io-mgmt-recv
.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 01/30/2023
.\"    Manual: NVMe Manual
.\"    Source: NVMe
.\"  Language: English
.\"
.TH "NVME\-IO\-MGMT\-RECV" "1" "01/30/2023" "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-io-mgmt-recv \- I/O Management Receive command
.SH "SYNOPSIS"
.sp
.nf
\fInvme io\-mgmt\-recv\fR <device> [\-\-namespace\-id=<NUM> | \-n <NUM>]
                             [\-\-mos=<NUM> | \-s <NUM>]
                             [\-\-mo=<NUM> | \-m <NUM>]
                             [\-\-data=<FILE> | \-d <FILE>]
                             [\-\-data\-len=<NUM> | \-l <NUM>]
.fi
.SH "DESCRIPTION"
.sp
For the NVMe device given, issues the I/O Management Receive command with the requested management operation (mo) and management operation specific parameter (mos)\&. This is the generic interface provided for forward compatibility as new operations are added that this program isn\(cqt aware of at the time of its development\&. As such, this is a generic command that does not do any additional decoding for specific types of data received\&. This will only report the data as a hex dump, or binary\&.
.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
\-d <FILE>, \-\-data=<FILE>
.RS 4
File to write received data into\&. If unspecified, received data will be hex dumped to the standard output stream\&.
.RE
.PP
\-l <NUM>, \-\-data\-len=<NUM>
.RS 4
Received data buffer length
.RE
.PP
\-m <NUM>, \-\-mo <NUM>
.RS 4
Management Operation to perform\&.
.RE
.PP
\-s <NUM>, \-\-mos=<NUM>
.RS 4
Management Operation Specific parameter\&.
.RE
.SH "NVME"
.sp
Part of nvme\-cli