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

Примечание

Этот модуль является частью коллекции openstack.cloud (версия 2.2.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

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
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 строка / обязательно	Имя отображения для управления.
region_name строка	Имя региона.
rules список / элементы=словарь	Правила, составляющие отображение. Это пары определений local и remote. Более подробную информацию о том, как они работают, см. в документации OpenStack по адресу https://docs.openstack.org/keystone/latest/admin/federation/mapping_combinations.html. Требуется, если state равен `present`.
local список / элементы=словарь / обязательно	Информация о том, какие локальные атрибуты будут сопоставлены.
remote список / элементы=словарь / обязательно	Информация о том, какие атрибуты удалённых систем будут сопоставлены.
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 ← (по умолчанию)

Примечания

Примечание

Имя равно ID сопоставления.
Можно использовать стандартные переменные окружения 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 словарь	Словарь, описывающий сопоставление федерации. Возвращаемое значение: всегда
id строка	Идентификатор сопоставления Возвращаемое значение: успех Пример: `"ansible-test-mapping"`
name строка	Имя сопоставления. Равно `id`. Возвращаемое значение: успех Пример: `"ansible-test-mapping"`
rules список / элементы=строка	Список правил для сопоставления Возвращаемое значение: успех

Авторы

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