mirror of
git://sourceware.org/git/lvm2.git
synced 2024-12-22 17:35:59 +03:00
382 lines
8.1 KiB
Plaintext
382 lines
8.1 KiB
Plaintext
.TH VGEXPORT 8 "LVM TOOLS #VERSION#" "Red Hat, Inc."
|
|
.SH NAME
|
|
vgexport - Unregister volume group(s) from the system
|
|
.
|
|
.SH SYNOPSIS
|
|
\fBvgexport\fP \fIoption_args\fP \fIposition_args\fP
|
|
.br
|
|
[ \fIoption_args\fP ]
|
|
.br
|
|
.SH DESCRIPTION
|
|
vgexport changes a VG into the exported state, which ensures that the VG
|
|
and its disks are not being used, and cannot be used until the VG is
|
|
imported by \fBvgimport\fP(8). Putting a VG into an unusable, offline
|
|
state can be useful when doing things like moving a VG's disks to another
|
|
system. Exporting a VG provides some protection from its LVs being
|
|
accidentally used, or being used by an automated system before it's ready.
|
|
|
|
A VG cannot be exported until all of its LVs are inactive.
|
|
|
|
LVM commands will ignore an exported VG or report an error if a command
|
|
tries to use it.
|
|
|
|
For an exported VG, the vgs command will display \"x\" in the third VG
|
|
attribute, and the pvs command will display \"x\" in the second PV
|
|
attribute. Both vgs and pvs will display \"exported\" from the export
|
|
report field.
|
|
|
|
vgexport clears the VG system ID, and vgimport sets the VG system ID to
|
|
match the host running vgimport (if the host has a system ID).
|
|
.SH USAGE
|
|
Export specified VGs.
|
|
.br
|
|
.P
|
|
\fBvgexport\fP \fIVG\fP|\fITag\fP|\fISelect\fP ...
|
|
.br
|
|
.RS 4
|
|
.ad l
|
|
[ \fB-S\fP|\fB--select\fP \fIString\fP ]
|
|
.ad b
|
|
.br
|
|
[ COMMON_OPTIONS ]
|
|
.RE
|
|
.br
|
|
|
|
Export all VGs.
|
|
.br
|
|
.P
|
|
\fBvgexport\fP \fB-a\fP|\fB--all\fP
|
|
.br
|
|
.RS 4
|
|
[ COMMON_OPTIONS ]
|
|
.RE
|
|
.br
|
|
|
|
Common options for command:
|
|
.
|
|
.RS 4
|
|
.ad l
|
|
[ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ]
|
|
.ad b
|
|
.RE
|
|
|
|
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--devices\fP \fIPV\fP ]
|
|
.ad b
|
|
.br
|
|
.ad l
|
|
[ \fB--devicesfile\fP \fIString\fP ]
|
|
.ad b
|
|
.br
|
|
.ad l
|
|
[ \fB--driverloaded\fP \fBy\fP|\fBn\fP ]
|
|
.ad b
|
|
.br
|
|
.ad l
|
|
[ \fB--lockopt\fP \fIString\fP ]
|
|
.ad b
|
|
.br
|
|
.ad l
|
|
[ \fB--longhelp\fP ]
|
|
.ad b
|
|
.br
|
|
.ad l
|
|
[ \fB--nolocking\fP ]
|
|
.ad b
|
|
.br
|
|
.ad l
|
|
[ \fB--profile\fP \fIString\fP ]
|
|
.ad b
|
|
.br
|
|
.ad l
|
|
[ \fB--version\fP ]
|
|
.ad b
|
|
.RE
|
|
.SH OPTIONS
|
|
.HP
|
|
.ad l
|
|
\fB-a\fP|\fB--all\fP
|
|
.br
|
|
.ad b
|
|
.HP
|
|
.ad l
|
|
\fB--commandprofile\fP \fIString\fP
|
|
.br
|
|
.ad b
|
|
The command profile to use for command configuration.
|
|
See \fBlvm.conf\fP(5) for more information about profiles.
|
|
.HP
|
|
.ad l
|
|
\fB--config\fP \fIString\fP
|
|
.br
|
|
.ad b
|
|
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.
|
|
.HP
|
|
.ad l
|
|
\fB-d\fP|\fB--debug\fP ...
|
|
.br
|
|
.ad b
|
|
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).
|
|
.HP
|
|
.ad l
|
|
\fB--devices\fP \fIPV\fP
|
|
.br
|
|
.ad b
|
|
Devices that the command can use. This option can be repeated
|
|
or accepts a comma separated list of devices. This overrides
|
|
the devices file.
|
|
.HP
|
|
.ad l
|
|
\fB--devicesfile\fP \fIString\fP
|
|
.br
|
|
.ad b
|
|
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 devices/devicesfile and
|
|
devices/use_devicesfile settings.
|
|
.HP
|
|
.ad l
|
|
\fB--driverloaded\fP \fBy\fP|\fBn\fP
|
|
.br
|
|
.ad b
|
|
If set to no, the command will not attempt to use device-mapper.
|
|
For testing and debugging.
|
|
.HP
|
|
.ad l
|
|
\fB-h\fP|\fB--help\fP
|
|
.br
|
|
.ad b
|
|
Display help text.
|
|
.HP
|
|
.ad l
|
|
\fB--lockopt\fP \fIString\fP
|
|
.br
|
|
.ad b
|
|
Used to pass options for special cases to lvmlockd.
|
|
See \fBlvmlockd\fP(8) for more information.
|
|
.HP
|
|
.ad l
|
|
\fB--longhelp\fP
|
|
.br
|
|
.ad b
|
|
Display long help text.
|
|
.HP
|
|
.ad l
|
|
\fB--nolocking\fP
|
|
.br
|
|
.ad b
|
|
Disable locking.
|
|
.HP
|
|
.ad l
|
|
\fB--profile\fP \fIString\fP
|
|
.br
|
|
.ad b
|
|
An alias for --commandprofile or --metadataprofile, depending
|
|
on the command.
|
|
.HP
|
|
.ad l
|
|
\fB-q\fP|\fB--quiet\fP ...
|
|
.br
|
|
.ad b
|
|
Suppress output and log messages. Overrides --debug and --verbose.
|
|
Repeat once to also suppress any prompts with answer 'no'.
|
|
.HP
|
|
.ad l
|
|
\fB--reportformat\fP \fBbasic\fP|\fBjson\fP
|
|
.br
|
|
.ad b
|
|
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.
|
|
.HP
|
|
.ad l
|
|
\fB-S\fP|\fB--select\fP \fIString\fP
|
|
.br
|
|
.ad b
|
|
Select objects for processing and reporting based on specified criteria.
|
|
The criteria syntax is described by \fB--select help\fP and \fBlvmreport\fP(7).
|
|
For reporting commands, one row is displayed for each object matching the criteria.
|
|
See \fB--options help\fP for selectable object fields.
|
|
Rows can be displayed with an additional "selected" field (-o selected)
|
|
showing 1 if the row matches the selection and 0 otherwise.
|
|
For non-reporting commands which process LVM entities, the selection is
|
|
used to choose items to process.
|
|
.HP
|
|
.ad l
|
|
\fB-t\fP|\fB--test\fP
|
|
.br
|
|
.ad b
|
|
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.
|
|
.HP
|
|
.ad l
|
|
\fB-v\fP|\fB--verbose\fP ...
|
|
.br
|
|
.ad b
|
|
Set verbose level. Repeat from 1 to 4 times to increase the detail
|
|
of messages sent to stdout and stderr.
|
|
.HP
|
|
.ad l
|
|
\fB--version\fP
|
|
.br
|
|
.ad b
|
|
Display version information.
|
|
.HP
|
|
.ad l
|
|
\fB-y\fP|\fB--yes\fP
|
|
.br
|
|
.ad b
|
|
Do not prompt for confirmation interactively but always assume the
|
|
answer yes. Use with extreme caution.
|
|
(For automatic no, see -qq.)
|
|
.SH VARIABLES
|
|
.HP
|
|
\fIVG\fP
|
|
.br
|
|
Volume Group name. See \fBlvm\fP(8) for valid names.
|
|
.HP
|
|
\fITag\fP
|
|
.br
|
|
Tag name. See \fBlvm\fP(8) for information about tag names and using tags
|
|
in place of a VG, LV or PV.
|
|
.HP
|
|
\fISelect\fP
|
|
.br
|
|
Select indicates that a required positional parameter can
|
|
be omitted if the \fB--select\fP option is used.
|
|
No arg appears in this position.
|
|
.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 KiB,
|
|
m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB.
|
|
(This should not be confused with the output control --units, where
|
|
capital letters mean multiple of 1000.)
|
|
.SH ENVIRONMENT VARIABLES
|
|
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 SEE ALSO
|
|
.nh
|
|
.ad l
|
|
.BR lvm (8),
|
|
.BR lvm.conf (5),
|
|
.BR lvmconfig (8),
|
|
.BR lvmdevices (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 vgimportdevices (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 lvm-fullreport (8),
|
|
.BR lvm-lvpoll (8),
|
|
.BR lvm2-activation-generator (8),
|
|
.BR blkdeactivate (8),
|
|
.BR lvmdump (8),
|
|
|
|
.BR dmeventd (8),
|
|
.BR lvmpolld (8),
|
|
.BR lvmlockd (8),
|
|
.BR lvmlockctl (8),
|
|
.BR cmirrord (8),
|
|
.BR lvmdbusd (8),
|
|
|
|
.BR lvmsystemid (7),
|
|
.BR lvmreport (7),
|
|
.BR lvmraid (7),
|
|
.BR lvmthin (7),
|
|
.BR lvmcache (7)
|