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

NAME

6       nvme-dir-send - Issue a directive send command, returns applicable
7       results
8

SYNOPSIS

10       nvme dir-send <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                                 [--endir=<endir> | -e <endir>]
16                                 [--target-dir=<tdir> | -T <tdir>]
17                                 [--human-readable | -H]
18                                 [--raw-binary | -b]
19

DESCRIPTION

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

OPTIONS

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

EXAMPLES

92       ·   Enable streams directive :
93
94               # nvme dir-send /dev/nvme0n1 --dir-type 0 --dir-oper 1 --target-dir 1 --endir 1
95
96       ·   Disable streams directive :
97
98               # nvme dir-send /dev/nvme0n1 --dir-type 0 --dir-oper 1 --target-dir 1 --endir 0
99
100       ·   Release all allocated streams resource :
101
102               # nvme dir-send /dev/nvme0n1 --dir-type 1 --dir-oper 2
103
104       ·   Release stream ID 3 :
105
106               # nvme dir-send /dev/nvme0 --dir-type 1 --dir-oper 1 --dir-spec 3
107
108           It is probably a bad idea to not redirect stdout when using this
109           mode.
110

NVME

112       Part of the nvme-user suite
113
114
115
116NVMe                              04/24/2020                  NVME-DIR-SEND(1)