Ansible Role: Sanoid

An Ansible Role that installs Sanoid and Syncoid on Linux servers for ZFS snapshot, backup, and replication management.

Requirements

ZFS.

Role Variables

Available variables are listed below, along with default values (see defaults/main.yml):

sanoid_conf: ""

The configuration to be stored inside /etc/sanoid/sanoid.conf. See the Sanoid project's README file and Wiki for examples.

Dependencies

None.

Example Playbook

Install from the system package manager:

    - hosts: zfs

      vars:
        # This assumes you have a ZFS volume `tank/volume`.
        sanoid_conf: >
          # Filesystem Backups
          [tank/volume]
            use_template = production
            recursive = yes

          # Templates
          [template_production]
            frequently = 0
            hourly = 24
            daily = 30
            monthly = 3
            yearly = 0
            autosnap = yes
            autoprune = yes

      roles:
        - role: geerlingguy.sanoid

License

GPLv3

Author Information

This role was created in 2024 by Jeff Geerling, author of Ansible for DevOps.