1NVME-WDC-PURGE-MO(1)              NVMe Manual             NVME-WDC-PURGE-MO(1)
2
3
4

NAME

6       nvme-wdc-purge-monitor - Send NVMe WDC Purge-Monitor Vendor Unique
7       Command, return result
8

SYNOPSIS

10       nvme wdc purge-monitor <device>
11

DESCRIPTION

13       For the NVMe device given, send a Vendor Unique WDC Purge-Monitor
14       command and provide the status of the purge command.
15
16       Expected status and description :-
17
18       ┌────────────┬───────────────────────────┐
19       │Status Code │ Description               │
20       ├────────────┼───────────────────────────┤
21       │            │                           │
22       │0x00        │ Purge State Idle.         │
23       ├────────────┼───────────────────────────┤
24       │            │                           │
25       │0x01        │ Purge State Done.         │
26       ├────────────┼───────────────────────────┤
27       │            │                           │
28       │0x02        │ Purge State Busy.         │
29       ├────────────┼───────────────────────────┤
30       │            │                           │
31       │0x03        │ Purge State Error : Purge │
32       │            │ operation resulted in     │
33       │            │ error, power cycle        │
34       │            │ required.                 │
35       ├────────────┼───────────────────────────┤
36       │            │                           │
37       │0x04        │ Purge State Error : Purge │
38       │            │ operation interrupted by  │
39       │            │ power cycle or reset.     │
40       └────────────┴───────────────────────────┘
41
42       The <device> parameter is mandatory and may be either the NVMe
43       character device (ex: /dev/nvme0), or a namespace block device (ex:
44       /dev/nvme0n1).
45
46       This will only work on WDC devices supporting this feature. Results for
47       any other device are undefined.
48
49       On success it returns 0, error code otherwise.
50

OPTIONS

52       No options yet.
53

EXAMPLES

55       •   Has the program issue WDC Purge-Monitor Vendor Unique Command :
56
57               # nvme wdc purge-monitor /dev/nvme0
58

NVME

60       Part of the nvme-user suite.
61
62
63
64NVMe                              09/29/2023              NVME-WDC-PURGE-MO(1)
Impressum