Модуль community.proxmox.proxmox_cluster_ha_resources — управление группами высокой доступности в кластере Proxmox VE

Примечание

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

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

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

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

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

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

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

Настройка групп высокой доступности через /cluster/ha/groups.

Требования

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

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`.
comment string	Описание По умолчанию: `""`
group string	Идентификатор группы высокой доступности.
hastate string	Запрашиваемое состояние ресурса. CRM считывает это состояние и выполняет соответствующие действия. Обратите внимание: `enabled` — это просто псевдоним для `started`. Варианты: `"started"` ← (по умолчанию) `"stopped"` `"disabled"` `"ignored"`
max_relocate integer	Максимальное количество попыток перемещения службы при сбое её запуска. По умолчанию: `1`
max_restart integer	Максимальное количество попыток перезапустить службу на узле после неудачного запуска. По умолчанию: `1`
name string / обязательный	Идентификатор ресурса высокой доступности. Он состоит из типа ресурса и имени, специфичного для этого ресурса, разделённых двоеточием (пример: `vm:100` / `ct:100` ). Для виртуальных машин и контейнеров можно использовать в качестве сокращения только идентификатор ВМ или контейнера (пример: 100). В документации API это поле называется \”sid\”.
state string / обязательный	создать или удалить Варианты: `"present"` `"absent"`
validate_certs boolean	Проверять TLS-сертификаты, используемые для подключения к API Proxmox VE. В настоящее время по умолчанию используется `false`; в community.proxmox 2.0.0 значение по умолчанию изменится на `true`. Если параметр не указан, используется переменная окружения `PROXMOX_VALIDATE_CERTS`. Варианты: `false` `true`

Атрибуты

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

Примеры

- name: Add VM to HA group
  community.proxmox.proxmox_cluster_ha_resources:
    api_host: "{{ ansible_host }}"
    api_password: "{{ proxmox_root_pw | default(lookup('ansible.builtin.env', 'PROXMOX_PASSWORD', default='')) }}"
    api_user: root@pam
    name: vm:100
    state: "present"
    group: ha0
    max_relocate: 2
    max_restart: 2
  delegate_to: localhost

- name: Delete vm from HA group
  community.proxmox.proxmox_cluster_ha_resources:
    api_host: "{{ ansible_host }}"
    api_password: "{{ proxmox_root_pw | default(lookup('ansible.builtin.env', 'PROXMOX_PASSWORD', default='')) }}"
    api_user: root@pam
    state: "absent"
    name: vm:100
  delegate_to: localhost

- name: Add VM to HA group based on 'ha_' tag
  community.proxmox.proxmox_cluster_ha_resources:
    api_host: "{{ ansible_host }}"
    api_password: "{{ proxmox_root_pw | default(lookup('ansible.builtin.env', 'PROXMOX_PASSWORD', default='')) }}"
    api_user: root@pam
    name: "{{ proxmox_type }}:{{ proxmox_vmid }}"
    state: "present"
    group: "{{ proxmox_tags | split(';') | select('match', '^ha_') }}"
    max_relocate: 2
    max_restart: 2
  delegate_to: localhost

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

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

Ключ	Описание
new_groups list / elements=string	Сообщение, сформированное тестовым модулем. Возвращается: при наличии изменений
old_groups list / elements=string	Исходное значение параметра name, переданное модулю. Возвращается: всегда

Авторы

Markus Kötter (@commonism)

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

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