SYNOPSIS
nvme [<global-options>] wdc purge-monitor <device>
DESCRIPTION
For the NVMe device given, send a Vendor Unique WDC Purge-Monitor command and provide the status of the purge command.
Expected status and description :-
| Status Code | Description |
|---|---|
0x00 |
Purge State Idle. |
0x01 |
Purge State Done. |
0x02 |
Purge State Busy. |
0x03 |
Purge State Error : Purge operation resulted in error, power cycle required. |
0x04 |
Purge State Error : Purge operation interrupted by power cycle or reset. |
The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace 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
No options yet.
GLOBAL OPTIONS
The following options are defined at the top-level nvme command
and are available to this subcommand:
- --dry-run
-
Print the command that would be executed, but do not actually execute it.
- --no-ioctl-probing
-
Disable probing for 64-bit IOCTL support.
- --no-retries
-
Disable retry logic on transient errors.
- -o <fmt>
- --output-format=<fmt>
-
Set the reporting format to normal, tabular, 'json, or binary. Only one output format may be used at a time.
- --output-format-version=<version>
-
Select the output format version. Version 1 uses the original field naming, while version 2 (default) provides more consistent and script-friendly field names.
- --timeout=<ms>
-
Set the timeout for the command in milliseconds.
- -v
- --verbose
-
Increase the level of detail in the output. May be specified multiple times to further increase verbosity.
EXAMPLES
-
Has the program issue WDC Purge-Monitor Vendor Unique Command :
# nvme wdc purge-monitor /dev/nvme0
NVME
Part of the nvme-user suite.