ovirt_vms_facts — Получение фактов о виртуальных машинах oVirt/RHV
Новая в версии 2.3.
Описание
- Получение фактов о одной или нескольких виртуальных машинах oVirt/RHV.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.2.4
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| all_content | Если true, все атрибуты виртуальных машин должны быть включены в ответ. | |
| 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 вместо стандартной аутентификации по протоколу basic.headers — Словарь HTTP-заголовков, которые необходимо добавить к каждому API-запросу. | |
| case_sensitive | Если true, выполняемый поиск учитывает регистр. | |
| fetch_nested (добавлено в 2.3) | Если True, модуль получит дополнительные данные из API. Он получит идентификаторы дисков ВМ, снимков и т.д. Пользователь может настроить запрос других атрибутов вложенных сущностей, указав nested_attributes. | |
| max | Максимальное количество возвращаемых результатов. | |
| nested_attributes (добавлено в 2.3) | Указывает список атрибутов, которые должны быть получены из API. Этот параметр применяется только тогда, когда fetch_nested равно true. | |
| pattern | Критерий поиска, который принимается бэкендом поиска oVirt/RHV. Например, чтобы найти ВМ X из кластера Y, используйте следующий шаблон: name=X and cluster=Y |
Примечания
Примечание
- Этот модуль создаёт новый факт верхнего уровня
ovirt_vms, который содержит список виртуальных машин. - Для использования этого модуля необходимо установить 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 about all VMs which names start with C(centos) and
# belong to cluster C(west):
- ovirt_vms_facts:
pattern: name=centos* and cluster=west
- debug:
var: ovirt_vms
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| ovirt_vms список | При успехе. | Список словарей, описывающих ВМ. Атрибуты ВМ сопоставлены с ключами словаря, все атрибуты ВМ можно найти по следующему URL-адресу: http://ovirt.github.io/ovirt-engine-api-model/master/#types/vm. |
Статус
Этот модуль помечен как preview, что означает, что его интерфейс не гарантируется как обратной совместимости.
Автор
- 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_vms_facts_module.html
