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|json_std ]
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           [    --devices PV ]
38           [    --devicesfile String ]
39           [    --driverloaded y|n ]
40           [    --journal String ]
41           [    --lockopt String ]
42           [    --longhelp ]
43           [    --nohints ]
44           [    --nolocking ]
45           [    --profile String ]
46           [    --version ]
47

OPTIONS

49       -A|--autobackup y|n
50              Specifies if metadata should be backed up automatically after  a
51              change.   Enabling  this is strongly advised! See vgcfgbackup(8)
52              for more information.
53
54       --commandprofile String
55              The command profile  to  use  for  command  configuration.   See
56              lvm.conf(5) for more information about profiles.
57
58       --config String
59              Config settings for the command. These override lvm.conf(5) set‐
60              tings.  The String arg uses the same format as  lvm.conf(5),  or
61              may use section/field syntax.  See lvm.conf(5) for more informa‐
62              tion about config.
63
64       -d|--debug ...
65              Set debug level. Repeat from 1 to 6 times to increase the detail
66              of messages sent to the log file and/or syslog (if configured).
67
68       --devices PV
69              Restricts  the  devices  that  are visible and accessible to the
70              command.  Devices not listed will appear to be missing. This op‐
71              tion  can  be repeated, or accepts a comma separated list of de‐
72              vices. This overrides the devices file.
73
74       --devicesfile String
75              A file listing devices that LVM should use.  The file must exist
76              in  /etc/lvm/devices/ and is managed with the lvmdevices(8) com‐
77              mand.  This overrides the  lvm.conf(5)  devices/devicesfile  and
78              devices/use_devicesfile settings.
79
80       --driverloaded y|n
81              If set to no, the command will not attempt to use device-mapper.
82              For testing and debugging.
83
84       -h|--help
85              Display help text.
86
87       --journal String
88              Record information in the systemd journal.  This information  is
89              in  addition  to information enabled by the lvm.conf log/journal
90              setting.  command: record information about the  command.   out‐
91              put: record the default command output.  debug: record full com‐
92              mand debugging.
93
94       --lockopt String
95              Used to pass options for special cases to  lvmlockd.   See  lvm‐
96              lockd(8) for more information.
97
98       --longhelp
99              Display long help text.
100
101       --nohints
102              Do  not  use the hints file to locate devices for PVs. A command
103              may read more devices to find PVs when hints are not  used.  The
104              command will still perform standard hint file invalidation where
105              appropriate.
106
107       --nolocking
108              Disable locking. Use with caution, concurrent commands may  pro‐
109              duce incorrect results.
110
111       --noudevsync
112              Disables udev synchronization. The process will not wait for no‐
113              tification from udev. It will continue irrespective of any  pos‐
114              sible  udev  processing in the background. Only use this if udev
115              is not running or has rules that ignore the devices LVM creates.
116
117       --profile String
118              An alias for --commandprofile or --metadataprofile, depending on
119              the command.
120
121       -q|--quiet ...
122              Suppress  output  and log messages. Overrides --debug and --ver‐
123              bose.  Repeat once to also  suppress  any  prompts  with  answer
124              'no'.
125
126       --reportformat basic|json|json_std
127              Overrides  current  output  format  for reports which is defined
128              globally by the  report/output_format  setting  in  lvm.conf(5).
129              basic is the original format with columns and rows.  If there is
130              more than one report per command, each report is  prefixed  with
131              the  report name for identification. json produces report output
132              in JSON format. json_std produces report output in  JSON  format
133              which  is  more  compliant with JSON standard.  See lvmreport(7)
134              for more information.
135
136       -t|--test
137              Run in test mode. Commands will not update  metadata.   This  is
138              implemented  by  disabling all metadata writing but nevertheless
139              returning success to the calling function. This may lead to  un‐
140              usual  error messages in multi-stage operations if a tool relies
141              on reading back metadata it believes has changed but hasn't.
142
143       -v|--verbose ...
144              Set verbose level. Repeat from 1 to 4 times to increase the  de‐
145              tail of messages sent to stdout and stderr.
146
147       --version
148              Display version information.
149
150       -y|--yes
151              Do  not  prompt for confirmation interactively but always assume
152              the answer yes. Use with extreme caution.   (For  automatic  no,
153              see -qq.)
154

VARIABLES

156       VG     Volume Group name.  See lvm(8) for valid names.
157
158       LV     Logical  Volume  name.  See lvm(8) for valid names.  An LV posi‐
159              tional arg generally includes the VG  name  and  LV  name,  e.g.
160              VG/LV.
161
162       String See the option description for information about the string con‐
163              tent.
164
165       Size[UNIT]
166              Size is an input number that accepts an  optional  unit.   Input
167              units are always treated as base two values, regardless of capi‐
168              talization, e.g. 'k' and 'K' both refer to  1024.   The  default
169              input unit is specified by letter, followed by |UNIT.  UNIT rep‐
170              resents other possible input units: b|B is bytes, s|S is sectors
171              of  512  bytes,  k|K is KiB, m|M is MiB, g|G is GiB, t|T is TiB,
172              p|P is PiB, e|E is EiB.  (This should not be confused  with  the
173              output  control  --units, where capital letters mean multiple of
174              1000.)
175

ENVIRONMENT VARIABLES

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

EXAMPLES

182       Rename "lvold" to "lvnew":
183       lvrename /dev/vg02/lvold vg02/lvnew
184
185       An alternate syntax to rename "lvold" to "lvnew":
186       lvrename vg02 lvold lvnew
187