Модуль openstack.cloud.endpoint – управление конечными точками службы идентификации OpenStack

Примечание

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

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

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

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

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

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

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

Требования

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

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	Путь к пакету сертификатов центра сертификации (CA), который можно использовать для проверки запросов API SSL.
client_cert псевдонимы: cert string	Путь к сертификату клиента, используемому при SSL-соединении.
client_key псевдонимы: key string	Путь к ключу клиента, используемому при SSL-соединении.
cloud any	Именованное облако или конфигурация облака, с которыми выполняются операции. Если cloud — строка, она указывает на именованную конфигурацию облака, определённую в файле clouds.yaml OpenStack. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не требуется, если задан auth или присутствуют переменные окружения OpenStack OS_. Если cloud* — словарь, он содержит полную конфигурацию облака, аналогичную конфигурации в разделе файла clouds.yaml.
enabled boolean	Включена ли служба. Варианты: `false` `true` ← (по умолчанию)
endpoint_interface string / обязательный	Интерфейс службы. Варианты: `"admin"` `"public"` `"internal"`
interface псевдонимы: endpoint_type string	Тип URL конечной точки, получаемый из каталога служб. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
region string	Идентификатор региона, к которому относится служба. Обратите внимание, что параметр region используется для аутентификации.
region_name string	Название региона.
sdk_log_level string	Уровень ведения журнала OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path string	Путь к файлу журнала OpenStackSDK. Если значение не задано, журнал не записывается.
service string / обязательный	Название или идентификатор службы.
state string	Следует ли создать ресурс (`present`) или удалить его (`absent`). Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout integer	Время ожидания Ansible запрошенного ресурса. По умолчанию: `180`
url string / обязательный	URL службы.
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 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 dictionary	Словарь с описанием конечной точки. Возвращается: При успешном выполнении, если state равен `present`
id string	Идентификатор конечной точки. Возвращается: при успешном выполнении Пример: `"3292f020780b4d5baf27ff7e1d224c44"`
interface string	Интерфейс конечной точки. Возвращается: при успешном выполнении Пример: `"public"`
is_enabled boolean	Статус службы. Возвращается: при успешном выполнении Пример: `true`
links string	Ссылки на конечную точку Возвращается: при успешном выполнении Пример: `"http://controller/identity/v3/endpoints/123"`
name string	Название конечной точки Возвращается: при успешном выполнении Пример: `"cinder"`
region_id string	Идентификатор региона. Возвращается: при успешном выполнении Пример: `"RegionOne"`
service_id string	Идентификатор службы. Возвращается: при успешном выполнении Пример: `"b91f1318f735494a825a55388ee118f3"`
url string	URL службы. Возвращается: при успешном выполнении Пример: `"http://controller:9292"`

Авторы

Специальная группа Ansible OpenStack

Ссылки на коллекцию

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