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           A nmemX device name, or a dimm id number. Restrict the operation to
22           the specified dimm(s). The keyword all can be specified to indicate
23           the lack of any restriction, however this is the same as not
24           supplying a --dimm option at all.
25
26       -s, --size=
27           Limit the operation to the given number of bytes. A size of 0
28           indicates to operate over the entire label capacity.
29
30       -O, --offset=
31           Begin the operation at the given offset into the label area.
32
33       -b, --bus=
34           A bus id number, or a provider string (e.g. "ACPI.NFIT"). Restrict
35           the operation to the specified bus(es). The keyword all can be
36           specified to indicate the lack of any restriction, however this is
37           the same as not supplying a --bus option at all.
38
39       -v
40           Turn on verbose debug messages in the library (if ndctl was built
41           with logging and debug enabled).
42
43       -I, --index
44           Limit the span of the label operation to just the index-block area.
45           This is useful to determine if the dimm label area is initialized.
46           Note that this option and --size/--offset are mutually exclusive.
47
48       -o, --output
49           output file
50
51       -j, --json
52           parse the label data into json assuming the NVDIMM Namespace
53           Specification format.
54
55       -u, --human
56           enable json output and convert number formats to human readable
57           strings, for example show the size in terms of "KB", "MB", "GB",
58           etc instead of a signed 64-bit numbers per the JSON interchange
59           format (implies --json).
60

62       Copyright © 2016 - 2020, Intel Corporation. License GPLv2: GNU GPL
63       version 2 http://gnu.org/licenses/gpl.html. This is free software: you
64       are free to change and redistribute it. There is NO WARRANTY, to the
65       extent permitted by law.
66

SEE ALSO

68       UEFI NVDIMM Label Protocol[1]
69

NOTES

71        1. UEFI NVDIMM Label Protocol
72           http://www.uefi.org/sites/default/files/resources/UEFI_Spec_2_7.pdf
73
74
75
76ndctl 71.1                        07/22/2021              NDCTL-READ-LABELS(1)
Impressum