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

Примечание

Этот плагин является частью коллекции community.general (версия 2.0.1).

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

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

Примечания

Примечание

Этот модуль возвращает переменную 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/ovirt_api_facts_module.html