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

Примечание

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

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

Для использования в книге задач укажите: community.general.ovirt_storage_vm_facts.

УСТЕРЕГШЕЕ
Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата
Статус

УСТЕРЕГШЕЕ

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

Обзор

Получение информации об одной или нескольких виртуальных машинах oVirt/RHV, связанных с областью хранения.

Требования

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

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
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.
fetch_nested boolean	Варианты: нет ← да	Если да, модуль получит дополнительные данные из API. Он получит только идентификаторы вложенных сущностей. Он не получает несколько уровней вложенных атрибутов. Только атрибуты текущей сущности. Пользователь может настроить запрос других атрибутов вложенных сущностей, указав `nested_attributes`.
max строка		Устанавливает максимальное количество виртуальных машин для возврата. Если не указано, возвращаются все виртуальные машины.
nested_attributes список / элементы=строка		Указывает список атрибутов, которые нужно получить из API. Этот параметр применяется только когда `fetch_nested` равен true.
storage_domain строка		Имя области хранения, где нужно перечислить виртуальные машины.
unregistered boolean	Варианты: нет ← да	Флаг, указывающий, нужно ли получить незарегистрированные виртуальные машины, содержащие один или несколько дисков, находящихся в области хранения, или виртуальные машины без дисков.

Примечания

Примечание

Этот модуль возвращает переменную ovirt_storage_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 relate to a storage domain and are unregistered
  ovirt_vms_info:
    unregistered: yes
  register: result

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

Значения возврата

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

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

Статус

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

Авторы

Maor Lipchuk (@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_storage_vm_facts_module.html