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

Примечание

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

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

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

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

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

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

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

Требования

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

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.
interface псевдонимы: endpoint_type string	Тип URL конечной точки, получаемой из каталога служб. Допустимые значения: `"admin"` `"internal"` `"public"` ← (по умолчанию)
name псевдонимы: id string / обязательный	Имя сопоставления, которым нужно управлять.
region_name string	Имя региона.
rules list / элементы=dictionary	Правила, составляющие сопоставление. Это пары определений local и remote. Подробнее о принципах их работы см. в документации OpenStack: https://docs.openstack.org/keystone/latest/admin/federation/mapping_combinations.html. Обязательно, если state имеет значение `present`.
local list / элементы=dictionary / обязательный	Сведения о локальных атрибутах, которые будут сопоставлены.
remote list / элементы=dictionary / обязательный	Сведения об удалённых атрибутах, которые будут сопоставлены.
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	Следует ли проверять запросы 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 new mapping
  openstack.cloud.federation_mapping:
    cloud: example_cloud
    name: example_mapping
    rules:
    - local:
      - user:
          name: '{0}'
      - group:
          id: '0cd5e9'
      remote:
      - type: UserName
      - type: orgPersonType
        any_one_of:
        - Contractor
        - SubContractor

- name: Delete a mapping
  openstack.cloud.federation_mapping:
    name: example_mapping
    state: absent

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

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

Ключ	Описание
mapping dictionary	Словарь с описанием сопоставления федерации. Возвращается: всегда
id string	Идентификатор сопоставления Возвращается: при успешном выполнении Пример: `"ansible-test-mapping"`
name string	Имя сопоставления. Совпадает с `id`. Возвращается: при успешном выполнении Пример: `"ansible-test-mapping"`
rules list / элементы=string	Список правил сопоставления Возвращается: при успешном выполнении

Авторы

Специальная группа 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/federation_mapping_module.html