ovirt_group_info – Получение информации об одной или нескольких группах oVirt/RHV

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

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

Получение информации об одной или нескольких группах oVirt/RHV.
Этот модуль назывался ovirt_group_facts до Ansible 2.9, возвращая ansible_facts. Обратите внимание, что модуль ovirt_group_info больше не возвращает ansible_facts!

Псевдонимы: ovirt_group_facts

Требования

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

python >= 2.7
ovirt-engine-sdk-python >= 4.3.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth словарь / обязательный		Словарь со значениями, необходимыми для создания HTTP/HTTPS-соединения с oVirt: `username`[обязательно] - Имя пользователя, например admin@internal. Значение по умолчанию задается переменной среды OVIRT_USERNAME. `password`[обязательно] - Пароль пользователя. Значение по умолчанию задается переменной среды OVIRT_PASSWORD. `url`- Строка, содержащая URL API сервера, обычно `https://server.example.com/ovirt-engine/api`. Значение по умолчанию задается переменной среды OVIRT_URL. Необходимо указать либо `url` либо `hostname`. `hostname` - Строка, содержащая имя хоста сервера, обычно `server.example.com`. Значение по умолчанию задается переменной среды OVIRT_HOSTNAME. Необходимо указать либо `url` либо `hostname`. `token` - Токен, используемый вместо входа с именем пользователя/паролем. Значение по умолчанию задается переменной среды OVIRT_TOKEN. `insecure` - Флаг булевого типа, указывающий, следует ли проверять сертификат TLS сервера и имя хоста. `ca_file` - PEM-файл, содержащий доверенные сертификаты CA. Представленный сервером сертификат будет проверен с помощью этих сертификатов CA. Если параметр ``ca_file`` не задан, используется системное хранилище сертификатов CA. Значение по умолчанию задается переменной среды OVIRT_CAFILE. `kerberos` - Флаг булевого типа, указывающий, следует ли использовать аутентификацию Kerberos вместо стандартной аутентификации. `headers` - Словарь HTTP-заголовков, которые нужно добавить к каждому API-запросу.
fetch_nested булево	Варианты: нет да	Если да, модуль получит дополнительные данные из API. Он получит только идентификаторы вложенных сущностей. Он не получает несколько уровней вложенных атрибутов. Только атрибуты текущей сущности. Пользователь может настроить загрузку других атрибутов вложенных сущностей, указав `nested_attributes`.
nested_attributes список		Указывает список атрибутов, которые следует получить из API. Этот параметр применяется только, когда `fetch_nested` равен истине.
pattern -		Поисковый термин, принимаемый бэкендом поиска oVirt/RHV. Например, чтобы найти группу X, используйте следующий шаблон: name=X

Примечания

Примечание

Этот модуль возвращает переменную ovirt_groups, которая содержит список групп. Вам необходимо зарегистрировать результат с помощью ключевого слова register, чтобы использовать его.
Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.3.0

Примеры

# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:

# Gather information about all groups which names start with C(admin):
- ovirt_group_info:
    pattern: name=admin*
  register: result
- debug:
    msg: "{{ result.ovirt_groups }}"

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

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

Ключ	Возвращаемое значение	Описание
ovirt_groups список	При успешном выполнении.	Список словарей, описывающих группы. Атрибуты группы сопоставлены с ключами словаря, все атрибуты групп можно найти по следующему адресу: http://ovirt.github.io/ovirt-engine-api-model/master/#types/group.

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Ondra Machacek (@machacekondra)

Подсказка

Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/ovirt_group_info_module.html