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

Примечание

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

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

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

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

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

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

Получение информации об одной или нескольких группах Proxmox VE.

Требования

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

proxmoxer >= 2.0
requests

Параметры

Параметр	Комментарии
api_host строка / обязательный	Укажите целевой узел кластера Proxmox VE. Если параметр не указан, используется переменная окружения `PROXMOX_HOST`.
api_password строка	Укажите пароль для аутентификации. Если параметр не указан, используется переменная окружения `PROXMOX_PASSWORD`.
api_port целое число	Укажите целевой порт кластера Proxmox VE. Если параметр не указан, используется переменная окружения `PROXMOX_PORT`.
api_timeout целое число	Ограничение времени для запросов к API Proxmox VE. По умолчанию: `5`
api_token_id строка	Укажите идентификатор токена. Если параметр не указан, используется переменная окружения `PROXMOX_TOKEN_ID`.
api_token_secret строка	Укажите секрет токена. Если параметр не указан, используется переменная окружения `PROXMOX_TOKEN_SECRET`.
api_user строка / обязательный	Укажите пользователя для аутентификации. Если параметр не указан, используется переменная окружения `PROXMOX_USER`.
ca_path путь	Путь к локальному сертификату, который будет использоваться для проверки TLS-соединений. Игнорируется, если `validate_certs=false`.
group псевдонимы: groupid, name строка	Ограничить результаты указанной группой.
validate_certs логическое значение	Проверять 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 groups
  community.proxmox.proxmox_group_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_groups

- name: Retrieve information about the admin group
  community.proxmox.proxmox_group_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) }}"
    group: admin
  register: proxmox_group_admin

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

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

Ключ	Описание
proxmox_groups список / элементы=словарь	Список групп. Возвращается: всегда, но может быть пустым
comment строка	Краткое описание группы. Возвращается: при успешном выполнении, может отсутствовать
groupid строка	Имя группы. Возвращается: при успешном выполнении
users список / элементы=строка	Список пользователей в группе. Возвращается: при успешном выполнении

Авторы

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_group_info_module.html