nvme-log-telemetry(1)

# nvme-log-telemetry(1) Manual Page

## NAME

nvme-log-telemetry - Retrieves a Telemetry Host-Initiated log page from an NVMe device

## SYNOPSIS

    nvme [<global-options>] log telemetry <device>
                            [--output-file=<file> | -O <file>]
                            [--host-generate=<gen> | -g <gen>]

## DESCRIPTION

Retrieves an Telemetry Host-Initiated log page from an NVMe device and provides the 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 will be in raw binary format only with --output-file option which is mandatory.

## OPTIONS

-O <file>
--output-file=<file>

  File name to which raw binary data will be saved to.

-g <gen>
--host-generate=<gen>

  If set to 1, controller shall capture the Telemetry Host-Initiated data representing the internal state of the controller at the time the associated Get Log Page command is processed. If cleated to 0, controller shall not update this data.

-d <da>
--data-area=<da>

  Retrieves the specific data area requested. Valid inputs are 1,2,3,4. If this option is not specified, the default value is 3, since data area 4 may not be supported.

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

- Retrieve Telemetry Host-Initiated data to telemetry_log.bin

      # nvme log telemetry /dev/nvme0 --output-file=telemetry_log.bin

## NVME

Part of the nvme-user suite