1NDCTL-READ-LABELS(1)             ndctl Manual             NDCTL-READ-LABELS(1)
2
3
4

NAME

6       ndctl-read-labels - read out the label area on a dimm or set of dimms
7

SYNOPSIS

9       ndctl read-labels <nmem0> [<nmem1>..<nmemN>] [<options>]
10

DESCRIPTION

12       The namespace label area is a small persistent partition of capacity
13       available on some NVDIMM devices. The label area is used to resolve
14       aliasing between pmem and blk capacity by delineating namespace
15       boundaries. This command dumps the raw binary data in a dimm’s label
16       area to stdout or a file. In the multi-dimm case the data is
17       concatenated.
18

OPTIONS

20       <memory device(s)>
21           One or more nmemX device names. The keyword all can be specified to
22           operate on every dimm in the system, optionally filtered by bus id
23           (see --bus= option).
24
25       -s, --size=
26           Limit the operation to the given number of bytes. A size of 0
27           indicates to operate over the entire label capacity.
28
29       -O, --offset=
30           Begin the operation at the given offset into the label area.
31
32       -b, --bus=
33           Limit operation to memory devices (dimms) that are on the given
34           bus. Where bus can be a provider name or a bus id number.
35
36       -v
37           Turn on verbose debug messages in the library (if ndctl was built
38           with logging and debug enabled).
39
40       -I, --index
41           Limit the span of the label operation to just the index-block area.
42           This is useful to determine if the dimm label area is initialized.
43           Note that this option and --size/--offset are mutually exclusive.
44
45       -o, --output
46           output file
47
48       -j, --json
49           parse the label data into json assuming the NVDIMM Namespace
50           Specification format.
51
52       -u, --human
53           enable json output and convert number formats to human readable
54           strings, for example show the size in terms of "KB", "MB", "GB",
55           etc instead of a signed 64-bit numbers per the JSON interchange
56           format (implies --json).
57

59       Copyright (c) 2016 - 2019, Intel Corporation. License GPLv2: GNU GPL
60       version 2 http://gnu.org/licenses/gpl.html. This is free software: you
61       are free to change and redistribute it. There is NO WARRANTY, to the
62       extent permitted by law.
63

SEE ALSO

65       UEFI NVDIMM Label Protocol
66       <http://www.uefi.org/sites/default/files/resources/UEFI_Spec_2_7.pdf>
67
68
69
70ndctl                             2020-03-24              NDCTL-READ-LABELS(1)
Impressum