ovirt_storage_vms_facts - Извлечение фактов о одной или нескольких виртуальных машинах oVirt/RHV, связанных с областью хранения.
Новая версия 2.4.
Описание
- Извлечение фактов о одной или нескольких виртуальных машинах oVirt/RHV, связанных с областью хранения.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.2.4
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth обязательный | Словарь со значениями, необходимыми для создания HTTP/HTTPS-соединения с oVirt: username[обязательный] - Имя пользователя, например, admin@internal. Значение по умолчанию задаётся переменной среды OVIRT_USERNAME.password[обязательный] - Пароль пользователя. Значение по умолчанию задаётся переменной среды OVIRT_PASSWORD.url[обязательный] - Строка, содержащая базовый URL сервера, обычно что-то вроде `https://server.example.com/ovirt-engine/api`. Значение по умолчанию задаётся переменной среды OVIRT_URL.token - Токен, используемый вместо входа с именем пользователя/паролем. Значение по умолчанию задаётся переменной среды OVIRT_TOKEN.insecure - Логический флаг, указывающий, нужно ли проверять сертификат TLS сервера и имя хоста.ca_file - Файл PEM, содержащий доверенные сертификаты CA. Представленный сервером сертификат будет проверен с помощью этих сертификатов CA. Если параметр `ca_file` не задан, используется системное хранилище сертификатов CA. Значение по умолчанию задаётся переменной среды OVIRT_CAFILE.kerberos - Логический флаг, указывающий, нужно ли использовать аутентификацию Kerberos вместо стандартной аутентификации.headers - Словарь HTTP-заголовков, которые необходимо добавить к каждому API-запросу. | |
| fetch_nested (добавлен в 2.3) | Если True, модуль извлечет дополнительные данные из API. Он извлечет идентификаторы дисков ВМ, снимков и т.д. Пользователь может настроить извлечение других атрибутов вложенных сущностей, указав nested_attributes. | |
| nested_attributes (добавлен в 2.3) | Указывает список атрибутов, которые необходимо извлечь из API. Этот параметр применяется только когда fetch_nested равен true. | |
| unregistered | Флаг, указывающий, нужно ли получать не зарегистрированные виртуальные машины, содержащие один или несколько дисков, находящихся в области хранения, или виртуальные машины без дисков. |
Примечания
Примечание
- Этот модуль создает новый факт верхнего уровня
ovirt_storage_vms, который содержит список виртуальных машин. - Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.0.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 список | При успешном выполнении. | Список словарей, описывающих ВМ. Атрибуты ВМ сопоставлены с ключами словаря, все атрибуты ВМ можно найти по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/vm. |
Статус
Этот модуль помечен как экспериментальный, что означает, что его интерфейс не гарантируется обратной совместимости.
Автор
- Maor Lipchuk
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/ovirt_storage_vms_facts_module.html
