vgexport(8)

1VGEXPORT(8)                 System Manager's Manual                VGEXPORT(8)
2
3
4

NAME

6       vgexport - Unregister volume group(s) from the system
7

SYNOPSIS

9       vgexport option_args position_args
10           [ option_args ]
11

DESCRIPTION

13       vgexport  changes  a VG into the exported state, which ensures that the
14       VG and its disks are not being used, and cannot be used until the VG is
15       imported  by vgimport(8).  Putting a VG into an unusable, offline state
16       can be useful when doing things like moving a  VG's  disks  to  another
17       system.   Exporting  a  VG  provides some protection from its LVs being
18       accidentally used, or being used by an  automated  system  before  it's
19       ready.
20
21       A VG cannot be exported until all of its LVs are inactive.
22
23       LVM commands will ignore an exported VG or report an error if a command
24       tries to use it.
25
26       For an exported VG, the vgs command will display attribute, and the pvs
27       command  will  display attribute.  Both vgs and pvs will display report
28       field.
29
30       vgexport clears the VG system ID, and vgimport sets the VG system ID to
31       match the host running vgimport (if the host has a system ID).
32

USAGE

34       Export specified VGs.
35
36       vgexport VG|Tag|Select ...
37           [ -S|--select String ]
38           [ COMMON_OPTIONS ]
39
40       Export all VGs.
41
42       vgexport -a|--all
43           [ COMMON_OPTIONS ]
44
45       Common options for command:
46           [    --reportformat basic|json ]
47
48       Common options for lvm:
49           [ -d|--debug ]
50           [ -h|--help ]
51           [ -q|--quiet ]
52           [ -t|--test ]
53           [ -v|--verbose ]
54           [ -y|--yes ]
55           [    --commandprofile String ]
56           [    --config String ]
57           [    --driverloaded y|n ]
58           [    --lockopt String ]
59           [    --longhelp ]
60           [    --profile String ]
61           [    --version ]
62

OPTIONS

64       -a|--all
65
66       --commandprofile String
67              The command profile to use for command configuration.  See
68              lvm.conf(5) for more information about profiles.
69
70       --config String
71              Config settings for the command. These override lvm.conf set‐
72              tings.  The String arg uses the same format as lvm.conf, or may
73              use section/field syntax.  See lvm.conf(5) for more information
74              about config.
75
76       -d|--debug ...
77              Set debug level. Repeat from 1 to 6 times to increase the detail
78              of messages sent to the log file and/or syslog (if configured).
79
80       --driverloaded y|n
81              If set to no, the command will not attempt to use device-mapper.
82              For testing and debugging.
83
84       -h|--help
85              Display help text.
86
87       --lockopt String
88              Used to pass options for special cases to lvmlockd.  See lvm‐
89              lockd(8) for more information.
90
91       --longhelp
92              Display long help text.
93
94       --profile String
95              An alias for --commandprofile or --metadataprofile, depending on
96              the command.
97
98       -q|--quiet ...
99              Suppress output and log messages. Overrides --debug and --ver‐
100              bose.  Repeat once to also suppress any prompts with answer
101              'no'.
102
103       --reportformat basic|json
104              Overrides current output format for reports which is defined
105              globally by the report/output_format setting in lvm.conf.  basic
106              is the original format with columns and rows.  If there is more
107              than one report per command, each report is prefixed with the
108              report name for identification. json produces report output in
109              JSON format. See lvmreport(7) for more information.
110
111       -S|--select String
112              Select objects for processing and reporting based on specified
113              criteria.  The criteria syntax is described by --select help and
114              lvmreport(7).  For reporting commands, one row is displayed for
115              each object matching the criteria.  See --options help for
116              selectable object fields.  Rows can be displayed with an addi‐
117              tional "selected" field (-o selected) showing 1 if the row
118              matches the selection and 0 otherwise.  For non-reporting com‐
119              mands which process LVM entities, the selection is used to
120              choose items to process.
121
122       -t|--test
123              Run in test mode. Commands will not update metadata.  This is
124              implemented by disabling all metadata writing but nevertheless
125              returning success to the calling function. This may lead to
126              unusual error messages in multi-stage operations if a tool
127              relies on reading back metadata it believes has changed but
128              hasn't.
129
130       -v|--verbose ...
131              Set verbose level. Repeat from 1 to 4 times to increase the
132              detail of messages sent to stdout and stderr.
133
134       --version
135              Display version information.
136
137       -y|--yes
138              Do not prompt for confirmation interactively but always assume
139              the answer yes. Use with extreme caution.  (For automatic no,
140              see -qq.)
141

VARIABLES

143       VG
144              Volume Group name.  See lvm(8) for valid names.
145
146       Tag
147              Tag name.  See lvm(8) for information about tag names and  using
148              tags in place of a VG, LV or PV.
149
150       Select
151              Select  indicates  that  a  required positional parameter can be
152              omitted if the --select option is used.  No arg appears in  this
153              position.
154
155       String
156              See the option description for information about the string con‐
157              tent.
158
159       Size[UNIT]
160              Size is an input number that accepts an  optional  unit.   Input
161              units are always treated as base two values, regardless of capi‐
162              talization, e.g. 'k' and 'K' both refer to  1024.   The  default
163              input unit is specified by letter, followed by |UNIT.  UNIT rep‐
164              resents other possible input units:  bBsSkKmMgGtTpPeE.   b|B  is
165              bytes,  s|S  is  sectors  of 512 bytes, k|K is kilobytes, m|M is
166              megabytes, g|G is gigabytes, t|T is terabytes, p|P is petabytes,
167              e|E  is  exabytes.  (This should not be confused with the output
168              control --units, where capital letters mean multiple of 1000.)
169

ENVIRONMENT VARIABLES

171       See lvm(8) for information about environment  variables  used  by  lvm.
172       For example, LVM_VG_NAME can generally be substituted for a required VG
173       parameter.
174