Модуль community.proxmox.proxmox_cluster_join_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_join_info.

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

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

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

Получение информации для присоединения к кластеру 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	Поддержка: Н/Д Это действие не изменяет состояние.	В режиме diff будут возвращены сведения об изменениях (или о возможных изменениях в `check_mode`).

Примеры

- name: List existing Proxmox VE cluster join information
  community.proxmox.proxmox_cluster_join_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: proxmox_cluster_join

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

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

Ключ	Описание
cluster_join list / элементы=dictionary	Список узлов Proxmox VE с информацией для присоединения к кластеру. Возвращается: всегда, но может быть пустым
config_digest string	Дайджест конфигурации кластера. Возвращается: при успешном выполнении Пример: `"aef68412f7976505ed083e6173b96274a281da25"`
nodelist list / элементы=dictionary	Список узлов кластера. Возвращается: при успешном выполнении
name string	Имя узла. Возвращается: при успешном выполнении Пример: `"pve2"`
nodeid string	Идентификатор узла. Возвращается: при успешном выполнении Пример: `"1"`
pve_addr string	Адрес Proxmox VE. Возвращается: при успешном выполнении Пример: `"10.10.10.159"`
pve_fp string	Отпечаток Proxmox VE. Возвращается: при успешном выполнении Пример: `"08:B5:B2:F9:EC:01:0B:D0:..."`
quorum_votes string	Количество голосов кворума, назначенных узлу. Возвращается: при успешном выполнении Пример: `"1"`
ring0_addr string	Адрес для ring0. Возвращается: при успешном выполнении Пример: `"vmbr0"`
preferred_node string	Предпочтительный узел кластера. Возвращается: при успешном выполнении Пример: `"pve2"`
totem dictionary	Конфигурация протокола Totem. Возвращается: при успешном выполнении
cluster_name string	Имя кластера из конфигурации Totem. Возвращается: при успешном выполнении Пример: `"devcluster"`
config_version string	Версия конфигурации. Возвращается: при успешном выполнении Пример: `"1"`
interface dictionary	Конфигурация интерфейса. Возвращается: при успешном выполнении
ip_version string	Версия IP. Возвращается: при успешном выполнении Пример: `"ipv4-6"`
link_mode string	Режим канала связи. Возвращается: при успешном выполнении Пример: `"passive"`
secauth string	Включена ли защищённая аутентификация. Возвращается: при успешном выполнении Пример: `"on"`
version string	Версия протокола Totem. Возвращается: при успешном выполнении Пример: `"2"`

Авторы

Florian Paul Azim Hoberg (@gyptazy)

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

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