ovirt_api_info – Получение информации об API oVirt/RHV

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

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

Обзор

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

Псевдонимы: ovirt_api_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 булево	Варианты: нет да	Если да, модуль получит дополнительные данные из API. Будет получены только идентификаторы вложенных сущностей. Он не получает несколько уровней вложенных атрибутов. Только атрибуты текущей сущности. Пользователь может настроить получение других атрибутов вложенных сущностей, указав `nested_attributes`.
nested_attributes список		Указывает список атрибутов, которые должны быть получены из API. Этот параметр применяется только когда `fetch_nested` равен true.

Примечания

Примечание

Этот модуль возвращает переменную ovirt_api, содержащую информацию об API oVirt/RHV. Для использования результата необходимо зарегистрировать его с помощью ключевого слова 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 oVirt API:
- ovirt_api_info:
  register: result
- debug:
    msg: "{{ result.ovirt_api }}"

Значения возврата

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

Ключ	Возвращаемое значение	Описание
ovirt_api словарь	При успешном выполнении.	Словарь, описывающий информацию об API oVirt. Атрибуты API отображаются в качестве ключей словаря, все атрибуты API можно найти по следующему адресу URL: https://ovirt.example.com/ovirt-engine/api/model#types/api.

Статус

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

Авторы

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.9/modules/ovirt_api_info_module.html