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

FreeBSD Manual Pages

  
 
  

home | help 
NVME-NVME-MI-RECV(1)		   NVMe Manual		    NVME-NVME-MI-RECV(1)

NAME
     nvme-nvme-mi-recv - Send a NVMe-MI Receive command to the specified device

SYNOPSIS
     nvme nvme-mi-recv <device> [--opcode=<opcode> | -O <opcode>]
			     [--namespace-id=<nsid> | -n <nsid>]
			     [--data-len=<data-len> | -l <data-len>]
			     [--nmimt=<nmimt> | -m <nmimt>]
			     [--nmd0=<nmd0> | -0 <nmd0>] [--nmd1=<nmd1> | -1 <nmd1>]
			     [--input-file=<file> | -i <file>]
			     [--output-format=<fmt> | -o <fmt>] [--verbose | -v]

DESCRIPTION
     Send a NVMe-MI Receive command to the specified device, return results.

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

     On success it returns 0, error code otherwise.

OPTIONS
     -O <opcode>, --opcode=<opcode>
	 The NVMe-MI opcode to send to the device in the command

     -n <nsid>, --namespace-id=<nsid>
	 The value for the ns-id in the command.

     -l <data-len>, --data-len=<data-len>
	 The data length for the buffer used for this command.

     -m <nmimt>, --nmimt=<nmimt>
	 The value for the NVMe-MI message type in the command.

     -0 <nmd0>, --nmd0=<nmd0>
	 The value for the NVMe management request dword 0 in the command.

     -1 <nmd1>, --nmd1=<nmd1>
	 The value for the NVMe management request dword 1 in the command.

     -i <file>, --input-file=<file>
	 If the command is a data-out (write) command, use this file to fill the
	 buffer sent to the device. If no file is given, assumed to use STDIN.

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

EXAMPLES
     *	 Has the program issue a nvme-mi-recv to execute the VPD read.

	     # nvme nvme-mi-recv /dev/nvme0n1 -O 5 -m 1 -0 0 -1 0x100 -l 256

NVME
     Part of the nvme-user suite.

NVMe				   10/31/2024		    NVME-NVME-MI-RECV(1)

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

home | help