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 ac‐
18       cidentally 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           [    --nolocking ]
61           [    --profile String ]
62           [    --version ]
63

OPTIONS

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

VARIABLES

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

ENVIRONMENT VARIABLES

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