Ubuntu Manpage: vgrename - Rename a volume group

Provided by: lvm2_2.02.176-4.1ubuntu3.18.04.3_amd64

NAME

       vgrename - Rename a volume group

SYNOPSIS

       vgrename position_args
           [ option_args ]

DESCRIPTION

       vgrename renames a VG.

       All VGs visible to a system need to have different names, otherwise many LVM commands will
       refuse to run or give warning messages. VGs with the same name can occur  when  disks  are
       moved  between  machines,  or filters are changed. If a newly connected disk has a VG with
       the same name as the  VG  containing  the  root  filesystem,  the  machine  may  not  boot
       correctly. When two VGs have the same name, the VG UUID can be used in place of the source
       VG name.

USAGE

       Rename a VG.

       vgrename VG VG_new
           [ COMMON_OPTIONS ]

       Rename a VG by specifying the VG UUID.

       vgrename String VG_new
           [ COMMON_OPTIONS ]

       Common options for command:
           [ -A|--autobackup y|n ]
           [ -f|--force ]
           [    --reportformat basic|json ]

       Common options for lvm:
           [ -d|--debug ]
           [ -h|--help ]
           [ -q|--quiet ]
           [ -t|--test ]
           [ -v|--verbose ]
           [ -y|--yes ]
           [    --commandprofile String ]
           [    --config String ]
           [    --driverloaded y|n ]
           [    --longhelp ]
           [    --profile String ]
           [    --version ]

OPTIONS

-A|--autobackup y|n
Specifies if metadata should be backed up automatically after a change. Enabling
this is strongly advised! See vgcfgbackup(8) for more information.

--commandprofile String
The command profile to use for command configuration. See lvm.conf(5) for more
information about profiles.

--config String
Config settings for the command. These override lvm.conf settings. The String arg
uses the same format as lvm.conf, or may use section/field syntax. See lvm.conf(5)
for more information about config.

-d|--debug ...
Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent
to the log file and/or syslog (if configured).

--driverloaded y|n
If set to no, the command will not attempt to use device-mapper. For testing and
debugging.

-f|--force ...
Override various checks, confirmations and protections. Use with extreme caution.

-h|--help
Display help text.

--longhelp
Display long help text.

--profile String
An alias for --commandprofile or --metadataprofile, depending on the command.

-q|--quiet ...
Suppress output and log messages. Overrides --debug and --verbose. Repeat once to
also suppress any prompts with answer 'no'.

--reportformat basic|json
Overrides current output format for reports which is defined globally by the
report/output_format setting in lvm.conf. basic is the original format with
columns and rows. If there is more than one report per command, each report is
prefixed with the report name for identification. json produces report output in
JSON format. See lvmreport(7) for more information.

-t|--test
Run in test mode. Commands will not update metadata. This is implemented by
disabling all metadata writing but nevertheless returning success to the calling
function. This may lead to unusual error messages in multi-stage operations if a
tool relies on reading back metadata it believes has changed but hasn't.

-v|--verbose ...
Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent
to stdout and stderr.

--version
Display version information.

-y|--yes
Do not prompt for confirmation interactively but always assume the answer yes. Use
with extreme caution. (For automatic no, see -qq.)

VARIABLES

       VG
              Volume Group name.  See lvm(8) for valid names.

       String
              See the option description for information about the string content.

       Size[UNIT]
              Size is an input number that accepts an optional  unit.   Input  units  are  always
              treated  as  base  two  values, regardless of capitalization, e.g. 'k' and 'K' both
              refer to 1024.  The default input unit is specified by letter, followed  by  |UNIT.
              UNIT represents other possible input units: bBsSkKmMgGtTpPeE.  b|B is bytes, s|S is
              sectors of 512 bytes, k|K is kilobytes, m|M is megabytes, g|G is gigabytes, t|T  is
              terabytes,  p|P  is  petabytes, e|E is exabytes.  (This should not be confused with
              the output control --units, where capital letters mean multiple of 1000.)

ENVIRONMENT VARIABLES

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

EXAMPLES

       Rename VG "vg02" to "myvg":
       vgrename vg02 myvg

       Rename the VG with the specified UUID to "myvg".
       vgrename Zvlifi-Ep3t-e0Ng-U42h-o0ye-KHu1-nl7Ns4 myvg