'\" t
.\"     Title: ndctl-read-labels
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.12
.\"      Date: 2022-04-08
.\"    Manual: ndctl Manual
.\"    Source: ndctl
.\"  Language: English
.\"
.TH "NDCTL\-READ\-LABELS" "1" "2022-04-08" "ndctl" "ndctl Manual"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
ndctl\-read\-labels \- read out the label area on a dimm or set of dimms
.SH "SYNOPSIS"
.sp
.sp
.nf
\fIndctl read\-labels\fP <nmem0> [<nmem1>..<nmemN>] [<options>]
.fi
.br
.SH "DESCRIPTION"
.sp
The namespace label area is a small persistent partition of capacity
available on some NVDIMM devices.  The label area is used to resolve
aliasing between \fIpmem\fP and \fIblk\fP capacity by delineating namespace
boundaries.
This command dumps the raw binary data in a dimm\(cqs label area to stdout or a
file.  In the multi\-dimm case the data is concatenated.
.SH "OPTIONS"
.sp
<memory device(s)>
.RS 4
A \fInmemX\fP device name, or a dimm id number. Restrict the operation to
the specified dimm(s). The keyword \fIall\fP can be specified to indicate
the lack of any restriction, however this is the same as not supplying
a \-\-dimm option at all.
.RE
.sp
\-s, \-\-size=
.RS 4
Limit the operation to the given number of bytes. A size of 0
indicates to operate over the entire label capacity.
.RE
.sp
\-O, \-\-offset=
.RS 4
Begin the operation at the given offset into the label area.
.RE
.sp
\-b, \-\-bus=
.RS 4
A bus id number, or a provider string (e.g. "ACPI.NFIT"). Restrict the
operation to the specified bus(es). The keyword \fIall\fP can be specified
to indicate the lack of any restriction, however this is the same as
not supplying a \-\-bus option at all.
.RE
.sp
\-v
.RS 4
Turn on verbose debug messages in the library (if ndctl was built with
logging and debug enabled).
.RE
.sp
\-I, \-\-index
.RS 4
Limit the span of the label operation to just the index\-block
area. This is useful to determine if the dimm label area is
initialized. Note that this option and \-\-size/\-\-offset are
mutually exclusive.
.RE
.sp
\-o, \-\-output
.RS 4
output file
.RE
.sp
\-j, \-\-json
.RS 4
parse the label data into json assuming the \fINVDIMM Namespace
Specification\fP format.
.RE
.sp
\-u, \-\-human
.RS 4
enable json output and convert number formats to human readable
strings, for example show the size in terms of "KB", "MB", "GB", etc
instead of a signed 64\-bit numbers per the JSON interchange
format (implies \-\-json).
.RE
.SH "COPYRIGHT"
.sp
Copyright \(co 2016 \- 2020, Intel Corporation. License GPLv2: GNU GPL
version 2 \c
.URL "http://gnu.org/licenses/gpl.html" "" "."
This is free software:
you are free to change and redistribute it.  There is NO WARRANTY, to
the extent permitted by law.
.SH "SEE ALSO"
.sp
.URL "http://www.uefi.org/sites/default/files/resources/UEFI_Spec_2_7.pdf" "UEFI NVDIMM Label Protocol" ""