Модуль community.proxmox.proxmox_backup_schedule — планирование резервного копирования ВМ и удаление заданий

Примечание

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

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

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

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

Добавлено в community.proxmox 1.0.0

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

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

Модуль изменяет задания резервного копирования, например, задаёт их или удаляет vmid.

Требования

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

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

Атрибуты

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

Примеры

- name: Ensure that VM is present in the backup job
  community.proxmox.proxmox_backup_schedule:
    api_user: 'myUser@pam'
    api_password: '*******'
    api_host: '192.168.20.20'
    vm_name: 'VM Name'
    backup_id: 'backup-b2adffdc-316e'
    state: 'present'

- name: Ensure that vmid is present in the backup job
  community.proxmox.proxmox_backup_schedule:
    api_user: 'myUser@pam'
    api_password: '*******'
    api_host: '192.168.20.20'
    vm_id: 'VM ID'
    backup_id: 'backup-b2adffdc-316e'
    state: 'present'

- name: Ensure that there is no scheduled backup for VM name within all backup jobs
  community.proxmox.proxmox_backup_schedule:
    api_user: 'myUser@pam'
    api_password: '*******'
    api_host: '192.168.20.20'
    vm_name: 'VM Name'
    state: 'absent'

- name: Ensure that there is no scheduled backup for vmid within all backup jobs
  community.proxmox.proxmox_backup_schedule:
    api_user: 'myUser@pam'
    api_password: '*******'
    api_host: '192.168.20.20'
    vm_id: 'VM ID'
    state: 'absent'

- name: Ensure that there is no scheduled backup for VM within specific backup job
  community.proxmox.proxmox_backup_schedule:
    api_user: 'myUser@pam'
    api_password: '*******'
    api_host: '192.168.20.20'
    vm_name: 'VM Name'
    backup_id: 'backup-b2adffdc-316e'
    state: 'absent'

- name: Ensure that there is no scheduled backup for vmid within specific backup job
  community.proxmox.proxmox_backup_schedule:
    api_user: 'myUser@pam'
    api_password: '*******'
    api_host: '192.168.20.20'
    vm_id: 'VM ID'
    backup_id: 'backup-b2adffdc-316e'
    state: 'absent'

Авторы

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