Модуль community.general.proxmox_snap — Управление снимками виртуальных машин в кластере Proxmox VE

Примечание

Этот модуль является частью коллекции community.general (версия 9.5.0).

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

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

Для использования в книге задач укажите: community.general.proxmox_snap.

Впервые появился в community.general 2.0.0

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

Описание

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

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

proxmoxer
requests

Параметры

Параметр	Комментарии
api_host строка / обязательно	Укажите целевой хост кластера Proxmox VE.
api_password строка	Укажите пароль для аутентификации. Можно использовать переменную среды `PROXMOX_PASSWORD`.
api_port целое число добавлен в community.general 9.1.0	Укажите целевой порт кластера Proxmox VE. Использует переменную среды `PROXMOX_PORT`, если не указано.
api_token_id строка добавлен в community.general 1.3.0	Укажите идентификатор токена. Требуется `proxmoxer>=1.1.0`, чтобы работать.
api_token_secret строка добавлен в community.general 1.3.0	Укажите секрет токена. Требуется `proxmoxer>=1.1.0`, чтобы работать.
api_user строка / обязательно	Укажите пользователя для аутентификации.
description строка	Укажите описание для снимка. Используется только в веб-интерфейсе конфигурации. Сохраняется как комментарий в файле конфигурации.
force булево	Для удаления из файла конфигурации, даже если удаление снимка диска завершится ошибкой. Варианты: `false` ← (по умолчанию) `true`
hostname строка	Имя экземпляра.
retention целое число добавлен в community.general 7.1.0	Удалить старые снимки, если их больше `retention`. Если `retention` установлено в `0`, все снимки будут сохранены. Это используется только при `state=present`, и при создании фактического снимка. Если снимок не создаётся, все существующие снимки сохраняются. По умолчанию: `0`
snapname строка	Имя снимка, который необходимо создать/удалить/восстановить. По умолчанию: `"ansible_snap"`
state строка	Указывает желаемое состояние снимка экземпляра. Значение `rollback` было добавлено в community.general 4.8.0. Варианты: `"present"` ← (по умолчанию) `"absent"` `"rollback"`
timeout целое число	Таймаут для операций. По умолчанию: `30`
unbind булево добавлен в community.general 5.7.0	Этот параметр применим только к контейнерам 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 булево	Если `false`, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах, использующих самозаверяющие сертификаты. Варианты: `false` ← (по умолчанию) `true`
vmid строка	Идентификатор экземпляра. Если не указано, будет получен из PromoxAPI на основе имени хоста.
vmstate булево	Снимок включает ОЗУ. Варианты: `false` ← (по умолчанию) `true`

Атрибуты

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

Примечания

Примечание

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

Примеры

- 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: Create new container snapshot and keep only the 2 newest snapshots
  community.general.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.general.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.general.proxmox_snap:
    api_user: root@pam
    api_password: 1q2w3e
    api_host: node1
    vmid: 100
    state: absent
    snapname: pre-updates

- name: Rollback container snapshot
  community.general.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–2024 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