diff options
Diffstat (limited to 'man/vgexport.8_pregen')
-rw-r--r-- | man/vgexport.8_pregen | 310 |
1 files changed, 310 insertions, 0 deletions
diff --git a/man/vgexport.8_pregen b/man/vgexport.8_pregen new file mode 100644 index 0000000..4fa6ead --- /dev/null +++ b/man/vgexport.8_pregen @@ -0,0 +1,310 @@ +.TH VGEXPORT 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. +.SH NAME +. +vgexport \(em 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. +.P +A VG cannot be exported until all of its LVs are inactive. +.P +LVM commands will ignore an exported VG or report an error if a command +tries to use it. +.P +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. +.P +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 ] +.br +[ COMMON_OPTIONS ] +.ad b +.RE +.P +Export all VGs. +.br +.P +\fBvgexport\fP \fB-a\fP|\fB--all\fP +.br +.RS 4 +.ad l +[ COMMON_OPTIONS ] +.ad b +.RE +.P +Common options for command: +. +.RS 4 +.ad l +[ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP|\fBjson_std\fP ] +.ad b +.RE +.P +Common options for lvm: +. +.RS 4 +.ad l +[ \fB-d\fP|\fB--debug\fP ] +.br +[ \fB-h\fP|\fB--help\fP ] +.br +[ \fB-q\fP|\fB--quiet\fP ] +.br +[ \fB-t\fP|\fB--test\fP ] +.br +[ \fB-v\fP|\fB--verbose\fP ] +.br +[ \fB-y\fP|\fB--yes\fP ] +.br +[ \fB--commandprofile\fP \fIString\fP ] +.br +[ \fB--config\fP \fIString\fP ] +.br +[ \fB--devices\fP \fIPV\fP ] +.br +[ \fB--devicesfile\fP \fIString\fP ] +.br +[ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] +.br +[ \fB--journal\fP \fIString\fP ] +.br +[ \fB--lockopt\fP \fIString\fP ] +.br +[ \fB--longhelp\fP ] +.br +[ \fB--nohints\fP ] +.br +[ \fB--nolocking\fP ] +.br +[ \fB--profile\fP \fIString\fP ] +.br +[ \fB--version\fP ] +.ad b +.RE +. +.SH OPTIONS +. +. +.HP +\fB-a\fP|\fB--all\fP +.br +. +.HP +\fB--commandprofile\fP \fIString\fP +.br +The command profile to use for command configuration. +See \fBlvm.conf\fP(5) for more information about profiles. +. +.HP +\fB--config\fP \fIString\fP +.br +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), +or may use section/field syntax. +See \fBlvm.conf\fP(5) for more information about config. +. +.HP +\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). +. +.HP +\fB--devices\fP \fIPV\fP +.br +Restricts the devices that are visible and accessible to the command. +Devices not listed will appear to be missing. This option can be +repeated, or accepts a comma separated list of devices. This overrides +the devices file. +. +.HP +\fB--devicesfile\fP \fIString\fP +.br +A file listing devices that LVM should use. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. +.HP +\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. +. +.HP +\fB-h\fP|\fB--help\fP +.br +Display help text. +. +.HP +\fB--journal\fP \fIString\fP +.br +Record information in the systemd journal. +This information is in addition to information +enabled by the lvm.conf log/journal setting. +command: record information about the command. +output: record the default command output. +debug: record full command debugging. +. +.HP +\fB--lockopt\fP \fIString\fP +.br +Used to pass options for special cases to lvmlockd. +See \fBlvmlockd\fP(8) for more information. +. +.HP +\fB--longhelp\fP +.br +Display long help text. +. +.HP +\fB--nohints\fP +.br +Do not use the hints file to locate devices for PVs. A command may read +more devices to find PVs when hints are not used. The command will still +perform standard hint file invalidation where appropriate. +. +.HP +\fB--nolocking\fP +.br +Disable locking. Use with caution, concurrent commands may produce +incorrect results. +. +.HP +\fB--profile\fP \fIString\fP +.br +An alias for --commandprofile or --metadataprofile, depending +on the command. +. +.HP +\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'. +. +.HP +\fB--reportformat\fP \fBbasic\fP|\fBjson\fP|\fBjson_std\fP +.br +Overrides current output format for reports which is defined globally by +the report/output_format setting in \fBlvm.conf\fP(5). +\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. \fBjson_std\fP produces report output in +JSON format which is more compliant with JSON standard. +See \fBlvmreport\fP(7) for more information. +. +.HP +\fB-S\fP|\fB--select\fP \fIString\fP +.br +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 +\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. +. +.HP +\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. +. +.HP +\fB--version\fP +.br +Display version information. +. +.HP +\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.) +. +.SH VARIABLES +. +.TP +.I VG +Volume Group name. See \fBlvm\fP(8) for valid names. +.TP +.I Tag +Tag name. See \fBlvm\fP(8) for information about tag names and using tags +in place of a VG, LV or PV. +.TP +.I Select +Select indicates that a required positional parameter can +be omitted if the \fB--select\fP option is used. +No arg appears in this position. +.TP +.I String +See the option description for information about the string content. +.TP +.IR Size [UNIT] +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: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR 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. |