openstack.cloud.endpoint модуль — Управление конечными точками сервиса OpenStack Identity

Примечание

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

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

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

Для использования в книге задач укажите: openstack.cloud.endpoint.

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

Описание

Создать, обновить или удалить конечные точки сервиса OpenStack Identity. Если сервис с той же комбинацией service, interface и region уже существует, будут обновлены url, enabled и state (present или absent).

Требования

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

python >= 3.6
openstacksdk >= 1.0.0

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
api_timeout целое число	Сколько времени в секундах должна ждать система сокетов, прежде чем истечёт время ожидания для вызовов API. Если этот параметр опущен, ничего не будет передано библиотеке requests.
auth словарь	Словарь, содержащий информацию об авторизации, необходимую для стратегии плагина авторизации облака. Для плагина по умолчанию password он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать параметры, необходимые этому плагину авторизации. Этот параметр не требуется, если указано имя облака или присутствуют переменные окружения OpenStack OS_*.
auth_type строка	Имя плагина авторизации для использования. Если облако использует что-то кроме парольной аутентификации, имя плагина должно быть указано здесь, а содержимое параметра auth должно быть соответствующим образом обновлено.
ca_cert псевдонимы: cacert строка	Путь к пакету сертификатов CA, который можно использовать для проверки запросов SSL API.
client_cert псевдонимы: cert строка	Путь к клиенту сертификату для использования в ходе SSL-транзакции.
client_key псевдонимы: key строка	Путь к ключу клиента для использования в ходе SSL-транзакции.
cloud любой	Наименованное облако или конфигурация облака для работы. Если cloud является строкой, она ссылается на конфигурацию облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не требуется, если указан auth или присутствуют переменные окружения OpenStack OS_. Если cloud* является словарем, он содержит полную конфигурацию облака, как в разделе clouds.yaml.
enabled булево	Включен ли сервис. Варианты: `false` `true` ← (по умолчанию)
endpoint_interface строка / обязательно	Интерфейс сервиса. Варианты: `"admin"` `"public"` `"internal"`
interface псевдонимы: endpoint_type строка	Тип URL конечной точки для извлечения из каталога сервисов. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
region строка	Идентификатор региона, к которому принадлежит сервис. Обратите внимание, что region используется для аутентификации.
region_name строка	Название региона.
sdk_log_level строка	Уровень ведения журнала OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path строка	Путь к файлу журнала OpenStackSDK. Если пусто, журнал не записывается
service строка / обязательно	Название или идентификатор сервиса.
state строка	Должен ли ресурс быть `present` или `absent`. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout целое число	Сколько времени Ansible должен ждать запрашиваемого ресурса. По умолчанию: `180`
url строка / обязательно	URL сервиса.
validate_certs псевдонимы: verify булево	Необходимо ли проверять запросы 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 service for glance
  openstack.cloud.endpoint:
     cloud: mycloud
     service: glance
     endpoint_interface: public
     url: http://controller:9292
     region: RegionOne
     state: present

- name: Delete a service for nova
  openstack.cloud.endpoint:
     cloud: mycloud
     service: nova
     endpoint_interface: public
     region: RegionOne
     state: absent

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

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

Ключ	Описание
endpoint словарь	Словарь, описывающий конечную точку. Возвращается: При успехе, когда state равен `present`
id строка	Идентификатор конечной точки. Возвращается: успех Пример: `"3292f020780b4d5baf27ff7e1d224c44"`
interface строка	Интерфейс конечной точки. Возвращается: успех Пример: `"public"`
is_enabled boolean	Статус службы. Возвращается: успех Пример: `true`
links строка	Ссылки для конечной точки Возвращается: успех Пример: `"http://controller/identity/v3/endpoints/123"`
name строка	Имя конечной точки Возвращается: успех Пример: `"cinder"`
region_id строка	Идентификатор региона. Возвращается: успех Пример: `"RegionOne"`
service_id строка	Идентификатор службы. Возвращается: успех Пример: `"b91f1318f735494a825a55388ee118f3"`
url строка	URL службы. Возвращается: успех Пример: `"http://controller:9292"`

Авторы

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