Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
NVME-SECURITY-SEND(1)		   NVMe Manual		   NVME-SECURITY-SEND(1)

NAME
     nvme-security-send - Security Send command

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

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 sub-
     mitted by a Security Send command are retrieved with the  Security  Receive
     command.

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

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 argu-
	 ment.

     -p <security-protocol>, --secp=<security-protocol>
	 Security Protocol: This field specifies the security  protocol  as  de-
	 fined	in SPC-4. The controller shall fail the command with Invalid Pa-
	 rameter indicated if a reserved value of the Security Protocol is spec-
	 ified.

     -s <security-protocol-specific>, --spsp=<security-protocol-specific>
	 SP Specific: The value of this field is specific to the Security Proto-
	 col 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.

     -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

NVMe				   10/31/2024		   NVME-SECURITY-SEND(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=nvme-security-send&sektion=1&manpath=FreeBSD+Ports+15.1.quarterly>

home | help