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

Примечание

Этот модуль входит в коллекцию openstack.cloud (версия 2.5.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 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.
idp псевдонимы: idp_id, idp_name string / обязательный	Идентификатор или имя поставщика удостоверений, с которым связан этот протокол. Этот атрибут нельзя обновить.
interface псевдонимы: endpoint_type string	Тип URL конечной точки, получаемой из каталога служб. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
mapping псевдонимы: mapping_id, mapping_name string	Идентификатор или имя сопоставления, используемого для этого протокола. Обязательный параметр при создании протокола.
name псевдонимы: id string / обязательный	Идентификатор или имя протокола федерации. Этот атрибут нельзя обновить.
region_name 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	Следует ли проверять SSL-запросы к API. До 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 dictionary	Словарь с описанием протокола федерации. Возвращается: всегда
id string	Идентификатор протокола федерации. Возвращается: при успешном выполнении
mapping_id string	Определение протокола федерации. Возвращается: при успешном выполнении
name string	Имя протокола. Совпадает с `id`. Возвращается: при успешном выполнении

Авторы

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

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

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