summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-security-recv.txt
blob: 3977a140f7910ac192528a4da3920132d1550699 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
nvme-security-recv(1)
=====================

NAME
----
nvme-security-recv - Security Recv command

SYNOPSIS
--------
[verse]
'nvme 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]
			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
			[--timeout=<timeout>]

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.

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.

-o <fmt>::
--output-format=<fmt>::
	Set the reporting format to 'normal', 'json' or 'binary'. Only one
	output format can be used at a time.

-v::
--verbose::
	Increase the information detail in the output.

--timeout=<timeout>::
	Override default timeout value. In milliseconds.

EXAMPLES
--------
No Examples

NVME
----
Part of the nvme-user suite