1PMEMPOOL-CHECK(1)          PMDK Programmer's Manual          PMEMPOOL-CHECK(1)
2
3
4

NAME

6       pmempool-check - check and repair persistent memory pool
7

SYNOPSIS

9              $ pmempool check [<options>] <file>
10

DESCRIPTION

12       The  pmempool  invoked with check command checks consistency of a given
13       pool file.  If the pool file is consistent pmempool exits with 0 value.
14       If the pool file is not consistent non-zero error code is returned.
15
16       In  case  of  any errors, the proper message is printed.  The verbosity
17       level may be increased using -v option.  The output messages may be al‐
18       so suppressed using -q option.
19
20       It  is possible to try to fix encountered problems using -r option.  In
21       order to be sure this will not corrupt your data you can either  create
22       backup  of  the  pool  file using -b option or just print what would be
23       fixed without modifying original pool using -N option.
24
25              NOTE: Currently, checking the consistency of a pmemobj  pool  is
26              not supported.
27
28   Available options:
29       -r, --repair
30
31       Try to repair a pool file if possible.
32
33       -y, --yes
34
35       Answer yes on all questions.
36
37       -d, --dry-run
38
39       Don't  execute,  just show what would be done.  Not supported on Device
40       DAX.
41
42       -N, --no-exec
43
44       Deprecated alias for dry-run.
45
46       -b, --backup <file>
47
48       Create backup of a pool file before executing.  Terminate if it is  not
49       possible to create a backup file.  This option requires -r option.
50
51       -a, --advanced
52
53       Perform advanced repairs.  This option enables more aggressive steps in
54       attempts to repair a pool.  This option requires -r, --repair.
55
56       -q, --quiet
57
58       Be quiet and don't print any messages.
59
60       -v, --verbose
61
62       Be more verbose.
63
64       -h, --help
65
66       Display help message and exit.
67

EXAMPLE

69              $ pmempool check pool.bin
70
71       Check consistency of “pool.bin” pool file
72
73              $ pmempool check --repair --backup pool.bin.backup pool.bin
74
75       Check consistency of “pool.bin” pool file, create backup and repair  if
76       necessary.
77
78              $ pmempool check -rvN pool.bin
79
80       Check consistency of “pool.bin” pool file, print what would be repaired
81       with increased verbosity level.
82

SEE ALSO

84       pmempool(1),  libpmemblk(7),  libpmemlog(7),  libpmemobj(7),   libpmem‐
85       pool(7) and <https://pmem.io>
86
87
88
89PMDK - pmem Tools version 1.4     2022-08-25                 PMEMPOOL-CHECK(1)
Impressum