Spec-Zone.ru › Ansible 2.4

ovirt_external_provider - Модуль для управления внешними поставщиками в oVirt/RHV

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

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

Обзор

  • Модуль для управления внешними поставщиками в oVirt/RHV

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

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

Параметры

параметр обязателен по умолчанию выбор комментарии
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.
authentication_url
нет
URL аутентификации Keystone для поставщика OpenStack.
Применимо для типов: os_image, os_volume и network.
псевдонимы: auth_url
data_center
нет
Имя ЦОД, к которому должен быть подключен поставщик.
Применимо для типа: os_volume.
description
нет
Описание внешнего поставщика.
fetch_nested
(добавлено в 2.3)
нет
Если True, модуль извлечёт дополнительные данные из API.
Он извлечёт идентификаторы дисков ВМ, снимков и т. д. Пользователь может настроить извлечение других атрибутов вложенных сущностей, указав nested_attributes.
name
нет
Имя внешнего поставщика для управления.
nested_attributes
(добавлено в 2.3)
нет
Указывает список атрибутов, которые должны быть извлечены из API.
Этот параметр применяется только когда fetch_nested равен true.
network_type
нет [u'external']
  • external
  • neutron
Тип внешнего поставщика сети, например, external (например, OVN) или neutron.
Применимо, если type равен network.
password
нет
Пароль пользователя, указанного в параметре username.
Применимо для всех типов.
poll_interval
нет 3
Количество секунд, в течение которых модуль ждёт, прежде чем отправлять запрос о состоянии сущности.
read_only
нет
Указывает, должна ли сеть быть только для чтения.
Применимо, если type равен network.
state
нет present
  • present
  • absent
Внешний поставщик должен быть present или absent.
tenant_name
нет
Имя арендатора.
Применимо для типов: os_image, os_volume и network.
псевдонимы: tenant
timeout
нет 180
Время в секундах, которое модуль должен ждать, пока экземпляр не перейдет в желаемое состояние.
type
нет
  • os_image
  • network
  • os_volume
  • foreman
Тип внешнего поставщика.
url
нет
URL, где размещён внешний поставщик.
Применимо для типов: os_image, os_volume, network и foreman.
username
нет
Имя пользователя для входа в внешний поставщик.
Применимо для всех типов.
wait
нет
True, если модуль должен дождаться, пока сущность перейдет в желаемое состояние.

Примеры

# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:

# Add image external provider:
- ovirt_external_provider:
    name: image_provider
    type: os_image
    url: http://10.34.63.71:9292
    username: admin
    password: 123456
    tenant: admin
    auth_url: http://10.34.63.71:35357/v2.0/

# Add foreman provider:
- ovirt_external_provider:
    name: foreman_provider
    type: foreman
    url: https://foreman.example.com
    username: admin
    password: 123456

# Add external network provider for OVN:
- ovirt_external_provider:
    name: ovn_provider
    type: network
    network_type: external
    url: http://1.2.3.4:9696

# Remove image external provider:
- ovirt_external_provider:
    state: absent
    name: image_provider
    type: os_image

Возвращаемые значения

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

имя описание возвращается тип пример
external_host_provider
Словарь всех атрибутов external_host_provider. Атрибуты внешнего поставщика можно найти на вашем экземпляре oVirt/RHV по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/external_host_provider.
При успехе и если используется параметр 'type: foreman'. словарь
id
ID внешнего поставщика, который управляется.
При успехе, если внешний поставщик найден. строка 7de90f31-222c-436c-a1ca-7e655bd5b60c
openstack_image_provider
Словарь всех атрибутов openstack_image_provider. Атрибуты внешнего поставщика можно найти на вашем экземпляре oVirt/RHV по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/openstack_image_provider.
При успехе и если используется параметр 'type: os_image'. словарь
openstack_network_provider
Словарь всех атрибутов openstack_network_provider. Атрибуты внешнего поставщика можно найти на вашем экземпляре oVirt/RHV по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/openstack_network_provider.
При успехе и если используется параметр 'type: network'. словарь
openstack_volume_provider
Словарь всех атрибутов openstack_volume_provider. Атрибуты внешнего поставщика можно найти на вашем экземпляре oVirt/RHV по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/openstack_volume_provider.
При успехе и если используется параметр 'type: os_volume'. словарь

Примечания

Примечание

  • Для использования этого модуля необходимо установить 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_external_provider_module.html

Spec-Zone.ru

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