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           [    --profile String ]
52           [    --version ]
53

OPTIONS

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

VARIABLES

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

ENVIRONMENT VARIABLES

149       See lvm(8) for information about environment  variables  used  by  lvm.
150       For example, LVM_VG_NAME can generally be substituted for a required VG
151       parameter.
152

EXAMPLES

154       Rename VG "vg02" to "myvg":
155       vgrename vg02 myvg
156
157       Rename the VG with the specified UUID to "myvg".
158       vgrename Zvlifi-Ep3t-e0Ng-U42h-o0ye-KHu1-nl7Ns4 myvg
159