summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-security-send.1
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/nvme-security-send.1')
-rw-r--r--Documentation/nvme-security-send.198
1 files changed, 98 insertions, 0 deletions
diff --git a/Documentation/nvme-security-send.1 b/Documentation/nvme-security-send.1
new file mode 100644
index 0000000..d463f85
--- /dev/null
+++ b/Documentation/nvme-security-send.1
@@ -0,0 +1,98 @@
+'\" t
+.\" Title: nvme-security-send
+.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
+.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
+.\" Date: 02/14/2024
+.\" Manual: NVMe Manual
+.\" Source: NVMe
+.\" Language: English
+.\"
+.TH "NVME\-SECURITY\-SEND" "1" "02/14/2024" "NVMe" "NVMe Manual"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+nvme-security-send \- Security Send command
+.SH "SYNOPSIS"
+.sp
+.nf
+\fInvme security\-send\fR <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>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
+.fi
+.SH "DESCRIPTION"
+.sp
+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\&.
+.sp
+The association between a Security Send command and subsequent Security Receive command is Security Protocol field dependent as defined in SPC\-4\&.
+.SH "OPTIONS"
+.PP
+\-n <nsid>, \-\-namespace\-id=<nsid>
+.RS 4
+Target a specific namespace for this security command\&.
+.RE
+.PP
+\-N <nssf>, \-\-nssf=<nssf>
+.RS 4
+NVMe Security Specific field\&. If using security protocol EAh assigned for NVMe use, the NVMe security specific field indicates which reply memory buffer target\&.
+.RE
+.PP
+\-f <file>, \-\-file=<file>
+.RS 4
+Path to file used as the security protocol\(cqs payload\&. Required argument\&.
+.RE
+.PP
+\-p <security\-protocol>, \-\-secp=<security\-protocol>
+.RS 4
+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\&.
+.RE
+.PP
+\-s <security\-protocol\-specific>, \-\-spsp=<security\-protocol\-specific>
+.RS 4
+SP Specific: The value of this field is specific to the Security Protocol as defined in SPC\-4\&.
+.RE
+.PP
+\-t <trans\-length>, \-\-tl=<trans\-length>
+.RS 4
+Transfer Length: The value of this field is specific to the Security Protocol as defined in SPC\-4\&.
+.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
+.SH "EXAMPLES"
+.sp
+No Examples
+.SH "NVME"
+.sp
+Part of the nvme\-user suite