ovirt_storage_template_info – Получение информации об одной или нескольких шаблонах oVirt/RHV, относящихся к домену хранения

Новая в версии 2.4.

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Описание

Получение информации об одной или нескольких шаблонах oVirt/RHV, относящихся к домену хранения.
Этот модуль назывался ovirt_storage_template_facts до Ansible 2.9, возвращая ansible_facts. Обратите внимание, что модуль ovirt_storage_template_info больше не возвращает ansible_facts!

Псевдонимы: ovirt_storage_template_facts

Требования

Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 2.7
ovirt-engine-sdk-python >= 4.3.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
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 логическое значение	Варианты: no yes	Если yes, модуль получит дополнительные данные из API. Он получит только идентификаторы вложенной сущности. Он не получает несколько уровней вложенных атрибутов. Только атрибуты текущей сущности. Пользователь может настроить запрос других атрибутов вложенных сущностей, указав `nested_attributes`.
max -		Устанавливает максимальное количество шаблонов, которые должны быть возвращены. Если не указано, возвращаются все шаблоны.
nested_attributes список		Указывает список атрибутов, которые должны быть получены из API. Этот параметр применяется только когда `fetch_nested` равен true.
storage_domain -		Имя домена хранения, где должны быть перечислены шаблоны.
unregistered логическое значение	Варианты: нет ← да	Флаг, указывающий, следует ли получать незарегистрированные шаблоны, содержащие один или несколько дисков, находящихся в домене хранения, или дискless шаблоны.

Примечания

Примечание

Этот модуль возвращает переменную ovirt_storage_templates, которая содержит список шаблонов. Вам необходимо зарегистрировать результат с помощью ключевого слова register, чтобы использовать его.
Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, вы можете создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.3.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 relate to a storage domain and
# are unregistered:
- ovirt_storage_template_info:
    unregistered=True
  register: result
- debug:
    msg: "{{ result.ovirt_storage_templates }}"

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
ovirt_storage_templates список	При успехе.	Список словарей, описывающих шаблоны. Атрибуты шаблона сопоставляются с ключами словаря, все атрибуты шаблонов можно найти по следующему URL-адресу: http://ovirt.github.io/ovirt-engine-api-model/master/#types/template.

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Maor Lipchuk (@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.9/modules/ovirt_storage_template_info_module.html