os_project_facts - Получение фактов о проектах OpenStack
Новое в версии 2.1.
- Описание
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Описание
- Получение фактов о проектах OpenStack
Требования (к хосту, на котором выполняется модуль)
- python >= 2.6
- python >= 2.7
- shade
Параметры
| Параметр | Обязательно | По умолчанию | Варианты | Комментарии |
|---|---|---|---|---|
| api_timeout | нет | None | Сколько времени должно ждать сокетное подключение, прежде чем произойдёт таймаут вызова API. Если этот параметр опущен, ничего не передаётся в библиотеку requests. | |
| auth | нет | Словарь, содержащий информацию об авторизации, необходимую стратегии подключа к облаку. Для стандартного плагина password, он будет содержать auth_url, username, password, project_name и любую информацию о доменах, если облако их поддерживает. Для других плагинов, этот параметр должен содержать параметры, требуемые этим плагином. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. | ||
| auth_type | нет | password | Имя плагина аутентификации. Если облако использует аутентификацию отличную от парольной, здесь нужно указать имя плагина и соответствующим образом обновить содержимое параметра auth. | |
| availability_zone | нет | Игнорируется. Присутствует для обратной совместимости | ||
| cacert | нет | None | Путь к файлу с корневыми сертификатами, который может быть использован для проверки SSL запросов к API. | |
| cert | нет | None | Путь к клиенту сертификату, который необходимо использовать в ходе SSL транзакции. | |
| cloud | нет | Имя облака, с которым нужно взаимодействовать. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен параметр auth или присутствуют переменные окружения OpenStack OS_*. | ||
| domain | нет | None | Имя или идентификатор домена, содержащего проект, если облако поддерживает домены | |
| endpoint_type | нет | public |
| Тип URL конечной точки, который нужно получить из каталога сервисов. |
| filters | нет | None | Словарь метаданных, используемых для дополнительного фильтрации. Элементы этого словаря могут быть дополнительными словарями. | |
| key | нет | None | Путь к клиентскому ключу, который необходимо использовать в ходе SSL транзакции. | |
| name | да | Имя или идентификатор проекта | ||
| region_name | нет | Имя региона. | ||
| timeout | нет | 180 | Сколько времени Ansible должно ждать запрашиваемого ресурса. | |
| validate_certs | нет | Необходимо ли проверять SSL запросы к API. До версии 2.3, по умолчанию было True. алиасы: verify | ||
| wait | нет | yes |
| Должен ли Ansible ждать завершения запрошенного ресурса. |
Примеры
# Gather facts about previously created projects
- os_project_facts:
cloud: awesomecloud
- debug:
var: openstack_projects
# Gather facts about a previously created project by name
- os_project_facts:
cloud: awesomecloud
name: demoproject
- debug:
var: openstack_projects
# Gather facts about a previously created project in a specific domain
- os_project_facts:
cloud: awesomecloud
name: demoproject
domain: admindomain
- debug:
var: openstack_projects
# Gather facts about a previously created project in a specific domain with filter
- os_project_facts:
cloud: awesomecloud
name: demoproject
domain: admindomain
filters:
enabled: False
- debug:
var: openstack_projects
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для данного модуля:
| Имя | Описание | Возвращается | Тип | Пример | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| openstack_projects | Содержит все факты OpenStack о проектах | всегда, но может быть null | сложный | |||||||||||||||||||||||||||||||
| содержит: |
| |||||||||||||||||||||||||||||||||
Примечания
Примечание
- Стандартные переменные окружения OpenStack, такие как
OS_USERNAMEмогут быть использованы вместо явного указания значений. - Информация об авторизации управляется os-client-config, что означает, что значения могут быть взяты из файла yaml конфигурации в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения, и, наконец, из явных параметров в задачах. Более подробную информацию можно найти на http://docs.openstack.org/developer/os-client-config
Статус
Этот модуль помечен как бета, что означает, что интерфейс не гарантирует обратную совместимость.
Для получения помощи в разработке модулей, если вы заинтересованы, пожалуйста, ознакомьтесь с Информацией о сообществе и участии, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/os_project_facts_module.html
