jammy (1) nvme-wdc-vs-temperature-stats.1.gz

Provided by: nvme-cli_1.16-3ubuntu0.3_amd64 bug

NAME

       nvme-wdc-vs-temperature-stats - Display temperature-related statistics

SYNOPSIS

       nvme wdc vs-temperature-stats <device>

DESCRIPTION

       For the NVMe device given, displays temperature statistics.

       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.

       Expected status and description :-

       ┌────────────────────────────────────┬──────────────────────────────────────┐
       │StatisticDescription                          │
       ├────────────────────────────────────┼──────────────────────────────────────┤
       │                                    │                                      │
       │The current composite temperature   │ device temperature                   │
       ├────────────────────────────────────┼──────────────────────────────────────┤
       │                                    │                                      │
       │Warning Composite TEMPerature       │ temp of overheating                  │
       │threshold                           │                                      │
       ├────────────────────────────────────┼──────────────────────────────────────┤
       │                                    │                                      │
       │Critical Composite TEMPerature      │ temp of critical overheating         │
       │threshold                           │                                      │
       ├────────────────────────────────────┼──────────────────────────────────────┤
       │                                    │                                      │
       │Device Initiated Thermal Throttling │ 0 = unsupported, 1 = supported       │
       │support status                      │                                      │
       ├────────────────────────────────────┼──────────────────────────────────────┤
       │                                    │                                      │
       │Host Controlled Thermal Management  │ 0 = unsupported, 1 = supported       │
       │support                             │                                      │
       ├────────────────────────────────────┼──────────────────────────────────────┤
       │                                    │                                      │
       │Thermal Management Temperature 1    │ temp to start light throttle         │
       │(Light throttle)                    │                                      │
       ├────────────────────────────────────┼──────────────────────────────────────┤
       │                                    │                                      │
       │Thermal Management Temperature 1    │ # times switched into light throttle │
       │Transition Counter                  │                                      │
       ├────────────────────────────────────┼──────────────────────────────────────┤
       │                                    │                                      │
       │Thermal Management Temperature 1    │ # seconds spent in light throttle    │
       │Total Time                          │                                      │
       ├────────────────────────────────────┼──────────────────────────────────────┤
       │                                    │                                      │
       │Thermal Management Temperature 2    │ temp to start heavy throttle         │
       │(Heavy throttle)                    │                                      │
       ├────────────────────────────────────┼──────────────────────────────────────┤
       │                                    │                                      │
       │Thermal Management Temperature 2    │ # times switched into heavy throttle │
       │Transition Counter                  │                                      │
       ├────────────────────────────────────┼──────────────────────────────────────┤
       │                                    │                                      │
       │Thermal Management Temperature 2    │ # seconds spent in heavy throttle    │
       │Total Time                          │                                      │
       ├────────────────────────────────────┼──────────────────────────────────────┤
       │                                    │                                      │
       │Thermal Shutdown Threshold          │ temp of device shutdown              │
       └────────────────────────────────────┴──────────────────────────────────────┘

       On success it returns 0, error code otherwise.

EXAMPLES

       •   Displays the temperature stats for the device:

               # nvme wdc vs-temperature-stats /dev/nvme0

NVME

       Part of the nvme-user suite.