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

Примечание

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

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

Чтобы использовать его в книге задач, укажите: 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` — Флажок типа boolean, указывающий, следует ли проверять сертификат TLS сервера и имя хоста. `ca_file` — Файл PEM, содержащий доверенные сертификаты CA. Представленный сервером сертификат будет проверен с использованием этих сертификатов CA. Если параметр ``ca_file`` не задан, используется системный хранилище сертификатов CA. Значение по умолчанию задается переменной среды OVIRT_CAFILE. `kerberos` — Флажок типа boolean, указывающий, следует ли использовать аутентификацию Kerberos вместо стандартной аутентификации. `headers` — Словарь HTTP-заголовков, которые необходимо добавить к каждому вызову API.
fetch_nested boolean	Варианты: нет ← да	Если да, модуль извлечет дополнительные данные из API. Он извлечет только идентификаторы вложенной сущности. Он не извлекает несколько уровней вложенных атрибутов. Только атрибуты текущей сущности. Пользователь может настроить извлечение других атрибутов вложенных сущностей, указав `nested_attributes`.
nested_attributes список / элементы=строка		Указывает список атрибутов, которые должны быть извлечены из API. Этот параметр применим только когда `fetch_nested` имеет значение true.
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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/ovirt_group_facts_module.html