Spec-Zone.ru › Ansible 2.9

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

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата
  • Статус

Обзор

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

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
auth
словарь / обязательно
Словарь со значениями, необходимыми для создания HTTP/HTTPS-соединения с oVirt:
ca_file
строка
Файл PEM, содержащий доверенные сертификаты CA.
Представленный сервером сертификат будет проверен с использованием этих сертификатов CA.
Если параметр ca_file не задан, используется системный хранилище сертификатов CA.
Значение по умолчанию устанавливается переменной среды OVIRT_CAFILE.
headers
словарь
Словарь HTTP-заголовков, которые будут добавлены к каждому API-запросу.
hostname
строка
Строка, содержащая имя хоста сервера, обычно что-то вроде `server.example.com`.
Значение по умолчанию устанавливается переменной среды OVIRT_HOSTNAME.
Требуется либо url, либо hostname.
insecure
булево
    Варианты:
  • нет
  • да
Флаг булевого типа, указывающий, следует ли проверять сертификат TLS сервера и имя хоста.
kerberos
булево
    Варианты:
  • нет
  • да
Флаг булевого типа, указывающий, следует ли использовать аутентификацию Kerberos вместо стандартной аутентификации по имени пользователя/паролю.
password
строка / обязательно
Пароль пользователя.
Значение по умолчанию устанавливается переменной среды OVIRT_PASSWORD.
token
строка
Токен для использования вместо входа с именем пользователя/паролем.
Значение по умолчанию устанавливается переменной среды OVIRT_TOKEN.
url
строка
Строка, содержащая API-URL сервера, обычно что-то вроде `https://server.example.com/ovirt-engine/api`.
Значение по умолчанию устанавливается переменной среды OVIRT_URL.
Требуется либо url, либо hostname.
username
строка / обязательно
Имя пользователя, например admin@internal.
Значение по умолчанию устанавливается переменной среды OVIRT_USERNAME.
authentication_keys
-
добавлен в 2.6
По умолчанию:
[]
Список ключей аутентификации. Каждый ключ представлен словарем, например {'uuid': 'our-uuid', 'value': 'YourSecretValue=='}
Если эти ключи не переданы, а некоторые из них уже определены в системе, они будут удалены.
Применимо для os_volume.
authentication_url
-
URL аутентификации Keystone для поставщика openstack.
Применимо для типов: os_image, os_volume и network.

Псевдонимы: auth_url
data_center
-
Имя ЦОД, к которому должен быть подключен поставщик.
Применимо для типа: os_volume.
description
-
Описание внешнего поставщика.
fetch_nested
булево
    Варианты:
  • нет
  • да
Если True, модуль извлечет дополнительные данные из API.
Будет извлечены идентификаторы дисков, снимков VM и т. д. Пользователь может настроить извлечение других атрибутов вложенных сущностей, указав nested_attributes.
name
-
Имя внешнего поставщика для управления.
nested_attributes
список
Указывает список атрибутов, которые должны быть извлечены из API.
Этот параметр применяется только когда fetch_nested равно истина.
network_type
-
    Варианты:
  • external ←
  • neutron
По умолчанию:
["external"]
Тип внешнего поставщика сети, либо external (например, OVN), либо neutron.
Применимо, если type равно network.
password
-
Пароль пользователя, указанный в параметре username.
Применимо для всех типов.
poll_interval
целое число
По умолчанию:
3
Количество секунд, которое модуль ожидает, прежде чем отправить ещё один запрос на проверку состояния сущности.
read_only
булево
    Варианты:
  • нет
  • да
Указать, должна ли сеть быть только для чтения.
Применимо, если type равно network.
state
-
    Варианты:
  • present ←
  • absent
Должен ли внешний поставщик быть present или absent
При использовании absent для os_volume, необходимо убедиться, что SD не прикреплен к ЦОД!
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
булево
    Варианты:
  • нет
  • да ←
yes если модуль должен ждать, пока сущность перейдет в нужное состояние.

Примечания

Примечание

  • Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: 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:

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

# Add volume external provider:
- ovirt_external_provider:
    name: image_provider
    type: os_volume
    url: http://1.2.3.4:9292
    username: admin
    password: 123456
    tenant: admin
    auth_url: http://1.2.3.4:5000/v2.0
    authentication_keys:
      -
        uuid: "1234567-a1234-12a3-a234-123abc45678"
        value: "ABCD00000000111111222333445w=="

# 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
словарь
При успехе и если используется параметр 'type: foreman'.
Словарь всех атрибутов external_host_provider. Атрибуты внешнего поставщика можно найти на вашем экземпляре oVirt/RHV по следующему адресу: http://ovirt.github.io/ovirt-engine-api-model/master/#types/external_host_provider.

id
строка
При успехе, если внешняя система поставщика найдена.
Идентификатор внешнего поставщика, который управляется

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

openstack_network_provider
словарь
При успехе и если используется параметр 'type: network'.
Словарь всех атрибутов openstack_network_provider. Атрибуты внешнего поставщика можно найти на вашем экземпляре oVirt/RHV по следующему адресу: http://ovirt.github.io/ovirt-engine-api-model/master/#types/openstack_network_provider.

openstack_volume_provider
словарь
При успехе и если используется параметр 'type: os_volume'.
Словарь всех атрибутов openstack_volume_provider. Атрибуты внешнего поставщика можно найти на вашем экземпляре oVirt/RHV по следующему адресу: http://ovirt.github.io/ovirt-engine-api-model/master/#types/openstack_volume_provider.



Статус

  • Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
  • Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

  • Ondra Machacek (@machacekondra)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

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

Spec-Zone.ru

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