ovirt_api_facts - Получение фактов об API oVirt/RHV
Новая версия 2.5.
Описание
- Получение фактов об API 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 сервера, обычно что-то вроде `https://server.example.com/ovirt-engine/api`. Значение по умолчанию устанавливается переменной среды OVIRT_URL.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. |
Примечания
Примечание
- Этот модуль создает новый факт верхнего уровня
ovirt_api, который содержит информацию об API oVirt/RHV. - Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.0.0
Примеры
# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:
# Gather facts oVirt API:
- ovirt_api_facts:
- debug:
var: ovirt_api
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| ovirt_api словарь | При успехе. | Словарь, описывающий информацию об API oVirt. Атрибуты API сопоставлены с ключами словаря, все атрибуты API можно найти по следующему URL-адресу: https://ovirt.example.com/ovirt-engine/api/model#types/api. |
Статус
Этот модуль помечен как предварительный, что означает, что его интерфейс не гарантируется как обратной совместимости.
Автор
- 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.5/modules/ovirt_api_facts_module.html
