vgck(8) - f38

1VGCK(8)                     System Manager's Manual                    VGCK(8)
2
3
4

NAME

6       vgck — Check the consistency of volume group(s)
7

SYNOPSIS

9       vgck option_args position_args
10           [ option_args ]
11           [ position_args ]
12

DESCRIPTION

14       vgck checks LVM metadata for consistency.
15

USAGE

17       Read and display information about a VG.
18
19       vgck
20           [    --reportformat basic|json|json_std ]
21           [ COMMON_OPTIONS ]
22           [ VG|Tag ... ]
23
24       Rewrite VG metadata to correct problems.
25
26       vgck --updatemetadata VG
27           [ COMMON_OPTIONS ]
28
29       Common options for lvm:
30           [ -d|--debug ]
31           [ -h|--help ]
32           [ -q|--quiet ]
33           [ -t|--test ]
34           [ -v|--verbose ]
35           [ -y|--yes ]
36           [    --commandprofile String ]
37           [    --config String ]
38           [    --devices PV ]
39           [    --devicesfile String ]
40           [    --driverloaded y|n ]
41           [    --journal String ]
42           [    --lockopt String ]
43           [    --longhelp ]
44           [    --nohints ]
45           [    --nolocking ]
46           [    --profile String ]
47           [    --version ]
48

OPTIONS

50       --commandprofile String
51              The  command  profile  to  use  for  command configuration.  See
52              lvm.conf(5) for more information about profiles.
53
54       --config String
55              Config settings for the command. These override lvm.conf(5) set‐
56              tings.   The  String arg uses the same format as lvm.conf(5), or
57              may use section/field syntax.  See lvm.conf(5) for more informa‐
58              tion about config.
59
60       -d|--debug ...
61              Set debug level. Repeat from 1 to 6 times to increase the detail
62              of messages sent to the log file and/or syslog (if configured).
63
64       --devices PV
65              Restricts the devices that are visible  and  accessible  to  the
66              command.  Devices not listed will appear to be missing. This op‐
67              tion can be repeated, or accepts a comma separated list  of  de‐
68              vices. This overrides the devices file.
69
70       --devicesfile String
71              A file listing devices that LVM should use.  The file must exist
72              in /etc/lvm/devices/ and is managed with the lvmdevices(8)  com‐
73              mand.   This  overrides  the lvm.conf(5) devices/devicesfile and
74              devices/use_devicesfile settings.
75
76       --driverloaded y|n
77              If set to no, the command will not attempt to use device-mapper.
78              For testing and debugging.
79
80       -h|--help
81              Display help text.
82
83       --journal String
84              Record  information in the systemd journal.  This information is
85              in addition to information enabled by the  lvm.conf  log/journal
86              setting.   command:  record information about the command.  out‐
87              put: record the default command output.  debug: record full com‐
88              mand debugging.
89
90       --lockopt String
91              Used  to  pass  options for special cases to lvmlockd.  See lvm‐
92              lockd(8) for more information.
93
94       --longhelp
95              Display long help text.
96
97       --nohints
98              Do not use the hints file to locate devices for PVs.  A  command
99              may  read  more devices to find PVs when hints are not used. The
100              command will still perform standard hint file invalidation where
101              appropriate.
102
103       --nolocking
104              Disable  locking. Use with caution, concurrent commands may pro‐
105              duce incorrect results.
106
107       --profile String
108              An alias for --commandprofile or --metadataprofile, depending on
109              the command.
110
111       -q|--quiet ...
112              Suppress  output  and log messages. Overrides --debug and --ver‐
113              bose.  Repeat once to also  suppress  any  prompts  with  answer
114              'no'.
115
116       --reportformat basic|json|json_std
117              Overrides  current  output  format  for reports which is defined
118              globally by the  report/output_format  setting  in  lvm.conf(5).
119              basic is the original format with columns and rows.  If there is
120              more than one report per command, each report is  prefixed  with
121              the  report name for identification. json produces report output
122              in JSON format. json_std produces report output in  JSON  format
123              which  is  more  compliant with JSON standard.  See lvmreport(7)
124              for more information.
125
126       -t|--test
127              Run in test mode. Commands will not update  metadata.   This  is
128              implemented  by  disabling all metadata writing but nevertheless
129              returning success to the calling function. This may lead to  un‐
130              usual  error messages in multi-stage operations if a tool relies
131              on reading back metadata it believes has changed but hasn't.
132
133       --updatemetadata
134              Update VG metadata to correct problems.  If VG metadata was  up‐
135              dated  while  a PV was missing, and the PV reappears with an old
136              version of metadata, then this option (or any other command that
137              writes  metadata)  will  update  the  metadata on the previously
138              missing PV. If a PV was removed from a VG while it was  missing,
139              and  the PV reappears, using this option will clear the outdated
140              metadata from the previously missing PV.  If  metadata  text  is
141              damaged  on  one  PV, using this option will replace the damaged
142              metadata text. For more severe damage, e.g.  with  headers,  see
143              pvck(8).
144
145       -v|--verbose ...
146              Set  verbose level. Repeat from 1 to 4 times to increase the de‐
147              tail of messages sent to stdout and stderr.
148
149       --version
150              Display version information.
151
152       -y|--yes
153              Do not prompt for confirmation interactively but  always  assume
154              the  answer  yes.  Use with extreme caution.  (For automatic no,
155              see -qq.)
156

VARIABLES

158       VG     Volume Group name.  See lvm(8) for valid names.
159
160       Tag    Tag name.  See lvm(8) for information about tag names and  using
161              tags in place of a VG, LV or PV.
162
163       String See the option description for information about the string con‐
164              tent.
165
166       Size[UNIT]
167              Size is an input number that accepts an  optional  unit.   Input
168              units are always treated as base two values, regardless of capi‐
169              talization, e.g. 'k' and 'K' both refer to  1024.   The  default
170              input unit is specified by letter, followed by |UNIT.  UNIT rep‐
171              resents other possible input units: b|B is bytes, s|S is sectors
172              of  512  bytes,  k|K is KiB, m|M is MiB, g|G is GiB, t|T is TiB,
173              p|P is PiB, e|E is EiB.  (This should not be confused  with  the
174              output  control  --units, where capital letters mean multiple of
175              1000.)
176

ENVIRONMENT VARIABLES

178       See lvm(8) for information about environment  variables  used  by  lvm.
179       For example, LVM_VG_NAME can generally be substituted for a required VG
180       parameter.
181