nvme-log-self-test(1)

# nvme-log-self-test(1) Manual Page

## NAME

nvme-log-self-test - Retrieve the log information initiated by device-self-test and display it

## SYNOPSIS

    nvme [<global-options>] log self-test <device>
                            [--log-entries=<entries> | -e <entries>]

## DESCRIPTION

Retrieves the log pages from an NVMe device corresponding to the requested self-test by the user and provides 20-most recent result returned structure.

The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

On success, the returned log structure may be returned in one of several ways depending on the option flags; the structure may parsed by the program and printed in a readable format or the raw buffer or the json format.

By default the log is printed out in the normal readable format.

## OPTION

-e <entries>
--log-entries=<entries>

  Specifies how many DST log entries the program should request from the device. This must be at least one, and shouldn’t exceed the 20 entries. Defaults to 20 DST log entries.

## 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

- Get the self-test-log and print it in a human readable format:

      # nvme log self-test /dev/nvme0

- Print the raw output to a file:

      # nvme log self-test /dev/nvme0 -o "binary"

- Get the self-test-log and print it in a json format:

      # nvme log self-test /dev/nvme0 -o "json"

## NVME

Part of the nvme-user suite