Модуль community.proxmox.proxmox_cluster_ha_rules — управление правилами HA

Примечание

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

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

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

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

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

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

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

Настройка правил HA /cluster/ha/rules.

Требования

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

proxmoxer >= 2.0
requests

Параметры

Параметр	Комментарии
affinity string	Определяет, должны ли ресурсы HA размещаться на одном узле `positive` или на разных узлах `negative`. Обязателен, если `type=resource-affinity`. Варианты: `"positive"` `"negative"`
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	Описание
disable boolean	Отключено ли правило HA. Если параметр не указан, используется значение по умолчанию `false` API Proxmox. Варианты: `false` `true`
force boolean	Существующие правила с определённым `type` нельзя изменить на правила другого типа. Если `force=true`, существующее правило будет удалено и создано заново с новым типом. Варианты: `false` ← (по умолчанию) `true`
name string / обязательный	Идентификатор правила HA.
nodes list / elements=string	Список узлов кластера, входящих в группу; для каждого узла можно указать приоритет. Ресурс, привязанный к группе, будет работать на доступных узлах с наивысшим приоритетом. Если узлов с наивысшим приоритетом несколько, службы будут распределены между ними. Приоритеты имеют только относительное значение: чем выше число, тем выше приоритет. Значение может быть строкой `node_name:priority,node_name:priority` или списком строк. Обязателен, если `type=node-affinity`.
resources list / elements=string	Список идентификаторов ресурсов HA. Значение может быть строкой `vm:100,ct:101` или списком строк.
state string / обязательный	создать или удалить правило Варианты: `"present"` `"absent"`
strict boolean	Если значение равно false, ресурс HA можно переместить и на другие узлы, когда ни один из указанных узлов недоступен. Если параметр не указан, используется значение по умолчанию `false` API Proxmox. Варианты: `false` `true`
type string	Тип правила HA. Варианты: `"node-affinity"` `"resource-affinity"`
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: Configure ha rule (node-affinity)
  community.proxmox.proxmox_cluster_ha_rules:
    api_host: "{{ proxmox_api_host }}"
    api_user: "{{ proxmox_api_user }}"
    api_token_id: "{{ proxmox_api_token_id }}"
    api_token_secret: "{{ proxmox_api_token_secret }}"
    name: node-affinity-rule-1
    state: present
    type: node-affinity
    comment: VM 100 is supposed run on proxmox02
    nodes:
      - proxmox01:10
      - proxmox02:20
    resources:
      - vm:100
    disable: false
  delegate_to: localhost

- name: Configure ha rule (node-affinity) - nodes and resources can also be provided as str
  community.proxmox.proxmox_cluster_ha_rules:
    api_host: "{{ proxmox_api_host }}"
    api_user: "{{ proxmox_api_user }}"
    api_token_id: "{{ proxmox_api_token_id }}"
    api_token_secret: "{{ proxmox_api_token_secret }}"
    name: node-affinity-rule-2
    state: present
    type: node-affinity
    comment: VM 100 is supposed to run on proxmox02
    nodes: proxmox01:10,proxmox02:20
    resources: vm:100
    disable: false
  delegate_to: localhost

- name: Configure ha rule (resource-affinity) - resource affinity
  community.proxmox.proxmox_cluster_ha_rules:
    api_host: "{{ proxmox_api_host }}"
    api_user: "{{ proxmox_api_user }}"
    api_token_id: "{{ proxmox_api_token_id }}"
    api_token_secret: "{{ proxmox_api_token_secret }}"
    name: resource-affinity-rule-1
    state: present
    type: resource-affinity
    comment: VM 100 and 101 are supposed to be kept on the same node
    affinity: positive
    resources:
      - vm:100
      - vm:101
    disable: false
  delegate_to: localhost

- name: Configure ha rule (resource-affinity) - resource anti-affinity
  community.proxmox.proxmox_cluster_ha_rules:
    api_host: "{{ proxmox_api_host }}"
    api_user: "{{ proxmox_api_user }}"
    api_token_id: "{{ proxmox_api_token_id }}"
    api_token_secret: "{{ proxmox_api_token_secret }}"
    name: resource-affinity-rule-1
    state: present
    type: resource-affinity
    comment: VM 100 and 101 are supposed to be kept on different nodes
    affinity: negative
    resources:
      - vm:100
      - vm:101
    disable: false
  delegate_to: localhost

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

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

Ключ	Описание
rule dictionary	Представление правила. Возвращается: success Пример: `{"comment": "My first ha rule", "digest": "f19acd44b43052343763cd9fd45a03b7449b3e2f", "disable": 0, "nodes": "proxmox01:10,proxmox02:10", "order": 2, "resources": "vm:100", "rule": "ha-rule1", "strict": 0, "type": "node-affinity"}`

Авторы

Reto Kupferschmid (@rekup)

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

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