Модуль community.proxmox.proxmox_domain_info – получение информации об одном или нескольких доменах Proxmox VE

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: community.proxmox.proxmox_domain_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`.
domain псевдонимы: realm, name string	Ограничить результаты указанной областью аутентификации.
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	Поддержка: full Это действие не изменяет состояние.	Может выполняться в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой объект.
diff_mode	Поддержка: N/A Это действие не изменяет состояние.	В режиме diff будут возвращены сведения об изменениях (или о том, что, возможно, требуется изменить в `check_mode`).

Примеры

- name: List existing domains
  community.proxmox.proxmox_domain_info:
    api_host: helldorado
    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_domains

- name: Retrieve information about the pve domain
  community.proxmox.proxmox_domain_info:
    api_host: helldorado
    api_user: root@pam
    api_password: "{{ password | default(omit) }}"
    api_token_id: "{{ token_id | default(omit) }}"
    api_token_secret: "{{ token_secret | default(omit) }}"
    domain: pve
  register: proxmox_domain_pve

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

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

Ключ	Описание
proxmox_domains list / elements=dictionary	Список доменов аутентификации. Возвращается: всегда, но список может быть пустым
comment string	Краткое описание области аутентификации. Возвращается: при успешном выполнении
digest string	Хеш области аутентификации. Возвращается: при успешном выполнении; может отсутствовать
realm string	Имя области аутентификации. Возвращается: при успешном выполнении
type string	Тип области аутентификации. Возвращается: при успешном выполнении

Авторы

Tristan Le Guern (@tleguern)

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

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