Модуль openstack.cloud.federation_idp_info — получение поставщиков удостоверений федерации OpenStack

Примечание

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

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

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

Чтобы использовать модуль в сценарии, укажите: openstack.cloud.federation_idp_info.

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

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

Получение поставщиков удостоверений федерации OpenStack.

Требования

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

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	Путь к пакету сертификатов CA, который можно использовать для проверки запросов 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.
id псевдонимы: name string	Идентификатор (и имя) поставщика удостоверений, данные которого нужно получить.
interface псевдонимы: endpoint_type string	Тип URL конечной точки, который нужно получить из каталога служб. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
region_name string	Имя региона.
sdk_log_level string	Уровень ведения журнала OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path string	Путь к файлу журнала OpenStackSDK. Если значение не указано, журнал не ведётся.
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: Fetch a specific identity provider
  openstack.cloud.federation_idp_info:
    cloud: example_cloud
    name: example_provider

- name: Fetch all providers
  openstack.cloud.federation_idp_info:
    cloud: example_cloud

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

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