community.general.proxmox_snap (2.5.9) — module

Install collection

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

Add to requirements.yml

  collections:
    - name: community.general
      version: 2.5.9

Description

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

• proxmoxer
• python >= 2.7
• requests

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

    
vmid:
    description:
    - The instance id.
    - If not set, will be fetched from PromoxAPI based on the hostname.
    type: str

force:
    default: false
    description:
    - For removal from config file, even if removing disk snapshot fails.
    type: bool

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Indicate desired state of the instance snapshot.
    type: str

timeout:
    default: 30
    description:
    - Timeout for operations.
    type: int

vmstate:
    default: false
    description:
    - Snapshot includes RAM.
    type: bool

api_host:
    description:
    - The host of the Proxmox VE cluster.
    required: true
    type: str

api_user:
    description:
    - The user to authenticate with.
    required: true
    type: str

hostname:
    description:
    - The instance name.
    type: str

snapname:
    default: ansible_snap
    description:
    - Name of the snapshot that has to be created.
    type: str

description:
    description:
    - Specify the description for the snapshot. Only used on the configuration web interface.
    - This is saved as a comment inside the configuration file.
    type: str

api_password:
    description:
    - The password to authenticate with.
    - You can use PROXMOX_PASSWORD environment variable.
    required: true
    type: str

validate_certs:
    default: false
    description:
    - Enable / disable https certificate verification.
    type: bool