NVME-SNDK-VS-ERRO(1)

NAME
nvme-sndk-vs-error-reason-identifier - Retrieve sndk device's telemetry log error reason identifier field

SYNOPSIS

nvme [<global-options>] sndk vs-error-reason-identifier <device>
                        [--log-id=<NUM>, -i <NUM>]
                        [--file=<FILE>, -O <FILE>]

DESCRIPTION

For the NVMe device given, retrieve the telemetry log error reason id field for either the host generated or controller initiated log. The controller initiated telemetry log page option must be enabled to retrieve the error reason id for that log page id.

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

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

On success it returns 0, error code otherwise.

OPTIONS

-i <id>, --log-id=<id>
    Specifies the telemetry log id of the error reason identifier to retrieve. Use id 7 for the host generated log page. Use id 8 for the controller initiated log page. The default is 7/host generated

-O <FILE>, --file=<FILE>
    Output file; defaults to "<device serial number>_error_reason_identifier_host_<date>_<time>.bin" for the host generated log or "<device serial number>_error_reason_identifier_ctlr_<date>_<time>.bin" for the controller initiated log.

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

    • Retrieves the host generated error reason identifier field and save it in file host_gen_error_reason_id.bin.

        # nvme sndk vs-error-reason-identifier /dev/nvme0 -i 7 -O host_gen_error_reason_id.bin

    • Retrieves the controller initiated error reason identifier field and save it in file ctlr_init_error_reason_id.bin.

        # nvme sndk vs-error-reason-identifier /dev/nvme0 -i 8 -O ctlr_init_error_reason_id.bin

NVME

Part of the nvme-user suite.