Модуль community.proxmox.proxmox_snap – управление снимками экземпляров в кластере Proxmox VE

Примечание

Этот модуль входит в коллекцию community.proxmox (версия 1.6.0).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.proxmox. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.proxmox.proxmox_snap.

Краткое описание
Требования
Параметры
Атрибуты
Примечания
Примеры

Краткое описание

Позволяет создавать, удалять и восстанавливать снимки экземпляров в кластере Proxmox VE.
Поддерживаются KVM и LXC. OpenVZ не тестировался, поскольку больше не поддерживается в Proxmox VE.

Требования

Следующие компоненты должны быть установлены на узле, выполняющем этот модуль.

proxmoxer >= 2.0
requests

Параметры

Параметр	Комментарии
api_host string / обязательный	Укажите целевой узел кластера Proxmox VE. Если параметр не указан, используется переменная окружения `PROXMOX_HOST`.
api_password string	Укажите пароль для аутентификации. Если параметр не указан, используется переменная окружения `PROXMOX_PASSWORD`.
api_port integer	Укажите целевой порт кластера Proxmox VE. Если параметр не указан, используется переменная окружения `PROXMOX_PORT`.
api_timeout integer	Ограничение времени для запросов к API Proxmox VE. По умолчанию: `5`
api_token_id string	Укажите ID токена. Если параметр не указан, используется переменная окружения `PROXMOX_TOKEN_ID`.
api_token_secret string	Укажите секрет токена. Если параметр не указан, используется переменная окружения `PROXMOX_TOKEN_SECRET`.
api_user string / обязательный	Укажите пользователя для аутентификации. Если параметр не указан, используется переменная окружения `PROXMOX_USER`.
ca_path path	Путь к локальному сертификату, который будет использоваться для проверки TLS-соединений. Игнорируется, если `validate_certs=false`.
description string	Укажите описание снимка. Используется только в веб-интерфейсе настройки. Сохраняется в файле конфигурации в виде комментария.
force boolean	Удалить запись из файла конфигурации, даже если не удалось удалить снимок диска. Варианты: `false` ← (по умолчанию) `true`
hostname string	Имя экземпляра.
retention integer	Удалять старые снимки, если их количество превышает `retention`. Если для `retention` задано значение `0`, будут сохранены все снимки. Используется только при `state=present` и создании нового снимка. Если снимок не создаётся, сохраняются все существующие снимки. По умолчанию: `0`
snapname string	Имя снимка, который необходимо создать, удалить или восстановить. По умолчанию: `"ansible_snap"`
state string	Укажите требуемое состояние снимка экземпляра. Варианты: `"present"` ← (по умолчанию) `"absent"` `"rollback"`
timeout integer	Тайм-аут операций. По умолчанию: `30`
unbind boolean	Этот параметр применяется только к контейнерам LXC. Позволяет создавать снимок контейнера, даже если для него настроены точки монтирования. Временно отключает все настроенные точки монтирования, создаёт снимок, а затем восстанавливает исходную конфигурацию. Если контейнер запущен, для применения изменений конфигурации он будет остановлен и перезапущен. Из-за ограничений API Proxmox этот параметр можно использовать только при аутентификации от имени `root@pam` с помощью `api_password`; API-токены также не поддерживаются. Подробности см. в разделе https://pve.proxmox.com/pve-docs/api-viewer/#/nodes/{node}/lxc/{vmid}/config (вкладка PUT). Варианты: `false` ← (по умолчанию) `true`
validate_certs boolean	Проверять TLS-сертификаты, используемые для подключения к API Proxmox VE. В настоящее время по умолчанию используется `false`; в community.proxmox 2.0.0 значение по умолчанию изменится на `true`. Если параметр не указан, используется переменная окружения `PROXMOX_VALIDATE_CERTS`. Варианты: `false` `true`
vmid string	ID экземпляра. Если параметр не задан, значение будет получено из PromoxAPI на основе имени узла.
vmstate boolean	Снимок включает оперативную память. Варианты: `false` ← (по умолчанию) `true`

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группа действий: community.proxmox.proxmox	Используйте `group/community.proxmox.proxmox` в `module_defaults`, чтобы задать значения по умолчанию для этого модуля.
check_mode	Поддержка: full	Модуль может работать в режиме `check_mode` и возвращать прогнозируемый статус изменений, не изменяя целевой узел.
diff_mode	Поддержка: none	В режиме diff будут возвращены сведения об изменениях (или возможных изменениях в `check_mode`).

Примечания

Примечание

На узле требуются модули proxmoxer и requests. Их можно установить с помощью pip.

Примеры

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

- name: Create new container snapshot and keep only the 2 newest snapshots
  community.proxmox.proxmox_snap:
    api_user: root@pam
    api_password: 1q2w3e
    api_host: node1
    vmid: 100
    state: present
    snapname: snapshot-42
    retention: 2

- name: Create new snapshot for a container with configured mountpoints
  community.proxmox.proxmox_snap:
    api_user: root@pam
    api_password: 1q2w3e
    api_host: node1
    vmid: 100
    state: present
    unbind: true # requires root@pam+password auth, API tokens are not supported
    snapname: pre-updates

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

- name: Rollback container snapshot
  community.proxmox.proxmox_snap:
    api_user: root@pam
    api_password: 1q2w3e
    api_host: node1
    vmid: 100
    state: rollback
    snapname: pre-updates

Авторы

Jeffrey van Pelt (@Thulium-Drake)

Ссылки на коллекцию

© 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_module.html