ovirt_external_provider – Модуль для управления внешними провайдерами в oVirt/RHV
Новый в версии 2.3.
Обзор
- Модуль для управления внешними провайдерами в oVirt/RHV
Псевдонимы: ovirt_external_providers
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- 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-запросу. | |
| 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 boolean добавлен в 2.3 |
| Если True, модуль загрузит дополнительные данные из API. Будут загружены идентификаторы дисков, снимков и т.д. виртуальных машин. Пользователь может настроить загрузку других атрибутов вложенных сущностей, указав nested_attributes. |
| name - | Имя внешнего провайдера для управления. | |
| nested_attributes - добавлен в 2.3 | Указывает список атрибутов, которые должны быть загружены из API. Этот параметр применяется только если fetch_nested равен true. | |
| network_type - |
["external"] | Тип внешнего провайдера сети: external (например, OVN) или neutron. Применимо, если type равен network. |
| password - | Пароль пользователя, указанный в параметре username. Применимо для всех типов. | |
| poll_interval - | По умолчанию: 3 | Количество секунд, которое модуль ожидает, прежде чем отправить другой запрос опроса состояния сущности. |
| read_only - | Указывает, должна ли сеть быть только для чтения. Применимо, если type равен network. | |
| state - |
| Должен ли внешний провайдер быть присутствующим или отсутствующим. При использовании значения absent для os_volume, убедитесь, что SD не подключён к ЦОД! |
| tenant_name - | Имя клиента. Применимо для типов: os_image, os_volume и network. псевдонимы: tenant | |
| timeout - | По умолчанию: 180 | Количество времени в секундах, которое модуль должен ждать, пока экземпляр не перейдет в желаемое состояние. |
| type - |
| Тип внешнего провайдера. |
| url - | URL, где размещен внешний провайдер. Применимо для типов: os_image, os_volume, network и foreman. | |
| username - | Имя пользователя для входа во внешний провайдер. Применимо для всех типов. | |
| wait boolean |
|
True, если модуль должен подождать, пока сущность не перейдет в желаемое состояние. |
Примечания
Примечание
- Для использования этого модуля необходимо установить 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:
# 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 по следующему URL: 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 по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/openstack_image_provider. |
| openstack_network_provider словарь | При успехе и если используется параметр 'type: network'. | Словарь всех атрибутов openstack_network_provider. Атрибуты внешнего поставщика можно найти на вашем экземпляре oVirt/RHV по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/openstack_network_provider. |
| openstack_volume_provider словарь | При успехе и если используется параметр 'type: os_volume'. | Словарь всех атрибутов openstack_volume_provider. Атрибуты внешнего поставщика можно найти на вашем экземпляре oVirt/RHV по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/openstack_volume_provider. |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.7/modules/ovirt_external_provider_module.html