NVME-WDC-GET-PFAI(1)

NAME
nvme-wdc-get-pfail-dump - Retrieve WDC device's pfail crash dump.

SYNOPSIS

nvme [<global-options>] wdc get-pfail-dump <device>
                        [--output-file=<FILE>, -O <FILE>]

DESCRIPTION

For the NVMe device given, sends the WDC vendor unique pfail crash dump request and saves the result to file. In current implementation pfail crash dump is captured if it is present. On success it will save the dump in file with appropriate suffix. Note that this command will clear the available dump from the device on success.

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.

OPTIONS

-O <FILE>, --output-file=<FILE>
    Output file; defaults to device serial number followed by "pfail_dump" suffix

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.

These options can also be set as machine-wide defaults in nvme-cli.conf(5). A command-line flag always overrides the file.

EXAMPLES

    • Gets the pfail crash dump from the device and saves to default file in current directory (e.g. STM00019F3F9_pfail_dump.bin):

        # nvme wdc get-pfail-dump /dev/nvme0

    • Gets the pfail crash dump from the device and saves to defined file in current directory (e.g. testSTM00019F3F9_pfail_dump.bin):

        # nvme wdc get-pfail-dump /dev/nvme0 -O test

    • Gets the pfail crash dump from the device and saves to defined file with pathname (e.g. /tmp/testSTM00019F3F9_pfail_dump.bin):

        # nvme wdc get-pfail-dump /dev/nvme0 -O /tmp/test

NVME

Part of the nvme-user suite