'\" t

.\"     Title: nvme-self-test-log

.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]

.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>

.\"      Date: 04/24/2020

.\"    Manual: NVMe Manual

.\"    Source: NVMe

.\"  Language: English

.\"

.TH "NVME\-SELF\-TEST\-LO" "1" "04/24/2020" "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-self-test-log \- Retrieve the log information initited by device\-self\-test and display it

.SH "SYNOPSIS"

.sp

.nf

\fInvme self\-test\fR\-log <device> [\-\-output\-format=<FMT> | \-o <FMT>]

.fi

.SH "DESCRIPTION"

.sp

Retrieves the log pages from an NVMe device corresponding to the requested self\-test by the user and provides 20\-most recent result 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 may be returned in one of several ways depending on the option flags; the structure may parsed by the program and printed in a readable format or the raw buffer or the json format\&.

.sp

By default the log is printed out in the normal readable format\&.

.SH "OPTION"

.PP

\-o <format>, \-\-output\-format=<format>

.RS 4

Set the reporting format to

\fInormal\fR,

\fIjson\fR, or

\fIbinary\fR\&. Only one output format can be used at a time\&.

.RE

.SH "EXAMPLES"

.sp

.RS 4

.ie n \{\

\h'-04'\(bu\h'+03'\c

.\}

.el \{\

.sp -1

.IP \(bu 2.3

.\}

Get the self\-test\-log and print it in a human readable format:

.sp

.if n \{\

.RS 4

.\}

.nf

# nvme self\-test\-log /dev/nvme0

.fi

.if n \{\

.RE

.\}

.RE

.sp

.RS 4

.ie n \{\

\h'-04'\(bu\h'+03'\c

.\}

.el \{\

.sp -1

.IP \(bu 2.3

.\}

Print the raw output to a file:

.sp

.if n \{\

.RS 4

.\}

.nf

# nvme self\-test\-log /dev/nvme0 \-o "binary"

.fi

.if n \{\

.RE

.\}

.RE

.sp

.RS 4

.ie n \{\

\h'-04'\(bu\h'+03'\c

.\}

.el \{\

.sp -1

.IP \(bu 2.3

.\}

Get the self\-test\-log and print it in a json format:

.sp

.if n \{\

.RS 4

.\}

.nf

# nvme self\-test\-log /dev/nvme0 \-o "json"

.fi

.if n \{\

.RE

.\}

.RE

.SH "NVME"

.sp

Part of the nvme\-user suite