community.proxmox.proxmox_snap_info module – Snapshot management of instances in Proxmox VE cluster

Note

This module is part of the community.proxmox collection (version 1.6.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.proxmox. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: community.proxmox.proxmox_snap_info.

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Return Values

Synopsis

Allows you to list 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 >= 2.0
requests

Parameters

Parameter	Comments
api_host string / required	Specify the target host of the Proxmox VE cluster. Uses the `PROXMOX_HOST` environment variable if not specified.
api_password string	Specify the password to authenticate with. Uses the `PROXMOX_PASSWORD` environment variable if not specified.
api_port integer	Specify the target port of the Proxmox VE cluster. Uses the `PROXMOX_PORT` environment variable if not specified.
api_timeout integer	Time limit for requests towards the Proxmox VE API. Default: `5`
api_token_id string	Specify the token ID. Uses the `PROXMOX_TOKEN_ID` environment variable if not specified.
api_token_secret string	Specify the token secret. Uses the `PROXMOX_TOKEN_SECRET` environment variable if not specified.
api_user string / required	Specify the user to authenticate with. Uses the `PROXMOX_USER` environment variable if not specified.
ca_path path	Path to a local certificate, which will be used to verify TLS connections. Ignored if `validate_certs=false`.
hostname string	The instance name.
snapname string	Name of the snapshot that has to be listed.
validate_certs boolean	Validate the TLS certificates used for the connection to the Proxmox VE API. Currently defaults to `false` and changes default to `true` with community.proxmox 2.0.0. Uses the `PROXMOX_VALIDATE_CERTS` environment variable if not specified. Choices: `false` `true`
vmid string	The instance ID. If not set, will be fetched from PromoxAPI based on the hostname.

Attributes

Attribute	Support	Description
action_group	Action group: community.proxmox.proxmox	Use `group/community.proxmox.proxmox` in `module_defaults` to set defaults for this module.
check_mode	Support: full	Can run in `check_mode` and return changed status prediction without modifying target.
diff_mode	Support: none	Will return details on what has changed (or possibly needs changing in `check_mode`), when in diff mode.

Notes

Note

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

Examples

- name: List all snapshots for container or VM
  community.proxmox.proxmox_snap_info:
    api_user: root@pam
    api_password: 1q2w3e
    api_host: node1
    vmid: 100

- name: List specific snapshot for container or VM
  community.proxmox.proxmox_snap_info:
    api_user: root@pam
    api_password: 1q2w3e
    api_host: node1
    vmid: 100
    snapname: my-snapshot

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
snapshot dictionary	Snapshot information when snapname is provided and found. Returned: when snapname is provided and the snapshot exists
snapshots list / elements=string	List of snapshots when snapname is not provided. Returned: when snapname is not provided

Authors

Jeffrey van Pelt (@Thulium-Drake)

Collection links

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