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

Примечание

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

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

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

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

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

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

Позволяет выводить список снимков экземпляров в кластере 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	Укажите идентификатор токена. Если параметр не указан, используется переменная окружения `PROXMOX_TOKEN_ID`.
api_token_secret string	Укажите секретный ключ токена. Если параметр не указан, используется переменная окружения `PROXMOX_TOKEN_SECRET`.
api_user string / обязательный	Укажите пользователя для аутентификации. Если параметр не указан, используется переменная окружения `PROXMOX_USER`.
ca_path path	Путь к локальному сертификату, который будет использоваться для проверки TLS-соединений. Игнорируется, если `validate_certs=false`.
hostname string	Имя экземпляра.
snapname string	Имя снимка, который необходимо вывести в списке.
validate_certs boolean	Проверять TLS-сертификаты, используемые для подключения к API Proxmox VE. В настоящее время по умолчанию используется `false`; начиная с community.proxmox 2.0.0 значение по умолчанию изменится на `true`. Если параметр не указан, используется переменная окружения `PROXMOX_VALIDATE_CERTS`. Варианты: `false` `true`
vmid string	Идентификатор экземпляра. Если значение не задано, оно будет получено из PromoxAPI на основе имени хоста.

Атрибуты

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

Примечания

Примечание

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

Примеры

- 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

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
snapshot dictionary	Информация о снимке, если задан snapname и снимок найден. Возвращается: если задан snapname и снимок существует
snapshots list / элементы=string	Список снимков, если параметр snapname не задан. Возвращается: если параметр snapname не задан

Авторы

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_info_module.html