openstack.cloud.identity_domain модуль — Управление доменнами OpenStack identity (Keystone)

Примечание

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

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

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

Чтобы использовать его в playbook, укажите: openstack.cloud.identity_domain.

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

Описание

Создание, обновление или удаление доменов OpenStack identity (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.
description строка	Описание домена.
interface псевдонимы: endpoint_type строка	Тип URL конечной точки для извлечения из каталога служб. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
is_enabled псевдонимы: enabled булево	Включен ли этот домен. Варианты: `false` `true`
name строка / обязательный	Имя домена.
region_name строка	Имя региона.
sdk_log_level строка	Уровень логирования OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path строка	Путь к файлу журнала OpenStackSDK. Если пусто, журнал не записывается
state строка	Ресурс должен присутствовать или отсутствовать. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout целое число	Сколько времени Ansible должно ждать запрашиваемого ресурса. По умолчанию: `180`
validate_certs псевдонимы: verify булево	Нужно ли проверять запросы API SSL. До Ansible 2.3 это имело значение по умолчанию `true`. Варианты: `false` `true`
wait булево	Должен ли Ansible ждать завершения запрошенного ресурса? Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

Примеры

- name: Create a domain
  openstack.cloud.identity_domain:
    cloud: mycloud
    state: present
    name: demo
    description: Demo Domain

- name: Delete a domain
  openstack.cloud.identity_domain:
    cloud: mycloud
    state: absent
    name: demo

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

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

Ключ	Описание
домен словарь	Словарь, описывающий домен. Возвращается: При успехе, когда состояние равно `present`.
описание строка	Описание домена. Возвращается: успех Пример: `"Demo Domain"`
идентификатор строка	Идентификатор домена. Возвращается: успех Пример: `"474acfe5-be34-494c-b339-50f06aa143e4"`
включен логическое значение	Описание домена. Возвращается: успех Пример: `true`
связи список / элементы=строка	Связи, связанные с ресурсом домена. Возвращается: успех
имя строка	Имя домена. Возвращается: успех Пример: `"demo"`

Авторы

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