Blame Documentation/nvme-security-recv.txt

Packit Service b7b338
nvme-security-recv(1)
Packit Service b7b338
=====================
Packit Service b7b338
Packit Service b7b338
NAME
Packit Service b7b338
----
Packit Service b7b338
nvme-security-recv - Security Recv command
Packit Service b7b338
Packit Service b7b338
SYNOPSIS
Packit Service b7b338
--------
Packit Service b7b338
[verse]
Packit Service b7b338
'nvme security-recv' <device> [--size=<size> | -x <size>]
Packit Service b7b338
		    [--secp=<security-protocol> | -p <security-protocol>]
Packit Service b7b338
		    [--spsp=<protocol-specific> | -s <protocol-specific>]
Packit Service b7b338
		    [--nssf=<nvme-specific> | -N <nvme-specific>]
Packit Service b7b338
		    [--al=<allocation-length> | -t <allocation-length>]
Packit Service b7b338
		    [--namespace-id=<nsid> | -n <nsid>]
Packit Service b7b338
		    [--raw-binary | -b]
Packit Service b7b338
Packit Service b7b338
DESCRIPTION
Packit Service b7b338
-----------
Packit Service b7b338
The Security Receive command transfers the status and data result of
Packit Service b7b338
one or more Security Send commands that were previously submitted to
Packit Service b7b338
the controller.
Packit Service b7b338
Packit Service b7b338
The association between a Security Receive command and previous Security
Packit Service b7b338
Send commands is dependent on the Security Protocol. The format of the
Packit Service b7b338
data to be transferred is dependent on the Security Protocol. Refer to
Packit Service b7b338
SPC-4 for Security Protocol details.
Packit Service b7b338
Packit Service b7b338
Each Security Receive command returns the appropriate data corresponding
Packit Service b7b338
to a Security Send command as defined by the rules of the Security
Packit Service b7b338
Protocol. The Security Receive command data may not be retained if there
Packit Service b7b338
is a loss of communication between the controller and host, or if a
Packit Service b7b338
controller reset occurs.
Packit Service b7b338
Packit Service b7b338
OPTIONS
Packit Service b7b338
-------
Packit Service b7b338
-n <nsid>::
Packit Service b7b338
--namespace-id=<nsid>::
Packit Service b7b338
	Target a specific namespace for this security command.
Packit Service b7b338
Packit Service b7b338
-N <nssf>::
Packit Service b7b338
--nssf=<nssf>::
Packit Service b7b338
	NVMe Security Specific field. If using security protocol EAh
Packit Service b7b338
	assigned for NVMe use, the NVMe security specific field indicates
Packit Service b7b338
	which reply memory buffer target.
Packit Service b7b338
Packit Service b7b338
-x <size>::
Packit Service b7b338
--size=<size>::
Packit Service b7b338
	Size of buffer to allocate. One success it will be printed
Packit Service b7b338
	to STDOUT.
Packit Service b7b338
Packit Service b7b338
-p <security-protocol>::
Packit Service b7b338
--secp=<security-protocol>::
Packit Service b7b338
	Security Protocol: This field specifies the security protocol
Packit Service b7b338
	as defined in SPC-4. The controller shall fail the command with
Packit Service b7b338
	Invalid Parameter indicated if a reserved value of the Security
Packit Service b7b338
	Protocol is specified.
Packit Service b7b338
Packit Service b7b338
-s <security-protocol-specific>::
Packit Service b7b338
--spsp=<security-protocol-specific>::
Packit Service b7b338
	SP Specific: The value of this field is specific to the Security
Packit Service b7b338
	Protocol as defined in SPC-4.
Packit Service b7b338
Packit Service b7b338
-t <allocation-length>::
Packit Service b7b338
--al=<allocation-length>::
Packit Service b7b338
	Allocation Length: The value of this field is specific to the
Packit Service b7b338
	Security Protocol as defined in SPC-4.
Packit Service b7b338
Packit Service b7b338
-b::
Packit Service b7b338
--raw-binary::
Packit Service b7b338
	Print the raw buffer to stdout. Defaults to print in hex.
Packit Service b7b338
Packit Service b7b338
EXAMPLES
Packit Service b7b338
--------
Packit Service b7b338
No Examples
Packit Service b7b338
Packit Service b7b338
NVME
Packit Service b7b338
----
Packit Service b7b338
Part of the nvme-user suite