'\" t
.\"     Title: ndctl-read-labels
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 1.5.7.1
.\"      Date: 2018-11-27
.\"    Manual: ndctl Manual
.\"    Source: ndctl
.\"  Language: English
.\"
.TH "NDCTL\-READ\-LABELS" "1" "2018-11-27" "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
.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
One or more \fInmemX\fP device names. The keyword \fIall\fP can be specified to
operate on every dimm in the system, optionally filtered by bus id (see
       \-\-bus= option).
.RE
.sp
\-b, \-\-bus=
.RS 4
Limit operation to memory devices (dimms) that are on the given bus.
Where \fIbus\fP can be a provider name or a bus id number.
.RE
.sp
\-v
.RS 4
Turn on verbose debug messages in the library (if ndctl was built with
logging and debug enabled).
.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
.SH "COPYRIGHT"
.sp
Copyright (c) 2016 \- 2018, 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" ""