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 no‐
83              tification from udev. It will continue irrespective of any pos‐
84              sible udev processing in the background. Only use this if udev
85              is not running or has rules that ignore the devices LVM creates.
86
87       --profile String
88              An alias for --commandprofile or --metadataprofile, depending on
89              the command.
90
91       -q|--quiet ...
92              Suppress output and log messages. Overrides --debug and --ver‐
93              bose.  Repeat once to also suppress any prompts with answer
94              'no'.
95
96       --reportformat basic|json
97              Overrides current output format for reports which is defined
98              globally by the report/output_format setting in lvm.conf.  basic
99              is the original format with columns and rows.  If there is more
100              than one report per command, each report is prefixed with the
101              report name for identification. json produces report output in
102              JSON format. See lvmreport(7) for more information.
103
104       -t|--test
105              Run in test mode. Commands will not update metadata.  This is
106              implemented by disabling all metadata writing but nevertheless
107              returning success to the calling function. This may lead to un‐
108              usual error messages in multi-stage operations if a tool relies
109              on reading back metadata it believes has changed but hasn't.
110
111       -v|--verbose ...
112              Set verbose level. Repeat from 1 to 4 times to increase the de‐
113              tail of messages sent to stdout and stderr.
114
115       --version
116              Display version information.
117
118       -y|--yes
119              Do not prompt for confirmation interactively but always assume
120              the answer yes. Use with extreme caution.  (For automatic no,
121              see -qq.)
122

VARIABLES

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

ENVIRONMENT VARIABLES

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

EXAMPLES

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