ovirt_group_facts - Получение фактов о группах oVirt/RHV
Новая версия 2.3.
- Обзор
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Обзор
- Получение фактов о группе oVirt/RHV.
Требования (к хосту, на котором выполняется модуль)
- python >= 2.7
- ovirt-engine-sdk-python >= 4.0.0
Параметры
| параметр | обязательно | по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| auth | да | Словарь со значениями, необходимыми для создания HTTP/HTTPS-соединения с oVirt: username[обязательно] - Имя пользователя, например admin@internal. Значение по умолчанию задано переменной окружения OVIRT_USERNAME.password[обязательно] - Пароль пользователя. Значение по умолчанию задано переменной окружения OVIRT_PASSWORD.url[обязательно] - Строка, содержащая базовый URL-адрес сервера, обычно подобный `https://server.example.com/ovirt-engine/api`. Значение по умолчанию задано переменной окружения OVIRT_URL.token - Токен для использования вместо входа с именем пользователя/паролем. Значение по умолчанию задано переменной окружения OVIRT_TOKEN.insecure - Флаг, указывающий, следует ли проверять сертификат TLS сервера и имя хоста.ca_file - Файл PEM, содержащий доверенные сертификаты CA. Сертификат, предоставленный сервером, будет проверен с помощью этих сертификатов CA. Если параметр `ca_file` не задан, используется системный хранилище сертификатов CA. Значение по умолчанию задано переменной окружения OVIRT_CAFILE.kerberos - Флаг, указывающий, следует ли использовать аутентификацию Kerberos вместо стандартной аутентификации.headers - Словарь HTTP-заголовков, которые необходимо добавить к каждому вызову API. | ||
| fetch_nested (добавлено в 2.3)
| нет | Если True, модуль извлечёт дополнительные данные из API. Он извлечёт идентификаторы дисков, снимков и т. д. пользователя, можно настроить извлечение других атрибутов вложенных сущностей, указав nested_attributes. | ||
| nested_attributes (добавлено в 2.3)
| нет | Указывает список атрибутов, которые должны быть извлечены из API. Этот параметр применяется только когда fetch_nested равен true. | ||
| pattern | нет | Запрос, который принимается бэкендом поиска oVirt/RHV. Например, для поиска группы X используйте следующий шаблон: name=X |
Примеры
# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:
# Gather facts about all groups which names start with C(admin):
- ovirt_group_facts:
pattern: name=admin*
- debug:
var: ovirt_groups
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для этого модуля:
| имя | описание | возвращено | тип | пример |
|---|---|---|---|---|
| ovirt_groups | Список словарей, описывающих группы. Атрибуты группы отображаются в ключах словаря, все атрибуты групп можно найти по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/group. | При успехе. | список |
Примечания
Примечание
- Этот модуль создаёт новый факт верхнего уровня
ovirt_groups, который содержит список групп. - Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.0.0
Статус
Этот модуль помечен как предварительная версия, что означает, что интерфейс не гарантированно будет обратной совместимым.
Для получения помощи в разработке модулей, если вы заинтересованы, пожалуйста, прочитайте Информация о сообществе и вклад, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/ovirt_group_facts_module.html