Модуль community.proxmox.proxmox_backup_info – получение сведений о запланированных резервных копиях Proxmox

Примечание

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

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

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

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

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

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

Получение с помощью API сервера Proxmox таких сведений, как время резервного копирования, имя и ID виртуальной машины, режим, тип и расписание резервного копирования.

Требования

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

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`.
backup_jobs boolean	Если `true`, модуль вернёт сведения обо всех заданиях резервного копирования. Если `false`, модуль обработает все задания резервного копирования по ID виртуальных машин и вернёт список сведений о резервном копировании виртуальных машин. Не может использоваться одновременно с `vm_id` и `vm_name`. Варианты: `false` ← (по умолчанию) `true`
ca_path path	Путь к локальному сертификату, который будет использоваться для проверки TLS-соединений. Не учитывается, если `validate_certs=false`.
validate_certs boolean	Проверять TLS-сертификаты, используемые для подключения к API Proxmox VE. В настоящее время значение по умолчанию — `false`; в community.proxmox 2.0.0 оно изменится на `true`. Если параметр не указан, используется переменная окружения `PROXMOX_VALIDATE_CERTS`. Варианты: `false` `true`
vm_id string	ID виртуальной машины Proxmox. Если параметр задан, возвращаемый список будет содержать задания резервного копирования, обработанные и отфильтрованные по значению `vm_id`. Не может использоваться одновременно с `vm_name` и `backup_jobs`.
vm_name string	Имя виртуальной машины Proxmox. Если параметр задан, возвращаемый список будет содержать задания резервного копирования, обработанные и отфильтрованные по значению `vm_name`. Не может использоваться одновременно с `vm_id` и `backup_jobs`.

Атрибуты

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

Примеры

- name: Print all backup information by VM ID and VM name
  community.proxmox.proxmox_backup_info:
    api_user: 'myUser@pam'
    api_password: '*******'
    api_host: '192.168.20.20'

- name: Print Proxmox backup information for a specific VM based on its name
  community.proxmox.proxmox_backup_info:
    api_user: 'myUser@pam'
    api_password: '*******'
    api_host: '192.168.20.20'
    vm_name: 'mailsrv'

- name: Print Proxmox backup information for a specific VM based on its VM ID
  community.proxmox.proxmox_backup_info:
    api_user: 'myUser@pam'
    api_password: '*******'
    api_host: '192.168.20.20'
    vm_id: '150'

- name: Print Proxmox all backup job information
  community.proxmox.proxmox_backup_info:
    api_user: 'myUser@pam'
    api_password: '*******'
    api_host: '192.168.20.20'
    backup_jobs: true

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

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

Ключ	Описание
backup_info list / элементы=dictionary	Возвращаемое значение содержит сведения о задании резервного копирования для указанного ID или имени виртуальной машины либо сведения обо всех заданиях резервного копирования. Возвращается: при успешном выполнении, но может быть пустым
bktype string	Тип резервной копии. Возвращается: при успешном выполнении Пример: `"vzdump"`
enabled integer	`1`, если резервное копирование включено, иначе `0`. Возвращается: при успешном выполнении Пример: `1`
id string	ID задания резервного копирования. Возвращается: при успешном выполнении Пример: `"backup-83831498-c631"`
mode string	Режим задания резервного копирования, например snapshot. Возвращается: при успешном выполнении Пример: `"snapshot"`
next-run string	Время следующего резервного копирования. Возвращается: при успешном выполнении Пример: `"2024-12-28 11:30:00"`
schedule string	Расписание задания резервного копирования. Возвращается: при успешном выполнении Пример: `"sat 15:00"`
storage string	Место хранения резервной копии. Возвращается: при успешном выполнении Пример: `"local"`
vm_name string	Имя виртуальной машины. Возвращается: при успешном выполнении Пример: `"test01"`
vmid string	ID виртуальной машины. Возвращается: при успешном выполнении Пример: `"100"`

Авторы

Marzieh Raoufnezhad (@raoufnezhad)
Maryam Mayabi (@mmayabi)

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

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