Subversion Repositories configs

Rev

Rev 203 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
192 - 1
# This is an example configuration file for the LVM2 system.
2
# It contains the default settings that would be used if there was no
3
# /etc/lvm/lvm.conf file.
4
#
5
# Refer to 'man lvm.conf' for further information including the file layout.
6
#
7
# Refer to 'man lvm.conf' for information about how settings configured in
8
# this file are combined with built-in values and command line options to
9
# arrive at the final values used by LVM.
10
#
11
# Refer to 'man lvmconfig' for information about displaying the built-in
12
# and configured values used by LVM.
13
#
14
# If a default value is set in this file (not commented out), then a
15
# new version of LVM using this file will continue using that value,
16
# even if the new version of LVM changes the built-in default value.
17
#
18
# To put this file in a different directory and override /etc/lvm set
19
# the environment variable LVM_SYSTEM_DIR before running the tools.
20
#
21
# N.B. Take care that each setting only appears once if uncommenting
22
# example settings in this file.
23
 
24
 
25
# Configuration section config.
26
# How LVM configuration settings are handled.
27
config {
28
 
29
	# Configuration option config/checks.
30
	# If enabled, any LVM configuration mismatch is reported.
31
	# This implies checking that the configuration key is understood by
32
	# LVM and that the value of the key is the proper type. If disabled,
33
	# any configuration mismatch is ignored and the default value is used
34
	# without any warning (a message about the configuration key not being
35
	# found is issued in verbose mode only).
204 - 36
	# This configuration option has an automatic default value.
37
	# checks = 1
192 - 38
 
39
	# Configuration option config/abort_on_errors.
40
	# Abort the LVM process if a configuration mismatch is found.
204 - 41
	# This configuration option has an automatic default value.
42
	# abort_on_errors = 0
192 - 43
 
44
	# Configuration option config/profile_dir.
45
	# Directory where LVM looks for configuration profiles.
204 - 46
	# This configuration option has an automatic default value.
47
	# profile_dir = "/etc/lvm/profile"
192 - 48
}
49
 
50
# Configuration section devices.
51
# How LVM uses block devices.
52
devices {
53
 
54
	# Configuration option devices/dir.
55
	# Directory in which to create volume group device nodes.
56
	# Commands also accept this as a prefix on volume group names.
57
	# This configuration option is advanced.
204 - 58
	# This configuration option has an automatic default value.
59
	# dir = "/dev"
192 - 60
 
61
	# Configuration option devices/scan.
62
	# Directories containing device nodes to use with LVM.
63
	# This configuration option is advanced.
204 - 64
	# This configuration option has an automatic default value.
65
	# scan = [ "/dev" ]
192 - 66
 
67
	# Configuration option devices/obtain_device_list_from_udev.
68
	# Obtain the list of available devices from udev.
69
	# This avoids opening or using any inapplicable non-block devices or
70
	# subdirectories found in the udev directory. Any device node or
71
	# symlink not managed by udev in the udev directory is ignored. This
72
	# setting applies only to the udev-managed device directory; other
73
	# directories will be scanned fully. LVM needs to be compiled with
74
	# udev support for this setting to apply.
204 - 75
	# This configuration option has an automatic default value.
76
	# obtain_device_list_from_udev = 0
192 - 77
 
78
	# Configuration option devices/external_device_info_source.
204 - 79
	# Enable device information from udev.
80
	# If set to "udev", lvm will supplement its own native device information
81
	# with information from libudev. This can potentially improve the detection
82
	# of MD component devices and multipath component devices.
83
	# This configuration option has an automatic default value.
84
	# external_device_info_source = "none"
192 - 85
 
86
	# Configuration option devices/hints.
87
	# Use a local file to remember which devices have PVs on them.
88
	# Some commands will use this as an optimization to reduce device
89
	# scanning, and will only scan the listed PVs. Removing the hint file
90
	# will cause lvm to generate a new one. Disable hints if PVs will
91
	# be copied onto devices using non-lvm commands, like dd.
203 - 92
	#
192 - 93
	# Accepted values:
94
	#   all
95
	#     Use all hints.
96
	#   none
97
	#     Use no hints.
203 - 98
	#
192 - 99
	# This configuration option has an automatic default value.
100
	# hints = "all"
101
 
102
	# Configuration option devices/preferred_names.
103
	# Select which path name to display for a block device.
104
	# If multiple path names exist for a block device, and LVM needs to
105
	# display a name for the device, the path names are matched against
106
	# each item in this list of regular expressions. The first match is
107
	# used. Try to avoid using undescriptive /dev/dm-N names, if present.
108
	# If no preferred name matches, or if preferred_names are not defined,
109
	# the following built-in preferences are applied in order until one
110
	# produces a preferred name:
111
	# Prefer names with path prefixes in the order of:
112
	# /dev/mapper, /dev/disk, /dev/dm-*, /dev/block.
113
	# Prefer the name with the least number of slashes.
114
	# Prefer a name that is a symlink.
115
	# Prefer the path with least value in lexicographical order.
203 - 116
	#
192 - 117
	# Example
118
	# preferred_names = [ "^/dev/mpath/", "^/dev/mapper/mpath", "^/dev/[hs]d" ]
119
	#
120
	# This configuration option has an automatic default value.
121
	# preferred_names = [ "^/dev/mpath/", "^/dev/mapper/mpath", "^/dev/[hs]d" ]
122
 
203 - 123
	# Configuration option devices/use_devicesfile.
124
	# Enable or disable the use of a devices file.
125
	# When enabled, lvm will only use devices that
126
	# are lised in the devices file. A devices file will
127
	# be used, regardless of this setting, when the --devicesfile
128
	# option is set to a specific file name.
129
	# This configuration option has an automatic default value.
130
	# use_devicesfile = 0
131
 
132
	# Configuration option devices/devicesfile.
133
	# The name of the system devices file, listing devices that LVM should use.
134
	# This should not be used to select a non-system devices file.
135
	# The --devicesfile option is intended for alternative devices files.
136
	# This configuration option has an automatic default value.
137
	# devicesfile = "system.devices"
138
 
139
	# Configuration option devices/search_for_devnames.
140
	# Look outside of the devices file for missing devname entries.
141
	# A devname entry is used for a device that does not have a stable
142
	# device id, e.g. wwid, so the unstable device name is used as
143
	# the device id. After reboot, or if the device is reattached,
144
	# the device name may change, in which case lvm will not find
145
	# the expected PV on the device listed in the devices file.
146
	# This setting controls whether lvm will search other devices,
147
	# outside the devices file, to look for the missing PV on a
148
	# renamed device. If "none", lvm will not look at other devices,
149
	# and the PV may appear to be missing. If "auto", lvm will look
150
	# at other devices, but only those that are likely to have the PV.
151
	# If "all", lvm will look at all devices on the system.
152
	# This configuration option has an automatic default value.
153
	# search_for_devnames = "auto"
154
 
192 - 155
	# Configuration option devices/filter.
156
	# Limit the block devices that are used by LVM commands.
157
	# This is a list of regular expressions used to accept or reject block
158
	# device path names. Each regex is delimited by a vertical bar '|'
159
	# (or any character) and is preceded by 'a' to accept the path, or
160
	# by 'r' to reject the path. The first regex in the list to match the
161
	# path is used, producing the 'a' or 'r' result for the device.
162
	# When multiple path names exist for a block device, if any path name
163
	# matches an 'a' pattern before an 'r' pattern, then the device is
164
	# accepted. If all the path names match an 'r' pattern first, then the
165
	# device is rejected. Unmatching path names do not affect the accept
166
	# or reject decision. If no path names for a device match a pattern,
167
	# then the device is accepted. Be careful mixing 'a' and 'r' patterns,
168
	# as the combination might produce unexpected results (test changes.)
169
	# Run vgscan after changing the filter to regenerate the cache.
203 - 170
	#
192 - 171
	# Example
172
	# Accept every block device:
173
	# filter = [ "a|.*|" ]
174
	# Reject the cdrom drive:
175
	# filter = [ "r|/dev/cdrom|" ]
176
	# Work with just loopback devices, e.g. for testing:
177
	# filter = [ "a|loop|", "r|.*|" ]
178
	# Accept all loop devices and ide drives except hdc:
179
	# filter = [ "a|loop|", "r|/dev/hdc|", "a|/dev/ide|", "r|.*|" ]
180
	# Use anchors to be very specific:
181
	# filter = [ "a|^/dev/hda8$|", "r|.*|" ]
203 - 182
	#
192 - 183
	# This configuration option has an automatic default value.
184
	# filter = [ "a|.*|" ]
185
 
186
	# Configuration option devices/global_filter.
187
	# Limit the block devices that are used by LVM system components.
188
	# Because devices/filter may be overridden from the command line, it is
189
	# not suitable for system-wide device filtering, e.g. udev.
190
	# Use global_filter to hide devices from these LVM system components.
191
	# The syntax is the same as devices/filter. Devices rejected by
192
	# global_filter are not opened by LVM.
193
	# This configuration option has an automatic default value.
194
	# global_filter = [ "a|.*|" ]
195
 
196
	# Configuration option devices/types.
197
	# List of additional acceptable block device types.
198
	# These are of device type names from /proc/devices, followed by the
199
	# maximum number of partitions.
203 - 200
	#
192 - 201
	# Example
202
	# types = [ "fd", 16 ]
203 - 203
	#
192 - 204
	# This configuration option is advanced.
205
	# This configuration option does not have a default value defined.
206
 
207
	# Configuration option devices/sysfs_scan.
208
	# Restrict device scanning to block devices appearing in sysfs.
209
	# This is a quick way of filtering out block devices that are not
210
	# present on the system. sysfs must be part of the kernel and mounted.)
204 - 211
	# This configuration option has an automatic default value.
212
	# sysfs_scan = 1
192 - 213
 
214
	# Configuration option devices/scan_lvs.
215
	# Scan LVM LVs for layered PVs, allowing LVs to be used as PVs.
216
	# When 1, LVM will detect PVs layered on LVs, and caution must be
217
	# taken to avoid a host accessing a layered VG that may not belong
218
	# to it, e.g. from a guest image. This generally requires excluding
219
	# the LVs with device filters. Also, when this setting is enabled,
220
	# every LVM command will scan every active LV on the system (unless
221
	# filtered), which can cause performance problems on systems with
222
	# many active LVs. When this setting is 0, LVM will not detect or
223
	# use PVs that exist on LVs, and will not allow a PV to be created on
224
	# an LV. The LVs are ignored using a built in device filter that
225
	# identifies and excludes LVs.
204 - 226
	# This configuration option has an automatic default value.
227
	# scan_lvs = 0
192 - 228
 
229
	# Configuration option devices/multipath_component_detection.
230
	# Ignore devices that are components of DM multipath devices.
204 - 231
	# This configuration option has an automatic default value.
232
	# multipath_component_detection = 1
192 - 233
 
204 - 234
	# Configuration option devices/multipath_wwids_file.
235
	# The path to the multipath wwids file used for multipath component detection.
236
	# Set this to an empty string to disable the use of the multipath wwids file.
237
	# This configuration option has an automatic default value.
238
	# multipath_wwids_file = "/etc/multipath/wwids"
239
 
192 - 240
	# Configuration option devices/md_component_detection.
241
	# Enable detection and exclusion of MD component devices.
242
	# An MD component device is a block device that MD uses as part
243
	# of a software RAID virtual device. When an LVM PV is created
244
	# on an MD device, LVM must only use the top level MD device as
245
	# the PV, and should ignore the underlying component devices.
246
	# In cases where the MD superblock is located at the end of the
247
	# component devices, it is more difficult for LVM to consistently
248
	# identify an MD component, see the md_component_checks setting.
204 - 249
	# This configuration option has an automatic default value.
250
	# md_component_detection = 1
192 - 251
 
252
	# Configuration option devices/md_component_checks.
253
	# The checks LVM should use to detect MD component devices.
254
	# MD component devices are block devices used by MD software RAID.
203 - 255
	#
192 - 256
	# Accepted values:
257
	#   auto
258
	#     LVM will skip scanning the end of devices when it has other
259
	#     indications that the device is not an MD component.
260
	#   start
261
	#     LVM will only scan the start of devices for MD superblocks.
262
	#     This does not incur extra I/O by LVM.
263
	#   full
264
	#     LVM will scan the start and end of devices for MD superblocks.
265
	#     This requires an extra read at the end of devices.
203 - 266
	#
192 - 267
	# This configuration option has an automatic default value.
268
	# md_component_checks = "auto"
269
 
270
	# Configuration option devices/fw_raid_component_detection.
271
	# Ignore devices that are components of firmware RAID devices.
272
	# LVM must use an external_device_info_source other than none for this
273
	# detection to execute.
204 - 274
	# This configuration option has an automatic default value.
275
	# fw_raid_component_detection = 0
192 - 276
 
277
	# Configuration option devices/md_chunk_alignment.
278
	# Align the start of a PV data area with md device's stripe-width.
279
	# This applies if a PV is placed directly on an md device.
203 - 280
	# default_data_alignment will be overridden if it is not aligned
192 - 281
	# with the value detected for this setting.
203 - 282
	# This setting is overridden by data_alignment_detection,
192 - 283
	# data_alignment, and the --dataalignment option.
204 - 284
	# This configuration option has an automatic default value.
285
	# md_chunk_alignment = 1
192 - 286
 
287
	# Configuration option devices/default_data_alignment.
288
	# Align the start of a PV data area with this number of MiB.
289
	# Set to 1 for 1MiB, 2 for 2MiB, etc. Set to 0 to disable.
203 - 290
	# This setting is overridden by data_alignment and the --dataalignment
192 - 291
	# option.
292
	# This configuration option has an automatic default value.
293
	# default_data_alignment = 1
294
 
295
	# Configuration option devices/data_alignment_detection.
296
	# Align the start of a PV data area with sysfs io properties.
297
	# The start of a PV data area will be a multiple of minimum_io_size or
298
	# optimal_io_size exposed in sysfs. minimum_io_size is the smallest
299
	# request the device can perform without incurring a read-modify-write
300
	# penalty, e.g. MD chunk size. optimal_io_size is the device's
301
	# preferred unit of receiving I/O, e.g. MD stripe width.
302
	# minimum_io_size is used if optimal_io_size is undefined (0).
303
	# If md_chunk_alignment is enabled, that detects the optimal_io_size.
203 - 304
	# default_data_alignment and md_chunk_alignment will be overridden
192 - 305
	# if they are not aligned with the value detected for this setting.
203 - 306
	# This setting is overridden by data_alignment and the --dataalignment
192 - 307
	# option.
204 - 308
	# This configuration option has an automatic default value.
309
	# data_alignment_detection = 1
192 - 310
 
311
	# Configuration option devices/data_alignment.
312
	# Align the start of a PV data area with this number of KiB.
313
	# When non-zero, this setting overrides default_data_alignment.
314
	# Set to 0 to disable, in which case default_data_alignment
315
	# is used to align the first PE in units of MiB.
203 - 316
	# This setting is overridden by the --dataalignment option.
204 - 317
	# This configuration option has an automatic default value.
318
	# data_alignment = 0
192 - 319
 
320
	# Configuration option devices/data_alignment_offset_detection.
321
	# Shift the start of an aligned PV data area based on sysfs information.
322
	# After a PV data area is aligned, it will be shifted by the
323
	# alignment_offset exposed in sysfs. This offset is often 0, but may
324
	# be non-zero. Certain 4KiB sector drives that compensate for windows
325
	# partitioning will have an alignment_offset of 3584 bytes (sector 7
326
	# is the lowest aligned logical block, the 4KiB sectors start at
327
	# LBA -1, and consequently sector 63 is aligned on a 4KiB boundary).
203 - 328
	# This setting is overridden by the --dataalignmentoffset option.
204 - 329
	# This configuration option has an automatic default value.
330
	# data_alignment_offset_detection = 1
192 - 331
 
332
	# Configuration option devices/ignore_suspended_devices.
333
	# Ignore DM devices that have I/O suspended while scanning devices.
334
	# Otherwise, LVM waits for a suspended device to become accessible.
335
	# This should only be needed in recovery situations.
204 - 336
	# This configuration option has an automatic default value.
337
	# ignore_suspended_devices = 0
192 - 338
 
339
	# Configuration option devices/ignore_lvm_mirrors.
340
	# Do not scan 'mirror' LVs to avoid possible deadlocks.
341
	# This avoids possible deadlocks when using the 'mirror' segment type.
342
	# This setting determines whether LVs using the 'mirror' segment type
343
	# are scanned for LVM labels. This affects the ability of mirrors to
344
	# be used as physical volumes. If this setting is enabled, it is
345
	# impossible to create VGs on top of mirror LVs, i.e. to stack VGs on
346
	# mirror LVs. If this setting is disabled, allowing mirror LVs to be
347
	# scanned, it may cause LVM processes and I/O to the mirror to become
348
	# blocked. This is due to the way that the mirror segment type handles
349
	# failures. In order for the hang to occur, an LVM command must be run
350
	# just after a failure and before the automatic LVM repair process
351
	# takes place, or there must be failures in multiple mirrors in the
352
	# same VG at the same time with write failures occurring moments before
353
	# a scan of the mirror's labels. The 'mirror' scanning problems do not
354
	# apply to LVM RAID types like 'raid1' which handle failures in a
355
	# different way, making them a better choice for VG stacking.
204 - 356
	# This configuration option has an automatic default value.
357
	# ignore_lvm_mirrors = 1
192 - 358
 
359
	# Configuration option devices/require_restorefile_with_uuid.
360
	# Allow use of pvcreate --uuid without requiring --restorefile.
204 - 361
	# This configuration option has an automatic default value.
362
	# require_restorefile_with_uuid = 1
192 - 363
 
364
	# Configuration option devices/pv_min_size.
365
	# Minimum size in KiB of block devices which can be used as PVs.
366
	# In a clustered environment all nodes must use the same value.
367
	# Any value smaller than 512KiB is ignored. The previous built-in
368
	# value was 512.
204 - 369
	# This configuration option has an automatic default value.
370
	# pv_min_size = 2048
192 - 371
 
372
	# Configuration option devices/issue_discards.
373
	# Issue discards to PVs that are no longer used by an LV.
374
	# Discards are sent to an LV's underlying physical volumes when the LV
375
	# is no longer using the physical volumes' space, e.g. lvremove,
376
	# lvreduce. Discards inform the storage that a region is no longer
377
	# used. Storage that supports discards advertise the protocol-specific
378
	# way discards should be issued by the kernel (TRIM, UNMAP, or
379
	# WRITE SAME with UNMAP bit set). Not all storage will support or
380
	# benefit from discards, but SSDs and thinly provisioned LUNs
381
	# generally do. If enabled, discards will only be issued if both the
382
	# storage and kernel provide support.
204 - 383
	# This configuration option has an automatic default value.
384
	# issue_discards = 0
192 - 385
 
386
	# Configuration option devices/allow_changes_with_duplicate_pvs.
387
	# Allow VG modification while a PV appears on multiple devices.
388
	# When a PV appears on multiple devices, LVM attempts to choose the
389
	# best device to use for the PV. If the devices represent the same
390
	# underlying storage, the choice has minimal consequence. If the
391
	# devices represent different underlying storage, the wrong choice
392
	# can result in data loss if the VG is modified. Disabling this
393
	# setting is the safest option because it prevents modifying a VG
394
	# or activating LVs in it while a PV appears on multiple devices.
395
	# Enabling this setting allows the VG to be used as usual even with
396
	# uncertain devices.
204 - 397
	# This configuration option has an automatic default value.
398
	# allow_changes_with_duplicate_pvs = 0
192 - 399
 
400
	# Configuration option devices/allow_mixed_block_sizes.
401
	# Allow PVs in the same VG with different logical block sizes.
402
	# When allowed, the user is responsible to ensure that an LV is
403
	# using PVs with matching block sizes when necessary.
204 - 404
	# This configuration option has an automatic default value.
405
	# allow_mixed_block_sizes = 0
192 - 406
}
407
 
408
# Configuration section allocation.
409
# How LVM selects space and applies properties to LVs.
410
allocation {
411
 
412
	# Configuration option allocation/cling_tag_list.
413
	# Advise LVM which PVs to use when searching for new space.
414
	# When searching for free space to extend an LV, the 'cling' allocation
415
	# policy will choose space on the same PVs as the last segment of the
416
	# existing LV. If there is insufficient space and a list of tags is
417
	# defined here, it will check whether any of them are attached to the
418
	# PVs concerned and then seek to match those PV tags between existing
419
	# extents and new extents.
203 - 420
	#
192 - 421
	# Example
422
	# Use the special tag "@*" as a wildcard to match any PV tag:
423
	# cling_tag_list = [ "@*" ]
424
	# LVs are mirrored between two sites within a single VG, and
425
	# PVs are tagged with either @site1 or @site2 to indicate where
426
	# they are situated:
427
	# cling_tag_list = [ "@site1", "@site2" ]
203 - 428
	#
192 - 429
	# This configuration option does not have a default value defined.
430
 
431
	# Configuration option allocation/maximise_cling.
432
	# Use a previous allocation algorithm.
433
	# Changes made in version 2.02.85 extended the reach of the 'cling'
434
	# policies to detect more situations where data can be grouped onto
435
	# the same disks. This setting can be used to disable the changes
436
	# and revert to the previous algorithm.
204 - 437
	# This configuration option has an automatic default value.
438
	# maximise_cling = 1
192 - 439
 
440
	# Configuration option allocation/use_blkid_wiping.
441
	# Use blkid to detect and erase existing signatures on new PVs and LVs.
442
	# The blkid library can detect more signatures than the native LVM
443
	# detection code, but may take longer. LVM needs to be compiled with
444
	# blkid wiping support for this setting to apply. LVM native detection
445
	# code is currently able to recognize: MD device signatures,
446
	# swap signature, and LUKS signatures. To see the list of signatures
447
	# recognized by blkid, check the output of the 'blkid -k' command.
204 - 448
	# This configuration option has an automatic default value.
449
	# use_blkid_wiping = 1
192 - 450
 
451
	# Configuration option allocation/wipe_signatures_when_zeroing_new_lvs.
452
	# Look for and erase any signatures while zeroing a new LV.
453
	# The --wipesignatures option overrides this setting.
454
	# Zeroing is controlled by the -Z/--zero option, and if not specified,
455
	# zeroing is used by default if possible. Zeroing simply overwrites the
456
	# first 4KiB of a new LV with zeroes and does no signature detection or
457
	# wiping. Signature wiping goes beyond zeroing and detects exact types
458
	# and positions of signatures within the whole LV. It provides a
459
	# cleaner LV after creation as all known signatures are wiped. The LV
460
	# is not claimed incorrectly by other tools because of old signatures
461
	# from previous use. The number of signatures that LVM can detect
462
	# depends on the detection code that is selected (see
463
	# use_blkid_wiping.) Wiping each detected signature must be confirmed.
464
	# When this setting is disabled, signatures on new LVs are not detected
465
	# or erased unless the --wipesignatures option is used directly.
204 - 466
	# This configuration option has an automatic default value.
467
	# wipe_signatures_when_zeroing_new_lvs = 1
192 - 468
 
469
	# Configuration option allocation/mirror_logs_require_separate_pvs.
470
	# Mirror logs and images will always use different PVs.
471
	# The default setting changed in version 2.02.85.
204 - 472
	# This configuration option has an automatic default value.
473
	# mirror_logs_require_separate_pvs = 0
192 - 474
 
475
	# Configuration option allocation/raid_stripe_all_devices.
476
	# Stripe across all PVs when RAID stripes are not specified.
477
	# If enabled, all PVs in the VG or on the command line are used for
478
	# raid0/4/5/6/10 when the command does not specify the number of
479
	# stripes to use.
480
	# This was the default behaviour until release 2.02.162.
481
	# This configuration option has an automatic default value.
482
	# raid_stripe_all_devices = 0
483
 
484
	# Configuration option allocation/cache_pool_metadata_require_separate_pvs.
485
	# Cache pool metadata and data will always use different PVs.
486
	# This configuration option has an automatic default value.
487
	# cache_pool_metadata_require_separate_pvs = 0
488
 
489
	# Configuration option allocation/cache_metadata_format.
490
	# Sets default metadata format for new cache.
203 - 491
	#
192 - 492
	# Accepted values:
493
	#   0  Automatically detected best available format
494
	#   1  Original format
495
	#   2  Improved 2nd. generation format
203 - 496
	#
192 - 497
	# This configuration option has an automatic default value.
498
	# cache_metadata_format = 0
499
 
500
	# Configuration option allocation/cache_mode.
501
	# The default cache mode used for new cache.
203 - 502
	#
192 - 503
	# Accepted values:
504
	#   writethrough
505
	#     Data blocks are immediately written from the cache to disk.
506
	#   writeback
507
	#     Data blocks are written from the cache back to disk after some
508
	#     delay to improve performance.
203 - 509
	#
192 - 510
	# This setting replaces allocation/cache_pool_cachemode.
511
	# This configuration option has an automatic default value.
512
	# cache_mode = "writethrough"
513
 
514
	# Configuration option allocation/cache_policy.
515
	# The default cache policy used for new cache volume.
516
	# Since kernel 4.2 the default policy is smq (Stochastic multiqueue),
517
	# otherwise the older mq (Multiqueue) policy is selected.
518
	# This configuration option does not have a default value defined.
519
 
520
	# Configuration section allocation/cache_settings.
521
	# Settings for the cache policy.
522
	# See documentation for individual cache policies for more info.
523
	# This configuration section has an automatic default value.
524
	# cache_settings {
525
	# }
526
 
527
	# Configuration option allocation/cache_pool_chunk_size.
528
	# The minimal chunk size in KiB for cache pool volumes.
529
	# Using a chunk_size that is too large can result in wasteful use of
530
	# the cache, where small reads and writes can cause large sections of
531
	# an LV to be mapped into the cache. However, choosing a chunk_size
532
	# that is too small can result in more overhead trying to manage the
533
	# numerous chunks that become mapped into the cache. The former is
534
	# more of a problem than the latter in most cases, so the default is
535
	# on the smaller end of the spectrum. Supported values range from
536
	# 32KiB to 1GiB in multiples of 32.
537
	# This configuration option does not have a default value defined.
538
 
539
	# Configuration option allocation/cache_pool_max_chunks.
540
	# The maximum number of chunks in a cache pool.
541
	# For cache target v1.9 the recommended maximumm is 1000000 chunks.
542
	# Using cache pool with more chunks may degrade cache performance.
543
	# This configuration option does not have a default value defined.
544
 
545
	# Configuration option allocation/thin_pool_metadata_require_separate_pvs.
546
	# Thin pool metadata and data will always use different PVs.
547
	# This configuration option has an automatic default value.
548
	# thin_pool_metadata_require_separate_pvs = 0
549
 
200 - 550
	# Configuration option allocation/thin_pool_crop_metadata.
551
	# Older version of lvm2 cropped pool's metadata size to 15.81 GiB.
552
	# This is slightly less then the actual maximum 15.88 GiB.
553
	# For compatibility with older version and use of cropped size set to 1.
554
	# This configuration option has an automatic default value.
555
	# thin_pool_crop_metadata = 0
556
 
192 - 557
	# Configuration option allocation/thin_pool_zero.
558
	# Thin pool data chunks are zeroed before they are first used.
559
	# Zeroing with a larger thin pool chunk size reduces performance.
560
	# This configuration option has an automatic default value.
561
	# thin_pool_zero = 1
562
 
563
	# Configuration option allocation/thin_pool_discards.
564
	# The discards behaviour of thin pool volumes.
203 - 565
	#
192 - 566
	# Accepted values:
567
	#   ignore
568
	#   nopassdown
569
	#   passdown
203 - 570
	#
192 - 571
	# This configuration option has an automatic default value.
572
	# thin_pool_discards = "passdown"
573
 
574
	# Configuration option allocation/thin_pool_chunk_size_policy.
575
	# The chunk size calculation policy for thin pool volumes.
203 - 576
	#
192 - 577
	# Accepted values:
578
	#   generic
579
	#     If thin_pool_chunk_size is defined, use it. Otherwise, calculate
580
	#     the chunk size based on estimation and device hints exposed in
581
	#     sysfs - the minimum_io_size. The chunk size is always at least
582
	#     64KiB.
583
	#   performance
584
	#     If thin_pool_chunk_size is defined, use it. Otherwise, calculate
585
	#     the chunk size for performance based on device hints exposed in
586
	#     sysfs - the optimal_io_size. The chunk size is always at least
587
	#     512KiB.
203 - 588
	#
192 - 589
	# This configuration option has an automatic default value.
590
	# thin_pool_chunk_size_policy = "generic"
591
 
592
	# Configuration option allocation/zero_metadata.
593
	# Zero whole metadata area before use with thin or cache pool.
594
	# This configuration option has an automatic default value.
595
	# zero_metadata = 1
596
 
597
	# Configuration option allocation/thin_pool_chunk_size.
598
	# The minimal chunk size in KiB for thin pool volumes.
599
	# Larger chunk sizes may improve performance for plain thin volumes,
600
	# however using them for snapshot volumes is less efficient, as it
601
	# consumes more space and takes extra time for copying. When unset,
602
	# lvm tries to estimate chunk size starting from 64KiB. Supported
603
	# values are in the range 64KiB to 1GiB.
604
	# This configuration option does not have a default value defined.
605
 
606
	# Configuration option allocation/physical_extent_size.
607
	# Default physical extent size in KiB to use for new VGs.
608
	# This configuration option has an automatic default value.
609
	# physical_extent_size = 4096
610
 
611
	# Configuration option allocation/vdo_use_compression.
612
	# Enables or disables compression when creating a VDO volume.
613
	# Compression may be disabled if necessary to maximize performance
614
	# or to speed processing of data that is unlikely to compress.
615
	# This configuration option has an automatic default value.
616
	# vdo_use_compression = 1
617
 
618
	# Configuration option allocation/vdo_use_deduplication.
619
	# Enables or disables deduplication when creating a VDO volume.
620
	# Deduplication may be disabled in instances where data is not expected
621
	# to have good deduplication rates but compression is still desired.
622
	# This configuration option has an automatic default value.
623
	# vdo_use_deduplication = 1
624
 
625
	# Configuration option allocation/vdo_use_metadata_hints.
626
	# Enables or disables whether VDO volume should tag its latency-critical
627
	# writes with the REQ_SYNC flag. Some device mapper targets such as dm-raid5
628
	# process writes with this flag at a higher priority.
629
	# Default is enabled.
630
	# This configuration option has an automatic default value.
631
	# vdo_use_metadata_hints = 1
632
 
633
	# Configuration option allocation/vdo_minimum_io_size.
634
	# The minimum IO size for VDO volume to accept, in bytes.
635
	# Valid values are 512 or 4096. The recommended and default value is 4096.
636
	# This configuration option has an automatic default value.
637
	# vdo_minimum_io_size = 4096
638
 
639
	# Configuration option allocation/vdo_block_map_cache_size_mb.
640
	# Specifies the amount of memory in MiB allocated for caching block map
641
	# pages for VDO volume. The value must be a multiple of 4096 and must be
642
	# at least 128MiB and less than 16TiB. The cache must be at least 16MiB
643
	# per logical thread. Note that there is a memory overhead of 15%.
644
	# This configuration option has an automatic default value.
645
	# vdo_block_map_cache_size_mb = 128
646
 
647
	# Configuration option allocation/vdo_block_map_period.
648
	# The speed with which the block map cache writes out modified block map pages.
649
	# A smaller era length is likely to reduce the amount time spent rebuilding,
650
	# at the cost of increased block map writes during normal operation.
651
	# The maximum and recommended value is 16380; the minimum value is 1.
652
	# This configuration option has an automatic default value.
653
	# vdo_block_map_period = 16380
654
 
655
	# Configuration option allocation/vdo_check_point_frequency.
656
	# The default check point frequency for VDO volume.
657
	# This configuration option has an automatic default value.
658
	# vdo_check_point_frequency = 0
659
 
660
	# Configuration option allocation/vdo_use_sparse_index.
661
	# Enables sparse indexing for VDO volume.
662
	# This configuration option has an automatic default value.
663
	# vdo_use_sparse_index = 0
664
 
665
	# Configuration option allocation/vdo_index_memory_size_mb.
666
	# Specifies the amount of index memory in MiB for VDO volume.
667
	# The value must be at least 256MiB and at most 1TiB.
668
	# This configuration option has an automatic default value.
669
	# vdo_index_memory_size_mb = 256
670
 
671
	# Configuration option allocation/vdo_slab_size_mb.
672
	# Specifies the size in MiB of the increment by which a VDO is grown.
673
	# Using a smaller size constrains the total maximum physical size
674
	# that can be accommodated. Must be a power of two between 128MiB and 32GiB.
675
	# This configuration option has an automatic default value.
676
	# vdo_slab_size_mb = 2048
677
 
678
	# Configuration option allocation/vdo_ack_threads.
679
	# Specifies the number of threads to use for acknowledging
680
	# completion of requested VDO I/O operations.
681
	# The value must be at in range [0..100].
682
	# This configuration option has an automatic default value.
683
	# vdo_ack_threads = 1
684
 
685
	# Configuration option allocation/vdo_bio_threads.
686
	# Specifies the number of threads to use for submitting I/O
687
	# operations to the storage device of VDO volume.
688
	# The value must be in range [1..100]
689
	# Each additional thread after the first will use an additional 18MiB of RAM,
690
	# plus 1.12 MiB of RAM per megabyte of configured read cache size.
691
	# This configuration option has an automatic default value.
692
	# vdo_bio_threads = 4
693
 
694
	# Configuration option allocation/vdo_bio_rotation.
695
	# Specifies the number of I/O operations to enqueue for each bio-submission
696
	# thread before directing work to the next. The value must be in range [1..1024].
697
	# This configuration option has an automatic default value.
698
	# vdo_bio_rotation = 64
699
 
700
	# Configuration option allocation/vdo_cpu_threads.
701
	# Specifies the number of threads to use for CPU-intensive work such as
702
	# hashing or compression for VDO volume. The value must be in range [1..100]
703
	# This configuration option has an automatic default value.
704
	# vdo_cpu_threads = 2
705
 
706
	# Configuration option allocation/vdo_hash_zone_threads.
707
	# Specifies the number of threads across which to subdivide parts of the VDO
708
	# processing based on the hash value computed from the block data.
709
	# The value must be at in range [0..100].
710
	# vdo_hash_zone_threads, vdo_logical_threads and vdo_physical_threads must be
711
	# either all zero or all non-zero.
712
	# This configuration option has an automatic default value.
713
	# vdo_hash_zone_threads = 1
714
 
715
	# Configuration option allocation/vdo_logical_threads.
716
	# Specifies the number of threads across which to subdivide parts of the VDO
717
	# processing based on the hash value computed from the block data.
718
	# A logical thread count of 9 or more will require explicitly specifying
719
	# a sufficiently large block map cache size, as well.
720
	# The value must be in range [0..100].
721
	# vdo_hash_zone_threads, vdo_logical_threads and vdo_physical_threads must be
722
	# either all zero or all non-zero.
723
	# This configuration option has an automatic default value.
724
	# vdo_logical_threads = 1
725
 
726
	# Configuration option allocation/vdo_physical_threads.
727
	# Specifies the number of threads across which to subdivide parts of the VDO
728
	# processing based on physical block addresses.
729
	# Each additional thread after the first will use an additional 10MiB of RAM.
730
	# The value must be in range [0..16].
731
	# vdo_hash_zone_threads, vdo_logical_threads and vdo_physical_threads must be
732
	# either all zero or all non-zero.
733
	# This configuration option has an automatic default value.
734
	# vdo_physical_threads = 1
735
 
736
	# Configuration option allocation/vdo_write_policy.
737
	# Specifies the write policy:
738
	# auto  - VDO will check the storage device and determine whether it supports flushes.
739
	#         If it does, VDO will run in async mode, otherwise it will run in sync mode.
740
	# sync  - Writes are acknowledged only after data is stably written.
741
	#         This policy is not supported if the underlying storage is not also synchronous.
742
	# async - Writes are acknowledged after data has been cached for writing to stable storage.
743
	#         Data which has not been flushed is not guaranteed to persist in this mode.
204 - 744
	# async-unsafe - Writes are handled like 'async' but there is no guarantee of the atomicity async provides.
745
	#         This mode should only be used for better performance when atomicity is not required.
192 - 746
	# This configuration option has an automatic default value.
747
	# vdo_write_policy = "auto"
748
 
749
	# Configuration option allocation/vdo_max_discard.
204 - 750
	# Specified the maximum size of discard bio accepted, in 4096 byte blocks.
192 - 751
	# I/O requests to a VDO volume are normally split into 4096-byte blocks,
752
	# and processed up to 2048 at a time. However, discard requests to a VDO volume
753
	# can be automatically split to a larger size, up to <max discard> 4096-byte blocks
754
	# in a single bio, and are limited to 1500 at a time.
755
	# Increasing this value may provide better overall performance, at the cost of
756
	# increased latency for the individual discard requests.
757
	# The default and minimum is 1. The maximum is UINT_MAX / 4096.
758
	# This configuration option has an automatic default value.
759
	# vdo_max_discard = 1
203 - 760
 
761
	# Configuration option allocation/vdo_pool_header_size.
762
	# Specified the emptry header size in KiB at the front and end of vdo pool device.
763
	# This configuration option has an automatic default value.
764
	# vdo_pool_header_size = 512
192 - 765
}
766
 
767
# Configuration section log.
768
# How LVM log information is reported.
769
log {
770
 
771
	# Configuration option log/report_command_log.
772
	# Enable or disable LVM log reporting.
773
	# If enabled, LVM will collect a log of operations, messages,
774
	# per-object return codes with object identification and associated
775
	# error numbers (errnos) during LVM command processing. Then the
776
	# log is either reported solely or in addition to any existing
777
	# reports, depending on LVM command used. If it is a reporting command
778
	# (e.g. pvs, vgs, lvs, lvm fullreport), then the log is reported in
779
	# addition to any existing reports. Otherwise, there's only log report
780
	# on output. For all applicable LVM commands, you can request that
781
	# the output has only log report by using --logonly command line
782
	# option. Use log/command_log_cols and log/command_log_sort settings
783
	# to define fields to display and sort fields for the log report.
784
	# You can also use log/command_log_selection to define selection
785
	# criteria used each time the log is reported.
786
	# This configuration option has an automatic default value.
787
	# report_command_log = 0
788
 
789
	# Configuration option log/command_log_sort.
790
	# List of columns to sort by when reporting command log.
791
	# See <lvm command> --logonly --configreport log -o help
792
	# for the list of possible fields.
793
	# This configuration option has an automatic default value.
794
	# command_log_sort = "log_seq_num"
795
 
796
	# Configuration option log/command_log_cols.
797
	# List of columns to report when reporting command log.
798
	# See <lvm command> --logonly --configreport log -o help
799
	# for the list of possible fields.
800
	# This configuration option has an automatic default value.
801
	# command_log_cols = "log_seq_num,log_type,log_context,log_object_type,log_object_name,log_object_id,log_object_group,log_object_group_id,log_message,log_errno,log_ret_code"
802
 
803
	# Configuration option log/command_log_selection.
804
	# Selection criteria used when reporting command log.
805
	# You can define selection criteria that are applied each
806
	# time log is reported. This way, it is possible to control the
807
	# amount of log that is displayed on output and you can select
808
	# only parts of the log that are important for you. To define
809
	# selection criteria, use fields from log report. See also
810
	# <lvm command> --logonly --configreport log -S help for the
811
	# list of possible fields and selection operators. You can also
812
	# define selection criteria for log report on command line directly
813
	# using <lvm command> --configreport log -S <selection criteria>
814
	# which has precedence over log/command_log_selection setting.
815
	# For more information about selection criteria in general, see
816
	# lvm(8) man page.
817
	# This configuration option has an automatic default value.
818
	# command_log_selection = "!(log_type=status && message=success)"
819
 
820
	# Configuration option log/verbose.
821
	# Controls the messages sent to stdout or stderr.
204 - 822
	# This configuration option has an automatic default value.
823
	# verbose = 0
192 - 824
 
825
	# Configuration option log/silent.
826
	# Suppress all non-essential messages from stdout.
827
	# This has the same effect as -qq. When enabled, the following commands
828
	# still produce output: dumpconfig, lvdisplay, lvmdiskscan, lvs, pvck,
829
	# pvdisplay, pvs, version, vgcfgrestore -l, vgdisplay, vgs.
830
	# Non-essential messages are shifted from log level 4 to log level 5
831
	# for syslog and lvm2_log_fn purposes.
832
	# Any 'yes' or 'no' questions not overridden by other arguments are
833
	# suppressed and default to 'no'.
204 - 834
	# This configuration option has an automatic default value.
835
	# silent = 0
192 - 836
 
837
	# Configuration option log/syslog.
838
	# Send log messages through syslog.
204 - 839
	# This configuration option has an automatic default value.
840
	# syslog = 0
192 - 841
 
842
	# Configuration option log/file.
843
	# Write error and debug log messages to a file specified here.
844
	# This configuration option does not have a default value defined.
845
 
204 - 846
	# Configuration option log/journal.
847
	# Record lvm information in the systemd journal.
848
	# command: record commands that are run.
849
	# output: record default output from commands.
850
	# debug: record debug messages from commands.
851
	# This configuration option has an automatic default value.
852
	# journal = [ ]
853
 
192 - 854
	# Configuration option log/overwrite.
855
	# Overwrite the log file each time the program is run.
204 - 856
	# This configuration option has an automatic default value.
857
	# overwrite = 0
192 - 858
 
859
	# Configuration option log/level.
860
	# The level of log messages that are sent to the log file or syslog.
861
	# There are 6 syslog-like log levels currently in use: 2 to 7 inclusive.
862
	# 7 is the most verbose (LOG_DEBUG).
204 - 863
	# This configuration option has an automatic default value.
864
	# level = 0
192 - 865
 
866
	# Configuration option log/indent.
867
	# Indent messages according to their severity.
868
	# This configuration option has an automatic default value.
869
	# indent = 0
870
 
871
	# Configuration option log/command_names.
872
	# Display the command name on each line of output.
204 - 873
	# This configuration option has an automatic default value.
874
	# command_names = 0
192 - 875
 
876
	# Configuration option log/prefix.
877
	# A prefix to use before the log message text.
878
	# (After the command name, if selected).
879
	# Two spaces allows you to see/grep the severity of each message.
880
	# To make the messages look similar to the original LVM tools use:
881
	# indent = 0, command_names = 1, prefix = " -- "
204 - 882
	# This configuration option has an automatic default value.
883
	# prefix = "  "
192 - 884
 
885
	# Configuration option log/activation.
886
	# Log messages during activation.
887
	# Don't use this in low memory situations (can deadlock).
204 - 888
	# This configuration option has an automatic default value.
889
	# activation = 0
192 - 890
 
891
	# Configuration option log/debug_classes.
892
	# Select log messages by class.
893
	# Some debugging messages are assigned to a class and only appear in
894
	# debug output if the class is listed here. Classes currently
895
	# available: memory, devices, io, activation, allocation,
896
	# metadata, cache, locking, lvmpolld. Use "all" to see everything.
204 - 897
	# This configuration option has an automatic default value.
898
	# debug_classes = [ "memory", "devices", "io", "activation", "allocation", "metadata", "cache", "locking", "lvmpolld", "dbus" ]
192 - 899
 
900
	# Configuration option log/debug_file_fields.
901
	# The fields included in debug output written to log file.
902
	# Use "all" to include everything (the default).
903
	# This configuration option is advanced.
904
	# This configuration option has an automatic default value.
905
	# debug_file_fields = [ "time", "command", "fileline", "message" ]
906
 
907
	# Configuration option log/debug_output_fields.
908
	# The fields included in debug output written to stderr.
909
	# Use "all" to include everything (the default).
910
	# This configuration option is advanced.
911
	# This configuration option has an automatic default value.
912
	# debug_output_fields = [ "time", "command", "fileline", "message" ]
913
}
914
 
915
# Configuration section backup.
916
# How LVM metadata is backed up and archived.
917
# In LVM, a 'backup' is a copy of the metadata for the current system,
918
# and an 'archive' contains old metadata configurations. They are
919
# stored in a human readable text format.
920
backup {
921
 
922
	# Configuration option backup/backup.
923
	# Maintain a backup of the current metadata configuration.
924
	# Think very hard before turning this off!
204 - 925
	# This configuration option has an automatic default value.
926
	# backup = 1
192 - 927
 
928
	# Configuration option backup/backup_dir.
929
	# Location of the metadata backup files.
930
	# Remember to back up this directory regularly!
204 - 931
	# This configuration option has an automatic default value.
932
	# backup_dir = "/etc/lvm/backup"
192 - 933
 
934
	# Configuration option backup/archive.
935
	# Maintain an archive of old metadata configurations.
936
	# Think very hard before turning this off.
204 - 937
	# This configuration option has an automatic default value.
938
	# archive = 1
192 - 939
 
940
	# Configuration option backup/archive_dir.
941
	# Location of the metdata archive files.
942
	# Remember to back up this directory regularly!
204 - 943
	# This configuration option has an automatic default value.
944
	# archive_dir = "/etc/lvm/archive"
192 - 945
 
946
	# Configuration option backup/retain_min.
947
	# Minimum number of archives to keep.
204 - 948
	# This configuration option has an automatic default value.
949
	# retain_min = 10
192 - 950
 
951
	# Configuration option backup/retain_days.
952
	# Minimum number of days to keep archive files.
204 - 953
	# This configuration option has an automatic default value.
954
	# retain_days = 30
192 - 955
}
956
 
957
# Configuration section shell.
958
# Settings for running LVM in shell (readline) mode.
959
shell {
960
 
961
	# Configuration option shell/history_size.
962
	# Number of lines of history to store in ~/.lvm_history.
204 - 963
	# This configuration option has an automatic default value.
964
	# history_size = 100
192 - 965
}
966
 
967
# Configuration section global.
968
# Miscellaneous global LVM settings.
969
global {
970
 
971
	# Configuration option global/umask.
972
	# The file creation mask for any files and directories created.
973
	# Interpreted as octal if the first digit is zero.
204 - 974
	# This configuration option has an automatic default value.
975
	# umask = 077
192 - 976
 
977
	# Configuration option global/test.
978
	# No on-disk metadata changes will be made in test mode.
979
	# Equivalent to having the -t option on every command.
204 - 980
	# This configuration option has an automatic default value.
981
	# test = 0
192 - 982
 
983
	# Configuration option global/units.
984
	# Default value for --units argument.
204 - 985
	# This configuration option has an automatic default value.
986
	# units = "r"
192 - 987
 
988
	# Configuration option global/si_unit_consistency.
989
	# Distinguish between powers of 1024 and 1000 bytes.
990
	# The LVM commands distinguish between powers of 1024 bytes,
991
	# e.g. KiB, MiB, GiB, and powers of 1000 bytes, e.g. KB, MB, GB.
992
	# If scripts depend on the old behaviour, disable this setting
993
	# temporarily until they are updated.
204 - 994
	# This configuration option has an automatic default value.
995
	# si_unit_consistency = 1
192 - 996
 
997
	# Configuration option global/suffix.
998
	# Display unit suffix for sizes.
999
	# This setting has no effect if the units are in human-readable form
1000
	# (global/units = "h") in which case the suffix is always displayed.
204 - 1001
	# This configuration option has an automatic default value.
1002
	# suffix = 1
192 - 1003
 
1004
	# Configuration option global/activation.
1005
	# Enable/disable communication with the kernel device-mapper.
1006
	# Disable to use the tools to manipulate LVM metadata without
1007
	# activating any logical volumes. If the device-mapper driver
1008
	# is not present in the kernel, disabling this should suppress
1009
	# the error messages.
204 - 1010
	# This configuration option has an automatic default value.
1011
	# activation = 1
192 - 1012
 
1013
	# Configuration option global/proc.
1014
	# Location of proc filesystem.
1015
	# This configuration option is advanced.
204 - 1016
	# This configuration option has an automatic default value.
1017
	# proc = "/proc"
192 - 1018
 
1019
	# Configuration option global/etc.
1020
	# Location of /etc system configuration directory.
204 - 1021
	# This configuration option has an automatic default value.
1022
	# etc = "/etc"
192 - 1023
 
1024
	# Configuration option global/wait_for_locks.
1025
	# When disabled, fail if a lock request would block.
204 - 1026
	# This configuration option has an automatic default value.
1027
	# wait_for_locks = 1
192 - 1028
 
1029
	# Configuration option global/locking_dir.
1030
	# Directory to use for LVM command file locks.
1031
	# Local non-LV directory that holds file-based locks while commands are
1032
	# in progress. A directory like /tmp that may get wiped on reboot is OK.
204 - 1033
	# This configuration option has an automatic default value.
1034
	# locking_dir = "/run/lock/lvm"
192 - 1035
 
1036
	# Configuration option global/prioritise_write_locks.
1037
	# Allow quicker VG write access during high volume read access.
1038
	# When there are competing read-only and read-write access requests for
1039
	# a volume group's metadata, instead of always granting the read-only
1040
	# requests immediately, delay them to allow the read-write requests to
1041
	# be serviced. Without this setting, write access may be stalled by a
193 - 1042
	# high volume of read-only requests. This option only affects file locks.
204 - 1043
	# This configuration option has an automatic default value.
1044
	# prioritise_write_locks = 1
192 - 1045
 
1046
	# Configuration option global/library_dir.
1047
	# Search this directory first for shared libraries.
1048
	# This configuration option does not have a default value defined.
1049
 
1050
	# Configuration option global/abort_on_internal_errors.
1051
	# Abort a command that encounters an internal error.
1052
	# Treat any internal errors as fatal errors, aborting the process that
1053
	# encountered the internal error. Please only enable for debugging.
204 - 1054
	# This configuration option has an automatic default value.
1055
	# abort_on_internal_errors = 0
192 - 1056
 
1057
	# Configuration option global/metadata_read_only.
1058
	# No operations that change on-disk metadata are permitted.
1059
	# Additionally, read-only commands that encounter metadata in need of
1060
	# repair will still be allowed to proceed exactly as if the repair had
1061
	# been performed (except for the unchanged vg_seqno). Inappropriate
1062
	# use could mess up your system, so seek advice first!
204 - 1063
	# This configuration option has an automatic default value.
1064
	# metadata_read_only = 0
192 - 1065
 
1066
	# Configuration option global/mirror_segtype_default.
1067
	# The segment type used by the short mirroring option -m.
1068
	# The --type mirror|raid1 option overrides this setting.
203 - 1069
	#
192 - 1070
	# Accepted values:
1071
	#   mirror
1072
	#     The original RAID1 implementation from LVM/DM. It is
1073
	#     characterized by a flexible log solution (core, disk, mirrored),
1074
	#     and by the necessity to block I/O while handling a failure.
1075
	#     There is an inherent race in the dmeventd failure handling logic
1076
	#     with snapshots of devices using this type of RAID1 that in the
1077
	#     worst case could cause a deadlock. (Also see
1078
	#     devices/ignore_lvm_mirrors.)
1079
	#   raid1
1080
	#     This is a newer RAID1 implementation using the MD RAID1
1081
	#     personality through device-mapper. It is characterized by a
1082
	#     lack of log options. (A log is always allocated for every
1083
	#     device and they are placed on the same device as the image,
1084
	#     so no separate devices are required.) This mirror
1085
	#     implementation does not require I/O to be blocked while
1086
	#     handling a failure. This mirror implementation is not
1087
	#     cluster-aware and cannot be used in a shared (active/active)
1088
	#     fashion in a cluster.
203 - 1089
	#
204 - 1090
	# This configuration option has an automatic default value.
1091
	# mirror_segtype_default = "raid1"
192 - 1092
 
1093
	# Configuration option global/support_mirrored_mirror_log.
1094
	# Enable mirrored 'mirror' log type for testing.
203 - 1095
	#
192 - 1096
	# This type is deprecated to create or convert to but can
1097
	# be enabled to test that activation of existing mirrored
1098
	# logs and conversion to disk/core works.
203 - 1099
	#
192 - 1100
	# Not supported for regular operation!
1101
	# This configuration option has an automatic default value.
1102
	# support_mirrored_mirror_log = 0
1103
 
1104
	# Configuration option global/raid10_segtype_default.
1105
	# The segment type used by the -i -m combination.
1106
	# The --type raid10|mirror option overrides this setting.
1107
	# The --stripes/-i and --mirrors/-m options can both be specified
1108
	# during the creation of a logical volume to use both striping and
1109
	# mirroring for the LV. There are two different implementations.
203 - 1110
	#
192 - 1111
	# Accepted values:
1112
	#   raid10
1113
	#     LVM uses MD's RAID10 personality through DM. This is the
1114
	#     preferred option.
1115
	#   mirror
1116
	#     LVM layers the 'mirror' and 'stripe' segment types. The layering
1117
	#     is done by creating a mirror LV on top of striped sub-LVs,
1118
	#     effectively creating a RAID 0+1 array. The layering is suboptimal
1119
	#     in terms of providing redundancy and performance.
203 - 1120
	#
204 - 1121
	# This configuration option has an automatic default value.
1122
	# raid10_segtype_default = "raid10"
192 - 1123
 
1124
	# Configuration option global/sparse_segtype_default.
1125
	# The segment type used by the -V -L combination.
1126
	# The --type snapshot|thin option overrides this setting.
1127
	# The combination of -V and -L options creates a sparse LV. There are
1128
	# two different implementations.
203 - 1129
	#
192 - 1130
	# Accepted values:
1131
	#   snapshot
1132
	#     The original snapshot implementation from LVM/DM. It uses an old
1133
	#     snapshot that mixes data and metadata within a single COW
1134
	#     storage volume and performs poorly when the size of stored data
1135
	#     passes hundreds of MB.
1136
	#   thin
1137
	#     A newer implementation that uses thin provisioning. It has a
1138
	#     bigger minimal chunk size (64KiB) and uses a separate volume for
1139
	#     metadata. It has better performance, especially when more data
1140
	#     is used. It also supports full snapshots.
203 - 1141
	#
204 - 1142
	# This configuration option has an automatic default value.
1143
	# sparse_segtype_default = "thin"
192 - 1144
 
1145
	# Configuration option global/lvdisplay_shows_full_device_path.
1146
	# Enable this to reinstate the previous lvdisplay name format.
1147
	# The default format for displaying LV names in lvdisplay was changed
1148
	# in version 2.02.89 to show the LV name and path separately.
1149
	# Previously this was always shown as /dev/vgname/lvname even when that
1150
	# was never a valid path in the /dev filesystem.
1151
	# This configuration option has an automatic default value.
1152
	# lvdisplay_shows_full_device_path = 0
1153
 
1154
	# Configuration option global/event_activation.
1155
	# Activate LVs based on system-generated device events.
203 - 1156
	# When a PV appears on the system, a system-generated uevent triggers
1157
	# the lvm2-pvscan service which runs the pvscan --cache -aay command.
1158
	# If the new PV completes a VG, pvscan autoactivates LVs in the VG.
1159
	# When event_activation is disabled, the lvm2-activation services are
1160
	# generated and run at fixed points during system startup.  These
1161
	# services run vgchange -aay to autoactivate LVs in VGs that happen
1162
	# to be present at that point in time.
1163
	# See the --setautoactivation option or the auto_activation_volume_list
1164
	# setting to configure autoactivation for specific VGs or LVs.
192 - 1165
	# This configuration option has an automatic default value.
1166
	# event_activation = 1
1167
 
1168
	# Configuration option global/use_aio.
1169
	# Use async I/O when reading and writing devices.
1170
	# This configuration option has an automatic default value.
1171
	# use_aio = 1
1172
 
1173
	# Configuration option global/use_lvmlockd.
1174
	# Use lvmlockd for locking among hosts using LVM on shared storage.
1175
	# Applicable only if LVM is compiled with lockd support in which
1176
	# case there is also lvmlockd(8) man page available for more
1177
	# information.
204 - 1178
	# This configuration option has an automatic default value.
1179
	# use_lvmlockd = 0
192 - 1180
 
1181
	# Configuration option global/lvmlockd_lock_retries.
1182
	# Retry lvmlockd lock requests this many times.
1183
	# Applicable only if LVM is compiled with lockd support
1184
	# This configuration option has an automatic default value.
1185
	# lvmlockd_lock_retries = 3
1186
 
1187
	# Configuration option global/sanlock_lv_extend.
1188
	# Size in MiB to extend the internal LV holding sanlock locks.
1189
	# The internal LV holds locks for each LV in the VG, and after enough
1190
	# LVs have been created, the internal LV needs to be extended. lvcreate
1191
	# will automatically extend the internal LV when needed by the amount
1192
	# specified here. Setting this to 0 disables the automatic extension
1193
	# and can cause lvcreate to fail. Applicable only if LVM is compiled
1194
	# with lockd support
1195
	# This configuration option has an automatic default value.
1196
	# sanlock_lv_extend = 256
1197
 
203 - 1198
	# Configuration option global/lvmlockctl_kill_command.
1199
	# The command that lvmlockctl --kill should use to force LVs offline.
1200
	# The lvmlockctl --kill command is run when a shared VG has lost
1201
	# access to locks (e.g. when sanlock has lost access to storage.)
1202
	# An empty string means that there will be no automatic attempt by
1203
	# lvmlockctl --kill to forcibly shut down LVs in the VG, and the user
1204
	# can manually intervene as described in lvmlockd(8).
1205
	# The VG name will be appended to the command specified here.
1206
	# This configuration option has an automatic default value.
1207
	# lvmlockctl_kill_command = ""
1208
 
192 - 1209
	# Configuration option global/thin_check_executable.
1210
	# The full path to the thin_check command.
1211
	# LVM uses this command to check that a thin metadata device is in a
1212
	# usable state. When a thin pool is activated and after it is
1213
	# deactivated, this command is run. Activation will only proceed if
1214
	# the command has an exit status of 0. Set to "" to skip this check.
1215
	# (Not recommended.) Also see thin_check_options.
1216
	# (See package device-mapper-persistent-data or thin-provisioning-tools)
1217
	# This configuration option has an automatic default value.
1218
	# thin_check_executable = "/usr/sbin/thin_check"
1219
 
1220
	# Configuration option global/thin_dump_executable.
1221
	# The full path to the thin_dump command.
1222
	# LVM uses this command to dump thin pool metadata.
1223
	# (See package device-mapper-persistent-data or thin-provisioning-tools)
1224
	# This configuration option has an automatic default value.
1225
	# thin_dump_executable = "/usr/sbin/thin_dump"
1226
 
1227
	# Configuration option global/thin_repair_executable.
1228
	# The full path to the thin_repair command.
1229
	# LVM uses this command to repair a thin metadata device if it is in
1230
	# an unusable state. Also see thin_repair_options.
1231
	# (See package device-mapper-persistent-data or thin-provisioning-tools)
1232
	# This configuration option has an automatic default value.
1233
	# thin_repair_executable = "/usr/sbin/thin_repair"
1234
 
1235
	# Configuration option global/thin_check_options.
1236
	# List of options passed to the thin_check command.
1237
	# With thin_check version 2.1 or newer you can add the option
1238
	# --ignore-non-fatal-errors to let it pass through ignorable errors
1239
	# and fix them later. With thin_check version 3.2 or newer you should
1240
	# include the option --clear-needs-check-flag.
1241
	# This configuration option has an automatic default value.
1242
	# thin_check_options = [ "-q", "--clear-needs-check-flag" ]
1243
 
1244
	# Configuration option global/thin_repair_options.
1245
	# List of options passed to the thin_repair command.
1246
	# This configuration option has an automatic default value.
1247
	# thin_repair_options = [ "" ]
1248
 
1249
	# Configuration option global/thin_disabled_features.
1250
	# Features to not use in the thin driver.
1251
	# This can be helpful for testing, or to avoid using a feature that is
1252
	# causing problems. Features include: block_size, discards,
1253
	# discards_non_power_2, external_origin, metadata_resize,
1254
	# external_origin_extend, error_if_no_space.
203 - 1255
	#
192 - 1256
	# Example
1257
	# thin_disabled_features = [ "discards", "block_size" ]
203 - 1258
	#
192 - 1259
	# This configuration option does not have a default value defined.
1260
 
1261
	# Configuration option global/cache_disabled_features.
1262
	# Features to not use in the cache driver.
1263
	# This can be helpful for testing, or to avoid using a feature that is
1264
	# causing problems. Features include: policy_mq, policy_smq, metadata2.
203 - 1265
	#
192 - 1266
	# Example
1267
	# cache_disabled_features = [ "policy_smq" ]
203 - 1268
	#
192 - 1269
	# This configuration option does not have a default value defined.
1270
 
1271
	# Configuration option global/cache_check_executable.
1272
	# The full path to the cache_check command.
1273
	# LVM uses this command to check that a cache metadata device is in a
1274
	# usable state. When a cached LV is activated and after it is
1275
	# deactivated, this command is run. Activation will only proceed if the
1276
	# command has an exit status of 0. Set to "" to skip this check.
1277
	# (Not recommended.) Also see cache_check_options.
1278
	# (See package device-mapper-persistent-data or thin-provisioning-tools)
1279
	# This configuration option has an automatic default value.
1280
	# cache_check_executable = "/usr/sbin/cache_check"
1281
 
1282
	# Configuration option global/cache_dump_executable.
1283
	# The full path to the cache_dump command.
1284
	# LVM uses this command to dump cache pool metadata.
1285
	# (See package device-mapper-persistent-data or thin-provisioning-tools)
1286
	# This configuration option has an automatic default value.
1287
	# cache_dump_executable = "/usr/sbin/cache_dump"
1288
 
1289
	# Configuration option global/cache_repair_executable.
1290
	# The full path to the cache_repair command.
1291
	# LVM uses this command to repair a cache metadata device if it is in
1292
	# an unusable state. Also see cache_repair_options.
1293
	# (See package device-mapper-persistent-data or thin-provisioning-tools)
1294
	# This configuration option has an automatic default value.
1295
	# cache_repair_executable = "/usr/sbin/cache_repair"
1296
 
1297
	# Configuration option global/cache_check_options.
1298
	# List of options passed to the cache_check command.
1299
	# With cache_check version 5.0 or newer you should include the option
1300
	# --clear-needs-check-flag.
1301
	# This configuration option has an automatic default value.
1302
	# cache_check_options = [ "-q", "--clear-needs-check-flag" ]
1303
 
1304
	# Configuration option global/cache_repair_options.
1305
	# List of options passed to the cache_repair command.
1306
	# This configuration option has an automatic default value.
1307
	# cache_repair_options = [ "" ]
1308
 
1309
	# Configuration option global/vdo_format_executable.
1310
	# The full path to the vdoformat command.
1311
	# LVM uses this command to initial data volume for VDO type logical volume
1312
	# This configuration option has an automatic default value.
1313
	# vdo_format_executable = "/usr/bin/vdoformat"
1314
 
1315
	# Configuration option global/vdo_format_options.
1316
	# List of options passed added to standard vdoformat command.
1317
	# This configuration option has an automatic default value.
1318
	# vdo_format_options = [ "" ]
1319
 
203 - 1320
	# Configuration option global/vdo_disabled_features.
1321
	# Features to not use in the vdo driver.
1322
	# This can be helpful for testing, or to avoid using a feature that is
1323
	# causing problems. Features include: online_rename
1324
	#
1325
	# Example
1326
	# vdo_disabled_features = [ "online_rename" ]
1327
	#
1328
	# This configuration option does not have a default value defined.
1329
 
192 - 1330
	# Configuration option global/fsadm_executable.
1331
	# The full path to the fsadm command.
1332
	# LVM uses this command to help with lvresize -r operations.
1333
	# This configuration option has an automatic default value.
1334
	# fsadm_executable = "/usr/sbin/fsadm"
1335
 
1336
	# Configuration option global/system_id_source.
1337
	# The method LVM uses to set the local system ID.
1338
	# Volume Groups can also be given a system ID (by vgcreate, vgchange,
1339
	# or vgimport.) A VG on shared storage devices is accessible only to
1340
	# the host with a matching system ID. See 'man lvmsystemid' for
1341
	# information on limitations and correct usage.
203 - 1342
	#
192 - 1343
	# Accepted values:
1344
	#   none
1345
	#     The host has no system ID.
1346
	#   lvmlocal
1347
	#     Obtain the system ID from the system_id setting in the 'local'
1348
	#     section of an lvm configuration file, e.g. lvmlocal.conf.
1349
	#   uname
1350
	#     Set the system ID from the hostname (uname) of the system.
1351
	#     System IDs beginning localhost are not permitted.
204 - 1352
	#   appmachineid
1353
	#     Use an LVM-specific derivation of the local machine-id as the
1354
	#     system ID. See 'man machine-id'.
192 - 1355
	#   machineid
204 - 1356
	#     Use the contents of the machine-id file to set the system ID
1357
	#     (appmachineid is recommended.)
192 - 1358
	#   file
1359
	#     Use the contents of another file (system_id_file) to set the
1360
	#     system ID.
203 - 1361
	#
204 - 1362
	# This configuration option has an automatic default value.
1363
	# system_id_source = "none"
192 - 1364
 
1365
	# Configuration option global/system_id_file.
1366
	# The full path to the file containing a system ID.
1367
	# This is used when system_id_source is set to 'file'.
1368
	# Comments starting with the character # are ignored.
1369
	# This configuration option does not have a default value defined.
1370
 
1371
	# Configuration option global/use_lvmpolld.
1372
	# Use lvmpolld to supervise long running LVM commands.
1373
	# When enabled, control of long running LVM commands is transferred
1374
	# from the original LVM command to the lvmpolld daemon. This allows
1375
	# the operation to continue independent of the original LVM command.
1376
	# After lvmpolld takes over, the LVM command displays the progress
1377
	# of the ongoing operation. lvmpolld itself runs LVM commands to
1378
	# manage the progress of ongoing operations. lvmpolld can be used as
1379
	# a native systemd service, which allows it to be started on demand,
1380
	# and to use its own control group. When this option is disabled, LVM
1381
	# commands will supervise long running operations by forking themselves.
1382
	# Applicable only if LVM is compiled with lvmpolld support.
204 - 1383
	# This configuration option has an automatic default value.
1384
	# use_lvmpolld = 1
192 - 1385
 
1386
	# Configuration option global/notify_dbus.
1387
	# Enable D-Bus notification from LVM commands.
1388
	# When enabled, an LVM command that changes PVs, changes VG metadata,
1389
	# or changes the activation state of an LV will send a notification.
204 - 1390
	# This configuration option has an automatic default value.
1391
	# notify_dbus = 1
192 - 1392
 
1393
	# Configuration option global/io_memory_size.
1394
	# The amount of memory in KiB that LVM allocates to perform disk io.
1395
	# LVM performance may benefit from more io memory when there are many
1396
	# disks or VG metadata is large. Increasing this size may be necessary
1397
	# when a single copy of VG metadata is larger than the current setting.
1398
	# This value should usually not be decreased from the default; setting
1399
	# it too low can result in lvm failing to read VGs.
1400
	# This configuration option has an automatic default value.
1401
	# io_memory_size = 8192
1402
}
1403
 
1404
# Configuration section activation.
1405
activation {
1406
 
1407
	# Configuration option activation/checks.
1408
	# Perform internal checks of libdevmapper operations.
1409
	# Useful for debugging problems with activation. Some of the checks may
1410
	# be expensive, so it's best to use this only when there seems to be a
1411
	# problem.
204 - 1412
	# This configuration option has an automatic default value.
1413
	# checks = 0
192 - 1414
 
1415
	# Configuration option activation/udev_sync.
1416
	# Use udev notifications to synchronize udev and LVM.
203 - 1417
	# The --noudevsync option overrides this setting.
192 - 1418
	# When disabled, LVM commands will not wait for notifications from
1419
	# udev, but continue irrespective of any possible udev processing in
1420
	# the background. Only use this if udev is not running or has rules
1421
	# that ignore the devices LVM creates. If enabled when udev is not
1422
	# running, and LVM processes are waiting for udev, run the command
1423
	# 'dmsetup udevcomplete_all' to wake them up.
204 - 1424
	# This configuration option has an automatic default value.
1425
	# udev_sync = 1
192 - 1426
 
1427
	# Configuration option activation/udev_rules.
1428
	# Use udev rules to manage LV device nodes and symlinks.
1429
	# When disabled, LVM will manage the device nodes and symlinks for
1430
	# active LVs itself. Manual intervention may be required if this
1431
	# setting is changed while LVs are active.
204 - 1432
	# This configuration option has an automatic default value.
1433
	# udev_rules = 1
192 - 1434
 
1435
	# Configuration option activation/verify_udev_operations.
1436
	# Use extra checks in LVM to verify udev operations.
1437
	# This enables additional checks (and if necessary, repairs) on entries
1438
	# in the device directory after udev has completed processing its
1439
	# events. Useful for diagnosing problems with LVM/udev interactions.
1440
	# This configuration option has an automatic default value.
1441
	# verify_udev_operations = 0
1442
 
1443
	# Configuration option activation/retry_deactivation.
1444
	# Retry failed LV deactivation.
1445
	# If LV deactivation fails, LVM will retry for a few seconds before
1446
	# failing. This may happen because a process run from a quick udev rule
1447
	# temporarily opened the device.
204 - 1448
	# This configuration option has an automatic default value.
1449
	# retry_deactivation = 1
192 - 1450
 
1451
	# Configuration option activation/missing_stripe_filler.
1452
	# Method to fill missing stripes when activating an incomplete LV.
1453
	# Using 'error' will make inaccessible parts of the device return I/O
1454
	# errors on access. Using 'zero' will return success (and zero) on I/O
1455
	# You can instead use a device path, in which case,
1456
	# that device will be used in place of missing stripes. Using anything
1457
	# other than 'error' with mirrored or snapshotted volumes is likely to
1458
	# result in data corruption.
1459
	# This configuration option is advanced.
204 - 1460
	# This configuration option has an automatic default value.
1461
	# missing_stripe_filler = "error"
192 - 1462
 
1463
	# Configuration option activation/use_linear_target.
1464
	# Use the linear target to optimize single stripe LVs.
1465
	# When disabled, the striped target is used. The linear target is an
1466
	# optimised version of the striped target that only handles a single
1467
	# stripe.
1468
	# This configuration option has an automatic default value.
1469
	# use_linear_target = 1
1470
 
1471
	# Configuration option activation/reserved_stack.
1472
	# Stack size in KiB to reserve for use while devices are suspended.
1473
	# Insufficent reserve risks I/O deadlock during device suspension.
1474
	# This configuration option has an automatic default value.
1475
	# reserved_stack = 64
1476
 
1477
	# Configuration option activation/reserved_memory.
1478
	# Memory size in KiB to reserve for use while devices are suspended.
1479
	# Insufficent reserve risks I/O deadlock during device suspension.
1480
	# This configuration option has an automatic default value.
1481
	# reserved_memory = 8192
1482
 
1483
	# Configuration option activation/process_priority.
1484
	# Nice value used while devices are suspended.
1485
	# Use a high priority so that LVs are suspended
1486
	# for the shortest possible time.
1487
	# This configuration option has an automatic default value.
1488
	# process_priority = -18
1489
 
1490
	# Configuration option activation/volume_list.
1491
	# Only LVs selected by this list are activated.
1492
	# If this list is defined, an LV is only activated if it matches an
1493
	# entry in this list. If this list is undefined, it imposes no limits
1494
	# on LV activation (all are allowed).
203 - 1495
	#
192 - 1496
	# Accepted values:
1497
	#   vgname
1498
	#     The VG name is matched exactly and selects all LVs in the VG.
1499
	#   vgname/lvname
1500
	#     The VG name and LV name are matched exactly and selects the LV.
1501
	#   @tag
1502
	#     Selects an LV if the specified tag matches a tag set on the LV
1503
	#     or VG.
1504
	#   @*
1505
	#     Selects an LV if a tag defined on the host is also set on the LV
1506
	#     or VG. See tags/hosttags. If any host tags exist but volume_list
1507
	#     is not defined, a default single-entry list containing '@*'
1508
	#     is assumed.
203 - 1509
	#
192 - 1510
	# Example
1511
	# volume_list = [ "vg1", "vg2/lvol1", "@tag1", "@*" ]
203 - 1512
	#
192 - 1513
	# This configuration option does not have a default value defined.
1514
 
1515
	# Configuration option activation/auto_activation_volume_list.
203 - 1516
	# A list of VGs or LVs that should be autoactivated.
1517
	# Autoactivation is an activation command run with -aay,
1518
	# i.e. vgchange -aay, lvchange -aay, or pvscan --cache -aay.
1519
	# When this list is defined, an autoactivation command will only
1520
	# activate LVs included in the list. If this list is undefined,
1521
	# it has no effect. If this list is defined but empty, then no
1522
	# LVs will be autoactivated. LVs can be included in the list by
1523
	# LV name, VG name (applies to all LVs in the VG), or tag name.
1524
	# VGs and LVs can also have an autoactivation property set in
1525
	# metadata, see --setautoactivation. LVs included in this list
1526
	# will not be autoactivated if the VG or LV autoactivation
1527
	# property is disabled (see vgs or lvs "-o autoactivation").
1528
	# The volume_list setting and the "activation skip" property
1529
	# also apply to autoactivation.
1530
	# The -aay option is meant to be used by activation commands that
1531
	# are run automatically by the system, e.g. from systemd services.
1532
	#
192 - 1533
	# Accepted values:
1534
	#   vgname
1535
	#     The VG name is matched exactly and selects all LVs in the VG.
1536
	#   vgname/lvname
1537
	#     The VG name and LV name are matched exactly and selects the LV.
1538
	#   @tag
1539
	#     Selects an LV if the specified tag matches a tag set on the LV
1540
	#     or VG.
1541
	#   @*
1542
	#     Selects an LV if a tag defined on the host is also set on the LV
1543
	#     or VG. See tags/hosttags. If any host tags exist but volume_list
1544
	#     is not defined, a default single-entry list containing '@*'
1545
	#     is assumed.
203 - 1546
	#
192 - 1547
	# Example
1548
	# auto_activation_volume_list = [ "vg1", "vg2/lvol1", "@tag1", "@*" ]
203 - 1549
	#
192 - 1550
	# This configuration option does not have a default value defined.
1551
 
1552
	# Configuration option activation/read_only_volume_list.
1553
	# LVs in this list are activated in read-only mode.
1554
	# If this list is defined, each LV that is to be activated is checked
1555
	# against this list, and if it matches, it is activated in read-only
1556
	# mode. This overrides the permission setting stored in the metadata,
1557
	# e.g. from --permission rw.
203 - 1558
	#
192 - 1559
	# Accepted values:
1560
	#   vgname
1561
	#     The VG name is matched exactly and selects all LVs in the VG.
1562
	#   vgname/lvname
1563
	#     The VG name and LV name are matched exactly and selects the LV.
1564
	#   @tag
1565
	#     Selects an LV if the specified tag matches a tag set on the LV
1566
	#     or VG.
1567
	#   @*
1568
	#     Selects an LV if a tag defined on the host is also set on the LV
1569
	#     or VG. See tags/hosttags. If any host tags exist but volume_list
1570
	#     is not defined, a default single-entry list containing '@*'
1571
	#     is assumed.
203 - 1572
	#
192 - 1573
	# Example
1574
	# read_only_volume_list = [ "vg1", "vg2/lvol1", "@tag1", "@*" ]
203 - 1575
	#
192 - 1576
	# This configuration option does not have a default value defined.
1577
 
1578
	# Configuration option activation/raid_region_size.
1579
	# Size in KiB of each raid or mirror synchronization region.
1580
	# The clean/dirty state of data is tracked for each region.
1581
	# The value is rounded down to a power of two if necessary, and
1582
	# is ignored if it is not a multiple of the machine memory page size.
204 - 1583
	# This configuration option has an automatic default value.
1584
	# raid_region_size = 2048
192 - 1585
 
1586
	# Configuration option activation/error_when_full.
1587
	# Return errors if a thin pool runs out of space.
1588
	# The --errorwhenfull option overrides this setting.
1589
	# When enabled, writes to thin LVs immediately return an error if the
1590
	# thin pool is out of data space. When disabled, writes to thin LVs
1591
	# are queued if the thin pool is out of space, and processed when the
1592
	# thin pool data space is extended. New thin pools are assigned the
1593
	# behavior defined here.
1594
	# This configuration option has an automatic default value.
1595
	# error_when_full = 0
1596
 
1597
	# Configuration option activation/readahead.
1598
	# Setting to use when there is no readahead setting in metadata.
203 - 1599
	#
192 - 1600
	# Accepted values:
1601
	#   none
1602
	#     Disable readahead.
1603
	#   auto
1604
	#     Use default value chosen by kernel.
203 - 1605
	#
192 - 1606
	# This configuration option has an automatic default value.
1607
	# readahead = "auto"
1608
 
1609
	# Configuration option activation/raid_fault_policy.
1610
	# Defines how a device failure in a RAID LV is handled.
1611
	# This includes LVs that have the following segment types:
1612
	# raid1, raid4, raid5*, and raid6*.
1613
	# If a device in the LV fails, the policy determines the steps
1614
	# performed by dmeventd automatically, and the steps perfomed by the
1615
	# manual command lvconvert --repair --use-policies.
1616
	# Automatic handling requires dmeventd to be monitoring the LV.
203 - 1617
	#
192 - 1618
	# Accepted values:
1619
	#   warn
1620
	#     Use the system log to warn the user that a device in the RAID LV
1621
	#     has failed. It is left to the user to run lvconvert --repair
1622
	#     manually to remove or replace the failed device. As long as the
1623
	#     number of failed devices does not exceed the redundancy of the LV
1624
	#     (1 device for raid4/5, 2 for raid6), the LV will remain usable.
1625
	#   allocate
1626
	#     Attempt to use any extra physical volumes in the VG as spares and
1627
	#     replace faulty devices.
203 - 1628
	#
204 - 1629
	# This configuration option has an automatic default value.
1630
	# raid_fault_policy = "warn"
192 - 1631
 
1632
	# Configuration option activation/mirror_image_fault_policy.
1633
	# Defines how a device failure in a 'mirror' LV is handled.
1634
	# An LV with the 'mirror' segment type is composed of mirror images
1635
	# (copies) and a mirror log. A disk log ensures that a mirror LV does
1636
	# not need to be re-synced (all copies made the same) every time a
1637
	# machine reboots or crashes. If a device in the LV fails, this policy
1638
	# determines the steps perfomed by dmeventd automatically, and the steps
1639
	# performed by the manual command lvconvert --repair --use-policies.
1640
	# Automatic handling requires dmeventd to be monitoring the LV.
203 - 1641
	#
192 - 1642
	# Accepted values:
1643
	#   remove
1644
	#     Simply remove the faulty device and run without it. If the log
1645
	#     device fails, the mirror would convert to using an in-memory log.
1646
	#     This means the mirror will not remember its sync status across
1647
	#     crashes/reboots and the entire mirror will be re-synced. If a
1648
	#     mirror image fails, the mirror will convert to a non-mirrored
1649
	#     device if there is only one remaining good copy.
1650
	#   allocate
1651
	#     Remove the faulty device and try to allocate space on a new
1652
	#     device to be a replacement for the failed device. Using this
1653
	#     policy for the log is fast and maintains the ability to remember
1654
	#     sync state through crashes/reboots. Using this policy for a
1655
	#     mirror device is slow, as it requires the mirror to resynchronize
1656
	#     the devices, but it will preserve the mirror characteristic of
1657
	#     the device. This policy acts like 'remove' if no suitable device
1658
	#     and space can be allocated for the replacement.
1659
	#   allocate_anywhere
1660
	#     Not yet implemented. Useful to place the log device temporarily
1661
	#     on the same physical volume as one of the mirror images. This
1662
	#     policy is not recommended for mirror devices since it would break
1663
	#     the redundant nature of the mirror. This policy acts like
1664
	#     'remove' if no suitable device and space can be allocated for the
1665
	#     replacement.
203 - 1666
	#
204 - 1667
	# This configuration option has an automatic default value.
1668
	# mirror_image_fault_policy = "remove"
192 - 1669
 
1670
	# Configuration option activation/mirror_log_fault_policy.
1671
	# Defines how a device failure in a 'mirror' log LV is handled.
1672
	# The mirror_image_fault_policy description for mirrored LVs also
1673
	# applies to mirrored log LVs.
204 - 1674
	# This configuration option has an automatic default value.
1675
	# mirror_log_fault_policy = "allocate"
192 - 1676
 
1677
	# Configuration option activation/snapshot_autoextend_threshold.
1678
	# Auto-extend a snapshot when its usage exceeds this percent.
1679
	# Setting this to 100 disables automatic extension.
1680
	# The minimum value is 50 (a smaller value is treated as 50.)
1681
	# Also see snapshot_autoextend_percent.
1682
	# Automatic extension requires dmeventd to be monitoring the LV.
203 - 1683
	#
192 - 1684
	# Example
1685
	# Using 70% autoextend threshold and 20% autoextend size, when a 1G
1686
	# snapshot exceeds 700M, it is extended to 1.2G, and when it exceeds
1687
	# 840M, it is extended to 1.44G:
1688
	# snapshot_autoextend_threshold = 70
203 - 1689
	#
204 - 1690
	# This configuration option has an automatic default value.
1691
	# snapshot_autoextend_threshold = 100
192 - 1692
 
1693
	# Configuration option activation/snapshot_autoextend_percent.
1694
	# Auto-extending a snapshot adds this percent extra space.
1695
	# The amount of additional space added to a snapshot is this
1696
	# percent of its current size.
203 - 1697
	#
192 - 1698
	# Example
1699
	# Using 70% autoextend threshold and 20% autoextend size, when a 1G
1700
	# snapshot exceeds 700M, it is extended to 1.2G, and when it exceeds
1701
	# 840M, it is extended to 1.44G:
1702
	# snapshot_autoextend_percent = 20
203 - 1703
	#
204 - 1704
	# This configuration option has an automatic default value.
1705
	# snapshot_autoextend_percent = 20
192 - 1706
 
1707
	# Configuration option activation/thin_pool_autoextend_threshold.
1708
	# Auto-extend a thin pool when its usage exceeds this percent.
1709
	# Setting this to 100 disables automatic extension.
1710
	# The minimum value is 50 (a smaller value is treated as 50.)
1711
	# Also see thin_pool_autoextend_percent.
1712
	# Automatic extension requires dmeventd to be monitoring the LV.
203 - 1713
	#
192 - 1714
	# Example
1715
	# Using 70% autoextend threshold and 20% autoextend size, when a 1G
1716
	# thin pool exceeds 700M, it is extended to 1.2G, and when it exceeds
1717
	# 840M, it is extended to 1.44G:
1718
	# thin_pool_autoextend_threshold = 70
203 - 1719
	#
204 - 1720
	# This configuration option has an automatic default value.
1721
	# thin_pool_autoextend_threshold = 100
192 - 1722
 
1723
	# Configuration option activation/thin_pool_autoextend_percent.
1724
	# Auto-extending a thin pool adds this percent extra space.
1725
	# The amount of additional space added to a thin pool is this
1726
	# percent of its current size.
203 - 1727
	#
192 - 1728
	# Example
1729
	# Using 70% autoextend threshold and 20% autoextend size, when a 1G
1730
	# thin pool exceeds 700M, it is extended to 1.2G, and when it exceeds
1731
	# 840M, it is extended to 1.44G:
1732
	# thin_pool_autoextend_percent = 20
203 - 1733
	#
204 - 1734
	# This configuration option has an automatic default value.
1735
	# thin_pool_autoextend_percent = 20
192 - 1736
 
1737
	# Configuration option activation/vdo_pool_autoextend_threshold.
1738
	# Auto-extend a VDO pool when its usage exceeds this percent.
1739
	# Setting this to 100 disables automatic extension.
1740
	# The minimum value is 50 (a smaller value is treated as 50.)
1741
	# Also see vdo_pool_autoextend_percent.
1742
	# Automatic extension requires dmeventd to be monitoring the LV.
203 - 1743
	#
192 - 1744
	# Example
1745
	# Using 70% autoextend threshold and 20% autoextend size, when a 10G
1746
	# VDO pool exceeds 7G, it is extended to 12G, and when it exceeds
1747
	# 8.4G, it is extended to 14.4G:
1748
	# vdo_pool_autoextend_threshold = 70
203 - 1749
	#
192 - 1750
	# This configuration option has an automatic default value.
1751
	# vdo_pool_autoextend_threshold = 100
1752
 
1753
	# Configuration option activation/vdo_pool_autoextend_percent.
1754
	# Auto-extending a VDO pool adds this percent extra space.
1755
	# The amount of additional space added to a VDO pool is this
1756
	# percent of its current size.
203 - 1757
	#
192 - 1758
	# Example
1759
	# Using 70% autoextend threshold and 20% autoextend size, when a 10G
1760
	# VDO pool exceeds 7G, it is extended to 12G, and when it exceeds
1761
	# 8.4G, it is extended to 14.4G:
1762
	# This configuration option has an automatic default value.
1763
	# vdo_pool_autoextend_percent = 20
1764
 
1765
	# Configuration option activation/mlock_filter.
1766
	# Do not mlock these memory areas.
1767
	# While activating devices, I/O to devices being (re)configured is
1768
	# suspended. As a precaution against deadlocks, LVM pins memory it is
1769
	# using so it is not paged out, and will not require I/O to reread.
1770
	# Groups of pages that are known not to be accessed during activation
1771
	# do not need to be pinned into memory. Each string listed in this
1772
	# setting is compared against each line in /proc/self/maps, and the
1773
	# pages corresponding to lines that match are not pinned. On some
1774
	# systems, locale-archive was found to make up over 80% of the memory
1775
	# used by the process.
203 - 1776
	#
192 - 1777
	# Example
1778
	# mlock_filter = [ "locale/locale-archive", "gconv/gconv-modules.cache" ]
203 - 1779
	#
192 - 1780
	# This configuration option is advanced.
1781
	# This configuration option does not have a default value defined.
1782
 
1783
	# Configuration option activation/use_mlockall.
1784
	# Use the old behavior of mlockall to pin all memory.
1785
	# Prior to version 2.02.62, LVM used mlockall() to pin the whole
1786
	# process's memory while activating devices.
1787
	# This configuration option has an automatic default value.
1788
	# use_mlockall = 0
1789
 
1790
	# Configuration option activation/monitoring.
1791
	# Monitor LVs that are activated.
1792
	# The --ignoremonitoring option overrides this setting.
1793
	# When enabled, LVM will ask dmeventd to monitor activated LVs.
204 - 1794
	# This configuration option has an automatic default value.
1795
	# monitoring = 1
192 - 1796
 
1797
	# Configuration option activation/polling_interval.
1798
	# Check pvmove or lvconvert progress at this interval (seconds).
1799
	# When pvmove or lvconvert must wait for the kernel to finish
1800
	# synchronising or merging data, they check and report progress at
1801
	# intervals of this number of seconds. If this is set to 0 and there
1802
	# is only one thing to wait for, there are no progress reports, but
1803
	# the process is awoken immediately once the operation is complete.
1804
	# This configuration option has an automatic default value.
1805
	# polling_interval = 15
1806
 
1807
	# Configuration option activation/auto_set_activation_skip.
1808
	# Set the activation skip flag on new thin snapshot LVs.
1809
	# The --setactivationskip option overrides this setting.
1810
	# An LV can have a persistent 'activation skip' flag. The flag causes
1811
	# the LV to be skipped during normal activation. The lvchange/vgchange
1812
	# -K option is required to activate LVs that have the activation skip
1813
	# flag set. When this setting is enabled, the activation skip flag is
1814
	# set on new thin snapshot LVs.
1815
	# This configuration option has an automatic default value.
1816
	# auto_set_activation_skip = 1
1817
 
1818
	# Configuration option activation/activation_mode.
1819
	# How LVs with missing devices are activated.
1820
	# The --activationmode option overrides this setting.
203 - 1821
	#
192 - 1822
	# Accepted values:
1823
	#   complete
1824
	#     Only allow activation of an LV if all of the Physical Volumes it
1825
	#     uses are present. Other PVs in the Volume Group may be missing.
1826
	#   degraded
1827
	#     Like complete, but additionally RAID LVs of segment type raid1,
1828
	#     raid4, raid5, radid6 and raid10 will be activated if there is no
1829
	#     data loss, i.e. they have sufficient redundancy to present the
1830
	#     entire addressable range of the Logical Volume.
1831
	#   partial
1832
	#     Allows the activation of any LV even if a missing or failed PV
1833
	#     could cause data loss with a portion of the LV inaccessible.
1834
	#     This setting should not normally be used, but may sometimes
1835
	#     assist with data recovery.
203 - 1836
	#
204 - 1837
	# This configuration option has an automatic default value.
1838
	# activation_mode = "degraded"
192 - 1839
 
1840
	# Configuration option activation/lock_start_list.
1841
	# Locking is started only for VGs selected by this list.
1842
	# The rules are the same as those for volume_list.
1843
	# This configuration option does not have a default value defined.
1844
 
1845
	# Configuration option activation/auto_lock_start_list.
1846
	# Locking is auto-started only for VGs selected by this list.
1847
	# The rules are the same as those for auto_activation_volume_list.
1848
	# This configuration option does not have a default value defined.
1849
}
1850
 
1851
# Configuration section metadata.
1852
# This configuration section has an automatic default value.
1853
# metadata {
1854
 
1855
	# Configuration option metadata/check_pv_device_sizes.
1856
	# Check device sizes are not smaller than corresponding PV sizes.
1857
	# If device size is less than corresponding PV size found in metadata,
1858
	# there is always a risk of data loss. If this option is set, then LVM
1859
	# issues a warning message each time it finds that the device size is
1860
	# less than corresponding PV size. You should not disable this unless
1861
	# you are absolutely sure about what you are doing!
1862
	# This configuration option is advanced.
1863
	# This configuration option has an automatic default value.
1864
	# check_pv_device_sizes = 1
1865
 
1866
	# Configuration option metadata/record_lvs_history.
1867
	# When enabled, LVM keeps history records about removed LVs in
1868
	# metadata. The information that is recorded in metadata for
1869
	# historical LVs is reduced when compared to original
1870
	# information kept in metadata for live LVs. Currently, this
1871
	# feature is supported for thin and thin snapshot LVs only.
1872
	# This configuration option has an automatic default value.
1873
	# record_lvs_history = 0
1874
 
1875
	# Configuration option metadata/lvs_history_retention_time.
1876
	# Retention time in seconds after which a record about individual
1877
	# historical logical volume is automatically destroyed.
1878
	# A value of 0 disables this feature.
1879
	# This configuration option has an automatic default value.
1880
	# lvs_history_retention_time = 0
1881
 
1882
	# Configuration option metadata/pvmetadatacopies.
1883
	# Number of copies of metadata to store on each PV.
1884
	# The --pvmetadatacopies option overrides this setting.
203 - 1885
	#
192 - 1886
	# Accepted values:
1887
	#   2
1888
	#     Two copies of the VG metadata are stored on the PV, one at the
1889
	#     front of the PV, and one at the end.
1890
	#   1
1891
	#     One copy of VG metadata is stored at the front of the PV.
1892
	#   0
1893
	#     No copies of VG metadata are stored on the PV. This may be
1894
	#     useful for VGs containing large numbers of PVs.
203 - 1895
	#
192 - 1896
	# This configuration option is advanced.
1897
	# This configuration option has an automatic default value.
1898
	# pvmetadatacopies = 1
1899
 
1900
	# Configuration option metadata/vgmetadatacopies.
1901
	# Number of copies of metadata to maintain for each VG.
1902
	# The --vgmetadatacopies option overrides this setting.
1903
	# If set to a non-zero value, LVM automatically chooses which of the
1904
	# available metadata areas to use to achieve the requested number of
1905
	# copies of the VG metadata. If you set a value larger than the the
1906
	# total number of metadata areas available, then metadata is stored in
1907
	# them all. The value 0 (unmanaged) disables this automatic management
1908
	# and allows you to control which metadata areas are used at the
1909
	# individual PV level using pvchange --metadataignore y|n.
1910
	# This configuration option has an automatic default value.
1911
	# vgmetadatacopies = 0
1912
 
1913
	# Configuration option metadata/pvmetadatasize.
1914
	# The default size of the metadata area in units of 512 byte sectors.
1915
	# The metadata area begins at an offset of the page size from the start
1916
	# of the device. The first PE is by default at 1 MiB from the start of
1917
	# the device. The space between these is the default metadata area size.
1918
	# The actual size of the metadata area may be larger than what is set
1919
	# here due to default_data_alignment making the first PE a MiB multiple.
1920
	# The metadata area begins with a 512 byte header and is followed by a
1921
	# circular buffer used for VG metadata text. The maximum size of the VG
1922
	# metadata is about half the size of the metadata buffer. VGs with large
1923
	# numbers of PVs or LVs, or VGs containing complex LV structures, may need
1924
	# additional space for VG metadata. The --metadatasize option overrides
1925
	# this setting.
1926
	# This configuration option does not have a default value defined.
1927
 
1928
	# Configuration option metadata/pvmetadataignore.
1929
	# Ignore metadata areas on a new PV.
1930
	# The --metadataignore option overrides this setting.
1931
	# If metadata areas on a PV are ignored, LVM will not store metadata
1932
	# in them.
1933
	# This configuration option is advanced.
1934
	# This configuration option has an automatic default value.
1935
	# pvmetadataignore = 0
1936
 
1937
	# Configuration option metadata/stripesize.
1938
	# This configuration option is advanced.
1939
	# This configuration option has an automatic default value.
1940
	# stripesize = 64
1941
# }
1942
 
1943
# Configuration section report.
1944
# LVM report command output formatting.
1945
# This configuration section has an automatic default value.
1946
# report {
1947
 
1948
	# Configuration option report/output_format.
1949
	# Format of LVM command's report output.
1950
	# If there is more than one report per command, then the format
1951
	# is applied for all reports. You can also change output format
1952
	# directly on command line using --reportformat option which
1953
	# has precedence over log/output_format setting.
1954
	# Accepted values:
1955
	#   basic
1956
	#     Original format with columns and rows. If there is more than
1957
	#     one report per command, each report is prefixed with report's
1958
	#     name for identification.
1959
	#   json
1960
	#     JSON format.
1961
	# This configuration option has an automatic default value.
1962
	# output_format = "basic"
1963
 
1964
	# Configuration option report/compact_output.
1965
	# Do not print empty values for all report fields.
1966
	# If enabled, all fields that don't have a value set for any of the
1967
	# rows reported are skipped and not printed. Compact output is
1968
	# applicable only if report/buffered is enabled. If you need to
1969
	# compact only specified fields, use compact_output=0 and define
1970
	# report/compact_output_cols configuration setting instead.
1971
	# This configuration option has an automatic default value.
1972
	# compact_output = 0
1973
 
1974
	# Configuration option report/compact_output_cols.
1975
	# Do not print empty values for specified report fields.
1976
	# If defined, specified fields that don't have a value set for any
1977
	# of the rows reported are skipped and not printed. Compact output
1978
	# is applicable only if report/buffered is enabled. If you need to
1979
	# compact all fields, use compact_output=1 instead in which case
1980
	# the compact_output_cols setting is then ignored.
1981
	# This configuration option has an automatic default value.
1982
	# compact_output_cols = ""
1983
 
1984
	# Configuration option report/aligned.
1985
	# Align columns in report output.
1986
	# This configuration option has an automatic default value.
1987
	# aligned = 1
1988
 
1989
	# Configuration option report/buffered.
1990
	# Buffer report output.
1991
	# When buffered reporting is used, the report's content is appended
1992
	# incrementally to include each object being reported until the report
1993
	# is flushed to output which normally happens at the end of command
1994
	# execution. Otherwise, if buffering is not used, each object is
1995
	# reported as soon as its processing is finished.
1996
	# This configuration option has an automatic default value.
1997
	# buffered = 1
1998
 
1999
	# Configuration option report/headings.
2000
	# Show headings for columns on report.
2001
	# This configuration option has an automatic default value.
2002
	# headings = 1
2003
 
2004
	# Configuration option report/separator.
2005
	# A separator to use on report after each field.
2006
	# This configuration option has an automatic default value.
2007
	# separator = " "
2008
 
2009
	# Configuration option report/list_item_separator.
2010
	# A separator to use for list items when reported.
2011
	# This configuration option has an automatic default value.
2012
	# list_item_separator = ","
2013
 
2014
	# Configuration option report/prefixes.
2015
	# Use a field name prefix for each field reported.
2016
	# This configuration option has an automatic default value.
2017
	# prefixes = 0
2018
 
2019
	# Configuration option report/quoted.
2020
	# Quote field values when using field name prefixes.
2021
	# This configuration option has an automatic default value.
2022
	# quoted = 1
2023
 
2024
	# Configuration option report/columns_as_rows.
2025
	# Output each column as a row.
2026
	# If set, this also implies report/prefixes=1.
2027
	# This configuration option has an automatic default value.
2028
	# columns_as_rows = 0
2029
 
2030
	# Configuration option report/binary_values_as_numeric.
2031
	# Use binary values 0 or 1 instead of descriptive literal values.
2032
	# For columns that have exactly two valid values to report
2033
	# (not counting the 'unknown' value which denotes that the
2034
	# value could not be determined).
2035
	# This configuration option has an automatic default value.
2036
	# binary_values_as_numeric = 0
2037
 
2038
	# Configuration option report/time_format.
2039
	# Set time format for fields reporting time values.
2040
	# Format specification is a string which may contain special character
2041
	# sequences and ordinary character sequences. Ordinary character
2042
	# sequences are copied verbatim. Each special character sequence is
2043
	# introduced by the '%' character and such sequence is then
2044
	# substituted with a value as described below.
203 - 2045
	#
192 - 2046
	# Accepted values:
2047
	#   %a
2048
	#     The abbreviated name of the day of the week according to the
2049
	#     current locale.
2050
	#   %A
2051
	#     The full name of the day of the week according to the current
2052
	#     locale.
2053
	#   %b
2054
	#     The abbreviated month name according to the current locale.
2055
	#   %B
2056
	#     The full month name according to the current locale.
2057
	#   %c
2058
	#     The preferred date and time representation for the current
2059
	#     locale (alt E)
2060
	#   %C
2061
	#     The century number (year/100) as a 2-digit integer. (alt E)
2062
	#   %d
2063
	#     The day of the month as a decimal number (range 01 to 31).
2064
	#     (alt O)
2065
	#   %D
2066
	#     Equivalent to %m/%d/%y. (For Americans only. Americans should
2067
	#     note that in other countries%d/%m/%y is rather common. This
2068
	#     means that in international context this format is ambiguous and
2069
	#     should not be used.
2070
	#   %e
2071
	#     Like %d, the day of the month as a decimal number, but a leading
2072
	#     zero is replaced by a space. (alt O)
2073
	#   %E
2074
	#     Modifier: use alternative local-dependent representation if
2075
	#     available.
2076
	#   %F
2077
	#     Equivalent to %Y-%m-%d (the ISO 8601 date format).
2078
	#   %G
2079
	#     The ISO 8601 week-based year with century as adecimal number.
2080
	#     The 4-digit year corresponding to the ISO week number (see %V).
2081
	#     This has the same format and value as %Y, except that if the
2082
	#     ISO week number belongs to the previous or next year, that year
2083
	#     is used instead.
2084
	#   %g
2085
	#     Like %G, but without century, that is, with a 2-digit year
2086
	#     (00-99).
2087
	#   %h
2088
	#     Equivalent to %b.
2089
	#   %H
2090
	#     The hour as a decimal number using a 24-hour clock
2091
	#     (range 00 to 23). (alt O)
2092
	#   %I
2093
	#     The hour as a decimal number using a 12-hour clock
2094
	#     (range 01 to 12). (alt O)
2095
	#   %j
2096
	#     The day of the year as a decimal number (range 001 to 366).
2097
	#   %k
2098
	#     The hour (24-hour clock) as a decimal number (range 0 to 23);
2099
	#     single digits are preceded by a blank. (See also %H.)
2100
	#   %l
2101
	#     The hour (12-hour clock) as a decimal number (range 1 to 12);
2102
	#     single digits are preceded by a blank. (See also %I.)
2103
	#   %m
2104
	#     The month as a decimal number (range 01 to 12). (alt O)
2105
	#   %M
2106
	#     The minute as a decimal number (range 00 to 59). (alt O)
2107
	#   %O
2108
	#     Modifier: use alternative numeric symbols.
2109
	#   %p
2110
	#     Either "AM" or "PM" according to the given time value,
2111
	#     or the corresponding strings for the current locale. Noon is
2112
	#     treated as "PM" and midnight as "AM".
2113
	#   %P
2114
	#     Like %p but in lowercase: "am" or "pm" or a corresponding
2115
	#     string for the current locale.
2116
	#   %r
2117
	#     The time in a.m. or p.m. notation. In the POSIX locale this is
2118
	#     equivalent to %I:%M:%S %p.
2119
	#   %R
2120
	#     The time in 24-hour notation (%H:%M). For a version including
2121
	#     the seconds, see %T below.
2122
	#   %s
2123
	#     The number of seconds since the Epoch,
2124
	#     1970-01-01 00:00:00 +0000 (UTC)
2125
	#   %S
2126
	#     The second as a decimal number (range 00 to 60). (The range is
2127
	#     up to 60 to allow for occasional leap seconds.) (alt O)
2128
	#   %t
2129
	#     A tab character.
2130
	#   %T
2131
	#     The time in 24-hour notation (%H:%M:%S).
2132
	#   %u
2133
	#     The day of the week as a decimal, range 1 to 7, Monday being 1.
2134
	#     See also %w. (alt O)
2135
	#   %U
2136
	#     The week number of the current year as a decimal number,
2137
	#     range 00 to 53, starting with the first Sunday as the first
2138
	#     day of week 01. See also %V and %W. (alt O)
2139
	#   %V
2140
	#     The ISO 8601 week number of the current year as a decimal number,
2141
	#     range 01 to 53, where week 1 is the first week that has at least
2142
	#     4 days in the new year. See also %U and %W. (alt O)
2143
	#   %w
2144
	#     The day of the week as a decimal, range 0 to 6, Sunday being 0.
2145
	#     See also %u. (alt O)
2146
	#   %W
2147
	#     The week number of the current year as a decimal number,
2148
	#     range 00 to 53, starting with the first Monday as the first day
2149
	#     of week 01. (alt O)
2150
	#   %x
2151
	#     The preferred date representation for the current locale without
2152
	#     the time. (alt E)
2153
	#   %X
2154
	#     The preferred time representation for the current locale without
2155
	#     the date. (alt E)
2156
	#   %y
2157
	#     The year as a decimal number without a century (range 00 to 99).
2158
	#     (alt E, alt O)
2159
	#   %Y
2160
	#     The year as a decimal number including the century. (alt E)
2161
	#   %z
2162
	#     The +hhmm or -hhmm numeric timezone (that is, the hour and minute
2163
	#     offset from UTC).
2164
	#   %Z
2165
	#     The timezone name or abbreviation.
2166
	#   %%
2167
	#     A literal '%' character.
203 - 2168
	#
192 - 2169
	# This configuration option has an automatic default value.
2170
	# time_format = "%Y-%m-%d %T %z"
2171
 
2172
	# Configuration option report/devtypes_sort.
2173
	# List of columns to sort by when reporting 'lvm devtypes' command.
2174
	# See 'lvm devtypes -o help' for the list of possible fields.
2175
	# This configuration option has an automatic default value.
2176
	# devtypes_sort = "devtype_name"
2177
 
2178
	# Configuration option report/devtypes_cols.
2179
	# List of columns to report for 'lvm devtypes' command.
2180
	# See 'lvm devtypes -o help' for the list of possible fields.
2181
	# This configuration option has an automatic default value.
2182
	# devtypes_cols = "devtype_name,devtype_max_partitions,devtype_description"
2183
 
2184
	# Configuration option report/devtypes_cols_verbose.
2185
	# List of columns to report for 'lvm devtypes' command in verbose mode.
2186
	# See 'lvm devtypes -o help' for the list of possible fields.
2187
	# This configuration option has an automatic default value.
2188
	# devtypes_cols_verbose = "devtype_name,devtype_max_partitions,devtype_description"
2189
 
2190
	# Configuration option report/lvs_sort.
2191
	# List of columns to sort by when reporting 'lvs' command.
2192
	# See 'lvs -o help' for the list of possible fields.
2193
	# This configuration option has an automatic default value.
2194
	# lvs_sort = "vg_name,lv_name"
2195
 
2196
	# Configuration option report/lvs_cols.
2197
	# List of columns to report for 'lvs' command.
2198
	# See 'lvs -o help' for the list of possible fields.
2199
	# This configuration option has an automatic default value.
2200
	# lvs_cols = "lv_name,vg_name,lv_attr,lv_size,pool_lv,origin,data_percent,metadata_percent,move_pv,mirror_log,copy_percent,convert_lv"
2201
 
2202
	# Configuration option report/lvs_cols_verbose.
2203
	# List of columns to report for 'lvs' command in verbose mode.
2204
	# See 'lvs -o help' for the list of possible fields.
2205
	# This configuration option has an automatic default value.
2206
	# lvs_cols_verbose = "lv_name,vg_name,seg_count,lv_attr,lv_size,lv_major,lv_minor,lv_kernel_major,lv_kernel_minor,pool_lv,origin,data_percent,metadata_percent,move_pv,copy_percent,mirror_log,convert_lv,lv_uuid,lv_profile"
2207
 
2208
	# Configuration option report/vgs_sort.
2209
	# List of columns to sort by when reporting 'vgs' command.
2210
	# See 'vgs -o help' for the list of possible fields.
2211
	# This configuration option has an automatic default value.
2212
	# vgs_sort = "vg_name"
2213
 
2214
	# Configuration option report/vgs_cols.
2215
	# List of columns to report for 'vgs' command.
2216
	# See 'vgs -o help' for the list of possible fields.
2217
	# This configuration option has an automatic default value.
2218
	# vgs_cols = "vg_name,pv_count,lv_count,snap_count,vg_attr,vg_size,vg_free"
2219
 
2220
	# Configuration option report/vgs_cols_verbose.
2221
	# List of columns to report for 'vgs' command in verbose mode.
2222
	# See 'vgs -o help' for the list of possible fields.
2223
	# This configuration option has an automatic default value.
2224
	# vgs_cols_verbose = "vg_name,vg_attr,vg_extent_size,pv_count,lv_count,snap_count,vg_size,vg_free,vg_uuid,vg_profile"
2225
 
2226
	# Configuration option report/pvs_sort.
2227
	# List of columns to sort by when reporting 'pvs' command.
2228
	# See 'pvs -o help' for the list of possible fields.
2229
	# This configuration option has an automatic default value.
2230
	# pvs_sort = "pv_name"
2231
 
2232
	# Configuration option report/pvs_cols.
2233
	# List of columns to report for 'pvs' command.
2234
	# See 'pvs -o help' for the list of possible fields.
2235
	# This configuration option has an automatic default value.
2236
	# pvs_cols = "pv_name,vg_name,pv_fmt,pv_attr,pv_size,pv_free"
2237
 
2238
	# Configuration option report/pvs_cols_verbose.
2239
	# List of columns to report for 'pvs' command in verbose mode.
2240
	# See 'pvs -o help' for the list of possible fields.
2241
	# This configuration option has an automatic default value.
2242
	# pvs_cols_verbose = "pv_name,vg_name,pv_fmt,pv_attr,pv_size,pv_free,dev_size,pv_uuid"
2243
 
2244
	# Configuration option report/segs_sort.
2245
	# List of columns to sort by when reporting 'lvs --segments' command.
2246
	# See 'lvs --segments -o help' for the list of possible fields.
2247
	# This configuration option has an automatic default value.
2248
	# segs_sort = "vg_name,lv_name,seg_start"
2249
 
2250
	# Configuration option report/segs_cols.
2251
	# List of columns to report for 'lvs --segments' command.
2252
	# See 'lvs --segments -o help' for the list of possible fields.
2253
	# This configuration option has an automatic default value.
2254
	# segs_cols = "lv_name,vg_name,lv_attr,stripes,segtype,seg_size"
2255
 
2256
	# Configuration option report/segs_cols_verbose.
2257
	# List of columns to report for 'lvs --segments' command in verbose mode.
2258
	# See 'lvs --segments -o help' for the list of possible fields.
2259
	# This configuration option has an automatic default value.
2260
	# segs_cols_verbose = "lv_name,vg_name,lv_attr,seg_start,seg_size,stripes,segtype,stripesize,chunksize"
2261
 
2262
	# Configuration option report/pvsegs_sort.
2263
	# List of columns to sort by when reporting 'pvs --segments' command.
2264
	# See 'pvs --segments -o help' for the list of possible fields.
2265
	# This configuration option has an automatic default value.
2266
	# pvsegs_sort = "pv_name,pvseg_start"
2267
 
2268
	# Configuration option report/pvsegs_cols.
2269
	# List of columns to sort by when reporting 'pvs --segments' command.
2270
	# See 'pvs --segments -o help' for the list of possible fields.
2271
	# This configuration option has an automatic default value.
2272
	# pvsegs_cols = "pv_name,vg_name,pv_fmt,pv_attr,pv_size,pv_free,pvseg_start,pvseg_size"
2273
 
2274
	# Configuration option report/pvsegs_cols_verbose.
2275
	# List of columns to sort by when reporting 'pvs --segments' command in verbose mode.
2276
	# See 'pvs --segments -o help' for the list of possible fields.
2277
	# This configuration option has an automatic default value.
2278
	# pvsegs_cols_verbose = "pv_name,vg_name,pv_fmt,pv_attr,pv_size,pv_free,pvseg_start,pvseg_size,lv_name,seg_start_pe,segtype,seg_pe_ranges"
2279
 
2280
	# Configuration option report/vgs_cols_full.
2281
	# List of columns to report for lvm fullreport's 'vgs' subreport.
2282
	# See 'vgs -o help' for the list of possible fields.
2283
	# This configuration option has an automatic default value.
2284
	# vgs_cols_full = "vg_all"
2285
 
2286
	# Configuration option report/pvs_cols_full.
2287
	# List of columns to report for lvm fullreport's 'vgs' subreport.
2288
	# See 'pvs -o help' for the list of possible fields.
2289
	# This configuration option has an automatic default value.
2290
	# pvs_cols_full = "pv_all"
2291
 
2292
	# Configuration option report/lvs_cols_full.
2293
	# List of columns to report for lvm fullreport's 'lvs' subreport.
2294
	# See 'lvs -o help' for the list of possible fields.
2295
	# This configuration option has an automatic default value.
2296
	# lvs_cols_full = "lv_all"
2297
 
2298
	# Configuration option report/pvsegs_cols_full.
2299
	# List of columns to report for lvm fullreport's 'pvseg' subreport.
2300
	# See 'pvs --segments -o help' for the list of possible fields.
2301
	# This configuration option has an automatic default value.
2302
	# pvsegs_cols_full = "pvseg_all,pv_uuid,lv_uuid"
2303
 
2304
	# Configuration option report/segs_cols_full.
2305
	# List of columns to report for lvm fullreport's 'seg' subreport.
2306
	# See 'lvs --segments -o help' for the list of possible fields.
2307
	# This configuration option has an automatic default value.
2308
	# segs_cols_full = "seg_all,lv_uuid"
2309
 
2310
	# Configuration option report/vgs_sort_full.
2311
	# List of columns to sort by when reporting lvm fullreport's 'vgs' subreport.
2312
	# See 'vgs -o help' for the list of possible fields.
2313
	# This configuration option has an automatic default value.
2314
	# vgs_sort_full = "vg_name"
2315
 
2316
	# Configuration option report/pvs_sort_full.
2317
	# List of columns to sort by when reporting lvm fullreport's 'vgs' subreport.
2318
	# See 'pvs -o help' for the list of possible fields.
2319
	# This configuration option has an automatic default value.
2320
	# pvs_sort_full = "pv_name"
2321
 
2322
	# Configuration option report/lvs_sort_full.
2323
	# List of columns to sort by when reporting lvm fullreport's 'lvs' subreport.
2324
	# See 'lvs -o help' for the list of possible fields.
2325
	# This configuration option has an automatic default value.
2326
	# lvs_sort_full = "vg_name,lv_name"
2327
 
2328
	# Configuration option report/pvsegs_sort_full.
2329
	# List of columns to sort by when reporting for lvm fullreport's 'pvseg' subreport.
2330
	# See 'pvs --segments -o help' for the list of possible fields.
2331
	# This configuration option has an automatic default value.
2332
	# pvsegs_sort_full = "pv_uuid,pvseg_start"
2333
 
2334
	# Configuration option report/segs_sort_full.
2335
	# List of columns to sort by when reporting lvm fullreport's 'seg' subreport.
2336
	# See 'lvs --segments -o help' for the list of possible fields.
2337
	# This configuration option has an automatic default value.
2338
	# segs_sort_full = "lv_uuid,seg_start"
2339
 
2340
	# Configuration option report/mark_hidden_devices.
2341
	# Use brackets [] to mark hidden devices.
2342
	# This configuration option has an automatic default value.
2343
	# mark_hidden_devices = 1
2344
 
2345
	# Configuration option report/two_word_unknown_device.
2346
	# Use the two words 'unknown device' in place of '[unknown]'.
2347
	# This is displayed when the device for a PV is not known.
2348
	# This configuration option has an automatic default value.
2349
	# two_word_unknown_device = 0
2350
# }
2351
 
2352
# Configuration section dmeventd.
2353
# Settings for the LVM event daemon.
2354
dmeventd {
2355
 
2356
	# Configuration option dmeventd/mirror_library.
2357
	# The library dmeventd uses when monitoring a mirror device.
2358
	# libdevmapper-event-lvm2mirror.so attempts to recover from
2359
	# failures. It removes failed devices from a volume group and
2360
	# reconfigures a mirror as necessary. If no mirror library is
2361
	# provided, mirrors are not monitored through dmeventd.
2362
	# This configuration option has an automatic default value.
2363
	# mirror_library = "libdevmapper-event-lvm2mirror.so"
2364
 
2365
	# Configuration option dmeventd/raid_library.
2366
	# This configuration option has an automatic default value.
2367
	# raid_library = "libdevmapper-event-lvm2raid.so"
2368
 
2369
	# Configuration option dmeventd/snapshot_library.
2370
	# The library dmeventd uses when monitoring a snapshot device.
2371
	# libdevmapper-event-lvm2snapshot.so monitors the filling of snapshots
2372
	# and emits a warning through syslog when the usage exceeds 80%. The
2373
	# warning is repeated when 85%, 90% and 95% of the snapshot is filled.
2374
	# This configuration option has an automatic default value.
2375
	# snapshot_library = "libdevmapper-event-lvm2snapshot.so"
2376
 
2377
	# Configuration option dmeventd/thin_library.
2378
	# The library dmeventd uses when monitoring a thin device.
2379
	# libdevmapper-event-lvm2thin.so monitors the filling of a pool
2380
	# and emits a warning through syslog when the usage exceeds 80%. The
2381
	# warning is repeated when 85%, 90% and 95% of the pool is filled.
2382
	# This configuration option has an automatic default value.
2383
	# thin_library = "libdevmapper-event-lvm2thin.so"
2384
 
2385
	# Configuration option dmeventd/thin_command.
2386
	# The plugin runs command with each 5% increment when thin-pool data volume
2387
	# or metadata volume gets above 50%.
2388
	# Command which starts with 'lvm ' prefix is internal lvm command.
2389
	# You can write your own handler to customise behaviour in more details.
2390
	# User handler is specified with the full path starting with '/'.
2391
	# This configuration option has an automatic default value.
2392
	# thin_command = "lvm lvextend --use-policies"
2393
 
2394
	# Configuration option dmeventd/vdo_library.
2395
	# The library dmeventd uses when monitoring a VDO pool device.
2396
	# libdevmapper-event-lvm2vdo.so monitors the filling of a pool
2397
	# and emits a warning through syslog when the usage exceeds 80%. The
2398
	# warning is repeated when 85%, 90% and 95% of the pool is filled.
2399
	# This configuration option has an automatic default value.
2400
	# vdo_library = "libdevmapper-event-lvm2vdo.so"
2401
 
2402
	# Configuration option dmeventd/vdo_command.
2403
	# The plugin runs command with each 5% increment when VDO pool volume
2404
	# gets above 50%.
2405
	# Command which starts with 'lvm ' prefix is internal lvm command.
2406
	# You can write your own handler to customise behaviour in more details.
2407
	# User handler is specified with the full path starting with '/'.
2408
	# This configuration option has an automatic default value.
2409
	# vdo_command = "lvm lvextend --use-policies"
2410
 
2411
	# Configuration option dmeventd/executable.
2412
	# The full path to the dmeventd binary.
2413
	# This configuration option has an automatic default value.
2414
	# executable = "/usr/sbin/dmeventd"
2415
}
2416
 
2417
# Configuration section tags.
2418
# Host tag settings.
2419
# This configuration section has an automatic default value.
2420
# tags {
2421
 
2422
	# Configuration option tags/hosttags.
2423
	# Create a host tag using the machine name.
2424
	# The machine name is nodename returned by uname(2).
2425
	# This configuration option has an automatic default value.
2426
	# hosttags = 0
2427
 
2428
	# Configuration section tags/<tag>.
2429
	# Replace this subsection name with a custom tag name.
2430
	# Multiple subsections like this can be created. The '@' prefix for
2431
	# tags is optional. This subsection can contain host_list, which is a
2432
	# list of machine names. If the name of the local machine is found in
2433
	# host_list, then the name of this subsection is used as a tag and is
2434
	# applied to the local machine as a 'host tag'. If this subsection is
2435
	# empty (has no host_list), then the subsection name is always applied
2436
	# as a 'host tag'.
203 - 2437
	#
192 - 2438
	# Example
2439
	# The host tag foo is given to all hosts, and the host tag
2440
	# bar is given to the hosts named machine1 and machine2.
2441
	# tags { foo { } bar { host_list = [ "machine1", "machine2" ] } }
203 - 2442
	#
192 - 2443
	# This configuration section has variable name.
2444
	# This configuration section has an automatic default value.
2445
	# tag {
2446
 
2447
		# Configuration option tags/<tag>/host_list.
2448
		# A list of machine names.
2449
		# These machine names are compared to the nodename returned
2450
		# by uname(2). If the local machine name matches an entry in
2451
		# this list, the name of the subsection is applied to the
2452
		# machine as a 'host tag'.
2453
		# This configuration option does not have a default value defined.
2454
	# }
2455
# }