--alloc contiguous|cling|cling_by_tags|normal|anywhere|inherit
Determines the allocation policy when a command needs to
allocate Physical Extents (PEs) from the VG. Each VG and
LV has an allocation policy which can be changed with
vgchange/lvchange, or overridden on the command line.
normal applies common sense rules such as not placing
parallel stripes on the same PV. inherit applies the VG
policy to an LV. contiguous requires new PEs be placed
adjacent to existing PEs. cling places new PEs on the
same PV as existing PEs in the same stripe of the LV. If
there are sufficient PEs for an allocation, but normal
does not use them, anywhere will use them even if it
reduces performance, e.g. by placing two stripes on the
same PV. Optional positional PV args on the command line
can also be used to limit which PVs the command will use
for allocation. See lvm(8) for more information about
allocation.
-b|--background
If the operation requires polling, this option causes the
command to return before the operation is complete, and
polling is done in the background.
-H|--cache
Specifies the command is handling a cache LV or cache
pool. See --type cache and --type cache-pool. See
lvmcache(7) for more information about LVM caching.
--cachedevice PV
The name of a device to use for a cache.
--cachemetadataformat auto|1|2
Specifies the cache metadata format used by cache target.
--cachemode writethrough|writeback|passthrough
Specifies when writes to a cache LV should be considered
complete. writeback considers a write complete as soon as
it is stored in the cache pool. writethough considers a
write complete only when it has been stored in both the
cache pool and on the origin LV. While writethrough may
be slower for writes, it is more resilient if something
should happen to a device associated with the cache pool
LV. With passthrough, all reads are served from the origin
LV (all reads miss the cache) and all writes are forwarded
to the origin LV; additionally, write hits cause cache
block invalidates. See lvmcache(7) for more information.
--cachepolicy String
Specifies the cache policy for a cache LV. See
lvmcache(7) for more information.
--cachepool LV
The name of a cache pool.
--cachesettings String
Specifies tunable values for a cache LV in "Key = Value"
form. Repeat this option to specify multiple values.
(The default values should usually be adequate.) The
special string value default switches settings back to
their default kernel values and removes them from the list
of settings stored in LVM metadata. See lvmcache(7) for
more information.
--cachesize Size[m|UNIT]
The size of cache to use.
--cachevol LV
The name of a cache volume.
-c|--chunksize Size[k|UNIT]
The size of chunks in a snapshot, cache pool or thin pool.
For snapshots, the value must be a power of 2 between 4KiB
and 512KiB and the default value is 4. For a cache pool
the value must be between 32KiB and 1GiB and the default
value is 64. For a thin pool the value must be between
64KiB and 1GiB and the default value starts with 64 and
scales up to fit the pool metadata size within 128MiB, if
the pool metadata size is not specified. The value must
be a multiple of 64KiB. See lvmthin(7) and lvmcache(7)
for more information.
--commandprofile String
The command profile to use for command configuration. See
lvm.conf(5) for more information about profiles.
--compression y|n
Controls whether compression is enabled or disable for VDO
volume. See lvmvdo(7) for more information about VDO
usage.
--config String
Config settings for the command. These override
lvm.conf(5) settings. The String arg uses the same format
as lvm.conf(5), or may use section/field syntax. See
lvm.conf(5) for more information about config.
-d|--debug ...
Set debug level. Repeat from 1 to 6 times to increase the
detail of messages sent to the log file and/or syslog (if
configured).
--deduplication y|n
Controls whether deduplication is enabled or disable for
VDO volume. See lvmvdo(7) for more information about VDO
usage.
--devices PV
Devices that the command can use. This option can be
repeated or accepts a comma separated list of devices.
This overrides the devices file.
--devicesfile String
A file listing devices that LVM should use. The file must
exist in /etc/lvm/devices/ and is managed with the
lvmdevices(8) command. This overrides the lvm.conf(5)
devices/devicesfile and devices/use_devicesfile settings.
--discards passdown|nopassdown|ignore
Specifies how the device-mapper thin pool layer in the
kernel should handle discards. ignore causes the thin
pool to ignore discards. nopassdown causes the thin pool
to process discards itself to allow reuse of unneeded
extents in the thin pool. passdown causes the thin pool
to process discards itself (like nopassdown) and pass the
discards to the underlying device. See lvmthin(7) for
more information.
--driverloaded y|n
If set to no, the command will not attempt to use device-
mapper. For testing and debugging.
--errorwhenfull y|n
Specifies thin pool behavior when data space is exhausted.
When yes, device-mapper will immediately return an error
when a thin pool is full and an I/O request requires
space. When no, device-mapper will queue these I/O
requests for a period of time to allow the thin pool to be
extended. Errors are returned if no space is available
after the timeout. (Also see dm-thin-pool kernel module
option no_space_timeout.) See lvmthin(7) for more
information.
-f|--force ...
Override various checks, confirmations and protections.
Use with extreme caution.
-h|--help
Display help text.
-i|--interval Number
Report progress at regular intervals.
--lockopt String
Used to pass options for special cases to lvmlockd. See
lvmlockd(8) for more information.
--longhelp
Display long help text.
--merge
An alias for --mergethin, --mergemirrors, or
--mergesnapshot, depending on the type of LV.
--mergemirrors
Merge LV images that were split from a raid1 LV. See
--splitmirrors with --trackchanges.
--mergesnapshot
Merge COW snapshot LV into its origin. When merging a
snapshot, if both the origin and snapshot LVs are not
open, the merge will start immediately. Otherwise, the
merge will start the first time either the origin or
snapshot LV are activated and both are closed. Merging a
snapshot into an origin that cannot be closed, for example
a root filesystem, is deferred until the next time the
origin volume is activated. When merging starts, the
resulting LV will have the origin's name, minor number and
UUID. While the merge is in progress, reads or writes to
the origin appear as being directed to the snapshot being
merged. When the merge finishes, the merged snapshot is
removed. Multiple snapshots may be specified on the
command line or a @tag may be used to specify multiple
snapshots be merged to their respective origin.
--mergethin
Merge thin LV into its origin LV. The origin thin LV
takes the content of the thin snapshot, and the thin
snapshot LV is removed. See lvmthin(7) for more
information.
--metadataprofile String
The metadata profile to use for command configuration.
See lvm.conf(5) for more information about profiles.
--mirrorlog core|disk
Specifies the type of mirror log for LVs with the "mirror"
type (does not apply to the "raid1" type.) disk is a
persistent log and requires a small amount of storage
space, usually on a separate device from the data being
mirrored. core is not persistent; the log is kept only in
memory. In this case, the mirror must be synchronized (by
copying LV data from the first device to others) each time
the LV is activated, e.g. after reboot. mirrored is a
persistent log that is itself mirrored, but should be
avoided. Instead, use the raid1 type for log redundancy.
-m|--mirrors [+|-]Number
Specifies the number of mirror images in addition to the
original LV image, e.g. --mirrors 1 means there are two
images of the data, the original and one mirror image.
Optional positional PV args on the command line can
specify the devices the images should be placed on. There
are two mirroring implementations: "raid1" and "mirror".
These are the names of the corresponding LV types, or
"segment types". Use the --type option to specify which
to use (raid1 is default, and mirror is legacy) Use
lvm.conf(5) global/mirror_segtype_default and
global/raid10_segtype_default to configure the default
types. The plus prefix + can be used, in which case the
number is added to the current number of images, or the
minus prefix - can be used, in which case the number is
subtracted from the current number of images. See
lvmraid(7) for more information.
-n|--name String
Specifies the name of a new LV. When unspecified, a
default name of "lvol#" is generated, where # is a number
generated by LVM.
--nolocking
Disable locking.
--noudevsync
Disables udev synchronisation. The process will not wait
for notification from udev. It will continue irrespective
of any possible udev processing in the background. Only
use this if udev is not running or has rules that ignore
the devices LVM creates.
--originname LV
Specifies the name to use for the external origin LV when
converting an LV to a thin LV. The LV being converted
becomes a read-only external origin with this name.
--poolmetadata LV
The name of a an LV to use for storing pool metadata.
--poolmetadatasize Size[m|UNIT]
Specifies the size of the new pool metadata LV.
--poolmetadataspare y|n
Enable or disable the automatic creation and management of
a spare pool metadata LV in the VG. A spare metadata LV is
reserved space that can be used when repairing a pool.
--profile String
An alias for --commandprofile or --metadataprofile,
depending on the command.
-q|--quiet ...
Suppress output and log messages. Overrides --debug and
--verbose. Repeat once to also suppress any prompts with
answer 'no'.
--raidintegrity y|n
Enable or disable data integrity checksums for raid
images.
--raidintegrityblocksize Number
The block size to use for dm-integrity on raid images.
The integrity block size should usually match the device
logical block size, or the file system block size. It may
be less than the file system block size, but not less than
the device logical block size. Possible values: 512,
1024, 2048, 4096.
--raidintegritymode String
Use a journal (default) or bitmap for keeping integrity
checksums consistent in case of a crash. The bitmap areas
are recalculated after a crash, so corruption in those
areas would not be detected. A journal does not have this
problem. The journal mode doubles writes to storage, but
can improve performance for scattered writes packed into a
single journal write. bitmap mode can in theory achieve
full write throughput of the device, but would not benefit
from the potential scattered write optimization.
-r|--readahead auto|none|Number
Sets read ahead sector count of an LV. auto is the
default which allows the kernel to choose a suitable value
automatically. none is equivalent to zero.
-R|--regionsize Size[m|UNIT]
Size of each raid or mirror synchronization region.
lvm.conf(5) activation/raid_region_size can be used to
configure a default.
--repair
Replace failed PVs in a raid or mirror LV, or run a repair
utility on a thin pool. See lvmraid(7) and lvmthin(7) for
more information.
--replace PV
Replace a specific PV in a raid LV with another PV. The
new PV to use can be optionally specified after the LV.
Multiple PVs can be replaced by repeating this option.
See lvmraid(7) for more information.
-s|--snapshot
Combine a former COW snapshot LV with a former origin LV
to reverse a previous --splitsnapshot command.
--splitcache
Separates a cache pool from a cache LV, and keeps the
unused cache pool LV. Before the separation, the cache is
flushed. Also see --uncache.
--splitmirrors Number
Splits the specified number of images from a raid1 or
mirror LV and uses them to create a new LV. If
--trackchanges is also specified, changes to the raid1 LV
are tracked while the split LV remains detached. If
--name is specified, then the images are permanently split
from the original LV and changes are not tracked.
--splitsnapshot
Separates a COW snapshot from its origin LV. The LV that
is split off contains the chunks that differ from the
origin LV along with metadata describing them. This LV can
be wiped and then destroyed with lvremove.
--startpoll
Start polling an LV to continue processing a conversion.
--stripes Number
Specifies the number of stripes in a striped LV. This is
the number of PVs (devices) that a striped LV is spread
across. Data that appears sequential in the LV is spread
across multiple devices in units of the stripe size (see
--stripesize). This does not apply to existing allocated
space, only newly allocated space can be striped.
-I|--stripesize Size[k|UNIT]
The amount of data that is written to one device before
moving to the next in a striped LV.
--swapmetadata
Extracts the metadata LV from a pool and replaces it with
another specified LV. The extracted LV is preserved and
given the name of the LV that replaced it. Use for repair
only. When the metadata LV is swapped out of the pool, it
can be activated directly and used with thin provisioning
tools: cache_dump(8), cache_repair(8), cache_restore(8),
thin_dump(8), thin_repair(8), thin_restore(8).
-t|--test
Run in test mode. Commands will not update metadata. This
is implemented by disabling all metadata writing but
nevertheless returning success to the calling function.
This may lead to unusual error messages in multi-stage
operations if a tool relies on reading back metadata it
believes has changed but hasn't.
-T|--thin
Specifies the command is handling a thin LV or thin pool.
See --type thin, --type thin-pool, and --virtualsize. See
lvmthin(7) for more information about LVM thin
provisioning.
--thinpool LV
The name of a thin pool LV.
--trackchanges
Can be used with --splitmirrors on a raid1 LV. This causes
changes to the original raid1 LV to be tracked while the
split images remain detached. This is a temporary state
that allows the read-only detached image to be merged
efficiently back into the raid1 LV later. Only the
regions with changed data are resynchronized during merge.
While a raid1 LV is tracking changes, operations on it are
limited to merging the split image (see --mergemirrors) or
permanently splitting the image (see --splitmirrors with
--name.
--type linear|striped|snapshot|raid|mirror|thin|thin-pool|vdo|
vdo-pool|cache|cache-pool|writecache
The LV type, also known as "segment type" or "segtype".
See usage descriptions for the specific ways to use these
types. For more information about redundancy and
performance (raid<N>, mirror, striped, linear) see
lvmraid(7). For thin provisioning (thin, thin-pool) see
lvmthin(7). For performance caching (cache, cache-pool)
see lvmcache(7). For copy-on-write snapshots (snapshot)
see usage definitions. For VDO (vdo) see lvmvdo(7).
Several commands omit an explicit type option because the
type is inferred from other options or shortcuts (e.g.
--stripes, --mirrors, --snapshot, --virtualsize, --thin,
--cache, --vdo). Use inferred types with care because it
can lead to unexpected results.
--uncache
Separates a cache pool from a cache LV, and deletes the
unused cache pool LV. Before the separation, the cache is
flushed. Also see --splitcache.
--usepolicies
Perform an operation according to the policy configured in
lvm.conf(5) or a profile.
--vdopool LV
The name of a VDO pool LV. See lvmvdo(7) for more
information about VDO usage.
-v|--verbose ...
Set verbose level. Repeat from 1 to 4 times to increase
the detail of messages sent to stdout and stderr.
--version
Display version information.
-V|--virtualsize Size[m|UNIT]
The virtual size of a new thin LV. See lvmthin(7) for
more information about LVM thin provisioning. Using
virtual size (-V) and actual size (-L) together creates a
sparse LV. lvm.conf(5) global/sparse_segtype_default
determines the default segment type used to create a
sparse LV. Anything written to a sparse LV will be
returned when reading from it. Reading from other areas
of the LV will return blocks of zeros. When using a
snapshot to create a sparse LV, a hidden virtual device is
created using the zero target, and the LV has the suffix
_vorigin. Snapshots are less efficient than thin
provisioning when creating large sparse LVs (GiB).
-y|--yes
Do not prompt for confirmation interactively but always
assume the answer yes. Use with extreme caution. (For
automatic no, see -qq.)
-Z|--zero y|n
For snapshots, this controls zeroing of the first 4KiB of
data in the snapshot. If the LV is read-only, the snapshot
will not be zeroed. For thin pools, this controls zeroing
of provisioned blocks. Provisioning of large zeroed
chunks negatively impacts performance.
