vgrename(8)

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

NAME

6       vgrename — Rename a volume group
7

SYNOPSIS

9       vgrename position_args
10           [ option_args ]
11

DESCRIPTION

13       vgrename renames a VG.
14
15       All  VGs  visible  to  a system need to have different names, otherwise
16       many LVM commands will refuse to run or give warning messages. VGs with
17       the  same name can occur when disks are moved between machines, or fil‐
18       ters are changed. If a newly connected disk has a VG with the same name
19       as the VG containing the root filesystem, the machine may not boot cor‐
20       rectly. When two VGs have the same name, the VG UUID  can  be  used  in
21       place of the source VG name.
22

USAGE

24       Rename a VG.
25
26       vgrename VG VG_new
27           [ COMMON_OPTIONS ]
28
29       Rename a VG by specifying the VG UUID.
30
31       vgrename String VG_new
32           [ COMMON_OPTIONS ]
33
34       Common options for command:
35           [ -A|--autobackup y|n ]
36           [ -f|--force ]
37           [    --reportformat basic|json|json_std ]
38
39       Common options for lvm:
40           [ -d|--debug ]
41           [ -h|--help ]
42           [ -q|--quiet ]
43           [ -t|--test ]
44           [ -v|--verbose ]
45           [ -y|--yes ]
46           [    --commandprofile String ]
47           [    --config String ]
48           [    --devices PV ]
49           [    --devicesfile String ]
50           [    --driverloaded y|n ]
51           [    --journal String ]
52           [    --lockopt String ]
53           [    --longhelp ]
54           [    --nohints ]
55           [    --nolocking ]
56           [    --profile String ]
57           [    --version ]
58

OPTIONS

60       -A|--autobackup y|n
61              Specifies  if metadata should be backed up automatically after a
62              change.  Enabling this is strongly advised!  See  vgcfgbackup(8)
63              for more information.
64
65       --commandprofile String
66              The  command  profile  to  use  for  command configuration.  See
67              lvm.conf(5) for more information about profiles.
68
69       --config String
70              Config settings for the command. These override lvm.conf(5) set‐
71              tings.   The  String arg uses the same format as lvm.conf(5), or
72              may use section/field syntax.  See lvm.conf(5) for more informa‐
73              tion about config.
74
75       -d|--debug ...
76              Set debug level. Repeat from 1 to 6 times to increase the detail
77              of messages sent to the log file and/or syslog (if configured).
78
79       --devices PV
80              Restricts the devices that are visible  and  accessible  to  the
81              command.  Devices not listed will appear to be missing. This op‐
82              tion can be repeated, or accepts a comma separated list  of  de‐
83              vices. This overrides the devices file.
84
85       --devicesfile String
86              A file listing devices that LVM should use.  The file must exist
87              in /etc/lvm/devices/ and is managed with the lvmdevices(8)  com‐
88              mand.   This  overrides  the lvm.conf(5) devices/devicesfile and
89              devices/use_devicesfile settings.
90
91       --driverloaded y|n
92              If set to no, the command will not attempt to use device-mapper.
93              For testing and debugging.
94
95       -f|--force ...
96              Override  various  checks,  confirmations  and protections.  Use
97              with extreme caution.
98
99       -h|--help
100              Display help text.
101
102       --journal String
103              Record information in the systemd journal.  This information  is
104              in  addition  to information enabled by the lvm.conf log/journal
105              setting.  command: record information about the  command.   out‐
106              put: record the default command output.  debug: record full com‐
107              mand debugging.
108
109       --lockopt String
110              Used to pass options for special cases to  lvmlockd.   See  lvm‐
111              lockd(8) for more information.
112
113       --longhelp
114              Display long help text.
115
116       --nohints
117              Do  not  use the hints file to locate devices for PVs. A command
118              may read more devices to find PVs when hints are not  used.  The
119              command will still perform standard hint file invalidation where
120              appropriate.
121
122       --nolocking
123              Disable locking. Use with caution, concurrent commands may  pro‐
124              duce incorrect results.
125
126       --profile String
127              An alias for --commandprofile or --metadataprofile, depending on
128              the command.
129
130       -q|--quiet ...
131              Suppress output and log messages. Overrides --debug  and  --ver‐
132              bose.   Repeat  once  to  also  suppress any prompts with answer
133              'no'.
134
135       --reportformat basic|json|json_std
136              Overrides current output format for  reports  which  is  defined
137              globally  by  the  report/output_format  setting in lvm.conf(5).
138              basic is the original format with columns and rows.  If there is
139              more  than  one report per command, each report is prefixed with
140              the report name for identification. json produces report  output
141              in  JSON  format. json_std produces report output in JSON format
142              which is more compliant with JSON  standard.   See  lvmreport(7)
143              for more information.
144
145       -t|--test
146              Run  in  test  mode. Commands will not update metadata.  This is
147              implemented by disabling all metadata writing  but  nevertheless
148              returning  success to the calling function. This may lead to un‐
149              usual error messages in multi-stage operations if a tool  relies
150              on reading back metadata it believes has changed but hasn't.
151
152       -v|--verbose ...
153              Set  verbose level. Repeat from 1 to 4 times to increase the de‐
154              tail of messages sent to stdout and stderr.
155
156       --version
157              Display version information.
158
159       -y|--yes
160              Do not prompt for confirmation interactively but  always  assume
161              the  answer  yes.  Use with extreme caution.  (For automatic no,
162              see -qq.)
163

VARIABLES

165       VG     Volume Group name.  See lvm(8) for valid names.
166
167       String See the option description for information about the string con‐
168              tent.
169
170       Size[UNIT]
171              Size  is  an  input number that accepts an optional unit.  Input
172              units are always treated as base two values, regardless of capi‐
173              talization,  e.g.  'k'  and 'K' both refer to 1024.  The default
174              input unit is specified by letter, followed by |UNIT.  UNIT rep‐
175              resents other possible input units: b|B is bytes, s|S is sectors
176              of 512 bytes, k|K is KiB, m|M is MiB, g|G is GiB,  t|T  is  TiB,
177              p|P  is  PiB, e|E is EiB.  (This should not be confused with the
178              output control --units, where capital letters mean  multiple  of
179              1000.)
180

ENVIRONMENT VARIABLES

182       See  lvm(8)  for  information  about environment variables used by lvm.
183       For example, LVM_VG_NAME can generally be substituted for a required VG
184       parameter.
185

EXAMPLES

187       Rename VG "vg02" to "myvg":
188       vgrename vg02 myvg
189
190       Rename the VG with the specified UUID to "myvg".
191       vgrename Zvlifi-Ep3t-e0Ng-U42h-o0ye-KHu1-nl7Ns4 myvg
192