community.general.lvol (8.5.0) — module

Configure LVM logical volumes

Authors: Jeroen Hoekx (@jhoekx), Alexander Bulimov (@abulimov), Raoul Baudach (@unkaputtbar112), Ziga Kern (@zigaSRC)

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0


Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

This module creates, removes or resizes logical volumes.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create a logical volume of 512m
  community.general.lvol:
    vg: firefly
    lv: test
    size: 512
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create a logical volume of 512m with disks /dev/sda and /dev/sdb
  community.general.lvol:
    vg: firefly
    lv: test
    size: 512
    pvs:
      - /dev/sda
      - /dev/sdb
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create cache pool logical volume
  community.general.lvol:
    vg: firefly
    lv: lvcache
    size: 512m
    opts: --type cache-pool
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create a logical volume of 512g.
  community.general.lvol:
    vg: firefly
    lv: test
    size: 512g
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create a logical volume the size of all remaining space in the volume group
  community.general.lvol:
    vg: firefly
    lv: test
    size: 100%FREE
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create a logical volume with special options
  community.general.lvol:
    vg: firefly
    lv: test
    size: 512g
    opts: -r 16
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Extend the logical volume to 1024m.
  community.general.lvol:
    vg: firefly
    lv: test
    size: 1024
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Extend the logical volume to consume all remaining space in the volume group
  community.general.lvol:
    vg: firefly
    lv: test
    size: +100%FREE
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Extend the logical volume by given space
  community.general.lvol:
    vg: firefly
    lv: test
    size: +512M
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Extend the logical volume to take all remaining space of the PVs and resize the underlying filesystem
  community.general.lvol:
    vg: firefly
    lv: test
    size: 100%PVS
    resizefs: true
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Resize the logical volume to % of VG
  community.general.lvol:
    vg: firefly
    lv: test
    size: 80%VG
    force: true
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Reduce the logical volume to 512m
  community.general.lvol:
    vg: firefly
    lv: test
    size: 512
    force: true
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Reduce the logical volume by given space
  community.general.lvol:
    vg: firefly
    lv: test
    size: -512M
    force: true
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Set the logical volume to 512m and do not try to shrink if size is lower than current one
  community.general.lvol:
    vg: firefly
    lv: test
    size: 512
    shrink: false
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Remove the logical volume.
  community.general.lvol:
    vg: firefly
    lv: test
    state: absent
    force: true
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create a snapshot volume of the test logical volume.
  community.general.lvol:
    vg: firefly
    lv: test
    snapshot: snap1
    size: 100m
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Deactivate a logical volume
  community.general.lvol:
    vg: firefly
    lv: test
    active: false
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create a deactivated logical volume
  community.general.lvol:
    vg: firefly
    lv: test
    size: 512g
    active: false
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create a thin pool of 512g
  community.general.lvol:
    vg: firefly
    thinpool: testpool
    size: 512g
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create a thin volume of 128g
  community.general.lvol:
    vg: firefly
    lv: test
    thinpool: testpool
    size: 128g

Inputs

    
lv:
    description:
    - The name of the logical volume.
    type: str

vg:
    description:
    - The volume group this logical volume is part of.
    required: true
    type: str

pvs:
    description:
    - List of physical volumes (for example V(/dev/sda, /dev/sdb)).
    elements: str
    type: list

opts:
    description:
    - Free-form options to be passed to the lvcreate command.
    type: str

size:
    description:
    - The size of the logical volume, according to lvcreate(8) --size, by default in megabytes
      or optionally with one of [bBsSkKmMgGtTpPeE] units; or according to lvcreate(8)
      --extents as a percentage of [VG|PVS|FREE|ORIGIN]; Float values must begin with
      a digit.
    - When resizing, apart from specifying an absolute size you may, according to lvextend(8)|lvreduce(8)
      C(--size), specify the amount to extend the logical volume with the prefix V(+)
      or the amount to reduce the logical volume by with prefix V(-).
    - Resizing using V(+) or V(-) was not supported prior to community.general 3.0.0.
    - Please note that when using V(+), V(-), or percentage of FREE, the module is B(not
      idempotent).
    type: str

force:
    default: false
    description:
    - Shrink or remove operations of volumes requires this switch. Ensures that that filesystems
      get never corrupted/destroyed by mistake.
    type: bool

state:
    choices:
    - absent
    - present
    default: present
    description:
    - Control if the logical volume exists. If V(present) and the volume does not already
      exist then the O(size) option is required.
    type: str

active:
    default: true
    description:
    - Whether the volume is active and visible to the host.
    type: bool

shrink:
    default: true
    description:
    - Shrink if current size is higher than size requested.
    type: bool

resizefs:
    default: false
    description:
    - Resize the underlying filesystem together with the logical volume.
    - Supported for C(ext2), C(ext3), C(ext4), C(reiserfs) and C(XFS) filesystems. Attempts
      to resize other filesystem types will fail.
    type: bool

snapshot:
    description:
    - The name of a snapshot volume to be configured. When creating a snapshot volume,
      the O(lv) parameter specifies the origin volume.
    type: str

thinpool:
    description:
    - The thin pool volume name. When you want to create a thin provisioned volume, specify
      a thin pool volume name.
    type: str