community.general.proxmox_snap – Snapshot management of instances in Proxmox VE cluster

Note

This plugin is part of the community.general collection (version 3.8.1).

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.proxmox_snap.

New in version 2.0.0: of community.general

Synopsis

  • Allows you to create/delete snapshots from instances in Proxmox VE cluster.
  • Supports both KVM and LXC, OpenVZ has not been tested, as it is no longer supported on Proxmox VE.

Requirements

The below requirements are needed on the host that executes this module.

  • proxmoxer
  • python >= 2.7
  • requests

Parameters

Parameter Choices/Defaults Comments
api_host
string / required
The host of the Proxmox VE cluster.
api_password
string / required
The password to authenticate with.
You can use PROXMOX_PASSWORD environment variable.
api_user
string / required
The user to authenticate with.
description
string
Specify the description for the snapshot. Only used on the configuration web interface.
This is saved as a comment inside the configuration file.
force
boolean
    Choices:
  • no ←
  • yes
For removal from config file, even if removing disk snapshot fails.
hostname
string
The instance name.
snapname
string
Default:
"ansible_snap"
Name of the snapshot that has to be created.
state
string
    Choices:
  • present ←
  • absent
Indicate desired state of the instance snapshot.
timeout
integer
Default:
30
Timeout for operations.
validate_certs
boolean
    Choices:
  • no ←
  • yes
Enable / disable https certificate verification.
vmid
string
The instance id.
If not set, will be fetched from PromoxAPI based on the hostname.
vmstate
boolean
    Choices:
  • no ←
  • yes
Snapshot includes RAM.

Notes

Note

  • Requires proxmoxer and requests modules on host. These modules can be installed with pip.
  • Supports check_mode.

Examples

- name: Create new container snapshot
  community.general.proxmox_snap:
    api_user: root@pam
    api_password: 1q2w3e
    api_host: node1
    vmid: 100
    state: present
    snapname: pre-updates

- name: Remove container snapshot
  community.general.proxmox_snap:
    api_user: root@pam
    api_password: 1q2w3e
    api_host: node1
    vmid: 100
    state: absent
    snapname: pre-updates

Authors

  • Jeffrey van Pelt (@Thulium-Drake)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/proxmox_snap_module.html