Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

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

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

Требования

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

  • python >= 3.6
  • openstacksdk >= 1.0.0

Параметры

Параметр

Комментарии

api_timeout

integer

Как долго слой сокета должен ожидать, прежде чем истечет время ожидания для вызовов API. Если это пропущено, ничего не будет передано в библиотеку запросов.

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

список / элементы=словарь

Словарь, описывающий поставщиков удостоверений

Возвращается: всегда

description

строка

Описание поставщика удостоверений

Возвращается: успешно

Пример: "demodescription"

domain_id

строка

Домен, к которому принадлежит поставщик удостоверений

Возвращается: успешно

Пример: "default"

id

строка

Идентификатор поставщика удостоверений

Возвращается: успешно

Пример: "test-idp"

is_enabled

булево

Указывает, включен ли поставщик удостоверений

Возвращается: успешно

name

строка

Имя поставщика удостоверений, равно его ID.

Возвращается: успешно

Пример: "test-idp"

remote_ids

список / элементы=строка

Удаленные идентификаторы, связанные с поставщиком удостоверений

Возвращается: успешно

Авторы

  • OpenStack Ansible SIG

Ссылки на сборник

  • Система отслеживания ошибок
  • Репозиторий (источники)

© 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_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API