community.general.ovirt_api_facts – Получение информации об API oVirt/RHV

Примечание

Этот плагин входит в коллекцию community.general (версия 1.3.2).

Для его установки используйте: ansible-galaxy collection install community.general.

Для использования в книге задач укажите: community.general.ovirt_api_facts.

УСТЕРЕКШЕЕ
Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

УСТЕРЕКШЕЕ

Удалено в: версии 3.0.0
Почему: При миграции в коллекцию мы решили использовать только модули _info.
Альтернатива: Используйте ovirt.ovirt.ovirt_api_info вместо этого.

Обзор

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

Требования

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

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

Примечания

Примечание

Этот модуль возвращает переменную ovirt_api, которая содержит информацию об API oVirt/RHV. Вам необходимо зарегистрировать результат с помощью ключевого слова register, чтобы использовать его.
Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: ansible.builtin.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:

- name: Gather information oVirt API
  ovirt_api_info:
  register: result

- name: Print gathered information
  ansible.builtin.debug:
    msg: "{{ result.ovirt_api }}"

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

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

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

Статус

Этот модуль будет удален в версии 3.0.0. [устаревший]
Дополнительная информация см. в УСТЕРЕКШЕЕ.

Авторы

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.10/collections/community/general/ovirt_api_facts_module.html