openstack.cloud.catalog_service модуль — Управление услугами OpenStack
Примечание
Этот модуль входит в состав коллекции openstack.cloud (версия 2.2.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.
Чтобы использовать его в книге задач, укажите: openstack.cloud.catalog_service.
Описание
- Создание, обновление или удаление службы OpenStack.
Требования
Ниже перечислены требования, которые должны быть выполнены на узле, на котором выполняется этот модуль.
- 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 конечной точки для извлечения из каталога сервисов. Варианты:
|
is_enabled псевдонимы: enabled логический тип | Включён ли данный сервис или нет. Варианты:
|
name строка / обязательный параметр | Имя сервиса. |
region_name строка | Имя региона. |
sdk_log_level строка | Уровень логирования OpenStackSDK Варианты:
|
sdk_log_path строка | Путь к файлу журнала OpenStackSDK. Если пусто, журнал не будет записан. |
state строка | Необходимо ли Варианты:
|
timeout целое число | Сколько времени Ansible должен ждать запрашиваемого ресурса. По умолчанию: |
type псевдонимы: service_type строка / обязательный параметр | Тип сервиса. |
validate_certs псевдонимы: verify логический тип | Должны ли проверяться запросы API SSL. До Ansible 2.3 это по умолчанию было Варианты:
|
wait boolean | Должен ли Ansible ждать завершения запрошенного ресурса. Варианты:
|
Примечания
Примечание
- Можно использовать стандартные переменные окружения 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.catalog_service:
cloud: mycloud
state: present
name: glance
type: image
description: OpenStack Image Service
- name: Delete a service
openstack.cloud.catalog_service:
cloud: mycloud
state: absent
name: glance
type: image
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
service словарь | Словарь, описывающий службу. Возвращаемое значение: При успехе, когда state равен ‘present’ |
|
description строка |
Описание службы. Возвращаемое значение: успех Пример: |
|
id строка |
Идентификатор службы. Возвращаемое значение: успех Пример: |
|
is_enabled булево |
Статус службы. Возвращаемое значение: успех Пример: |
|
links строка |
Ссылка на службу Возвращаемое значение: успех Пример: |
|
name строка |
Название службы. Возвращаемое значение: успех Пример: |
|
type строка |
Тип службы. Возвращаемое значение: успех Пример: |
Ссылки на сборку
© 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/catalog_service_module.html