Documentation

lvg - Configure LVM volume groups

Synopsis

  • This module creates, removes or resizes volume groups.

Options

parameter required default choices comments
force
 no no
  • yes
  • no
If yes, allows to remove volume group with logical volumes.
pesize
 no 4
The size of the physical extent in megabytes. Must be a power of 2.
pv_options
(added in 2.4)
 no
Additional options to pass to pvcreate when creating the volume group.
pvs
 no
List of comma-separated devices to use as physical devices in this volume group. Required when creating or resizing volume group.
The module will take care of running pvcreate if needed.
state
 no present
  • present
  • absent
Control if the volume group exists.
vg
 yes
The name of the volume group.
vg_options
(added in 1.6)
 no
Additional options to pass to vgcreate when creating the volume group.

Examples

# Create a volume group on top of /dev/sda1 with physical extent size = 32MB.
- lvg:
    vg: vg.services
    pvs: /dev/sda1
    pesize: 32

# Create or resize a volume group on top of /dev/sdb1 and /dev/sdc5.
# If, for example, we already have VG vg.services on top of /dev/sdb1,
# this VG will be extended by /dev/sdc5.  Or if vg.services was created on
# top of /dev/sda5, we first extend it with /dev/sdb1 and /dev/sdc5,
# and then reduce by /dev/sda5.
- lvg:
    vg: vg.services
    pvs: /dev/sdb1,/dev/sdc5

# Remove a volume group with name vg.services.
- lvg:
    vg: vg.services
    state: absent

Notes

Note

  • module does not modify PE size for already present volume group

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.