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

Новая в версии 2.4.

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

Обзор

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

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

Требования

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

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

Примечания

Примечание

Этот модуль возвращает переменную ovirt_storage_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 relate to a storage domain and
# are unregistered:
- ovirt_storage_vm_info:
    unregistered=True
  register: result
- debug:
    msg: "{{ result.ovirt_storage_vms }}"

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

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

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

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

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.9/modules/ovirt_storage_vm_info_module.html