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 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-запросу. | |
| case_sensitive | Если true, поиск будет учитывать регистр. | |
| fetch_nested (добавлено в 2.3) | Если True, модуль получит дополнительные данные из API. Будут получены ID дисков, снимков VM и т.д. Пользователь может настроить запрос других атрибутов вложенных объектов, указав nested_attributes. | |
| max | Максимальное количество результатов для возврата. | |
| nested_attributes (добавлено в 2.3) | Указывает список атрибутов, которые необходимо получить из API. Этот параметр применяется только когда fetch_nested равен true. | |
| pattern | Исковое выражение, которое принимается механизмом поиска oVirt/RHV. Например, для поиска VM X из кластера Y используйте следующее выражение: name=X and cluster=Y |
Примечания
Примечание
- Этот модуль создает новый факт верхнего уровня
ovirt_vms, который содержит список виртуальных машин. - Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.2.4
Примеры
# 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 список | При успехе. | Список словарей, описывающих VM. Атрибуты VM сопоставлены с ключами словаря, все атрибуты VM можно найти по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/vm. |
Статус
Этот модуль помечен как предварительный, что означает, что его интерфейс не гарантированно будет совместим с предыдущими версиями.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/ovirt_vms_facts_module.html
