ovirt_template_facts – Получение фактов о шаблонах oVirt/RHV
Новое в версии 2.3.
Обзор
- Получение фактов о одном или нескольких шаблонах oVirt/RHV.
Псевдонимы: ovirt_templates_facts
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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. |
| nested_attributes - добавлено в 2.3 | Указывает список атрибутов, которые должны быть получены из API. Этот параметр применим только когда fetch_nested равен true. | |
| pattern - | Поисковый термин, принятый oVirt/RHV-поисковым бэкендом. Например, чтобы найти шаблон X из дата-центра Y, используйте следующий шаблон: name=X и datacenter=Y |
Примечания
Примечание
- Этот модуль создаёт новый факт верхнего уровня
ovirt_templates, содержащий список шаблонов. - Для использования этого модуля необходимо установить 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 templates which names start with C(centos) and
# belongs to data center C(west):
- ovirt_template_facts:
pattern: name=centos* and datacenter=west
- debug:
var: ovirt_templates
Возвращаемые значения
Общие значения возврата документированы здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| ovirt_templates список | При успешном выполнении. | Список словарей, описывающих шаблоны. Атрибуты шаблонов сопоставлены с ключами словаря, все атрибуты шаблонов можно найти по следующему адресу: http://ovirt.github.io/ovirt-engine-api-model/master/#types/template. |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.7/modules/ovirt_template_facts_module.html
