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 ]
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           [    --driverloaded y|n ]
49           [    --lockopt String ]
50           [    --longhelp ]
51           [    --nolocking ]
52           [    --profile String ]
53           [    --version ]
54

OPTIONS

56       -A|--autobackup y|n
57              Specifies if metadata should be backed up automatically after a
58              change.  Enabling this is strongly advised! See vgcfgbackup(8)
59              for more information.
60
61       --commandprofile String
62              The command profile to use for command configuration.  See
63              lvm.conf(5) for more information about profiles.
64
65       --config String
66              Config settings for the command. These override lvm.conf set‐
67              tings.  The String arg uses the same format as lvm.conf, or may
68              use section/field syntax.  See lvm.conf(5) for more information
69              about config.
70
71       -d|--debug ...
72              Set debug level. Repeat from 1 to 6 times to increase the detail
73              of messages sent to the log file and/or syslog (if configured).
74
75       --driverloaded y|n
76              If set to no, the command will not attempt to use device-mapper.
77              For testing and debugging.
78
79       -f|--force ...
80              Override various checks, confirmations and protections.  Use
81              with extreme caution.
82
83       -h|--help
84              Display help text.
85
86       --lockopt String
87              Used to pass options for special cases to lvmlockd.  See lvm‐
88              lockd(8) for more information.
89
90       --longhelp
91              Display long help text.
92
93       --nolocking
94              Disable locking.
95
96       --profile String
97              An alias for --commandprofile or --metadataprofile, depending on
98              the command.
99
100       -q|--quiet ...
101              Suppress output and log messages. Overrides --debug and --ver‐
102              bose.  Repeat once to also suppress any prompts with answer
103              'no'.
104
105       --reportformat basic|json
106              Overrides current output format for reports which is defined
107              globally by the report/output_format setting in lvm.conf.  basic
108              is the original format with columns and rows.  If there is more
109              than one report per command, each report is prefixed with the
110              report name for identification. json produces report output in
111              JSON format. See lvmreport(7) for more information.
112
113       -t|--test
114              Run in test mode. Commands will not update metadata.  This is
115              implemented by disabling all metadata writing but nevertheless
116              returning success to the calling function. This may lead to
117              unusual error messages in multi-stage operations if a tool
118              relies on reading back metadata it believes has changed but
119              hasn't.
120
121       -v|--verbose ...
122              Set verbose level. Repeat from 1 to 4 times to increase the
123              detail of messages sent to stdout and stderr.
124
125       --version
126              Display version information.
127
128       -y|--yes
129              Do not prompt for confirmation interactively but always assume
130              the answer yes. Use with extreme caution.  (For automatic no,
131              see -qq.)
132

VARIABLES

134       VG
135              Volume Group name.  See lvm(8) for valid names.
136
137       String
138              See the option description for information about the string con‐
139              tent.
140
141       Size[UNIT]
142              Size is an input number that accepts an  optional  unit.   Input
143              units are always treated as base two values, regardless of capi‐
144              talization, e.g. 'k' and 'K' both refer to  1024.   The  default
145              input unit is specified by letter, followed by |UNIT.  UNIT rep‐
146              resents other possible input units:  bBsSkKmMgGtTpPeE.   b|B  is
147              bytes,  s|S  is  sectors  of 512 bytes, k|K is kilobytes, m|M is
148              megabytes, g|G is gigabytes, t|T is terabytes, p|P is petabytes,
149              e|E  is  exabytes.  (This should not be confused with the output
150              control --units, where capital letters mean multiple of 1000.)
151

ENVIRONMENT VARIABLES

153       See lvm(8) for information about environment  variables  used  by  lvm.
154       For example, LVM_VG_NAME can generally be substituted for a required VG
155       parameter.
156

EXAMPLES

158       Rename VG "vg02" to "myvg":
159       vgrename vg02 myvg
160
161       Rename the VG with the specified UUID to "myvg".
162       vgrename Zvlifi-Ep3t-e0Ng-U42h-o0ye-KHu1-nl7Ns4 myvg
163