Модуль openstack.cloud.federation_mapping_info – Извлечение сопоставлений федерации Keystone

Примечание

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

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

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

Для использования в playbook, укажите: openstack.cloud.federation_mapping_info.

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

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

Извлечение сопоставлений федерации Keystone.

Требования

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

python >= 3.6
openstacksdk >= 1.0.0

Параметры

Параметр	Комментарии
api_timeout целое число	Как долго сокетный уровень должен ждать, прежде чем истечет время ожидания для вызовов API. Если этот параметр опущен, ничего не будет передано в библиотеку запросов.
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.
interface псевдонимы: endpoint_type строка	Тип URL конечной точки для извлечения из каталога служб. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
name псевдонимы: id строка	ID или имя сопоставления федерации.
region_name строка	Имя региона.
sdk_log_level строка	Уровень логирования OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path строка	Путь к файлу журнала OpenStackSDK. Если пусто, журнал не записывается.
timeout целое число	Как долго ansible должен ждать запрашиваемый ресурс. Значение по умолчанию: `180`
validate_certs псевдонимы: verify логическое	Следует ли проверять запросы API SSL. До Ansible 2.3 это значение по умолчанию было `true`. Варианты: `false` `true`
wait логическое	Должен ли ansible ждать, пока запрашиваемый ресурс не будет завершен. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Имя равно ID отображения федерации.
Стандартные переменные среды OpenStack, такие как OS_USERNAME, могут быть использованы вместо явных значений.
Информация об авторизации управляется openstacksdk, что означает, что значения могут быть взяты из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, а затем, наконец, из явных параметров в задачах. Дополнительную информацию можно найти на сайте https://docs.openstack.org/openstacksdk/

Примеры

- name: Fetch all federation mappings
  openstack.cloud.federation_mapping_info:
    cloud: example_cloud

- name: Fetch federation mapping by name
  openstack.cloud.federation_mapping_info:
    cloud: example_cloud
    name: example_mapping

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

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

Ключ	Описание
отображения список / элементы=словарь	Список словарей отображения федерации. Возвращаемое значение: всегда
id строка	Идентификатор отображения. Возвращаемое значение: успех Пример: `"ansible-test-mapping"`
имя строка	Имя отображения. Равно `id`. Возвращаемое значение: успех Пример: `"ansible-test-mapping"`
правила список / элементы=строка	Список правил для отображения. Возвращаемое значение: успех

Авторы

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_mapping_info_module.html