ovirt_tags_facts — Получение фактов о тегах oVirt/RHV
Новая версия с 2.3.
Обзор
- Получение фактов о одном или нескольких тегах oVirt/RHV.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.2.4
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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. | |
| host | Имя хоста, для которого нужно получить список тегов. | |
| name | Имя тега, который нужно получить. | |
| nested_attributes (добавлен в 2.3) | Указывает список атрибутов, которые должны быть получены из API. Этот параметр применяется только когда fetch_nested равен true. | |
| poll_interval | Значение по умолчанию: 3 | Число секунд, которые модуль ожидает до отправки следующего запроса о статусе объекта. |
| timeout | Значение по умолчанию: 180 | Время в секундах, которое модуль должен ждать, пока экземпляр не перейдет в нужное состояние. |
| vm | Имя ВМ, для которого нужно получить список тегов. | |
| wait |
True, если модуль должен ждать, пока объект перейдет в нужное состояние. |
Примечания
Примечание
- Этот модуль создаёт новый факт верхнего уровня
ovirt_tags, который содержит список тегов. - Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.0.0
Примеры
# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:
# Gather facts about all tags, which names start with C(tag):
- ovirt_tags_facts:
name: tag*
- debug:
var: tags
# Gather facts about all tags, which are assigned to VM C(postgres):
- ovirt_tags_facts:
vm: postgres
- debug:
var: tags
# Gather facts about all tags, which are assigned to host C(west):
- ovirt_tags_facts:
host: west
- debug:
var: tags
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращённое значение | Описание |
|---|---|---|
| ovirt_tags список | При успехе. | Список словарей, описывающих теги. Атрибуты тегов сопоставлены с ключами словаря, все атрибуты тегов можно найти по следующему URL-адресу: http://ovirt.github.io/ovirt-engine-api-model/master/#types/tag. |
Статус
Этот модуль помечен как предварительный просмотр, что означает, что он не гарантирует обратной совместимости.
Автор
- Ондржей Махачек (@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.5/modules/ovirt_tags_facts_module.html
