dwww Home | Manual pages | Find package

NVME-OCP-INTERNAL(1)              NVMe Manual              NVME-OCP-INTERNAL(1)

NAME
       nvme-ocp-internal-log - Conditionally retrieves 07h Telemetry
       Host-Initiated log, C9h OCP Strings Log from an NVMe device or from
       user-specified file path. Takes retrieved logs and decodes into
       human-readable output format specified by user.

SYNOPSIS
       nvme ocp internal-log <device>
                               [--telemetry-log=<file> | -l <file>]
                               [--string-log=<file> | -s <file>]
                               [--output-file=<file> | -o <file>]
                               [--output-format=<fmt> | -f <fmt>]
                               [--data-area=<da> | -a <da>]
                               [--telemetry-type=<type> | -t <type>]

DESCRIPTION
       Conditionally retrieves 07h Telemetry Host-Initiated log, C9h OCP
       Strings Log from an NVMe device or from user-specified file path. Takes
       retrieved logs and decodes (or) parses into human-readable output format
       specified by user.

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

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

       On success it returns 0, error code otherwise.

OPTIONS
       -l <file>, --telemetry-log=<file>
           File name to existing Telemetry Host-Initiated raw binary data to be
           used. If no path is specified, a live retrieval of payload on
           <device> will be performed.

       -s <file>, --string-log=<file>
           File name to existing OCP String Log raw binary data to be used. If
           no path is specified, a live retrieval of payload on <device> will
           be performed.

       -o <file>, --output-file=<file>
           Filepath name to where human-readable output data will be saved to.

       -f <fmt>, --output-format=<fmt>
           Set the reporting format to normal, json. Only one output format can
           be used at a time, the default value is json.

       -a <da>, --data-area=<da>
           Retrieves the specific data area requested. Valid inputs are 1,2. If
           this option is not specified, the default value is 1.

       -t <type>, --telemetry-type=<type>
           Set the telemetry type to host, host0, host1 or controller. If set
           to host1, 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 set to host0,
           controller shall not update this data.

EXAMPLES
       •   Retrieve in both OCP String Log and Telemetry Host-Initiated Log
           from device. Decode default data-area(s) in default format and
           output to console.

               # nvme ocp internal-log /dev/nvme0

       •   Retrieve Telemetry Host-Initiated data, reads in the OCP String Log
           locally. Decode default data-area(s) in default format.

               # nvme ocp internal-log /dev/nvme0 --string-log=ocp_string_log.bin
                --output-file=output_file.json

       •   Retrieve OCP String Log, reads in the Telemetry Host-Initiated Log
           locally. Decode data-areas 1 and 2, and output in json format.

               # nvme ocp internal-log /dev/nvme0 --telemetry-log=host_telemetry.bin
                --output-format=json --output-file=output_file.json --data-area=2

       •   Reads in both OCP String Log and Telemetry Host-Initiated Log
           locally. Decode data-areas 1 and 2, and output in normal text
           format.

               # nvme ocp internal-log /dev/nvme0 --string-log=ocp_string_log.bin
                --telemetry-log=host_telemetry.bin --output-format=normal
                --output-file=output_file.txt --data-area=2

NVME
       Part of the nvme-user suite

NVMe                               05/02/2025              NVME-OCP-INTERNAL(1)

Generated by dwww version 1.16 on Mon Nov 9 05:43:36 CET 2026.