- Collection Index
- Collections in the Community Namespace
- Community.General
- community.general.lvol module – Configure LVM logical volumes
- Edit on GitHub
'; */ // Create a banner if we're not on the official docs site if (location.host == "docs.testing.ansible.com") { document.write('
' + '
This is the testing site for Ansible Documentation. Unless you are reviewing pre-production changes, please visit the official documentation website.
' + '
'); } // Create a banner current_url_path = window.location.pathname; var important = false; var msg = '
'; if (startsWith(current_url_path, "/ansible-core/")) { msg += 'You are reading documentation for Ansible Core, which contains no plugins except for those in ansible.builtin. For documentation of the Ansible package, go to the latest documentation.'; } else if (startsWithOneOf(current_url_path, ["/ansible/latest/", "/ansible/9/"])) { /* temp extra banner to advertise something */ banner += extra_banner; msg += 'This is the latest (stable) Ansible community documentation. For Red Hat Ansible Automation Platform subscriptions, see Life Cycle for version details.'; } else if (startsWith(current_url_path, "/ansible/2.9/")) { msg += 'You are reading the latest Red Hat released version of the Ansible documentation. Community users can use this version, or select latest from the version selector to the left for the most recent community version.'; } else if (startsWith(current_url_path, "/ansible/devel/")) { /* temp extra banner to advertise something */ banner += extra_banner; msg += 'You are reading the devel version of the Ansible documentation - this version is not guaranteed stable. Use the version selection to the left if you want the latest (stable) released version.'; } else { msg += 'You are reading an older version of the Ansible documentation. Use the version selection to the left if you want the latest (stable) released version.'; /* temp extra banner to advertise something - this is for testing*/ banner += extra_banner; } msg += '
'; banner += '
'; banner += important ? '
' : ''; banner += msg; banner += important ? '
' : ''; banner += '
'; document.write(banner);
Note
This module is part of the community.general collection (version 8.5.0).
You might already have this collection installed if you are using the ansible package.It is not included in ansible-core.To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install community.general.
To use it in a playbook, specify: community.general.lvol.
Synopsis
This module creates, removes or resizes logical volumes.
Aliases: system.lvol
Parameters
Parameter | Comments |
|---|---|
active boolean | Whether the volume is active and visible to the host. Choices:
|
force boolean | Shrink or remove operations of volumes requires this switch. Ensures that that filesystems get never corrupted/destroyed by mistake. Choices:
|
lv string | The name of the logical volume. |
opts string | Free-form options to be passed to the lvcreate command. |
pvs list / elements=string | List of physical volumes (for example |
resizefs boolean | Resize the underlying filesystem together with the logical volume. Supported for Choices:
|
shrink boolean | Shrink if current size is higher than size requested. Choices:
|
size string | 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) Resizing using Please note that when using |
snapshot string | The name of a snapshot volume to be configured. When creating a snapshot volume, the |
state string | Control if the logical volume exists. If Choices:
|
thinpool string | The thin pool volume name. When you want to create a thin provisioned volume, specify a thin pool volume name. |
vg string / required | The volume group this logical volume is part of. |
Attributes
Attribute | Support | Description |
|---|---|---|
check_mode | Support: full | Can run in |
diff_mode | Support: none | Will return details on what has changed (or possibly needs changing in |
Notes
Note
You must specify lv (when managing the state of logical volumes) or thinpool (when managing a thin provisioned volume).
Examples
- name: Create a logical volume of 512m community.general.lvol: vg: firefly lv: test size: 512- 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- name: Create cache pool logical volume community.general.lvol: vg: firefly lv: lvcache size: 512m opts: --type cache-pool- name: Create a logical volume of 512g. community.general.lvol: vg: firefly lv: test size: 512g- 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- name: Create a logical volume with special options community.general.lvol: vg: firefly lv: test size: 512g opts: -r 16- name: Extend the logical volume to 1024m. community.general.lvol: vg: firefly lv: test size: 1024- name: Extend the logical volume to consume all remaining space in the volume group community.general.lvol: vg: firefly lv: test size: +100%FREE- name: Extend the logical volume by given space community.general.lvol: vg: firefly lv: test size: +512M- 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- name: Resize the logical volume to % of VG community.general.lvol: vg: firefly lv: test size: 80%VG force: true- name: Reduce the logical volume to 512m community.general.lvol: vg: firefly lv: test size: 512 force: true- name: Reduce the logical volume by given space community.general.lvol: vg: firefly lv: test size: -512M force: true- 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- name: Remove the logical volume. community.general.lvol: vg: firefly lv: test state: absent force: true- name: Create a snapshot volume of the test logical volume. community.general.lvol: vg: firefly lv: test snapshot: snap1 size: 100m- name: Deactivate a logical volume community.general.lvol: vg: firefly lv: test active: false- name: Create a deactivated logical volume community.general.lvol: vg: firefly lv: test size: 512g active: false- name: Create a thin pool of 512g community.general.lvol: vg: firefly thinpool: testpool size: 512g- name: Create a thin volume of 128g community.general.lvol: vg: firefly lv: test thinpool: testpool size: 128g
Authors
Jeroen Hoekx (@jhoekx)
Alexander Bulimov (@abulimov)
Raoul Baudach (@unkaputtbar112)
Ziga Kern (@zigaSRC)
