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 (добавлено в 2.3) | Если True, модуль извлечёт дополнительные данные из API. Он извлечёт идентификаторы дисков, снимков VM и т. д. Пользователь может настроить извлечение других атрибутов вложенных сущностей, указав 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 |
True, если модуль должен ждать, пока сущность не перейдёт в нужное состояние. |
Примечания
Примечание
- Для использования данного модуля необходимо установить Python SDK oVirt. Для обеспечения установки с правильной версией можно создать следующую задачу: 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. См. Техническое обслуживание модулей и поддержка для получения дополнительной информации.
Для просмотра списка других модулей, также поддерживаемых сообществом 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.6/modules/ovirt_external_provider_module.html
