Модуль community.proxmox.proxmox_cluster_status_info — получение информации о состоянии кластера Proxmox VE

Примечание

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

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

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

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

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

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

Получение информации о состоянии кластера 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`.
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: Get cluster status
  community.proxmox.proxmox_cluster_status_info:
    api_host: proxmox1
    api_user: root@pam
    api_password: "{{ password | default(omit) }}"
    api_token_id: "{{ token_id | default(omit) }}"
    api_token_secret: "{{ token_secret | default(omit) }}"
  register: cluster_status

- name: Display cluster quorum status
  ansible.builtin.debug:
    msg: "Cluster has quorum: {{ cluster_status.cluster_status | selectattr('type', 'equalto', 'cluster') | map(attribute='quorate') | first }}"

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

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

Ключ	Описание
cluster_status list / elements=dictionary	Список со сведениями о состоянии кластера и узлов. Возвращается: всегда, но может быть пустым
id string	Уникальный идентификатор записи. Возвращается: всегда
ip string	IP-адрес определённого имени узла. Возвращается: если type имеет значение ‘node’
level string	Уровень подписки Proxmox VE; указывает, доступна ли корпоративная поддержка. Возвращается: если type имеет значение ‘node’
local boolean	Указывает, является ли этот узел отвечающим. Возвращается: если type имеет значение ‘node’
name string	Имя кластера или узла. Возвращается: всегда
nodeid integer	Идентификатор узла из конфигурации corosync. Возвращается: если type имеет значение ‘node’
nodes integer	Общее количество узлов в кластере, включая отключённые узлы. Возвращается: если type имеет значение ‘cluster’
online boolean	Указывает, подключён узел или отключён. Возвращается: если type имеет значение ‘node’
quorate boolean	Указывает, подключено ли большинство узлов, необходимое для принятия решений. Возвращается: если type имеет значение ‘cluster’
type string	Тип записи: ‘cluster’ или ‘node’. Возвращается: всегда
version integer	Текущая версия файла конфигурации corosync. Возвращается: если type имеет значение ‘cluster’

Авторы

Michael Dombek (@michaelwdombek)

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

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