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

FreeBSD Manual Pages

  
 
  

home | help
NVME-WDC-CAP-DIAG(1)		  NVMe Manual		  NVME-WDC-CAP-DIAG(1)

NAME
       nvme-wdc-cap-diag - Retrieve WDC	device's diagnostic log	and save to
       file.

SYNOPSIS
       nvme wdc	cap-diag <device> [--output-file=<FILE>, -o <FILE>] [--transfer-size=<SIZE>, -s	<SIZE>]

DESCRIPTION
       For the NVMe device given, sends	the WDC	Vendor Unique
       Capture-Diagnostics request and saves the result	to a file.

       The <device> parameter is mandatory NVMe	character device (ex:
       /dev/nvme0).

       This will only work on WDC devices supporting this feature. Results for
       any other device	are undefined.

OPTIONS
       -o <FILE>, --output-file=<FILE>
	   Output file;	defaults to device serial number followed by
	   "cap_diag" suffix

       -s <SIZE>, --transfer-size=<SIZE>
	   Transfer size; defaults to 0x10000 (65536 decimal) bytes

EXAMPLES
          Gets	the capture diagnostics	log from the device and	saves to
	   default file	in current directory (e.g. STM00019F3F9cap_diag.bin):

	       # nvme wdc cap-diag /dev/nvme0

          Gets	the capture diagnostics	log from the device and	saves to
	   defined file	in current directory (e.g.
	   testSTM00019F3F9cap_diag.bin):

	       # nvme wdc cap-diag /dev/nvme0 -o test

          Gets	the capture diagnostics	log from the device and	saves to
	   defined file	with pathname (e.g.
	   /tmp/testSTM00019F3F9cap_diag.bin):

	       # nvme wdc cap-diag /dev/nvme0 -o /tmp/test

          Gets	the capture diagnostics	log from the device transferring the
	   data	in 64k chunks and saves	to default file	in current directory
	   (e.g. STM00019F3F9internal_fw_log.bin):

	       # nvme wdc cap-diag /dev/nvme0 -s 0x10000

          Gets	the capture diagnostics	log from the device transferring the
	   data	in 16k chunks and saves	to default file	in current directory
	   (e.g. STM00019F3F9internal_fw_log.bin):

	       # nvme wdc cap-diag /dev/nvme0 -s 16384

NVME
       Part of the nvme-user suite.

NVMe				  10/31/2024		  NVME-WDC-CAP-DIAG(1)

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

home | help