NVME-LOG-EFFECTS(1)

NAME
nvme-log-effects - Send NVMe Command Effects log page request, returns result and log

SYNOPSIS

nvme [<global-options>] log effects <device> [--raw-binary | -b]

DESCRIPTION

Retrieves the NVMe Command Effects log page from an NVMe device and provides the returned structure.

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

On success, the returned command effects log structure will be printed for each command that is supported.

OPTIONS

-b, --raw-binary
    This option will print the raw buffer to stdout. Structure is not parsed by program. This overrides the verbose option.

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

    • Print the effects log page in a human readable format:

        # nvme log effects /dev/nvme0

    • Have the program return the raw structure in binary:

        # nvme log effects /dev/nvme0 --raw-binary > effects_log.raw
        # nvme log effects /dev/nvme0 -b > effects_log.raw

NVME

Part of the nvme-user suite