NVME-SECURITY-RECV(1)

NAME
nvme-security-recv - Security Recv command

SYNOPSIS

nvme [<global-options>] security recv <device> [--size=<size> | -x <size>]
                        [--secp=<security-protocol> | -p <security-protocol>]
                        [--spsp=<protocol-specific> | -s <protocol-specific>]
                        [--nssf=<nvme-specific> | -N <nvme-specific>]
                        [--al=<allocation-length> | -t <allocation-length>]
                        [--namespace-id=<nsid> | -n <nsid>] [--raw-binary | -b]

DESCRIPTION

The Security Receive command transfers the status and data result of one or more Security Send commands that were previously submitted to the controller.

The association between a Security Receive command and previous Security Send commands is dependent on the Security Protocol. The format of the data to be transferred is dependent on the Security Protocol. Refer to SPC-4 for Security Protocol details.

Each Security Receive command returns the appropriate data corresponding to a Security Send command as defined by the rules of the Security Protocol. The Security Receive command data may not be retained if there is a loss of communication between the controller and host, or if a controller reset occurs.

The bare nvme security-recv form (without a space) still works as a deprecated alias and will be removed in a future major version. New scripts should use nvme security recv instead.

OPTIONS

-n <nsid>, --namespace-id=<nsid>
    Target a specific namespace for this security command.

-N <nssf>, --nssf=<nssf>
    NVMe Security Specific field. If using security protocol EAh assigned for NVMe use, the NVMe security specific field indicates which reply memory buffer target.

-x <size>, --size=<size>
    Size of buffer to allocate. One success it will be printed to STDOUT.

-p <security-protocol>, --secp=<security-protocol>
    Security Protocol: This field specifies the security protocol as defined in SPC-4. The controller shall fail the command with Invalid Parameter indicated if a reserved value of the Security Protocol is specified.

-s <security-protocol-specific>, --spsp=<security-protocol-specific>
    SP Specific: The value of this field is specific to the Security Protocol as defined in SPC-4.

-t <allocation-length>, --al=<allocation-length>
    Allocation Length: The value of this field is specific to the Security Protocol as defined in SPC-4.

-b, --raw-binary
    Print the raw buffer to stdout. Defaults to print in hex.

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

No Examples

NVME

Part of the nvme-user suite