diff options
Diffstat (limited to 'man/vgcreate.8_pregen')
| -rw-r--r-- | man/vgcreate.8_pregen | 626 |
1 files changed, 626 insertions, 0 deletions
diff --git a/man/vgcreate.8_pregen b/man/vgcreate.8_pregen new file mode 100644 index 000000000..5c733122f --- /dev/null +++ b/man/vgcreate.8_pregen @@ -0,0 +1,626 @@ +.TH VGCREATE 8 "LVM TOOLS 2.02.169(2)-git (2016-11-30)" "Red Hat, Inc." +.SH NAME +. +vgcreate \- Create a volume group +.P +. +.SH SYNOPSIS +.br +.P +. +\fBvgcreate\fP \fIposition_args\fP +.br + [ \fIoption_args\fP ] +.br +.P + +.SH DESCRIPTION +vgcreate creates a new VG on block devices. If the devices were not +previously intialized as PVs with \fBpvcreate\fP(8), vgcreate will +inititialize them, making them PVs. The pvcreate options for initializing +devices are also available with vgcreate. + +.P +.SH USAGE +.br +.P +. +\fBvgcreate\fP \fIVG\fP\fI_new\fP \fIPV\fP ... +.br +.RS 4 +.ad l +[ \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP ] +.ad b +.br +.ad l +[ \fB-c\fP|\fB--clustered\fP \fBy\fP|\fBn\fP ] +.ad b +.br +.ad l +[ \fB-l\fP|\fB--maxlogicalvolumes\fP \fINumber\fP ] +.ad b +.br +.ad l +[ \fB-p\fP|\fB--maxphysicalvolumes\fP \fINumber\fP ] +.ad b +.br +.ad l +[ \fB-M\fP|\fB--metadatatype\fP \fBlvm2\fP|\fBlvm1\fP ] +.ad b +.br +.ad l +[ \fB-s\fP|\fB--physicalextentsize\fP \fISize\fP[m|UNIT] ] +.ad b +.br +.ad l +[ \fB-f\fP|\fB--force\fP ] +.ad b +.br +.ad l +[ \fB-Z\fP|\fB--zero\fP \fBy\fP|\fBn\fP ] +.ad b +.br +.ad l +[ \fB--addtag\fP \fITag\fP ] +.ad b +.br +.ad l +[ \fB--alloc\fP \fBcontiguous\fP|\fBcling\fP|\fBcling_by_tags\fP|\fBnormal\fP|\fBanywhere\fP|\fBinherit\fP ] +.ad b +.br +.ad l +[ \fB--metadataprofile\fP \fIString\fP ] +.ad b +.br +.ad l +[ \fB--labelsector\fP \fINumber\fP ] +.ad b +.br +.ad l +[ \fB--metadatasize\fP \fISize\fP[m|UNIT] ] +.ad b +.br +.ad l +[ \fB--pvmetadatacopies\fP \fB0\fP|\fB1\fP|\fB2\fP ] +.ad b +.br +.ad l +[ \fB--[vg]metadatacopies\fP \fBall\fP|\fBunmanaged\fP|\fINumber\fP ] +.ad b +.br +.ad l +[ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] +.ad b +.br +.ad l +[ \fB--dataalignment\fP \fISize\fP[k|UNIT] ] +.ad b +.br +.ad l +[ \fB--dataalignmentoffset\fP \fISize\fP[k|UNIT] ] +.ad b +.br +.ad l +[ \fB--shared\fP ] +.ad b +.br +.ad l +[ \fB--systemid\fP \fIString\fP ] +.ad b +.br +.ad l +[ \fB--locktype\fP \fBsanlock\fP|\fBdlm\fP|\fBnone\fP ] +.ad b +.br +.ad l +[ \fB--lockopt\fP \fIString\fP ] +.ad b +.br +[ COMMON_OPTIONS ] +.RE +.br + + +Common options for lvm: +. +.RS 4 +.ad l +[ \fB-d\fP|\fB--debug\fP ] +.ad b +.br +.ad l +[ \fB-h\fP|\fB--help\fP ] +.ad b +.br +.ad l +[ \fB-q\fP|\fB--quiet\fP ] +.ad b +.br +.ad l +[ \fB-t\fP|\fB--test\fP ] +.ad b +.br +.ad l +[ \fB-v\fP|\fB--verbose\fP ] +.ad b +.br +.ad l +[ \fB-y\fP|\fB--yes\fP ] +.ad b +.br +.ad l +[ \fB--commandprofile\fP \fIString\fP ] +.ad b +.br +.ad l +[ \fB--config\fP \fIString\fP ] +.ad b +.br +.ad l +[ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] +.ad b +.br +.ad l +[ \fB--longhelp\fP ] +.ad b +.br +.ad l +[ \fB--profile\fP \fIString\fP ] +.ad b +.br +.ad l +[ \fB--version\fP ] +.ad b + +.RE + +.SH OPTIONS +.br + +.HP +.ad l +\fB--addtag\fP \fITag\fP +.br +Adds a tag to a PV, VG or LV. This option can be repeated to add +multiple tags at once. See lvm(8) for information about tags. +.ad b + +.HP +.ad l +\fB--alloc\fP \fBcontiguous\fP|\fBcling\fP|\fBcling_by_tags\fP|\fBnormal\fP|\fBanywhere\fP|\fBinherit\fP +.br +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 overriden on the +command line. +\fBnormal\fP applies common sense rules such as not placing parallel stripes +on the same PV. +\fBinherit\fP applies the VG policy to an LV. +\fBcontiguous\fP requires new PEs be placed adjacent to existing PEs. +\fBcling\fP 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, \fBanywhere\fP 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 \fBlvm\fP(8) for more information about allocation. +.ad b + +.HP +.ad l +\fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP +.br +Specifies if metadata should be backed up automatically after a change. +Enabling this is strongly advised! See vgcfgbackup(8) for more information. +.ad b + +.HP +.ad l +\fB-c\fP|\fB--clustered\fP \fBy\fP|\fBn\fP +.br +Create a clustered VG using clvmd if LVM is compiled with cluster support. +This allows multiple hosts to share a VG on shared devices. +clvmd and a lock manager must be configured and running. +(A clustered VG using clvmd is different from a shared VG using lvmlockd.) +See clvmd(8) for more information about clustered VGs. +.ad b + +.HP +.ad l +\fB--commandprofile\fP \fIString\fP +.br +The command profile to use for command configuration. +See \fBlvm.conf\fP(5) for more information about profiles. +.ad b + +.HP +.ad l +\fB--config\fP \fIString\fP +.br +Config settings for the command. These override lvm.conf settings. +The String arg uses the same format as lvm.conf, +or may use section/field syntax. +See \fBlvm.conf\fP(5) for more information about config. +.ad b + +.HP +.ad l +\fB--dataalignment\fP \fISize\fP[k|UNIT] +.br +Align the start of the data to a multiple of this number. +Also specify an appropriate Physical Extent size when creating a VG. +To see the location of the first Physical Extent of an existing PV, +use pvs -o +pe_start. In addition, it may be shifted by an alignment offset. +See lvm.conf/data_alignment_offset_detection and --dataalignmentoffset. +.ad b + +.HP +.ad l +\fB--dataalignmentoffset\fP \fISize\fP[k|UNIT] +.br +Shift the start of the data area by this additional offset. +.ad b + +.HP +.ad l +\fB-d\fP|\fB--debug\fP ... +.br +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). +.ad b + +.HP +.ad l +\fB--driverloaded\fP \fBy\fP|\fBn\fP +.br +If set to no, the command will not attempt to use device-mapper. +For testing and debugging. +.ad b + +.HP +.ad l +\fB-f\fP|\fB--force\fP ... +.br +Override various checks, confirmations and protections. +Use with extreme caution. +.ad b + +.HP +.ad l +\fB-h\fP|\fB--help\fP +.br +Display help text. +.ad b + +.HP +.ad l +\fB--labelsector\fP \fINumber\fP +.br +By default the PV is labelled with an LVM2 identifier in its second +sector (sector 1). This lets you use a different sector near the +start of the disk (between 0 and 3 inclusive - see LABEL_SCAN_SECTORS +in the source). Use with care. +.ad b + +.HP +.ad l +\fB--lockopt\fP \fIString\fP +.br +Used to pass options for special cases to lvmlockd. +See lvmlockd(8) for more information. +.ad b + +.HP +.ad l +\fB--locktype\fP \fBsanlock\fP|\fBdlm\fP|\fBnone\fP +.br +Specify the VG lock type directly in place of using --shared. +See lvmlockd(8) for more information. +.ad b + +.HP +.ad l +\fB--longhelp\fP +.br +Display long help text. +.ad b + +.HP +.ad l +\fB-l\fP|\fB--maxlogicalvolumes\fP \fINumber\fP +.br +Sets the maximum number of LVs allowed in a VG. +.ad b + +.HP +.ad l +\fB-p\fP|\fB--maxphysicalvolumes\fP \fINumber\fP +.br +Sets the maximum number of PVs that can belong to the VG. +The value 0 removes any limitation. +For large numbers of PVs, also see options --pvmetadatacopies, +and --vgmetadatacopies for improving performance. +.ad b + +.HP +.ad l +\fB--metadataprofile\fP \fIString\fP +.br +The metadata profile to use for command configuration. +See \fBlvm.conf\fP(5) for more information about profiles. +.ad b + +.HP +.ad l +\fB--metadatasize\fP \fISize\fP[m|UNIT] +.br +The approximate amount of space used for each VG metadata area. +The size may be rounded. +.ad b + +.HP +.ad l +\fB-M\fP|\fB--metadatatype\fP \fBlvm2\fP|\fBlvm1\fP +.br +Specifies the type of on-disk metadata to use. +\fBlvm2\fP (or just \fB2\fP) is the current, standard format. +\fBlvm1\fP (or just \fB1\fP) is a historical format that +can be used for accessing old data. +.ad b + +.HP +.ad l +\fB-s\fP|\fB--physicalextentsize\fP \fISize\fP[m|UNIT] +.br +Sets the physical extent size of PVs in the VG. +The value must be either a power of 2 of at least 1 sector +(where the sector size is the largest sector size of the PVs +currently used in the VG), or at least 128KiB. +Once this value has been set, it is difficult to change +without recreating the VG, unless no extents need moving. +.ad b + +.HP +.ad l +\fB--profile\fP \fIString\fP +.br +An alias for --commandprofile or --metadataprofile, depending +on the command. +.ad b + +.HP +.ad l +\fB--pvmetadatacopies\fP \fB0\fP|\fB1\fP|\fB2\fP +.br +The number of metadata areas to set aside on a PV for storing VG metadata. +When 2, one copy of the VG metadata is stored at the front of the PV +and a second copy is stored at the end. +When 1, one copy of the VG metadata is stored at the front of the PV +(starting in the 5th sector). +When 0, no copies of the VG metadata are stored on the given PV. +This may be useful in VGs containing many PVs (this places limitations +on the ability to use vgsplit later.) +.ad b + +.HP +.ad l +\fB-q\fP|\fB--quiet\fP ... +.br +Suppress output and log messages. Overrides --debug and --verbose. +Repeat once to also suppress any prompts with answer no. +.ad b + +.HP +.ad l +\fB--reportformat\fP \fBbasic\fP|\fBjson\fP +.br +Overrides current output format for reports which is defined globally by +the report/output_format setting in lvm.conf. +\fBbasic\fP is the original format with columns and rows. +If there is more than one report per command, each report is prefixed +with the report name for identification. \fBjson\fP produces report +output in JSON format. See \fBlvmreport\fP(7) for more information. +.ad b + +.HP +.ad l +\fB--shared\fP +.br +Create a shared VG using lvmlockd if LVM is compiled with lockd support. +lvmlockd will select lock type sanlock or dlm depending on which lock +manager is running. This allows multiple hosts to share a VG on shared +devices. lvmlockd and a lock manager must be configured and running. +(A shared VG using lvmlockd is different from a clustered VG using clvmd.) +See lvmlockd(8) for more information about shared VGs. +.ad b + +.HP +.ad l +\fB--systemid\fP \fIString\fP +.br +Specifies the system ID that will be given to the new VG, overriding the +system ID of the host running the command. A VG is normally created +without this option, in which case the new VG is given the system ID of +the host creating it. Using this option requires caution because the +system ID of the new VG may not match the system ID of the host running +the command, leaving the VG inaccessible to the host. +See lvmsystemid(7) for more information. +.ad b + +.HP +.ad l +\fB-t\fP|\fB--test\fP +.br +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. +.ad b + +.HP +.ad l +\fB-v\fP|\fB--verbose\fP ... +.br +Set verbose level. Repeat from 1 to 4 times to increase the detail +of messages sent to stdout and stderr. +.ad b + +.HP +.ad l +\fB--version\fP +.br +Display version information. +.ad b + +.HP +.ad l +\fB--[vg]metadatacopies\fP \fBall\fP|\fBunmanaged\fP|\fINumber\fP +.br +Number of copies of the VG metadata that are kept. +VG metadata is kept in VG metadata areas on PVs in the VG, +i.e. reserved space at the start and/or end of the PVs. +Keeping a copy of the VG metadata on every PV can reduce performance +in VGs containing a large number of PVs. +When this number is set to a non-zero value, LVM will automatically +choose PVs on which to store metadata, using the metadataignore flags +on PVs to achieve the specified number. +The number can also be replaced with special string values: +\fBunmanaged\fP causes LVM to not automatically manage the PV +metadataignore flags. +\fBall\fP causes LVM to first clear the metadataignore flags on +all PVs, and then to become unmanaged. +.ad b + +.HP +.ad l +\fB-y\fP|\fB--yes\fP +.br +Do not prompt for confirmation interactively but always assume the +answer yes. Use with extreme caution. +(For automatic no, see -qq.) +.ad b + +.HP +.ad l +\fB-Z\fP|\fB--zero\fP \fBy\fP|\fBn\fP +.br +Controls if the first 4 sectors (2048 bytes) of the device are wiped. +The default is to wipe these sectors unless either or both of +--restorefile or --uuid are specified. +.ad b +.SH VARIABLES +.br + +.HP +\fIVG\fP +.br +Volume Group name. See \fBlvm\fP(8) for valid names. + +.HP +\fIPV\fP +.br +Physical Volume name, a device path under /dev. +For commands managing physical extents, a PV positional arg +generally accepts a suffix indicating a range (or multiple ranges) +of physical extents (PEs). When the first PE is omitted, it defaults +to the start of the device, and when the last PE is omitted it defaults to end. +Start and end range (inclusive): \fIPV\fP[\fB:\fP\fIPE\fP\fB-\fP\fIPE\fP]... +Start and length range (counting from 0): \fIPV\fP[\fB:\fP\fIPE\fP\fB+\fP\fIPE\fP]... + +.HP +\fIString\fP +.br +See the option description for information about the string content. + +.HP +\fISize\fP[UNIT] +.br +Size is an input number that accepts an optional unit. +Input units are always treated as base two values, regardless of +capitalization, e.g. 'k' and 'K' both refer to 1024. +The default input unit is specified by letter, followed by |UNIT. +UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. +b|B is bytes, s|S is sectors of 512 bytes, k|K is kilobytes, +m|M is megabytes, g|G is gigabytes, t|T is terabytes, +p|P is petabytes, e|E is exabytes. +(This should not be confused with the output control --units, where +capital letters mean multiple of 1000.) +.SH ENVIRONMENT VARIABLES +.br +See \fBlvm\fP(8) for information about environment variables used by lvm. +For example, LVM_VG_NAME can generally be substituted for a required VG parameter. +.SH EXAMPLES + +Create a VG with two PVs, using the default physical extent size. +.br +.B vgcreate myvg /dev/sdk1 /dev/sdl1 + +.SH SEE ALSO + +.BR lvm (8) +.BR lvm.conf (5) +.BR lvmconfig (8) + +.BR pvchange (8) +.BR pvck (8) +.BR pvcreate (8) +.BR pvdisplay (8) +.BR pvmove (8) +.BR pvremove (8) +.BR pvresize (8) +.BR pvs (8) +.BR pvscan (8) + +.BR vgcfgbackup (8) +.BR vgcfgrestore (8) +.BR vgchange (8) +.BR vgck (8) +.BR vgcreate (8) +.BR vgconvert (8) +.BR vgdisplay (8) +.BR vgexport (8) +.BR vgextend (8) +.BR vgimport (8) +.BR vgimportclone (8) +.BR vgmerge (8) +.BR vgmknodes (8) +.BR vgreduce (8) +.BR vgremove (8) +.BR vgrename (8) +.BR vgs (8) +.BR vgscan (8) +.BR vgsplit (8) + +.BR lvcreate (8) +.BR lvchange (8) +.BR lvconvert (8) +.BR lvdisplay (8) +.BR lvextend (8) +.BR lvreduce (8) +.BR lvremove (8) +.BR lvrename (8) +.BR lvresize (8) +.BR lvs (8) +.BR lvscan (8) + +.BR lvm2-activation-generator (8) +.BR blkdeactivate (8) +.BR lvmdump (8) + +.BR dmeventd (8) +.BR lvmetad (8) +.BR lvmpolld (8) +.BR lvmlockd (8) +.BR lvmlockctl (8) +.BR clvmd (8) +.BR cmirrord (8) +.BR lvmdbusd (8) + +.BR lvmsystemid (7) +.BR lvmreport (7) +.BR lvmraid (7) +.BR lvmthin (7) +.BR lvmcache (7) + |