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           [    --profile String ]
41           [    --version ]
42

OPTIONS

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

VARIABLES

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

ENVIRONMENT VARIABLES

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

EXAMPLES

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