ovirt_storage_template_facts – Получение фактов о шаблонах oVirt/RHV, связанных с областью хранения.
Новое в версии 2.4.
Описание
- Получение фактов о шаблонах oVirt/RHV, связанных с областью хранения.
Псевдонимы: ovirt_storage_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 boolean добавлено в 2.3 |
| Если True, модуль получит дополнительные данные из API. Он получит идентификаторы дисков, снимков и т. д. ВМ. Пользователь может настроить получение других атрибутов вложенных сущностей, указав nested_attributes. |
| max - | Устанавливает максимальное количество шаблонов для возврата. Если не указано, возвращаются все шаблоны. | |
| nested_attributes - добавлено в 2.3 | Указывает список атрибутов, которые должны быть получены из API. Этот параметр применяется только когда fetch_nested равен true. | |
| storage_domain - | Имя домена хранения, в котором должны быть перечислены шаблоны. | |
| unregistered boolean |
| Флаг, указывающий, нужно ли получить не зарегистрированные шаблоны, которые содержат один или несколько дисков, находящихся в области хранения, или шаблоны без дисков. |
Примечания
Примечание
- Этот модуль создаёт новый факт верхнего уровня
ovirt_storage_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 relate to a storage domain and
# are unregistered:
- ovirt_storage_template_facts:
unregistered=True
- debug:
var: ovirt_storage_templates
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| ovirt_storage_templates список | При успешном выполнении. | Список словарей, описывающих шаблоны. Атрибуты шаблонов сопоставлены с ключами словаря, все атрибуты шаблонов можно найти по следующему адресу: http://ovirt.github.io/ovirt-engine-api-model/master/#types/template. |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Maor Lipchuk
Подсказка
Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать его, чтобы улучшить его.
© 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_storage_template_facts_module.html
