Spec-Zone.ru › Ansible 2.4

ovirt_vms_facts - Получение фактов о одной или нескольких виртуальных машинах oVirt/RHV

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

  • Описание
  • Требования (к хосту, на котором выполняется модуль)
  • Параметры
  • Примеры
  • Значения возврата
  • Примечания
    • Статус

Описание

  • Получение фактов об одной или нескольких виртуальных машинах oVirt/RHV.

Требования (к хосту, на котором выполняется модуль)

  • python >= 2.7
  • ovirt-engine-sdk-python >= 4.0.0

Параметры

параметр обязательно значение по умолчанию выбор комментарии
all_content
нет
Если true, все атрибуты виртуальных машин должны быть включены в ответ.
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-запросу.
case_sensitive
нет
Если true, в поиске учитываются регистр символов.
fetch_nested
(добавлено в 2.3)
нет
Если True, модуль извлечёт дополнительные данные из API.
Он извлечёт ID дисков, снимков и т. п. для ВМ. Пользователь может настроить загрузку других атрибутов вложенных сущностей, указав nested_attributes.
max
нет
Максимальное количество возвращаемых результатов.
nested_attributes
(добавлено в 2.3)
нет
Указывает список атрибутов, которые должны быть извлечены из API.
Этот параметр применяется только, когда fetch_nested имеет значение true.
pattern
нет
Запрос, принимаемый механизмом поиска oVirt/RHV.
Например, чтобы найти VM X из кластера Y, используйте следующий запрос: name=X and cluster=Y

Примеры

# 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 names start with C(centos) and
# belong to cluster C(west):
- ovirt_vms_facts:
    pattern: name=centos* and cluster=west
- debug:
    var: ovirt_vms

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

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

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

Примечания

Примечание

  • Этот модуль создает новый факт верхнего уровня ovirt_vms, который содержит список виртуальных машин.
  • Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.0.0

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратную совместимость.

Для помощи в разработке модулей, если вам это интересно, прочитайте Документацию по сообществу и участию в разработке, Тестирование Ansible и Разработка модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/ovirt_vms_facts_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API