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

FreeBSD Manual Pages

  
 
  

home | help
NVME-SET-FEATURE(1)		  NVMe Manual		   NVME-SET-FEATURE(1)

NAME
       nvme-set-feature	- Sets an NVMe feature,	returns	applicable results

SYNOPSIS
       nvme set-feature	<device> [--namespace-id=<nsid>	| -n <nsid>]
			       [--feature-id=<fid> | -f	<fid>] [--value=<value>	| -V <value>]
			       [--uuid-index=<uuid-index> | -U <uuid_index>]
			       [--data-len=<data-len> |	-l <data-len>]
			       [--data=<data-file> | -d	<data-file>] [--save | -s]
			       [--output-format=<fmt> |	-o <fmt>] [--verbose | -v]
			       [--cdw12=<cdw12>	| -c <cdw12>]
			       [--timeout=<timeout> | -t <timeout>]

DESCRIPTION
       Submits an NVMe Set Feature admin command and returns the applicable
       results.	This may be the	feature's value, or may	also include a feature
       structure if the	feature	requires it (ex: LBA Range Type).

       The <device> parameter is mandatory and may be either the NVMe
       character device	(ex: /dev/nvme0), or a namespace block device (ex:
       /dev/nvme0n1).

       On success, the value sent to the device	is displayed

OPTIONS
       -n <nsid>, --namespace-id=<nsid>
	   Sets	the feature for	the given nsid.	This is	optional and most
	   features do not use this value.

       -f <fid>, --feature-id=<fid>
	   The feature id to send with the command. Value provided should be
	   in hex.

       -l <data-len>, --data-len=<data-len>
	   The data length for the buffer submitted for	this feature. Most
	   known features do not use this value. The exceptions	are LBA	Range
	   Type	and host identifier.

       -d <data-file>, --data=<data-file>
	   The data file for the buffer	submitted for this feature. Most known
	   features do not use this value. The exceptions is LBA Range Type
	   and host identifier.	This defaults to STDIN so files	and echo can
	   be piped.

       -V <value>, --value=<value>
	   The value for command dword 11, the value you want to set the
	   feature to.

       -s, --save
	   Save	the attribute so that it persists through all power states and
	   resets.

       -U <uuid-index>,	--uuid-index=<uuid-index>
	   UUID	Index of the feature

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

       -c <cdw12>, --cdw12=<cdw12>
	   The value for command dword 12, if applicable.

       -t <timeout>, --timeout=<timeout>
	   Override default timeout value. In milliseconds.

EXAMPLES
          Sets	the Power State	(PS) to	1 in feature id	2:

	       # nvme set-feature /dev/nvme0 -f	2 /dev/nvme0n1 -V 0x1

          Sets	the host id to the ascii string.

	       # echo "abcdefgh" | nvme	set-feature /dev/nvme0 -f 0x81 -l 8

	   nvme	set-feature /dev/nvme0 -f 0x81 -l 8 -U 0x1

NVME
       Part of the nvme-user suite

NVMe				  10/31/2024		   NVME-SET-FEATURE(1)

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

home | help