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

Примечание

Этот плагин является частью коллекции community.general (версия 1.3.2).

Для его установки используйте: 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. Например, чтобы найти VM 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/ovirt_vm_facts_module.html