1NVME-WDC-VS-INTER(1)              NVMe Manual             NVME-WDC-VS-INTER(1)
2
3
4

NAME

6       nvme-wdc-vs-internal-log - Retrieve WDC device's internal firmware log
7       and save to file.
8

SYNOPSIS

10       nvme wdc vs-internal-log <device> [--output-file=<FILE>, -o <FILE>] [--transfer-size=<SIZE>, -s <SIZE>]
11           [--data-area=<DATA AREA>, -d <DATA_AREA>] [--file-size=<FILE SIZE>, -f <FILE SIZE>] [--offset=<OFFSET>, -e <OFFSET>]
12           [--type=<TYPE>, -t <type>] [--verbose, -v]
13

DESCRIPTION

15       For the NVMe device given, sends the WDC Vendor Specific Internal Log
16       request and saves the result to a file.
17
18       The <device> parameter is mandatory NVMe character device (ex:
19       /dev/nvme0).
20
21       This will only work on WDC devices supporting this feature. Results for
22       any other device are undefined.
23

OPTIONS

25       -o <FILE>, --output-file=<FILE>
26           Output file; defaults to device serial number followed by
27           "internal_fw_log<date>_<time>.bin" suffix
28
29       -s <SIZE>, --transfer-size=<SIZE>
30           Transfer size; defaults to 0x10000 (65536 decimal) bytes
31
32       -d <DATA AREA>, --data-area=<DATA AREA>
33           DUI data area to retrieve. The DUI data areas from 1 to <DATA AREA>
34           will be retrieved. This parameter is currently only supported on
35           the SN340, SN640, SN730, and SN840 devices.
36
37       -f <FILE SIZE>, --file-size=<FILE SIZE>
38           Specifies the desired size of the data file starting at the passed
39           in offset. This allows the user to retrieve the data in several
40           smaller files of the passed in size. This parameter is currently
41           only supported on the SN340 device.
42
43       -e <OFFSET>, --offset=<OFFSET>
44           Specifies the data offset at which to start retrieving the data.
45           This parameter is used in combination with the file size parameter
46           to retrieve the data in several smaller files. This parameter is
47           currently only supported on the SN340 device.
48
49       -t <TYPE>, --type=<TYPE>
50           Specifies the telemetry type - NONE, HOST, or CONTROLLER. This
51           parameter is used to get either the host generated or controller
52           initiated telemetry log page. If not specified or none is
53           specified, the command will return the default E6 log data. This
54           parameter is currently only supported on the SN640 and SN840
55           devices.
56
57       -v <VERBOSE>, --verbose=<VERBOSE>
58           Provides additional debug messages for certain drives.
59

EXAMPLES

61       •   Gets the internal firmware log from the device and saves to default
62           file in current directory (e.g.
63           STM00019F3F9_internal_fw_log_20171127_095704.bin):
64
65               # nvme wdc vs-internal-log /dev/nvme0
66
67       •   Gets the internal firmware log from the device and saves to defined
68           file in current directory (e.g. test.bin):
69
70               # nvme wdc vs-internal-log /dev/nvme0 -o test.bin
71
72       •   Gets the internal firmware log from the device and saves to defined
73           file with pathname (e.g. /tmp/test):
74
75               # nvme wdc vs-internal-log /dev/nvme0 -o /tmp/test
76
77       •   Gets the internal firmware log from the device transferring the
78           data in 64k chunks and saves to default file in current directory
79           (e.g. STM00019F3F9_internal_fw_log_20171127_100754.bin):
80
81               # nvme wdc vs-internal-log /dev/nvme0 -s 0x10000
82
83       •   Gets the internal firmware log from the device transferring the
84           data in 16k chunks and saves to default file in current directory
85           (e.g. STM00019F3F9_internal_fw_log_20171127_100950.bin):
86
87               # nvme wdc vs-internal-log /dev/nvme0 -s 16384
88
89       •   Gets the internal firmware log up to data area 3 from the device in
90           3 files of 0x1000000 bytes:
91
92               # nvme wdc vs-internal-log /dev/nvme0 -d 3 -f 0x1000000 -t 0x0000000 -o /tmp/sn340_dui_data_1.bin
93               # nvme wdc vs-internal-log /dev/nvme0 -d 3 -f 0x1000000 -t 0x1000000 -o /tmp/sn340_dui_data_2.bin
94               # nvme wdc vs-internal-log /dev/nvme0 -d 3 -f 0x1000000 -t 0x2000000 -o /tmp/sn340_dui_data_3.bin
95
96       •   Gets the host telemetry log page to data area 3 from the device and
97           stores it in file host-telem-log-da3.bin:
98
99               # nvme wdc vs-internal-log /dev/nvme1 -t host -o host-telem-log-da3.bin -d 3
100
101       •   Gets the controller telemetry log page to data area 3 from the
102           device and stores it in file ctlr-telem-log-da3.bin:
103
104               # nvme wdc vs-internal-log /dev/nvme1 -t controller -o ctlr-telem-log-da3.bin -d 3
105

NVME

107       Part of the nvme-user suite.
108
109
110
111NVMe                              09/29/2023              NVME-WDC-VS-INTER(1)
Impressum