ovirt_vm_facts – Получение фактов о одной или нескольких виртуальных машинах oVirt/RHV
Новое в версии 2.3.
Описание
- Получение фактов о одной или нескольких виртуальных машинах oVirt/RHV.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| all_content boolean |
| Если истина, все атрибуты виртуальных машин должны быть включены в ответ. |
| 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 boolean |
| Если истина, при выполнении поиска учитывается регистр символов. |
| fetch_nested boolean добавлено в 2.3 |
| Если да, модуль получит дополнительные данные из API. Он получит идентификаторы дисков ВМ, снимков и т. д. Пользователь может настроить получение других атрибутов вложенных сущностей, указав nested_attributes. |
| max - | Максимальное количество возвращаемых результатов. | |
| nested_attributes список добавлено в 2.3 | Указывает список атрибутов, которые должны быть получены из API. Этот параметр применяется только когда fetch_nested равен истина. | |
| next_run boolean добавлено в 2.8 |
| Указывает, описывает ли возвращаемый результат виртуальную машину в текущем состоянии или описывает виртуальную машину с изменениями, которые уже были выполнены, но которые вступят в силу только при перезапуске виртуальной машины. По умолчанию значение устанавливается движком. |
| pattern - | Поисковый запрос, принимаемый бэкендом поиска oVirt/RHV. Например, для поиска ВМ X из кластера Y используйте следующий шаблон: name=X и cluster=Y |
Примечания
Примечание
- Этот модуль создает новый факт верхнего уровня
ovirt_vms, который содержит список виртуальных машин. - Для использования этого модуля необходимо установить 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 facts about all VMs which names start with C(centos) and
# belong to cluster C(west):
- ovirt_vm_facts:
pattern: name=centos* and cluster=west
- debug:
var: ovirt_vms
# Gather info about next run configuration of virtual machine named myvm
- ovirt_vm_facts:
pattern: name=myvm
next_run: true
- debug:
var: ovirt_vms[0]
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| ovirt_vms список | При успехе. | Список словарей, описывающих ВМ. Атрибуты ВМ сопоставлены с ключами словаря, все атрибуты ВМ можно найти по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/vm. |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.8/modules/ovirt_vm_facts_module.html
