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

Примечание

Этот плагин входит в сборку community.general (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install community.general.

Для использования в плейбуке укажите: community.general.ovirt_vm_facts.

УСТЕРЕЛО
Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

УСТЕРЕЛО

Убрано в: версии 3.0.0
Почему: При миграции на сборку мы решили использовать только модули _info.
Альтернатива: Используйте ovirt.ovirt.ovirt_vm_info вместо этого.

Описание

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

Примечания

Примечание

Этот модуль возвращает переменную ovirt_vms, которая содержит список виртуальных машин. Для использования результата необходимо зарегистрировать его с помощью ключевого слова register.
Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: ansible.builtin.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:

- name: Gather information about all VMs which names start with centos and belong to cluster west
  ovirt_vm_info:
    pattern: name=centos* and cluster=west
  register: result

- name: Print gathered information
  ansible.builtin.debug:
    msg: "{{ result.ovirt_vms }}"

- name: Gather info about next run configuration of virtual machine named myvm
  ovirt_vm_info:
    pattern: name=myvm
    next_run: true
  register: result

- name: Print gathered information
  ansible.builtin.debug:
    msg: "{{ result.ovirt_vms[0] }}"

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

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

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

Статус

Этот модуль будет удален в версии 3.0.0. [устарел]
Дополнительную информацию см. в разделе УСТЕРЕЛО.

Авторы

Ondra Machacek (@machacekondra)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/ovirt_vm_facts_module.html