ovirt_vmpool_info – Получение информации об одном или нескольких пулах виртуальных машин oVirt/RHV

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Краткое описание

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

Псевдонимы: ovirt_vmpool_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` установлен в истинное значение.
pattern -		Критерий поиска, который поддерживается механизмом поиска oVirt/RHV. Например, для поиска пула виртуальных машин X: name=X

Примечания

Примечание

Этот модуль возвращает переменную ovirt_vmpools, которая содержит список пулов виртуальных машин. Вам необходимо зарегистрировать результат с помощью ключевого слова 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 about all vm pools which names start with C(centos):
- ovirt_vmpool_info:
    pattern: name=centos*
  register: result
- debug:
    msg: "{{ result.ovirt_vm_pools }}"

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

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

Ключ	Возвращаемое значение	Описание
ovirt_vm_pools список	При успехе.	Список словарей, описывающих пулы виртуальных машин. Атрибуты пула виртуальных машин сопоставляются с ключами словаря, все атрибуты пулов виртуальных машин можно найти по следующему URL-адресу: http://ovirt.github.io/ovirt-engine-api-model/master/#types/vm_pool.

Статус

Гарантия обратной совместимости интерфейса этого модуля не предоставляется. [preview]
Этот модуль поддерживается сообществом 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_vmpool_info_module.html