openstack.cloud.keystone_federation_protocol модуль — Управление протоколом федерации Keystone

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: openstack.cloud.keystone_federation_protocol.

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

Описание

Управление протоколом федерации Keystone.

Требования

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

python >= 3.6
openstacksdk >= 1.0.0

Параметры

Параметр	Комментарии
api_timeout целое число	Сколько времени должна ждать система сокетов перед тем, как истечёт время ожидания для вызовов API. Если этот параметр опущен, ничего не будет передано в библиотеку requests.
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.
idp псевдонимы: idp_id, idp_name строка / обязательный	Идентификатор или имя поставщика идентификации, с которым связан этот протокол. Это атрибут нельзя изменить.
interface псевдонимы: endpoint_type строка	Тип URL конечной точки для извлечения из каталога служб. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
mapping псевдонимы: mapping_id, mapping_name строка	Идентификатор или имя отображения для использования в этом протоколе. Требуется при создании нового протокола.
name псевдонимы: id строка / обязательный	Идентификатор или имя протокола федерации. Это атрибут нельзя изменить.
region_name строка	Имя региона.
sdk_log_level строка	Уровень ведения журнала OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path строка	Путь к журналу OpenStackSDK. Если пусто, журнал не записывается.
state строка	Состояние протокола должно быть `present` или `absent`. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout целое число	Сколько времени Ansible должно ждать запрошенного ресурса. По умолчанию: `180`
validate_certs псевдонимы: verify булево	Необходимо ли проверять запросы 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 a protocol
  openstack.cloud.keystone_federation_protocol:
    cloud: example_cloud
    name: example_protocol
    idp: example_idp
    mapping: example_mapping

- name: Delete a protocol
  openstack.cloud.keystone_federation_protocol:
    cloud: example_cloud
    name: example_protocol
    idp: example_idp
    state: absent

Значения возврата

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

Ключ	Описание
protocol словарь	Словарь, описывающий протокол федерации. Возвращается: всегда
id строка	Идентификатор протокола федерации. Возвращается: при успехе
mapping_id строка	Определение протокола федерации. Возвращается: при успехе
name строка	Имя протокола. Равно `id`. Возвращается: при успехе

Авторы

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/keystone_federation_protocol_module.html