Модуль openstack.cloud.catalog_service_info – Получение информации о сервисах из OpenStack
Примечание
Этот модуль является частью коллекции openstack.cloud (версия 2.2.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install openstack.cloud. Вам потребуются дополнительные требования для использования этого модуля, см. Требования для получения подробной информации.
Для использования в playbook укажите: openstack.cloud.catalog_service_info.
Краткое описание
- Получение информации о сервисах из OpenStack.
Требования
Ниже указаны требования, необходимые на хосте, который выполняет этот модуль.
- python >= 3.6
- openstacksdk >= 1.0.0
Параметры
Параметр | Комментарии |
|---|---|
api_timeout integer | Как долго socket layer должен ожидать перед тайм-аутом для вызовов API. Если это опущено, ничего не будет передано в библиотеку запросов. |
auth dictionary | Словарь, содержащий информацию об аутентификации, необходимую стратегии подключаемого модуля аутентификации облака. Для плагина password по умолчанию это будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен будет содержать все параметры, которые требуются этому плагину аутентификации. Этот параметр не требуется, если указано имя облака или присутствуют переменные окружения OpenStack OS_* . |
auth_type string | Имя подключаемого модуля аутентификации для использования. Если облако использует что-то другое, кроме парольной аутентификации, имя плагина должно быть указано здесь, а содержимое параметра auth должно быть обновлено соответствующим образом. |
ca_cert aliases: cacert string | Путь к пакету сертификатов CA, который может использоваться в качестве части проверки запросов SSL API. |
client_cert aliases: cert string | Путь к клиентскому сертификату, который будет использоваться как часть транзакции SSL. |
client_key aliases: key string | Путь к клиентскому ключу, который будет использоваться как часть транзакции SSL. |
cloud any | Именованная конфигурация облака или конфигурация облака для работы. Если cloud — это строка, она ссылается на именованную конфигурацию облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не требуется, если указан auth или если присутствуют переменные окружения OpenStack OS_*. Если cloud — это словарь, он содержит полную конфигурацию облака, как это было бы в разделе clouds.yaml. |
interface aliases: endpoint_type string | Тип URL-адреса конечной точки для получения из каталога сервисов. Варианты:
|
name string | Имя или ID сервиса. |
region_name string | Имя региона. |
sdk_log_level string | Уровень логирования OpenStackSDK Варианты:
|
sdk_log_path string | Путь к файлу журнала OpenStackSDK. Если пусто, журнал не записывается. |
timeout integer | Как долго ansible должен ждать запрашиваемый ресурс. По умолчанию: |
validate_certs aliases: verify boolean | Следует ли проверять запросы SSL API. До Ansible 2.3 это значение по умолчанию было Варианты:
|
wait boolean | Должен ли ansible ждать, пока запрашиваемый ресурс не будет завершен. Варианты:
|
Примечания
Примечание
- Вместо указания явных значений могут использоваться стандартные переменные среды OpenStack, такие как
OS_USERNAME. - Информация для аутентификации управляется openstacksdk, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, а затем, наконец, из явных параметров в play. Более подробная информация может быть найдена по адресу https://docs.openstack.org/openstacksdk/
Примеры
- name: Fetch all services
openstack.cloud.catalog_service_info:
cloud: devstack
- name: Fetch a single service
openstack.cloud.catalog_service_info:
cloud: devstack
name: heat
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
services list / elements=dictionary | Список словарей сервисов. Возвращается: всегда |
|
description string |
Описание сервиса. Возвращается: успех Пример: |
|
id string |
ID сервиса. Возвращается: успех Пример: |
|
is_enabled boolean |
Статус сервиса. Возвращается: успех Пример: |
|
links string |
Ссылка на сервис Возвращается: успех Пример: |
|
name string |
Имя сервиса. Возвращается: успех Пример: |
|
type string |
Тип сервиса. Возвращается: успех Пример: |
Ссылки на коллекцию
© 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_info_module.html