Модуль openstack.cloud.federation_idp — управление поставщиком удостоверений в облаке OpenStack

Примечание

Этот модуль входит в коллекцию openstack.cloud (версия 2.5.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: openstack.cloud.federation_idp.

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Создание, обновление или удаление поставщика удостоверений службы идентификации OpenStack (Keystone).

Требования

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

python >= 3.6
openstacksdk >= 1.0.0

Параметры

Параметр	Комментарии
api_timeout integer	Сколько времени уровень сокетов должен ожидать ответа, прежде чем считать вызовы API завершившимися по тайм-ауту. Если параметр не указан, библиотеке requests ничего не передаётся.
auth dictionary	Словарь с данными аутентификации, необходимыми используемой в облаке стратегии плагина аутентификации. Для стандартного плагина password здесь указываются auth_url, username, password, project_name и сведения о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать данные, необходимые соответствующему плагину аутентификации. Этот параметр не требуется, если указано имя облака или заданы переменные окружения OpenStack OS_*.
auth_type string	Имя используемого плагина аутентификации. Если в облаке используется не парольная аутентификация, здесь следует указать имя плагина и соответствующим образом обновить содержимое параметра auth.
ca_cert псевдонимы: cacert string	Путь к набору сертификатов центра сертификации, который можно использовать для проверки запросов API SSL.
client_cert псевдонимы: cert string	Путь к сертификату клиента, используемому при обмене данными SSL.
client_key псевдонимы: key string	Путь к ключу клиента, используемому при обмене данными SSL.
cloud any	Именованное облако или конфигурация облака, с которыми выполняются операции. Если cloud — строка, она указывает на конфигурацию именованного облака, заданную в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не требуется, если задан auth или присутствуют переменные окружения OpenStack OS_. Если cloud* — словарь, он содержит полную конфигурацию облака, аналогичную секции файла clouds.yaml.
description string	Описание поставщика удостоверений.
domain_id string	Идентификатор домена, связанного с поставщиком удостоверений. Федеративные пользователи, прошедшие аутентификацию с помощью поставщика удостоверений, будут созданы в указанном домене. Обязателен при создании нового поставщика удостоверений.
id псевдонимы: name string / обязательный	Идентификатор (и имя) поставщика удостоверений.
interface псевдонимы: endpoint_type string	Тип URL конечной точки, получаемой из каталога служб. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
is_enabled псевдонимы: enabled boolean	Включён ли поставщик удостоверений. При создании нового поставщика удостоверений по умолчанию будет использоваться значение `false`. Варианты: `false` `true`
region_name string	Название региона.
remote_ids list / элементы типа string	Список уникальных удалённых идентификаторов поставщика удостоверений. При создании нового поставщика удостоверений по умолчанию используется пустой список.
sdk_log_level string	Уровень журналирования OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path string	Путь к файлу журнала OpenStackSDK. Если значение пустое, журнал не ведётся.
state string	Следует ли `present` или `absent` поставщик удостоверений. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout integer	Как долго Ansible должен ожидать запрошенный ресурс. По умолчанию: `180`
validate_certs псевдонимы: verify boolean	Следует ли проверять запросы API SSL. До Ansible 2.3 значением по умолчанию было `true`. Варианты: `false` `true`
wait boolean	Должен ли Ansible ожидать завершения операции с запрошенным ресурсом. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Вместо явного указания значений можно использовать стандартные переменные окружения 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 dictionary	Словарь с описанием поставщиков удостоверений Возвращается: При успешном выполнении, если state имеет значение `present`.
description string	Описание поставщика удостоверений Возвращается: при успешном выполнении Пример: `"demodescription"`
domain_id string	Домен, к которому относится поставщик удостоверений Возвращается: при успешном выполнении Пример: `"default"`
id string	Идентификатор поставщика удостоверений Возвращается: при успешном выполнении Пример: `"test-idp"`
is_enabled boolean	Указывает, включён ли поставщик удостоверений Возвращается: при успешном выполнении
name string	Имя поставщика удостоверений, совпадающее с его идентификатором. Возвращается: при успешном выполнении Пример: `"test-idp"`
remote_ids list / элементы типа string	Удалённые идентификаторы, связанные с поставщиком удостоверений Возвращается: при успешном выполнении

Авторы

Специальная группа Ansible по OpenStack

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/openstack/cloud/federation_idp_module.html