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

Описание
Требования
Параметры
Примечания
Примеры
Значения возврата
Статус

Описание

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

Псевдонимы: ovirt_vm_facts

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

python >= 2.7
ovirt-engine-sdk-python >= 4.3.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
all_content boolean	Варианты: no yes	Если 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 boolean	Варианты: no yes ←	Если true, поиск будет учитывать регистр.
fetch_nested boolean	Варианты: no yes	Если yes, модуль получит дополнительные данные из API. Он получит только идентификаторы вложенных сущностей. Он не получает несколько уровней вложенных атрибутов. Только атрибуты текущей сущности. Пользователь может настроить получение других атрибутов вложенных сущностей, указав `nested_attributes`.
max -		Максимальное количество возвращаемых результатов.
nested_attributes список		Указывает список атрибутов, которые должны быть получены из API. Этот параметр применяется только когда `fetch_nested` равно true.
next_run boolean добавлен в 2.8	Варианты: no yes	Указывает, описывает ли возвращаемый результат виртуальную машину, как она работает в настоящее время, или описывает виртуальную машину с изменениями, которые уже были выполнены, но вступят в силу только при перезапуске виртуальной машины. По умолчанию значение устанавливается движком.
pattern -		Критерий поиска, который принимается механизмом поиска oVirt/RHV. Например, для поиска виртуальной машины X из кластера Y используйте следующий шаблон: name=X and cluster=Y

Примечания

Примечание

Этот модуль возвращает переменную ovirt_vms, которая содержит список виртуальных машин. Для использования результата необходимо использовать ключевое слово 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 VMs which names start with C(centos) and
# belong to cluster C(west):
- ovirt_vm_info:
    pattern: name=centos* and cluster=west
  register: result
- debug:
    msg: "{{ result.ovirt_vms }}"

# Gather info about next run configuration of virtual machine named myvm
- ovirt_vm_info:
    pattern: name=myvm
    next_run: true
  register: result
- debug:
    msg: "{{ result.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.9/modules/ovirt_vm_info_module.html