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 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 (добавлен в 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.2.4
Примеры
# 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. |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Подробнее см. Поддержка модулей и техническое обслуживание.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/ovirt_tags_facts_module.html
