ovirt_storage_vm_facts – Получение фактов о одной или нескольких виртуальных машинах oVirt/RHV, относящихся к домену хранения.
Новое в версии 2.4.
Описание
- Получение фактов об одной или нескольких виртуальных машинах oVirt/RHV, относящихся к домену хранения.
Псевдонимы: ovirt_storage_vms_facts
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется данный модуль.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.2.4
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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 добавлен в 2.3 |
| Если True, модуль будет получать дополнительные данные из API. Он будет получать идентификаторы дисков ВМ, снимков и т.д. Пользователь может настроить получение других атрибутов вложенных сущностей, указав nested_attributes. |
| max - | Устанавливает максимальное количество виртуальных машин для возврата. Если не указано, возвращаются все виртуальные машины. | |
| nested_attributes - добавлен в 2.3 | Указывает список атрибутов, которые должны быть получены из API. Этот параметр применяется только когда fetch_nested равен true. | |
| storage_domain - | Имя домена хранения, в котором должны быть перечислены виртуальные машины. | |
| unregistered boolean |
| Флаг, указывающий, следует ли получать незарегистрированные виртуальные машины, содержащие один или несколько дисков, расположенных в домене хранения, или виртуальные машины без дисков. |
Примечания
Примечание
- Этот модуль создает новый факт верхнего уровня
ovirt_storage_vms, который содержит список виртуальных машин. - Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.2.4
Примеры
# 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. |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.7/modules/ovirt_storage_vm_facts_module.html
