87 lines
2.8 KiB
Groff
87 lines
2.8 KiB
Groff
'\" t
|
|
.\" Title: nvme-telemetry-log
|
|
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
|
|
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
|
|
.\" Date: 11/11/2021
|
|
.\" Manual: NVMe Manual
|
|
.\" Source: NVMe
|
|
.\" Language: English
|
|
.\"
|
|
.TH "NVME\-TELEMETRY\-LOG" "1" "11/11/2021" "NVMe" "NVMe Manual"
|
|
.\" -----------------------------------------------------------------
|
|
.\" * Define some portability stuff
|
|
.\" -----------------------------------------------------------------
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.\" http://bugs.debian.org/507673
|
|
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\" -----------------------------------------------------------------
|
|
.\" * set default formatting
|
|
.\" -----------------------------------------------------------------
|
|
.\" disable hyphenation
|
|
.nh
|
|
.\" disable justification (adjust text to left margin only)
|
|
.ad l
|
|
.\" -----------------------------------------------------------------
|
|
.\" * MAIN CONTENT STARTS HERE *
|
|
.\" -----------------------------------------------------------------
|
|
.SH "NAME"
|
|
nvme-telemetry-log \- Retrieves a Telemetry Host\-Initiated log page from an NVMe device
|
|
.SH "SYNOPSIS"
|
|
.sp
|
|
.nf
|
|
\fInvme telemetry\-log\fR <device> [\-\-output\-file=<file> | \-o <file>]
|
|
[\-\-host\-generate=<gen> | \-g <gen>]
|
|
.fi
|
|
.SH "DESCRIPTION"
|
|
.sp
|
|
Retrieves an Telemetry Host\-Initiated log page from an NVMe device and provides the returned structure\&.
|
|
.sp
|
|
The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&.
|
|
.sp
|
|
On success, the returned log structure will be in raw binary format \fIonly\fR with \-\-output\-file option which is mandatory\&.
|
|
.SH "OPTIONS"
|
|
.PP
|
|
\-o <file>, \-\-output\-file=<file>
|
|
.RS 4
|
|
File name to which raw binary data will be saved to\&.
|
|
.RE
|
|
.PP
|
|
\-g <gen>, \-\-host\-generate=<gen>
|
|
.RS 4
|
|
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
|
|
\fInot\fR
|
|
update this data\&.
|
|
.RE
|
|
.PP
|
|
\-d <da>, \-\-data\-area=<da>
|
|
.RS 4
|
|
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\&.
|
|
.RE
|
|
.SH "EXAMPLES"
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
Retrieve Telemetry Host\-Initiated data to telemetry_log\&.bin
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
# nvme telemetry\-log /dev/nvme0 \-\-output\-file=telemetry_log\&.bin
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.RE
|
|
.SH "NVME"
|
|
.sp
|
|
Part of the nvme\-user suite
|