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

NAME

6       nvme-wdc-vs-error-reason-identifier - Retrieve WDC device's telemetry
7       log error reason identifier field
8

SYNOPSIS

10       nvme wdc vs-error-reason-identifier <device> [--log-id=<NUM>, -i <NUM>] [--file=<FILE>, -o <FILE>]
11

DESCRIPTION

13       For the NVMe device given, retrieve the telemetry log error reason id
14       field for either the host generated or controller initiated log. The
15       controller initiated telemetry log page option must be enabled to
16       retrieve the error reason id for that log page id.
17
18       The <device> parameter is mandatory and must be the NVMe character
19       device (ex: /dev/nvme0).
20
21       This will only work on WDC devices supporting this feature. Results for
22       any other device are undefined.
23
24       On success it returns 0, error code otherwise.
25

OPTIONS

27       -i <id>, --log-id=<id>
28           Specifies the telemetry log id of the error reason identifier to
29           retrieve. Use id 7 for the host generated log page. Use id 8 for
30           the controller initiated log page. The default is 7/host generated
31
32       -o <FILE>, --output-file=<FILE>
33           Output file; defaults to "<device serial
34           number>_error_reason_identifier_host_<date>_<time>.bin" for the
35           host generated log or "<device serial
36           number>_error_reason_identifier_ctlr_<date>_<time>.bin" for the
37           controller initiated log.
38

EXAMPLES

40       •   Retrieves the host generated error reason identifier field and save
41           it in file host_gen_error_reason_id.bin.
42
43               # nvme wdc vs-error-reason-identifier /dev/nvme0 -i 7 -o host_gen_error_reason_id.bin
44
45       •   Retrieves the controller initiated error reason identifier field
46           and save it in file ctlr_init_error_reason_id.bin.
47
48               # nvme wdc vs-error-reason-identifier /dev/nvme0 -i 8 -o ctlr_init_error_reason_id.bin
49

NVME

51       Part of the nvme-user suite.
52
53
54
55NVMe                              10/06/2023              NVME-WDC-VS-ERROR(1)
Impressum