1NDCTL-CHECK-NAMESP(1)                                    NDCTL-CHECK-NAMESP(1)
2
3
4

NAME

6       ndctl-check-namespace - check namespace metadata consistency
7

SYNOPSIS

9       ndctl check-namespace <namespace> [<options>]
10

DESCRIPTION

12       A namespace in the sector mode will have metadata on it to describe the
13       kernel BTT (Block Translation Table). The check-namespace command can
14       be used to check the consistency of this metadata, and optionally, also
15       attempt to repair it, if it has enough information to do so.
16
17       The namespace being checked has to be disabled before initiating a
18       check on it as a precautionary measure. The --force option can override
19       this.
20

EXAMPLES

22       Check a namespace (only report errors)
23
24           ndctl disable-namespace namespace0.0
25           ndctl check-namespace namespace0.0
26
27       Check a namespace, and perform repairs if possible
28
29           ndctl disable-namespace namespace0.0
30           ndctl check-namespace --repair namespace0.0
31

OPTIONS

33       -R, --repair
34           Perform metadata repairs if possible. Without this option, the raw
35           namespace contents will not be touched.
36
37       -L, --rewrite-log
38           Regenerate the BTT log and write it to media. This can be used to
39           convert from the old (pre 4.15) padding format that was
40           incompatible with other BTT implementations to the updated format.
41           This requires the --repair option to be provided.
42
43               WARNING: Do not interrupt this operation as it can potentially cause
44               unrecoverable metadata corruption. It is highly recommended to create
45               a backup of the raw namespace before attempting this.
46
47       -f, --force
48           Unless this option is specified, a check-namespace operation will
49           fail if the namespace is presently active. Specifying --force
50           causes the namespace to be disabled before checking.
51
52       -v, --verbose
53           Emit debug messages for the namespace check process.
54
55       -r, --region=
56           A regionX device name, or a region id number. Restrict the
57           operation to the specified region(s). The keyword all can be
58           specified to indicate the lack of any restriction, however this is
59           the same as not supplying a --region option at all.
60
61       -b, --bus=
62           A bus id number, or a provider string (e.g. "ACPI.NFIT"). Restrict
63           the operation to the specified bus(es). The keyword all can be
64           specified to indicate the lack of any restriction, however this is
65           the same as not supplying a --bus option at all.
66

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

SEE ALSO

74       linkndctl:ndctl-disable-namespace[1],
75       linkndctl:ndctl-enable-namespace[1], UEFI NVDIMM Label Protocol[1]
76

NOTES

78        1. UEFI NVDIMM Label Protocol
79           http://www.uefi.org/sites/default/files/resources/UEFI_Spec_2_7.pdf
80
81
82
83                                  08/03/2023             NDCTL-CHECK-NAMESP(1)
Impressum