ovirt.ovirt.ovirt_template_info – Получение информации об одном или нескольких шаблонах oVirt/RHV
Примечание
Этот плагин входит в коллекцию ovirt.ovirt (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install ovirt.ovirt.
Чтобы использовать его в плейбуке, укажите: ovirt.ovirt.ovirt_template_info.
Новое в версии 1.0.0: из ovirt.ovirt
Описание
- Получение информации об одном или нескольких шаблонах oVirt/RHV.
- Этот модуль назывался
ovirt_template_factsдо Ansible 2.9, возвращаяansible_facts. Обратите внимание, что модуль ovirt.ovirt.ovirt_template_info больше не возвращаетansible_facts!
Требования
Ниже приведены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.4.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth словарь / обязательно | Словарь со значениями, необходимыми для создания HTTP/HTTPS-соединения с oVirt: | ||
| ca_file строка | Файл PEM, содержащий доверенные сертификаты CA. Сертификат, представленный сервером, будет проверен с помощью этих сертификатов CA. Если параметр ca_file не задан, используется системный хранилище сертификатов CA.Значение по умолчанию задается переменной окружения OVIRT_CAFILE. | ||
| headers словарь | Словарь HTTP-заголовков, которые будут добавлены к каждому API-запросу. | ||
| hostname строка | Строка, содержащая имя хоста сервера, обычно что-то вроде `server.example.com`. Значение по умолчанию задается переменной окружения OVIRT_HOSTNAME.Требуется либо url, либо hostname. | ||
| insecure логическое значение |
| Логический флаг, указывающий, следует ли проверять TLS-сертификат сервера и имя хоста. | |
| kerberos логическое значение |
| Логический флаг, указывающий, следует ли использовать аутентификацию Kerberos вместо стандартной аутентификации. | |
| password строка / обязательно | Пароль пользователя. Значение по умолчанию задается переменной окружения OVIRT_PASSWORD. | ||
| token строка | Токен для использования вместо входа с именем пользователя/паролем. Значение по умолчанию задается переменной окружения OVIRT_TOKEN. | ||
| url строка | Строка, содержащая URL API-сервера, обычно что-то вроде `https://server.example.com/ovirt-engine/api`. Значение по умолчанию задается переменной окружения OVIRT_URL.Требуется либо url, либо hostname. | ||
| username строка / обязательно | Имя пользователя, например admin@internal. Значение по умолчанию задается переменной окружения OVIRT_USERNAME. | ||
| fetch_nested логическое значение |
| Если да, модуль получит дополнительные данные из API. Он получит только идентификаторы вложенных сущностей. Он не получает несколько уровней вложенных атрибутов. Только атрибуты текущей сущности. Пользователь может настроить получение других атрибутов вложенных сущностей, указав nested_attributes. | |
| nested_attributes список / элементы=строка | Указывает список атрибутов, которые должны быть получены из API. Этот параметр применяется только тогда, когда fetch_nested имеет значение true. | ||
| pattern строка | Критерий поиска, который поддерживается сервером поиска oVirt/RHV. Например, для поиска шаблона X из центров данных Y используйте следующий шаблон: name=X and datacenter=Y | ||
Примечания
Примечание
- Этот модуль возвращает переменную
ovirt_templates, которая содержит список шаблонов. Вам необходимо зарегистрировать результат с помощью ключевого слова register, чтобы использовать его. - Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.4.0
Примеры
# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:
# Gather information about all templates which names start with C(centos) and
# belongs to data center C(west):
- ovirt.ovirt.ovirt_template_info:
pattern: name=centos* and datacenter=west
register: result
- ansible.builtin.debug:
msg: "{{ result.ovirt_templates }}"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие — поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| ovirt_templates список / элементы=строка | При успехе. | Список словарей, описывающих шаблоны. Атрибуты шаблона сопоставляются с ключами словаря, все атрибуты шаблонов можно найти по следующему URL-адресу: http://ovirt.github.io/ovirt-engine-api-model/master/#types/template. |
Авторы
- Ondra Machacek (@machacekondra)
- Martin Necas (@mnecas)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ovirt/ovirt/ovirt_template_info_module.html