NVME-SECURITY-SEND(1)

NAME
nvme-security-send - Security Send command

SYNOPSIS

nvme [<global-options>] security send <device> [--file=<file> | -f <file>]
                        [--secp=<security-protocol> | -p <security-protocol>]
                        [--spsp=<protocol-specific> | -s <protocol-specific>]
                        [--tl=<transfer-length> | -t <transfer-length>]
                        [--nssf=<nvme-specific> | -N <nvme-specific>]
                        [--namespace-id=<nsid> | -n <nsid>]

DESCRIPTION

The Security Send command is used to transfer security protocol data to the controller. The data structure transferred to the controller as part of this command contains security protocol specific commands to be performed by the controller. The data structure transferred may also contain data or parameters associated with the security protocol commands. Status and data that is to be returned to the host for the security protocol commands submitted by a Security Send command are retrieved with the Security Receive command.

The association between a Security Send command and subsequent Security Receive command is Security Protocol field dependent as defined in SPC-4.

The bare nvme security-send 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 send 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.

-f <file>, --file=<file>
    Path to file used as the security protocol’s payload. Required argument.

-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 <trans-length>, --tl=<trans-length>
    Transfer Length: The value of this field is specific to the Security Protocol as defined in SPC-4.

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