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