openstack.cloud.federation_idp модуль — Управление поставщиком идентификации в облаке OpenStack
Примечание
Этот модуль является частью коллекции openstack.cloud (версия 2.2.0).
У вас может быть уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля необходимы дополнительные требования. Подробнее см. Требования.
Для использования в playbook укажите: openstack.cloud.federation_idp.
Описание
- Создание, обновление или удаление поставщика идентификации службы идентификации OpenStack (Keystone).
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 3.6
- openstacksdk >= 1.0.0
Параметры
Параметр | Комментарии |
|---|---|
api_timeout целое число | Сколько времени должна ждать система сокетов, прежде чем истечёт время ожидания для вызовов API. Если это значение опущено, библиотека запросов ничего не получит. |
auth словарь | Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для плагина по умолчанию password, он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать любые параметры, необходимые этому плагину авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. |
auth_type строка | Имя плагина авторизации для использования. Если облако использует что-то другое, кроме парольной аутентификации, здесь должно быть указано имя плагина, и содержимое параметра auth должно быть соответствующим образом обновлено. |
ca_cert псевдонимы: cacert строка | Путь к пакету сертификатов CA, который можно использовать в процессе проверки запросов API SSL. |
client_cert псевдонимы: cert строка | Путь к клиенту сертификату, который будет использоваться в рамках SSL транзакции. |
client_key псевдонимы: key строка | Путь к ключу клиента, который будет использоваться в рамках SSL транзакции. |
cloud любой | Именованное облако или конфигурация облака, для работы с ним. Если cloud является строкой, то она ссылается на конфигурацию именованного облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен auth или присутствуют переменные окружения OpenStack OS_* . Если cloud является словарем, он содержит полную конфигурацию облака, как это было бы в разделе clouds.yaml. |
description строка | Описание поставщика идентификаторов. |
domain_id строка | Идентификатор домена, связанного с поставщиком идентификаторов. Учётные записи федеративных пользователей, которые аутентифицируются с помощью поставщика идентификаторов, будут созданы в указанном домене. Требуется при создании нового поставщика идентификаторов. |
id псевдонимы: name строка / обязательный | Идентификатор (и имя) поставщика идентификаторов. |
interface псевдонимы: endpoint_type строка | Тип URL конечной точки для извлечения из каталога служб. Варианты:
|
is_enabled псевдонимы: enabled булево | Включён ли поставщик идентификаторов или нет. Будет по умолчанию Варианты:
|
region_name строка | Название региона. |
remote_ids список / элементы=строка | Список уникальных удалённых идентификаторов поставщика идентификаторов. Будет по умолчанию пустым списком при создании нового поставщика идентификаторов. |
sdk_log_level строка | Уровень логирования OpenStackSDK Варианты:
|
sdk_log_path строка | Путь к файлу журнала OpenStackSDK. Если пусто, журнал не будет записан |
state строка | Должен ли поставщик идентификаторов быть Варианты:
|
timeout целое число | Сколько времени Ansible должен ждать запрашиваемого ресурса. По умолчанию: |
validate_certs aliases: verify boolean | Проверять ли SSL API-запросы. До Ansible 2.3 это по умолчанию было Варианты:
|
wait boolean | Должен ли Ansible ожидать завершения запрошенного ресурса. Варианты:
|
Примечания
Примечание
- Можно использовать стандартные переменные среды OpenStack, такие как
OS_USERNAME, вместо явных значений. - Информация об авторизации обрабатывается openstacksdk, что означает, что значения могут быть взяты из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, а затем из явных параметров в задачах. Более подробную информацию можно найти на странице https://docs.openstack.org/openstacksdk/
Примеры
- name: Create an identity provider
openstack.cloud.federation_idp:
cloud: example_cloud
name: example_provider
domain_id: 0123456789abcdef0123456789abcdef
description: 'My example IDP'
remote_ids:
- 'https://auth.example.com/auth/realms/ExampleRealm'
- name: Delete an identity provider
openstack.cloud.federation_idp:
cloud: example_cloud
name: example_provider
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
identity_provider словарь | Словарь, описывающий поставщиков идентификации Возвращается: при успехе, когда state равен |
|
description строка |
Описание поставщика идентификации Возвращается: успех Пример: |
|
domain_id строка |
Домен, к которому принадлежит поставщик идентификации Возвращается: успех Пример: |
|
id строка |
Идентификатор поставщика идентификации Возвращается: успех Пример: |
|
is_enabled boolean |
Указывает, включен ли поставщик идентификации Возвращается: успех |
|
name строка |
Имя поставщика идентификации, равно его ID. Возвращается: успех Пример: |
|
remote_ids список / элементы=строка |
Удаленные ID, связанные с поставщиком идентификации Возвращается: успех |
Ссылки на сборку
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/openstack/cloud/federation_idp_module.html
