1NDCTL-CHECK-NAMESPACE(1)         ndctl Manual         NDCTL-CHECK-NAMESPACE(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
25       ndctl disable-namespace namespace0.0
26       ndctl check-namespace namespace0.0
27
28       Check a namespace, and perform repairs if possible
29
30
31       ndctl disable-namespace namespace0.0
32       ndctl check-namespace --repair namespace0.0
33

OPTIONS

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

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

SEE ALSO

76       ndctl-disable-namespace(1), ndctl-enable-namespace(1), UEFI NVDIMM
77       Label Protocol
78       <http://www.uefi.org/sites/default/files/resources/UEFI_Spec_2_7.pdf>
79
80
81
82ndctl                             2020-03-24          NDCTL-CHECK-NAMESPACE(1)
Impressum