Модуль openstack.cloud.catalog_service_info — получение информации о сервисах из OpenStack
Примечание
Этот модуль входит в коллекцию openstack.cloud (версия 2.5.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: openstack.cloud.catalog_service_info.
Краткое описание
- Получение информации о сервисах из OpenStack.
Требования
На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.
- python >= 3.6
- openstacksdk >= 1.0.0
Параметры
Параметр | Описание |
|---|---|
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 строка | Путь к набору сертификатов центра сертификации, который можно использовать для проверки запросов API SSL. |
client_cert псевдонимы: cert строка | Путь к клиентскому сертификату, используемому при SSL-соединении. |
client_key псевдонимы: key строка | Путь к клиентскому ключу, используемому при SSL-соединении. |
cloud любой тип | Именованное облако или конфигурация облака, с которой нужно работать. Если cloud — строка, она указывает на именованную конфигурацию облака, заданную в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не требуется, если задан auth или установлены переменные окружения OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, аналогичную разделу в clouds.yaml. |
interface псевдонимы: endpoint_type строка | Тип URL конечной точки, получаемой из каталога сервисов. Варианты:
|
name строка | Имя или идентификатор сервиса. |
region_name строка | Имя региона. |
sdk_log_level строка | Уровень журналирования OpenStackSDK Варианты:
|
sdk_log_path строка | Путь к файлу журнала OpenStackSDK. Если значение пустое, журнал не записывается. |
timeout целое число | Как долго Ansible должен ожидать запрошенный ресурс. По умолчанию: |
validate_certs псевдонимы: verify логическое значение | Нужно ли проверять запросы API SSL. До Ansible 2.3 значение по умолчанию было Варианты:
|
wait логическое значение | Должен ли Ansible ожидать завершения операции с запрошенным ресурсом. Варианты:
|
Примечания
Примечание
- Вместо явного указания значений можно использовать стандартные переменные окружения OpenStack, например
OS_USERNAME. - Обработка данных аутентификации выполняется openstacksdk: значения могут поступать из файла конфигурации YAML /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения и, наконец, из явно заданных параметров плейбука. Дополнительные сведения приведены на странице 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 список / элементы=словарь | Список словарей с сервисами. Возвращается: всегда |
|
description строка |
Описание сервиса. Возвращается: при успешном выполнении Пример: |
|
id строка |
Идентификатор сервиса. Возвращается: при успешном выполнении Пример: |
|
is_enabled логическое значение |
Состояние сервиса. Возвращается: при успешном выполнении Пример: |
|
links строка |
Ссылка на сервис Возвращается: при успешном выполнении Пример: |
|
name строка |
Имя сервиса. Возвращается: при успешном выполнении Пример: |
|
type строка |
Тип сервиса. Возвращается: при успешном выполнении Пример: |
Ссылки на коллекцию
© 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/catalog_service_info_module.html