1NDCTL-WRITE-LABELS(1)                                    NDCTL-WRITE-LABELS(1)
2
3
4

NAME

6       ndctl-write-labels - write data to the label area on a dimm
7

SYNOPSIS

9       ndctl write-labels <nmem> [-i <filename>]
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. Read data from the input
15       filename, or stdin, and write it to the given <nmem> device. Note that
16       the device must not be active in any region, otherwise the kernel will
17       not allow write access to the device’s label data area.
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, --input
44           input file
45

SEE ALSO

47       UEFI NVDIMM Label Protocol[1]
48

NOTES

50        1. UEFI NVDIMM Label Protocol
51           http://www.uefi.org/sites/default/files/resources/UEFI_Spec_2_7.pdf
52
53
54
55                                  08/03/2023             NDCTL-WRITE-LABELS(1)
Impressum