1VGEXPORT(8) System Manager's Manual VGEXPORT(8)
2
6 vgexport — Unregister volume group(s) from the system
7
9 vgexport option_args position_args
10 [ option_args ]
11
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 ac‐
18 cidentally used, or being used by an automated system before it's
19 ready.
20 A VG cannot be exported until all of its LVs are inactive.
22 LVM commands will ignore an exported VG or report an error if a command
24 tries to use it.
25 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 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
34 Export specified VGs.
35 vgexport VG|Tag|Select ...
37 [ -S|--select String ]
38 [ COMMON_OPTIONS ]
39 Export all VGs.
41 vgexport -a|--all
43 [ COMMON_OPTIONS ]
44 Common options for command:
46 [ --reportformat basic|json|json_std ]
47 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 [ --devices PV ]
58 [ --devicesfile String ]
59 [ --driverloaded y|n ]
60 [ --journal String ]
61 [ --lockopt String ]
62 [ --longhelp ]
63 [ --nohints ]
64 [ --nolocking ]
65 [ --profile String ]
66 [ --version ]
67
69 -a|--all
70 --commandprofile String
72 The command profile to use for command configuration. See
73 lvm.conf(5) for more information about profiles.
74 --config String
76 Config settings for the command. These override lvm.conf(5) set‐
77 tings. The String arg uses the same format as lvm.conf(5), or
78 may use section/field syntax. See lvm.conf(5) for more informa‐
79 tion about config.
80 -d|--debug ...
82 Set debug level. Repeat from 1 to 6 times to increase the detail
83 of messages sent to the log file and/or syslog (if configured).
84 --devices PV
86 Restricts the devices that are visible and accessible to the
87 command. Devices not listed will appear to be missing. This op‐
88 tion can be repeated, or accepts a comma separated list of de‐
89 vices. This overrides the devices file.
90 --devicesfile String
92 A file listing devices that LVM should use. The file must exist
93 in /etc/lvm/devices/ and is managed with the lvmdevices(8) com‐
94 mand. This overrides the lvm.conf(5) devices/devicesfile and
95 devices/use_devicesfile settings.
96 --driverloaded y|n
98 If set to no, the command will not attempt to use device-mapper.
99 For testing and debugging.
100 -h|--help
102 Display help text.
103 --journal String
105 Record information in the systemd journal. This information is
106 in addition to information enabled by the lvm.conf log/journal
107 setting. command: record information about the command. out‐
108 put: record the default command output. debug: record full com‐
109 mand debugging.
110 --lockopt String
112 Used to pass options for special cases to lvmlockd. See lvm‐
113 lockd(8) for more information.
114 --longhelp
116 Display long help text.
117 --nohints
119 Do not use the hints file to locate devices for PVs. A command
120 may read more devices to find PVs when hints are not used. The
121 command will still perform standard hint file invalidation where
122 appropriate.
123 --nolocking
125 Disable locking. Use with caution, concurrent commands may pro‐
126 duce incorrect results.
127 --profile String
129 An alias for --commandprofile or --metadataprofile, depending on
130 the command.
131 -q|--quiet ...
133 Suppress output and log messages. Overrides --debug and --ver‐
134 bose. Repeat once to also suppress any prompts with answer
135 'no'.
136 --reportformat basic|json|json_std
138 Overrides current output format for reports which is defined
139 globally by the report/output_format setting in lvm.conf(5).
140 basic is the original format with columns and rows. If there is
141 more than one report per command, each report is prefixed with
142 the report name for identification. json produces report output
143 in JSON format. json_std produces report output in JSON format
144 which is more compliant with JSON standard. See lvmreport(7)
145 for more information.
146 -S|--select String
148 Select objects for processing and reporting based on specified
149 criteria. The criteria syntax is described by --select help and
150 lvmreport(7). For reporting commands, one row is displayed for
151 each object matching the criteria. See --options help for se‐
152 lectable object fields. Rows can be displayed with an addi‐
153 tional "selected" field (-o selected) showing 1 if the row
154 matches the selection and 0 otherwise. For non-reporting com‐
155 mands which process LVM entities, the selection is used to
156 choose items to process.
157 -t|--test
159 Run in test mode. Commands will not update metadata. This is
160 implemented by disabling all metadata writing but nevertheless
161 returning success to the calling function. This may lead to un‐
162 usual error messages in multi-stage operations if a tool relies
163 on reading back metadata it believes has changed but hasn't.
164 -v|--verbose ...
166 Set verbose level. Repeat from 1 to 4 times to increase the de‐
167 tail of messages sent to stdout and stderr.
168 --version
170 Display version information.
171 -y|--yes
173 Do not prompt for confirmation interactively but always assume
174 the answer yes. Use with extreme caution. (For automatic no,
175 see -qq.)
176
178 VG Volume Group name. See lvm(8) for valid names.
179 Tag Tag name. See lvm(8) for information about tag names and using
181 tags in place of a VG, LV or PV.
182 Select Select indicates that a required positional parameter can be
184 omitted if the --select option is used. No arg appears in this
185 position.
186 String See the option description for information about the string con‐
188 tent.
189 Size[UNIT]
191 Size is an input number that accepts an optional unit. Input
192 units are always treated as base two values, regardless of capi‐
193 talization, e.g. 'k' and 'K' both refer to 1024. The default
194 input unit is specified by letter, followed by |UNIT. UNIT rep‐
195 resents other possible input units: b|B is bytes, s|S is sectors
196 of 512 bytes, k|K is KiB, m|M is MiB, g|G is GiB, t|T is TiB,
197 p|P is PiB, e|E is EiB. (This should not be confused with the
198 output control --units, where capital letters mean multiple of
199 1000.)
200
202 See lvm(8) for information about environment variables used by lvm.
203 For example, LVM_VG_NAME can generally be substituted for a required VG
204 parameter.
205
207 lvm(8), lvm.conf(5), lvmconfig(8), lvmdevices(8),
208 pvchange(8), pvck(8), pvcreate(8), pvdisplay(8), pvmove(8),
210 pvremove(8), pvresize(8), pvs(8), pvscan(8),
211 vgcfgbackup(8), vgcfgrestore(8), vgchange(8), vgck(8), vgcreate(8),
213 vgconvert(8), vgdisplay(8), vgexport(8), vgextend(8), vgimport(8),
214 vgimportclone(8), vgimportdevices(8), vgmerge(8), vgmknodes(8),
215 vgreduce(8), vgremove(8), vgrename(8), vgs(8), vgscan(8), vgsplit(8),
216 lvcreate(8), lvchange(8), lvconvert(8), lvdisplay(8), lvextend(8),
218 lvreduce(8), lvremove(8), lvrename(8), lvresize(8), lvs(8), lvscan(8),
219 lvm-fullreport(8), lvm-lvpoll(8), blkdeactivate(8), lvmdump(8),
221 dmeventd(8), lvmpolld(8), lvmlockd(8), lvmlockctl(8), cmirrord(8),
223 lvmdbusd(8), fsadm(8),
224 lvmsystemid(7), lvmreport(7), lvmcache(7), lvmraid(7), lvmthin(7),
226 lvmvdo(7), lvmautoactivation(7)
227Red Hat, Inc. LVM TOOLS 2.03.22(2) (2023-08-02) VGEXPORT(8)