diff options
Diffstat (limited to 'man/lvchange.8.in')
| -rw-r--r-- | man/lvchange.8.in | 491 |
1 files changed, 0 insertions, 491 deletions
diff --git a/man/lvchange.8.in b/man/lvchange.8.in deleted file mode 100644 index 8da9f2dd4..000000000 --- a/man/lvchange.8.in +++ /dev/null @@ -1,491 +0,0 @@ -.TH LVCHANGE 8 "LVM TOOLS #VERSION#" "Sistina Software UK" \" -*- nroff -*- - -.de UNITS -.. - -. -.SH NAME -. -lvchange \(em change attributes of a logical volume -. -.SH SYNOPSIS -. -.ad l -.B lvchange -.RB [ \-a | \-\-activate -.RB [ a ][ e | s | l ]{ y | n }] -.RB [ \-\-activationmode -.RB { complete | degraded | partial }] -.RB [ \-\-addtag -.IR Tag ] -.RB [ \-K | \-\-ignoreactivationskip ] -.RB [ \-k | \-\-setactivationskip -.RB { y | n }] -.RB [ \-\-alloc -.IR AllocationPolicy ] -.RB [ \-A | \-\-autobackup -.RB { y | n }] -.RB [ \-\-rebuild -.IR PhysicalVolume ] -.RB [ \-\-cachemode -.RB { passthrough | writeback | writethrough }] -.RB [ \-\-cachepolicy -.IR Policy ] -.RB [ \-\-cachesettings -.IR Key \fB= Value ] -.RB [ \-\-commandprofile -.IR ProfileName ] -.RB [ \-C | \-\-contiguous -.RB { y | n }] -.RB [ \-d | \-\-debug ] -.RB [ \-\-deltag -.IR Tag ] -.RB [ \-\-detachprofile ] -.RB [ \-\-discards -.RB { ignore | nopassdown | passdown }] -.RB [ \-\-errorwhenfull -.RB { y | n }] -.RB [ \-h | \-? | \-\-help ] -.RB \%[ \-\-ignorelockingfailure ] -.RB \%[ \-\-ignoremonitoring ] -.RB \%[ \-\-ignoreskippedcluster ] -.RB \%[ \-\-metadataprofile -.IR ProfileName ] -.RB [ \-\-monitor -.RB { y | n }] -.RB [ \-\-noudevsync ] -.RB [ \-P | \-\-partial ] -.RB [ \-p | \-\-permission -.RB { r | rw }] -.RB [ \-M | \-\-persistent -.RB { y | n } -.RB [ \-\-major -.IR Major ] -.RB [ \-\-minor -.IR Minor ]] -.RB [ \-\-poll -.RB { y | n }] -.RB [ \-\- [ raid ] maxrecoveryrate -.IR Rate ] -.RB [ \-\- [ raid ] minrecoveryrate -.IR Rate ] -.RB [ \-\- [ raid ] syncaction -.RB { check | repair }] -.RB [ \-\- [ raid ] writebehind -.IR IOCount ] -.RB [ \-\- [ raid ] writemostly -.BR \fIPhysicalVolume [ : { y | n | t }]] -.RB [ \-r | \-\-readahead -.RB { \fIReadAheadSectors | auto | none }] -.RB [ \-\-refresh ] -.RB [ \-\-reportformat -.RB { basic | json }] -.RB [ \-\-resync ] -.RB [ \-S | \-\-select -.IR Selection ] -.RB [ \-\-sysinit ] -.RB [ \-t | \-\-test ] -.RB [ \-v | \-\-verbose ] -.RB [ \-Z | \-\-zero -.RB { y | n }] -.RI [ LogicalVolumePath ...] -.ad b -. -.SH DESCRIPTION -. -lvchange allows you to change the attributes of a logical volume -including making them known to the kernel ready for use. -. -.SH OPTIONS -. -See \fBlvm\fP(8) for common options. -. -.HP -.BR \-a | \-\-activate -.RB [ a ][ e | s | l ]{ y | n } -.br -Controls the availability of the logical volumes for use. -Communicates with the kernel device-mapper driver via -libdevmapper to activate (\fB\-ay\fP) or deactivate (\fB\-an\fP) the -logical volumes. -.br -Activation of a logical volume creates a symbolic link -\fI/dev/VolumeGroupName/LogicalVolumeName\fP pointing to the device node. -This link is removed on deactivation. -All software and scripts should access the device through -this symbolic link and present this as the name of the device. -The location and name of the underlying device node may depend on -the distribution and configuration (e.g. udev) and might change -from release to release. -.br -If autoactivation option is used (\fB\-aay\fP), -the logical volume is activated only if it matches an item in -the \fBactivation/auto_activation_volume_list\fP -set in \fBlvm.conf\fP(5). -If this list is not set, then all volumes are considered for -activation. The \fB\-aay\fP option should be also used during system -boot so it's possible to select which volumes to activate using -the \fBactivation/auto_activation_volume_list\fP setting. -.br -In a clustered VG, clvmd is used for activation, and the -following options are possible: - -With \fB\-aey\fP, clvmd activates the LV in exclusive mode -(with an exclusive lock), allowing a single node to activate the LV. - -With \fB\-asy\fP, clvmd activates the LV in shared mode -(with a shared lock), allowing multiple nodes to activate the LV concurrently. -If the LV type prohibits shared access, such as an LV with a snapshot, -the '\fBs\fP' option is ignored and an exclusive lock is used. - -With \fB\-ay\fP (no mode specified), clvmd activates the LV in shared mode -if the LV type allows concurrent access, such as a linear LV. -Otherwise, clvmd activates the LV in exclusive mode. - -With \fB\-aey\fP, \fB\-asy\fP, and \fB\-ay\fP, clvmd attempts to activate the LV -on all nodes. If exclusive mode is used, then only one of the -nodes will be successful. - -With \fB\-an\fP, clvmd attempts to deactivate the LV on all nodes. - -With \fB\-aly\fP, clvmd activates the LV only on the local node, and \fB\-aln\fP -deactivates only on the local node. If the LV type allows concurrent -access, then shared mode is used, otherwise exclusive. - -LVs with snapshots are always activated exclusively because they can only -be used on one node at once. - -For local VGs \fB\-ay\fP, \fB\-aey\fP, and \fB\-asy\fP are all equivalent. -. -.HP -.BR \-\-activationmode -.RB { complete | degraded | partial } -.br -The activation mode determines whether logical volumes are allowed to -activate when there are physical volumes missing (e.g. due to a device -failure). \fBcomplete\fP is the most restrictive; allowing only those -logical volumes to be activated that are not affected by the missing -PVs. \fBdegraded\fP allows RAID logical volumes to be activated even if -they have PVs missing. (Note that the "\fImirror\fP" segment type is not -considered a RAID logical volume. The "\fIraid1\fP" segment type should -be used instead.) Finally, \fBpartial\fP allows any logical volume to -be activated even if portions are missing due to a missing or failed -PV. This last option should only be used when performing recovery or -repair operations. \fBdegraded\fP is the default mode. To change it, -modify \fBactivation_mode\fP in \fBlvm.conf\fP(5). -. -.HP -.BR \-K | \-\-ignoreactivationskip -.br -Ignore the flag to skip Logical Volumes during activation. -. -.HP -.BR \-k | \-\-setactivationskip -.RB { y | n } -.br -Controls whether Logical Volumes are persistently flagged to be -skipped during activation. By default, thin snapshot volumes are -flagged for activation skip. To activate such volumes, -an extra \fB\-\-ignoreactivationskip\fP option must be used. -The flag is not applied during deactivation. To see whether -the flag is attached, use \fBlvs\fP(8) command where the state -of the flag is reported within \fBlv_attr\fP bits. -. -.HP -.BR \-\-cachemode -.RB { passthrough | writeback | writethrough } -.br -Specifying a cache mode determines when the writes to a cache LV -are considered complete. When \fBwriteback\fP is specified, a write is -considered complete as soon as it is stored in the cache pool LV. -If \fBwritethough\fP is specified, a write is considered complete only -when it has been stored in the cache pool LV and on the origin LV. -While \fBwritethrough\fP may be slower for writes, it is more -resilient if something should happen to a device associated with the -cache pool LV. With \fBpassthrough\fP mode, all reads are served -from origin LV (all reads miss the cache) and all writes are -forwarded to the origin LV; additionally, write hits cause cache -block invalidates. See \fBlvmcache(7)\fP for more details. -. -.HP -.BR \-\-cachepolicy -.IR Policy , -.BR \-\-cachesettings -.IR Key \fB= Value -.br -Only applicable to cached LVs; see also \fBlvmcache(7)\fP. Sets -the cache policy and its associated tunable settings. In most use-cases, -default values should be adequate. -. -.HP -.BR \-C | \-\-contiguous -.RB { y | n } -.br -Tries to set or reset the contiguous allocation policy for -logical volumes. It's only possible to change a non-contiguous -logical volume's allocation policy to contiguous, if all of the -allocated physical extents are already contiguous. -. -.HP -.BR \-\-detachprofile -.br -Detach any metadata configuration profiles attached to given -Logical Volumes. See \fBlvm.conf\fP(5) for more information -about metadata profiles. -. -.HP -.BR \-\-discards -.RB { ignore | nopassdown | passdown } -.br -Set this to \fBignore\fP to ignore any discards received by a -thin pool Logical Volume. Set to \fBnopassdown\fP to process such -discards within the thin pool itself and allow the no-longer-needed -extents to be overwritten by new data. Set to \fBpassdown\fP (the -default) to process them both within the thin pool itself and to -pass them down the underlying device. -. -.HP -.BR \-\-errorwhenfull -.RB { y | n } -.br -Sets thin pool behavior when data space is exhaused. See -.BR lvcreate (8) -for information. -. -.HP -.BR \-\-ignoremonitoring -.br -Make no attempt to interact with dmeventd unless \fB\-\-monitor\fP -is specified. -Do not use this if dmeventd is already monitoring a device. -. -.HP -.BR \-\-major -.IR Major -.br -Sets the major number. This option is supported only on older systems -(kernel version 2.4) and is ignored on modern Linux systems where major -numbers are dynamically assigned. -. -.HP -.BR \-\-minor -.IR Minor -.br -Set the minor number. -. -.HP -.BR \-\-metadataprofile -.IR ProfileName -.br -Uses and attaches \fIProfileName\fP configuration profile to the logical -volume metadata. Whenever the logical volume is processed next time, -the profile is automatically applied. If the volume group has another -profile attached, the logical volume profile is preferred. -See \fBlvm.conf\fP(5) for more information about metadata profiles. -. -.HP -.BR \-\-monitor -.RB { y | n } -.br -Start or stop monitoring a mirrored or snapshot logical volume with -dmeventd, if it is installed. -If a device used by a monitored mirror reports an I/O error, -the failure is handled according to -\%\fBmirror_image_fault_policy\fP and \fBmirror_log_fault_policy\fP -set in \fBlvm.conf\fP(5). -. -.HP -.BR \-\-noudevsync -.br -Disable udev synchronisation. The -process will not wait for notification from udev. -It will continue irrespective of any possible udev processing -in the background. You should only use this if udev is not running -or has rules that ignore the devices LVM2 creates. -. -.HP -.BR \-p | \-\-permission -.RB { r | rw } -.br -Change access permission to read-only or read/write. -. -.HP -.BR \-M | \-\-persistent -.RB { y | n } -.br -Set to \fBy\fP to make the minor number specified persistent. -Change of persistent numbers is not supported for pool volumes. -. -.HP -.BR \-\-poll -.RB { y | n } -.br -Without polling a logical volume's backgrounded transformation process -will never complete. If there is an incomplete pvmove or lvconvert (for -example, on rebooting after a crash), use \fB\-\-poll y\fP to restart the -process from its last checkpoint. However, it may not be appropriate to -immediately poll a logical volume when it is activated, use -\fB\-\-poll n\fP to defer and then \fB\-\-poll y\fP to restart the process. -. -.HP -.BR \-\- [ raid ] rebuild -.BR \fIPhysicalVolume -.br -Option can be repeated multiple times. -Selects PhysicalVolume(s) to be rebuild in a RaidLV. -Use this option instead of -.BR \-\-resync -or -.BR \-\- [ raid ] syncaction -\fBrepair\fP in case the PVs with corrupted data are known and their data -should be reconstructed rather than reconstructing default (rotating) data. -.br -E.g. in a raid1 mirror, the master leg on /dev/sda may hold corrupt data due -to a known transient disk error, thus -.br -\fBlvchange --rebuild /dev/sda LV\fP -.br -will request the master leg to be rebuild rather than rebuilding -all other legs from the master. -On a raid5 with rotating data and parity -.br -\fBlvchange --rebuild /dev/sda LV\fP -.br -will rebuild all data and parity blocks in the stripe on /dev/sda. -.HP -.BR \-\- [ raid ] maxrecoveryrate -.BR \fIRate [ b | B | s | S | k | K | m | M | g | G ] -.br -Sets the maximum recovery rate for a RAID logical volume. \fIRate\fP -is specified as an amount per second for each device in the array. -If no suffix is given, then KiB/sec/device is assumed. Setting the -recovery rate to \fB0\fP means it will be unbounded. -. -.HP -.BR \-\- [ raid ] minrecoveryrate -.BR \fIRate [ b | B | s | S | k | K | m | M | g | G ] -.br -Sets the minimum recovery rate for a RAID logical volume. \fIRate\fP -is specified as an amount per second for each device in the array. -If no suffix is given, then KiB/sec/device is assumed. Setting the -recovery rate to \fB0\fP means it will be unbounded. -. -.HP -.BR \-\- [ raid ] syncaction -.RB { check | repair } -.br -This argument is used to initiate various RAID synchronization operations. -The \fBcheck\fP and \fBrepair\fP options provide a way to check the -integrity of a RAID logical volume (often referred to as "scrubbing"). -These options cause the RAID logical volume to -read all of the data and parity blocks in the array and check for any -discrepancies (e.g. mismatches between mirrors or incorrect parity values). -If \fBcheck\fP is used, the discrepancies will be counted but not repaired. -If \fBrepair\fP is used, the discrepancies will be corrected as they are -encountered. The \fBlvs\fP(8) command can be used to show the number of -discrepancies found or repaired. -. -.HP -.BR \-\- [ raid ] writebehind -.IR IOCount -.br -Specify the maximum number of outstanding writes that are allowed to -devices in a RAID1 logical volume that are marked as write-mostly. -Once this value is exceeded, writes become synchronous (i.e. all writes -to the constituent devices must complete before the array signals the -write has completed). Setting the value to zero clears the preference -and allows the system to choose the value arbitrarily. -. -.HP -.BR \-\- [ raid ] writemostly -.BR \fIPhysicalVolume [ : { y | n | t }] -.br -Mark a device in a RAID1 logical volume as write-mostly. All reads -to these drives will be avoided unless absolutely necessary. This keeps -the number of I/Os to the drive to a minimum. The default behavior is to -set the write-mostly attribute for the specified physical volume in the -logical volume. It is possible to also remove the write-mostly flag by -appending a "\fB:n\fP" to the physical volume or to toggle the value by specifying -"\fB:t\fP". The \fB\-\-writemostly\fP argument can be specified more than one time -in a single command; making it possible to toggle the write-mostly attributes -for all the physical volumes in a logical volume at once. -. -.HP -.BR \-r | \-\-readahead -.RB { \fIReadAheadSectors | auto | none } -.br -Set read ahead sector count of this logical volume. -For volume groups with metadata in lvm1 format, this must -be a value between 2 and 120 sectors. -The default value is "\fBauto\fP" which allows the kernel to choose -a suitable value automatically. -"\fBnone\fP" is equivalent to specifying zero. -. -.HP -.BR \-\-refresh -.br -If the logical volume is active, reload its metadata. -This is not necessary in normal operation, but may be useful -if something has gone wrong or if you're doing clustering -manually without a clustered lock manager. -. -.HP -.BR \-\-resync -.br -Forces the complete resynchronization of a mirror. In normal -circumstances you should not need this option because synchronization -happens automatically. Data is read from the primary mirror device -and copied to the others, so this can take a considerable amount of -time - and during this time you are without a complete redundant copy -of your data. -. -.HP -.BR \-\-sysinit -.br -Indicates that \fBlvchange\fP(8) is being invoked from early system -initialisation scripts (e.g. rc.sysinit or an initrd), -before writeable filesystems are available. As such, -some functionality needs to be disabled and this option -acts as a shortcut which selects an appropriate set of options. Currently -this is equivalent to using \fB\-\-ignorelockingfailure\fP, -\fB\-\-ignoremonitoring\fP, \fB\-\-poll n\fP and setting -\fBLVM_SUPPRESS_LOCKING_FAILURE_MESSAGES\fP -environment variable. - -If \fB\-\-sysinit\fP is used in conjunction with -\fBlvmetad\fP(8) enabled and running, -autoactivation is preferred over manual activation via direct lvchange call. -Logical volumes are autoactivated according to -\fBauto_activation_volume_list\fP set in \fBlvm.conf\fP(5). -. -.HP -.BR \-Z | \-\-zero -.RB { y | n } -.br -Set zeroing mode for thin pool. Note: already provisioned blocks from pool -in non-zero mode are not cleared in unwritten parts when setting zero to -\fBy\fP. -. -.SH ENVIRONMENT VARIABLES -. -.TP -.B LVM_SUPPRESS_LOCKING_FAILURE_MESSAGES -Suppress locking failure messages. -. -.SH Examples -. -Changes the permission on volume lvol1 in volume group vg00 to be read-only: -.sp -.B lvchange \-pr vg00/lvol1 -. -.SH SEE ALSO -. -.nh -.BR lvm (8), -.BR lvmetad (8), -.BR lvs (8), -.BR lvcreate (8), -.BR vgchange (8), -.BR lvmcache (7), -.BR lvmthin (7), -.BR lvm.conf (5) |