1NVME-DIR-RECEIVE(1)               NVMe Manual              NVME-DIR-RECEIVE(1)
2
3
4

NAME

6       nvme-dir-receive - Send a directive receive command, returns applicable
7       results
8

SYNOPSIS

10       nvme dir-receive <device> [--namespace-id=<nsid> | -n <nsid>]
11                                 [--data-len=<data-len> | -l <data-len>]
12                                 [--dir-type=<dtype> | -D <dtype>]
13                                 [--dir-spec=<dspec> | -S <dspec>]
14                                 [--dir-oper=<doper> | -O <doper>]
15                                 [--req-resource=<nsr> | -r <nsr>]
16                                 [--human-readable | -H]
17                                 [--raw-binary | -b]
18

DESCRIPTION

20       Submits an NVMe Directive Receive admin command and returns the
21       applicable results. This may be the combination of directive type, and
22       operation, as well as number of requested resource if specific
23       operation needs it.
24
25       The <device> parameter is mandatory and may be either the NVMe
26       character device (ex: /dev/nvme0), or a namespace block device (ex:
27       /dev/nvme0n1).
28
29       On success, the returned directive’s parameter structure (if
30       applicable) is returned in one of several ways depending on the option
31       flags; the structure may parsed by the program and printed in a
32       readable format if it is a known structure, displayed in hex, or the
33       raw buffer may be printed to stdout for another program to parse.
34

OPTIONS

36       -n <nsid>, --namespace-id=<nsid>
37           Retrieve the feature for the given nsid. This is optional and most
38           features do not use this value.
39
40       -D <dtype>, --dir-type=<dtype>
41           Directive type
42
43       -S <dspec>, --dir-spec=<dspec>
44           Directive specific
45
46       -O <doper>, --dir-oper=<doper>
47           Directive operation
48
49       -r <nsr>, --req-resource=<nsr>
50           Directive requested resource count
51
52       +
53
54       ┌───────┬────────────────────────┐
55       │       │                        │
56       │Select │ Description            │
57       ├───────┼────────────────────────┤
58       │       │                        │
59       │0      │ Current                │
60       ├───────┼────────────────────────┤
61       │       │                        │
62       │1      │ Default                │
63       ├───────┼────────────────────────┤
64       │       │                        │
65       │2      │ Saved                  │
66       ├───────┼────────────────────────┤
67       │       │                        │
68       │3      │ Supported capabilities │
69       ├───────┼────────────────────────┤
70       │       │                        │
71       │4–7    │ Reserved               │
72       └───────┴────────────────────────┘
73
74       -l <data-len>, --data-len=<data-len>
75           The data length for the buffer returned for this feature. Most
76           known features do not use this value. The exception is LBA Range
77           Type
78
79       -b, --raw-binary
80           Print the raw receive buffer to stdout if the command returns a
81           structure.
82
83       -H, --human-readable
84           Print the decoded receive buffer to stdout if the command returns a
85           structure.
86

EXAMPLES

88       •   Identify directive type supported :
89
90               # nvme dir-receive /dev/nvme0 --dir-type 0 --dir-oper 1 --human-readable
91
92       •   Get stream directive parameters :
93
94               # nvme dir-receive /dev/nvme0 --dir-type 1 --dir-oper 1 --human-readable
95
96       •   Allocate 3 streams for namespace 1
97
98               # nvme dir-receive /dev/nvme0n1 --dir-type 1 --dir-oper 3 --req-resource 3 --human-readable
99
100       •   Get streams directive status :
101
102               # nvme dir-receive /dev/nvme0 --dir-type 1 --dir-oper 2 --human-readable
103
104           It is probably a bad idea to not redirect stdout when using this
105           mode.
106

NVME

108       Part of the nvme-user suite
109
110
111
112NVMe                              09/29/2023               NVME-DIR-RECEIVE(1)