1. Manuals
  2. Tumbleweed
  3. nvme-cli
  4. nvme-dir-receive(1)

Scroll to navigation

NVME-DIR-RECEIVE(1) NVMe Manual NVME-DIR-RECEIVE(1)

NAME

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

SYNOPSIS

nvme [<global-options>] dir-receive <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>]


                        [--req-resource=<nsr> | -r <nsr>] [--raw-binary | -b]

DESCRIPTION

Submits an NVMe Directive Receive admin command and returns the applicable results. This may be the combination of directive type, and operation, as well as number of requested resource if specific operation needs it.

The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

On success, the returned directive’s 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.

OPTIONS

-n <nsid>, --namespace-id=<nsid>

Retrieve the feature for the given nsid. This is optional and most features do not use this value.

-D <dtype>, --dir-type=<dtype>

Directive type

-S <dspec>, --dir-spec=<dspec>

Directive specific

-O <doper>, --dir-oper=<doper>

Directive operation

-r <nsr>, --req-resource=<nsr>

Directive requested resource count
Select Description
0 Current
1 Default
2 Saved
3 Supported capabilities
4–7 Reserved

-l <data-len>, --data-len=<data-len>

The data length for the buffer returned for this feature. Most known features do not use this value. The exception is LBA Range Type

-b, --raw-binary

Print the raw receive buffer to stdout if the command returns a structure.

GLOBAL OPTIONS

The following options are defined at the top-level nvme command and are available to this subcommand:

--dry-run

Print the command that would be executed, but do not actually execute it.

--no-ioctl-probing

Disable probing for 64-bit IOCTL support.

--no-retries

Disable retry logic on transient errors.

-o <fmt>, --output-format=<fmt>

Set the reporting format to normal, tabular, 'json, or binary. Only one output format may be used at a time.

--output-format-version=<version>

Select the output format version. Version 1 uses the original field naming, while version 2 (default) provides more consistent and script-friendly field names.

--timeout=<ms>

Set the timeout for the command in milliseconds.

-v, --verbose

Increase the level of detail in the output. May be specified multiple times to further increase verbosity.

These options can also be set as machine-wide defaults in nvme-cli.conf(5). A command-line flag always overrides the file.

EXAMPLES

•Identify directive type supported : 

# nvme dir-receive /dev/nvme0 --dir-type 0 --dir-oper 1 --verbose

•Get stream directive parameters : 

# nvme dir-receive /dev/nvme0 --dir-type 1 --dir-oper 1 --verbose

•Allocate 3 streams for namespace 1 

# nvme dir-receive /dev/nvme0n1 --dir-type 1 --dir-oper 3 --req-resource 3 --verbose

•Get streams directive status : 

# nvme dir-receive /dev/nvme0 --dir-type 1 --dir-oper 2 --verbose

It is probably a bad idea to not redirect stdout when using this mode.

NVME

Part of the nvme-user suite

07/31/2026 NVMe