ovirt_storage_vm_facts – Получение фактов о виртуальных машинах oVirt/RHV, связанных с областью хранения
Новое в версии 2.4.
Описание
- Получение фактов о одной или нескольких виртуальных машинах 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 логический добавлено в 2.3 |
| Если да, модуль извлечет дополнительные данные из API. Он извлечет идентификаторы дисков ВМ, снимков и т.д. Пользователь может настроить извлечение других атрибутов вложенных сущностей, указав nested_attributes. |
| max - | Устанавливает максимальное количество виртуальных машин, которые нужно вернуть. Если не указано, возвращаются все виртуальные машины. | |
| nested_attributes список добавлено в 2.3 | Указывает список атрибутов, которые следует извлечь из API. Этот параметр применяется только когда fetch_nested равен истинному. | |
| storage_domain - | Имя области хранения, где должны быть перечислены виртуальные машины. | |
| unregistered логический |
| Флаг, указывающий, следует ли получать не зарегистрированные виртуальные машины, содержащие один или несколько дисков, находящихся в области хранения, или виртуальные машины без дисков. |
Примечания
Примечание
- Этот модуль создает новый факт верхнего уровня
ovirt_storage_vms, который содержит список виртуальных машин. - Для использования этого модуля необходимо установить 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 facts about all VMs which relate to a storage domain and
# are unregistered:
- ovirt_vms_facts:
unregistered=True
- debug:
var: ovirt_storage_vms
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| ovirt_storage_vms список | При успехе. | Список словарей, описывающих ВМ. Атрибуты ВМ сопоставлены с ключами словаря, все атрибуты ВМ можно найти по следующему адресу: http://ovirt.github.io/ovirt-engine-api-model/master/#types/vm. |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [preview]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.8/modules/ovirt_storage_vm_facts_module.html
