ovirt_tags_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. Он получит идентификаторы дисков, снимков VM и т. д. Пользователь может настроить получение других атрибутов вложенных сущностей, указав nested_attributes. | ||
| host | нет | Имя хоста, теги которого нужно отобразить. | ||
| name | нет | Имя тега, который нужно отобразить. | ||
| nested_attributes (добавлено в 2.3)
| нет | Указывает список атрибутов, которые необходимо получить из API. Этот параметр применяется только когда fetch_nested равен true. | ||
| poll_interval | нет | 3 | Количество секунд, в течение которых модуль ожидает, пока не будет отправлен другой запрос на проверку статуса сущности. | |
| timeout | нет | 180 | Время в секундах, в течение которого модуль должен ждать, пока экземпляр не перейдет в нужное состояние. | |
| vm | нет | Имя VM, теги которого нужно отобразить. | ||
| wait | нет |
True, если модуль должен ждать, пока сущность не перейдет в нужное состояние. |
Примеры
# 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. | При успехе. | список |
Примечания
Примечание
- Этот модуль создает новый факт верхнего уровня
ovirt_tags, который содержит список тегов - Для использования этого модуля необходимо установить 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_tags_facts_module.html
