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

NAME

6       nvme-wdc-vs-smart-add-log - Send NVMe WDC vs-smart-add-log Vendor
7       Unique Command, return result
8

SYNOPSIS

10       nvme wdc vs-smart-add-log <device> [--interval=<NUM>, -i <NUM>]
11                               [--output-format=<normal|json> -o <normal|json>]
12                               [--log-page-version=<NUM>, -l <NUM>]
13                               [--log-page-mask=<LIST>, -p <LIST>]
14                               [--namespace-id=<nsid> | -n <nsid>]
15

DESCRIPTION

17       For the NVMe device given, send a Vendor Unique WDC vs-smart-add-log
18       command and provide the additional smart log.
19
20       The <device> parameter is mandatory and may be either the NVMe
21       character device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1).
22
23       This will only work on WDC devices supporting this feature. Results for
24       any other device are undefined.
25
26       On success it returns 0, error code otherwise.
27

OPTIONS

29       -i <NUM>, --interval=<NUM>
30           Return the statistics from specific interval, defaults to 14. This
31           parameter is only valid for the 0xC1 log page and ignored for all
32           other log pages.
33
34       -o <format>, --output-format=<format>
35           Set the reporting format to normal, or json. Only one output format
36           can be used at a time. Default is normal.
37
38       -l <NUM>, --log-page-version=<NUM>
39           Log Page Version: 0 = vendor, 1 = WDC. This parameter is only valid
40           for the 0xC0 log page and ignored for all other log pages.
41
42       -p <LIST>, --log-page-mask=<LIST>
43           Supply a comma separated list of desired log pages to display. The
44           possible values are 0xc0, 0xc1, 0xca, 0xd0. Note: Not all pages are
45           supported on all drives. The default is to display all supported
46           log pages.
47
48       -n <nsid>, --namespace-id=<nsid>
49           Sets the command’s nsid value to the given nsid. Defaults to
50           0xffffffff if not given. This option may not affect anything
51           depending on the log page, which may or may not be specific to a
52           namespace.
53
54       Valid Interval values and description :-
55
56       ┌──────┬────────────────────────────┐
57       │Value │ Description                │
58       ├──────┼────────────────────────────┤
59       │      │                            │
60       │1     │ Most recent five (5)       │
61       │      │ minute accumulated set.    │
62       ├──────┼────────────────────────────┤
63       │      │                            │
64       │2-12  │ Previous five (5) minute   │
65       │      │ accumulated sets.          │
66       ├──────┼────────────────────────────┤
67       │      │                            │
68       │13    │ The accumulated total of   │
69       │      │ sets 1 through 12 that     │
70       │      │ contain the previous hour  │
71       │      │ of accumulated statistics. │
72       ├──────┼────────────────────────────┤
73       │      │                            │
74       │14    │ The statistical set        │
75       │      │ accumulated since          │
76       │      │ power-up.                  │
77       ├──────┼────────────────────────────┤
78       │      │                            │
79       │15    │ The statistical set        │
80       │      │ accumulated during the     │
81       │      │ entire lifetime of the     │
82       │      │ device.                    │
83       └──────┴────────────────────────────┘
84

EXAMPLES

86       •   Has the program issue WDC vs-smart-add-log Vendor Unique Command
87           with default interval (14) :
88
89               # nvme wdc vs-smart-add-log /dev/nvme0
90
91       •   Has the program issue WDC vs-smart-add-log Vendor Unique Command
92           for just the 0xCA log page :
93
94               # nvme wdc vs-smart-add-log /dev/nvme0 -p 0xCA
95
96       •   Has the program issue WDC vs-smart-add-log Vendor Unique Command
97           for 0xC0 and 0xCA log pages :
98
99               # nvme wdc vs-smart-add-log /dev/nvme0 -p 0xCA,0xC0
100

NVME

102       Part of the nvme-user suite.
103
104
105
106NVMe                              09/29/2023              NVME-WDC-VS-SMART(1)