2025-02-16 12:17:56 +01:00
'\" t
. \" Title: nvme-seagate-get-host-tele
. \" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
. \" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
2025-02-16 12:28:14 +01:00
. \" Date: 10/31/2024
2025-02-16 12:17:56 +01:00
. \" Manual: NVMe Manual
. \" Source: NVMe
. \" Language: English
. \"
2025-02-16 12:28:14 +01:00
.TH "NVME\-SEAGATE\-GET\-" "1" "10/31/2024" "NVMe" "NVMe Manual"
2025-02-16 12:17:56 +01:00
. \" -----------------------------------------------------------------
. \" * 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-seagate-get-host-tele \- Retrieve Seagate Host\- Initiated Telemetry in either hex\- dump (default) or binary format
.SH "SYNOPSIS"
.sp
.nf
\fI nvme seagate get\- host\- tele <device> [OPTIONS]\fR
.fi
.SH "DESCRIPTION"
.sp
This will only work on Seagate devices supporting this feature\& . Not all commands work across all product families\& .
.sp
2025-02-16 12:25:25 +01:00
The \fI <device>\fR parameter is mandatory and may be either an NVMe character device (ex: /dev/nvme0) or an block device (ex: /dev/nvme0n1)\& .
2025-02-16 12:17:56 +01:00
.SH "OPTIONS"
.PP
\- n <NUM>, \- \- namespace\- id=<NUM>
.RS 4
desired namespace
.RE
.PP
\- i <NUM>, \- \- log_specific=<NUM>
.RS 4
1 \- controller shall capture Data representing the internal state of the controller at the time the command is processed\& . 0 \- controller shall not update the Telemetry Host Initiated Data\& .
.RE
.PP
\- b, \- \- raw\- binary
.RS 4
output in raw format
.RE
.SH "EXAMPLES"
.sp
Get the host initiated telemetry log in hexdump or binary format for the specified device\& .
.sp
.if n \{ \
.RS 4
. \}
.nf
# nvme seagate get\- host\- tele /dev/nvme0
.fi
.if n \{ \
.RE
. \}
.SH "NVME"
.sp
Part of the nvme\- user suite