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

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: community.general.proxmox_group_info.

Новая в community.general 1.3.0

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

Описание

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

Требования

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

proxmoxer
requests

Параметры

Параметр	Комментарии
api_host строка / обязательный	Укажите целевой хост кластера Proxmox VE.
api_password строка	Укажите пароль для аутентификации. Можно использовать переменную окружения `PROXMOX_PASSWORD`.
api_port целое число добавлено в community.general 9.1.0	Укажите целевой порт кластера Proxmox VE. Используется переменная окружения `PROXMOX_PORT`, если не указана.
api_token_id строка добавлено в community.general 1.3.0	Укажите идентификатор токена. Требуется `proxmoxer>=1.1.0` для работы.
api_token_secret строка добавлено в community.general 1.3.0	Укажите секрет токена. Требуется `proxmoxer>=1.1.0` для работы.
api_user строка / обязательный	Укажите пользователя для аутентификации.
group псевдонимы: groupid, name строка	Ограничить результаты конкретной группой.
validate_certs булево	Если `false`, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах, использующих самозаверяющие сертификаты. Варианты: `false` ← (по умолчанию) `true`

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группа действий: community.general.proxmox добавлено в community.general 9.0.0	Используйте `group/community.general.proxmox` в `module_defaults` для установки значений по умолчанию для этого модуля.
check_mode	Поддержка: полная Это действие не изменяет состояние.	Может работать в режиме `check_mode` и возвращать прогноз состояния изменений без модификации целевого объекта.
diff_mode	Поддержка: нет Это действие не изменяет состояние.	В режиме сравнения вернет детали изменений (или, возможно, необходимых изменений в `check_mode`).

Примеры

- name: List existing groups
  community.general.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.general.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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/proxmox_group_info_module.html