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

Примечание

Этот плагин входит в состав коллекции community.general (версия 1.3.2).

Для его установки используйте: ansible-galaxy collection install community.general.

Для использования в playbook, укажите: community.general.ovirt_group_facts.

УСТЕРЕГШИЙСЯ
Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

УСТЕРЕГШИЙСЯ

Удалили в: версии 3.0.0
Почему: При миграции в коллекцию мы решили использовать только модули _info.
Альтернатива: Используйте ovirt.ovirt.ovirt_group_info вместо этого.

Описание

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

Требования

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

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. Чтобы убедиться, что он установлен с правильной версией, вы можете создать следующую задачу: ansible.builtin.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:

- name: Gather information about all groups which names start with admin
  ovirt_group_info:
    pattern: name=admin*
  register: result

- name: Print gathered information
  ansible.builtin.debug:
    msg: "{{ result.ovirt_groups }}"

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

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

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

Статус

Этот модуль будет удален в версии 3.0.0. [устаревший]
Дополнительную информацию см. в УСТЕРЕГШИЙСЯ.

Авторы

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.10/collections/community/general/ovirt_group_facts_module.html