Documentation

PLEASE NOTE: This document applies to latest version and not to the latest stable release v2.21

Documentation for other releases can be found by using the version selector in the top right of any doc page.

btrfs

Manage Btrfs subvolumes, snapshots, and properties.

Attributes

check_mode:
  support: full

Parameters

Parameter	Required	Type	Values	Description
device	true	string		Path to the Btrfs device or mount point.
subvolume	true	string		Subvolume path relative to the mount point.
state		string	present absent	Whether the subvolume should exist or not. [default: `"present"`]
snapshot		string		Destination path for a snapshot of the subvolume.
readonly		boolean		Whether the snapshot should be read-only. [default: `true`]
properties		object		Dict of subvolume properties to set.
compression		string		Compression algorithm (e.g., zstd, lzo, zlib).

Example

- name: Create Btrfs subvolume
  btrfs:
    device: /dev/sda1
    subvolume: /data/app
    state: present

- name: Create subvolume with compression
  btrfs:
    device: /dev/sda1
    subvolume: /data/compressed
    state: present
    compression: zstd

- name: Create read-only snapshot
  btrfs:
    device: /dev/sda1
    subvolume: /data/app
    snapshot: /data/app-snap
    readonly: true

- name: Create read-write snapshot
  btrfs:
    device: /dev/sda1
    subvolume: /data/app
    snapshot: /data/app-rw-snap
    readonly: false

- name: Set subvolume properties
  btrfs:
    device: /dev/sda1
    subvolume: /data/app
    state: present
    properties:
      compression: zstd

- name: Delete subvolume
  btrfs:
    device: /dev/sda1
    subvolume: /data/old
    state: absent

- name: Delete snapshot
  btrfs:
    device: /dev/sda1
    subvolume: /data/app-snap
    state: absent