summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-io-mgmt-recv.txt
blob: e611c15f3910ded179b0f877892db02a5d6fdbf2 (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
nvme-io-mgmt-recv(1)
====================

NAME
----
nvme-io-mgmt-recv - I/O Management Receive command

SYNOPSIS
--------
[verse]
'nvme io-mgmt-recv' <device> [--namespace-id=<NUM> | -n <NUM>]
			     [--mos=<NUM> | -s <NUM>]
			     [--mo=<NUM> | -m <NUM>]
			     [--data=<FILE> | -d <FILE>]
			     [--data-len=<NUM> | -l <NUM>]

DESCRIPTION
-----------
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't 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.

OPTIONS
-------
-n <NUM>::
--namespace-id=<NUM>::
	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.

-d <FILE>::
--data=<FILE>::
	File to write received data into. If unspecified, received data will be
	hex dumped to the standard output stream.

-l <NUM>::
--data-len=<NUM>::
	Received data buffer length

-m <NUM>::
--mo <NUM>::
	Management Operation to perform.

-s <NUM>::
--mos=<NUM>::
	Management Operation Specific parameter.


NVME
----
Part of nvme-cli