community.general.ovirt_storage_vm_facts – Получение информации об одной или нескольких виртуальных машинах oVirt/RHV, связанных с областью хранения.
Примечание
Этот плагин входит в коллекцию community.general (версия 2.0.1).
Для его установки используйте: 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 логический |
| Если да, модуль получит дополнительные данные из API. Будут получены только идентификаторы вложенных сущностей. Он не получает несколько уровней вложенных атрибутов. Только атрибуты текущей сущности. Пользователь может настроить получение других атрибутов вложенных сущностей, указав nested_attributes. |
| max строка | Устанавливает максимальное количество виртуальных машин для возврата. Если не указано, возвращаются все виртуальные машины. | |
| nested_attributes список / элементы=строка | Указывает список атрибутов, которые должны быть получены из API. Этот параметр применяется только при fetch_nested равно true. | |
| storage_domain строка | Имя области хранения, в которой должны быть перечислены виртуальные машины. | |
| unregistered логический |
| Флаг, указывающий, следует ли получать не зарегистрированные виртуальные машины, содержащие один или несколько дисков, находящихся в области хранения, или виртуальные машины без дисков. |
Примечания
Примечание
- Этот модуль возвращает переменную
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 список / элементы=строка | При успехе. | Список словарей, описывающих ВМ. Атрибуты ВМ сопоставляются с ключами словаря, все атрибуты ВМ можно найти по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/vm. |
Статус
- Этот модуль будет удален в версии 3.0.0. [устаревший]
- Для получения дополнительной информации см. УСТАРЕВШИЙ.
Авторы
- Maor Lipchuk (@machacekondra)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/ovirt_storage_vm_facts_module.html
