lvrename(8)

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

NAME

6       lvrename - Rename a logical volume
7

SYNOPSIS

9       lvrename position_args
10           [ option_args ]
11

DESCRIPTION

13       lvrename  renames  an  existing LV or a historical LV (see lvremove for
14       historical LV information.)
15

USAGE

17       lvrename VG LV LV_new
18           [ COMMON_OPTIONS ]
19
20       lvrename LV LV_new
21           [ COMMON_OPTIONS ]
22
23       Common options for command:
24           [ -A|--autobackup y|n ]
25           [    --noudevsync ]
26           [    --reportformat basic|json ]
27
28       Common options for lvm:
29           [ -d|--debug ]
30           [ -h|--help ]
31           [ -q|--quiet ]
32           [ -t|--test ]
33           [ -v|--verbose ]
34           [ -y|--yes ]
35           [    --commandprofile String ]
36           [    --config String ]
37           [    --driverloaded y|n ]
38           [    --lockopt String ]
39           [    --longhelp ]
40           [    --nolocking ]
41           [    --profile String ]
42           [    --version ]
43

OPTIONS

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

VARIABLES

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

ENVIRONMENT VARIABLES

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

EXAMPLES

155       Rename "lvold" to "lvnew":
156       lvrename /dev/vg02/lvold vg02/lvnew
157
158       An alternate syntax to rename "lvold" to "lvnew":
159       lvrename vg02 lvold lvnew
160