NVME-WDC-ENC-GET(1)

NAME
nvme-wdc-enc-get-log - Send NVMe WDC enc-get-log Vendor Unique Command, return result.

SYNOPSIS

nvme [<global-options>] wdc enc-get-log <device> [--log-id=<NUM>, -l <NUM>]
                        [--output-file=<FILE>, -O <FILE>]
                        [--transfer-size=<SIZE>, -s <SIZE>]

DESCRIPTION

For the NVMe device given, send a Vendor Unique WDC enc-get-log command and output the Enclosure logs.

The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0).

The --log-id=<NUM>, -l <NUM> parameter is mandatory and may be either 0xd1, 0xd2, 0xd3, 0xd4, 0xe2 and 0xe4.

This will only work on WDC devices supporting this feature. Results for any other device are undefined.

On success it returns the enclosure log data, error code otherwise.

OPTIONS

-O <FILE>, --output-file=<FILE>
    Output file pathname

-s <SIZE>, --transfer-size=<NUM>
    Data retrieval transfer size, maximum transfer size should be 0x2000 (decimal 8192)

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 enclosure log from the device based on the log id(0xd1) with transfer size(0x2000) and saves to defined file in current directory:

        # nvme wdc enc-get-log /dev/nvme0 -l 0xd1 -O d1_log.bin -s 0x2000

    • Gets the enclosure log from the device based on the log id(0xd2) with default transfer size(0x1000) and saves to defined file in current directory:

        # nvme wdc enc-get-log /dev/nvme0 -l 0xd2 -O d1_log.bin

NVME

Part of the nvme-user suite.