summaryrefslogtreecommitdiff
path: root/man/pvscan.8.in
diff options
context:
space:
mode:
authorDavid Teigland <teigland@redhat.com>2017-02-10 16:20:19 -0600
committerDavid Teigland <teigland@redhat.com>2017-02-13 10:31:23 -0600
commit698abdde165a3e747b81f18cf3405f2d4abb5bae (patch)
tree360ce7617187b2e4c713cbb10c30c39c1c62dea8 /man/pvscan.8.in
parent13a6368522894e9d32544d8fb3d6360bbe9018d1 (diff)
downloadlvm2-698abdde165a3e747b81f18cf3405f2d4abb5bae.tar.gz
generate man pages
Diffstat (limited to 'man/pvscan.8.in')
-rw-r--r--man/pvscan.8.in178
1 files changed, 0 insertions, 178 deletions
diff --git a/man/pvscan.8.in b/man/pvscan.8.in
deleted file mode 100644
index 5ff5fa554..000000000
--- a/man/pvscan.8.in
+++ /dev/null
@@ -1,178 +0,0 @@
-.TH PVSCAN 8 "LVM TOOLS #VERSION#" "Sistina Software UK" \" -*- nroff -*-
-.SH NAME
-pvscan \(em scan all disks for physical volumes
-
-.SH SYNOPSIS
-.B pvscan
-.RB [ \-\-commandprofile
-.IR ProfileName ]
-.RB [ \-d | \-\-debug ]
-.RB [ \-h | \-\-help ]
-.RB [ \-v | \-\-verbose ]
-.RB [ \-\-version ]
-.RB [ \-\-ignorelockingfailure ]
-.RB [ \-e | \-\-exported ]
-.RB [ \-n | \-\-novolumegroup ]
-.RB [ \-\-reportformat
-.RB { basic | json }]
-.RB [ \-s | \-\-short ]
-.RB [ \-u | \-\-uuid ]
-.BR
-
-.B pvscan
-.RB [ \-d | \-\-debug ]
-.RB [ \-h | \-\-help ]
-.B \-\-cache
-.RB [ \-a | \-\-activate " " \fIay ]
-.RB [ \-b | \-\-background ]
-.RB [ \-\-reportformat
-.RB { basic | json }]
-.RB [ \-\-major
-.I major
-.B \-\-minor
-.I minor
-|
-.IR DevicePath
-|
-.IR major:minor ]...
-
-.SH DESCRIPTION
-pvscan scans all supported LVM block devices in the system for physical
-volumes.
-
-.SS Scanning with lvmetad
-
-pvscan operates differently when used with the
-.BR lvmetad (8)
-daemon.
-
-Scanning disks is required to read LVM metadata and identify LVM PVs.
-Once read, lvmetad caches the metadata so that LVM commands can read it
-without repeatedly scanning disks. This is helpful because scanning disks
-is time consuming, and frequent scanning may interfere with the normal
-work of the system and disks.
-
-When lvmetad is not used, LVM commands revert to scanning disks to read
-metadata. Any LVM command that needs metadata will scan disks for it;
-running the pvscan command is not necessary for the sake of other LVM
-commands.
-
-When lvmetad is used, LVM commands avoid scanning disks by reading
-metadata from lvmetad. When new disks appear, they must be scanned so
-their metadata can be cached in lvmetad. This is done by the command
-pvscan \-\-cache, which scans disks and passes the metadata to lvmetad.
-
-The pvscan \-\-cache command is typically run automatically by system
-services when a new device appears. Users do not generally need to run
-this command if the system and lvmetad are running properly.
-
-Many scripts contain unnecessary pvscan (or vgscan) commands for
-historical reasons. To avoid disrupting the system with extraneous disk
-scanning, an ordinary pvscan (without \-\-cache) will simply read metadata
-from lvmetad like other LVM commands. It does not do anything beyond
-displaying the current state of the cache.
-
-.I Notes
-
-.IP \[bu] 2
-When given specific device name arguments, pvscan \-\-cache will only
-read the named devices.
-
-.IP \[bu] 2
-LVM udev rules and systemd services are used to initiate automatic device
-scanning.
-
-.IP \[bu] 2
-To prevent devices from being scanned by pvscan --cache, add them
-to
-.BR lvm.conf (5)
-.B devices/global_filter.
-The devices/filter setting does not
-apply to system level scanning.
-For more information, see:
-.br
-.B lvmconfig --withcomments devices/global_filter
-
-.IP \[bu] 2
-If lvmetad is started or restarted after devices are visible, or
-if the global_filter has changed, then all devices must be rescanned
-for metadata with the command pvscan \-\-cache.
-
-.IP \[bu] 2
-lvmetad does not cache older metadata formats, e.g. lvm1, and will
-be temporarily disabled if they are seen.
-
-.IP \[bu] 2
-To notify lvmetad about a device that is no longer present, the major and
-minor numbers must be given, not the path.
-
-.SS Automatic activation
-
-When event-driven system services detect a new LVM device, the first step
-is to automatically scan and cache the metadata from the device. This is
-done by pvscan \-\-cache. A second step is to automatically activate LVs
-that are present on the new device. This auto-activation is done by the
-same pvscan \-\-cache command when the option '\-a|\-\-activate ay' is
-included.
-
-Auto-activation of VGs or LVs can be enabled/disabled using:
-.br
-.BR lvm.conf (5)
-.B activation/auto_activation_volume_list
-
-For more information, see:
-.br
-.B lvmconfig --withcomments activation/auto_activation_volume_list
-
-When this setting is undefined, all LVs are auto-activated (when lvm is
-fully integrated with the event-driven system services.)
-
-When a VG or LV is not auto-activated, traditional activation using
-vgchange or lvchange -a|--activate is needed.
-
-.I Notes
-
-.IP \[bu] 2
-pvscan auto-activation can be only done in combination with \-\-cache.
-
-.IP \[bu] 2
-Auto-activation is designated by the "a" argument in '-a|--activate ay'.
-This is meant to distinguish system generated commands from explicit user
-commands, although it can be used in any activation command. Whenever it
-is used, the auto_activation_volume_list is applied.
-
-.IP \[bu] 2
-Auto-activation is not yet supported for LVs that are part of partial or
-clustered volume groups.
-
-.P
-
-.SH OPTIONS
-See \fBlvm\fP(8) for common options.
-.TP
-.BR \-e ", " \-\-exported
-Only show physical volumes belonging to exported volume groups.
-.TP
-.BR \-n ", " \-\-novolumegroup
-Only show physical volumes not belonging to any volume group.
-.TP
-.BR \-s ", " \-\-short
-Short listing format.
-.TP
-.BR \-u ", " \-\-uuid
-Show UUIDs in addition to device names.
-.TP
-.BR \-a ", " \-\-activate " " \fIay
-Automatically activate any logical volumes that are possible to activate
-with the addition of the new devices.
-.TP
-.BR \-b ", " \-\-background
-Run the command in the background.
-.TP
-.BR \-\-cache " [" \-\-major " " \fImajor " " \-\-minor " " \fIminor " | " \fIDevicePath " | " \fImajor:minor " ]..."
-Scan one or more devices and send the metadata to lvmetad.
-
-.SH SEE ALSO
-.BR lvm (8),
-.BR lvmconfig (8),
-.BR lvmetad (8)