diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-29 04:41:05 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-29 04:41:05 +0000 |
commit | 1cc8413aaf5f8fa6595aece1933462c096e88639 (patch) | |
tree | e97b4f25c511372d73bdd96c389c5f468d99138a /Documentation/nvme-wdc-vs-smart-add-log.txt | |
parent | Initial commit. (diff) | |
download | nvme-cli-5cfa46883ee24249a66010b27ade5caf2917916a.tar.xz nvme-cli-5cfa46883ee24249a66010b27ade5caf2917916a.zip |
Adding upstream version 2.4+really2.3.upstream/2.4+really2.3upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r-- | Documentation/nvme-wdc-vs-smart-add-log.txt | 106 |
1 files changed, 106 insertions, 0 deletions
diff --git a/Documentation/nvme-wdc-vs-smart-add-log.txt b/Documentation/nvme-wdc-vs-smart-add-log.txt new file mode 100644 index 0000000..7de1ac8 --- /dev/null +++ b/Documentation/nvme-wdc-vs-smart-add-log.txt @@ -0,0 +1,106 @@ +nvme-wdc-vs-smart-add-log(1) +============================ + +NAME +---- +nvme-wdc-vs-smart-add-log - Send NVMe WDC vs-smart-add-log Vendor Unique Command, return result + +SYNOPSIS +-------- +[verse] +'nvme wdc vs-smart-add-log' <device> [--interval=<NUM>, -i <NUM>] + [--output-format=<normal|json> -o <normal|json>] + [--log-page-version=<NUM>, -l <NUM>] + [--log-page-mask=<LIST>, -p <LIST>] + [--namespace-id=<nsid> | -n <nsid>] + +DESCRIPTION +----------- +For the NVMe device given, send a Vendor Unique WDC vs-smart-add-log command and +provide the additional smart log. + +The <device> parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1). + +This will only work on WDC devices supporting this feature. +Results for any other device are undefined. + +On success it returns 0, error code otherwise. + +OPTIONS +------- +-i <NUM>:: +--interval=<NUM>:: + Return the statistics from specific interval, defaults to 14. This parameter is only valid for the 0xC1 log page + and ignored for all other log pages. + +-o <format>:: +--output-format=<format>:: + Set the reporting format to 'normal', or + 'json'. Only one output format can be used at a time. + Default is normal. + +-l <NUM>:: +--log-page-version=<NUM>:: + Log Page Version: 0 = vendor, 1 = WDC. This parameter is only valid for the 0xC0 log page and ignored for all + other log pages. + +-p <LIST>:: +--log-page-mask=<LIST>:: + Supply a comma separated list of desired log pages to display. + The possible values are 0xc0, 0xc1, 0xca, 0xd0. + Note: Not all pages are supported on all drives. + The default is to display all supported log pages. + +-n <nsid>:: +--namespace-id=<nsid>:: + Sets the command's nsid value to the given nsid. Defaults to + 0xffffffff if not given. This option may not affect anything + depending on the log page, which may or may not be specific to + a namespace. + +Valid Interval values and description :- + +[cols="2*", frame="topbot", align="center", options="header"] +|=== +|Value |Description + +|*1* +|Most recent five (5) minute accumulated set. + +|*2-12* +|Previous five (5) minute accumulated sets. + +|*13* +|The accumulated total of sets 1 through 12 that contain the previous hour of +accumulated statistics. + +|*14* +|The statistical set accumulated since power-up. + +|*15* +|The statistical set accumulated during the entire lifetime of the device. +|=== + + +EXAMPLES +-------- +* Has the program issue WDC vs-smart-add-log Vendor Unique Command with default interval (14) : ++ +------------ +# nvme wdc vs-smart-add-log /dev/nvme0 +------------ +* Has the program issue WDC vs-smart-add-log Vendor Unique Command for just the 0xCA log page : ++ +------------ +# nvme wdc vs-smart-add-log /dev/nvme0 -p 0xCA +------------ +* Has the program issue WDC vs-smart-add-log Vendor Unique Command for 0xC0 and 0xCA log pages : ++ +------------ +# nvme wdc vs-smart-add-log /dev/nvme0 -p 0xCA,0xC0 +------------ + +NVME +---- +Part of the nvme-user suite. |