1NDCTL-READ-LABELS(1)                                      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 provision
14       one, or more, namespaces from regions. This command dumps the raw
15       binary data in a dimm’s label area to stdout or a file. In the
16       multi-dimm case the data is concatenated.
17

OPTIONS

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

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

SEE ALSO

67       UEFI NVDIMM Label Protocol[1]
68

NOTES

70        1. UEFI NVDIMM Label Protocol
71           http://www.uefi.org/sites/default/files/resources/UEFI_Spec_2_7.pdf
72
73
74
75                                  03/08/2022              NDCTL-READ-LABELS(1)
Impressum