os_project_facts - Получение фактов о проектах OpenStack
Новая в версии 2.1.
Обзор
- Получение фактов о одном или нескольких проектах OpenStack
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- python >= 2.7
- shade
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout | Сколько времени должно ожидать сокетное соединение перед истечением времени ожидания для вызовов API. Если этот параметр опущен, ничего не будет передано библиотеке requests. | |
| auth | Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для плагина по умолчанию password, он будет содержать auth_url, username, password, project_name и любую информацию о доменах, если облако их поддерживает. Для других плагинов этот параметр должен содержать необходимые параметры плагина авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. | |
| auth_type | Имя плагина авторизации для использования. Если облако использует что-то кроме аутентификации по паролю, здесь должно быть указано имя плагина, и содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone | Игнорируется. Присутствует для обратной совместимости | |
| cacert | Путь к пакету сертификатов CA, который может использоваться для проверки запросов API SSL. | |
| cert | Путь к клиентскому сертификату для использования в рамках транзакции SSL. | |
| cloud | Именованное облако или конфигурация облака для работы. Если cloud является строкой, она ссылается на именованную конфигурацию облака, определенную в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если задан auth или присутствуют переменные окружения OpenStack OS_*. Если cloud является словарем, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| domain | По умолчанию: None | Имя или ID домена, содержащего проект, если облако поддерживает домены |
| filters | По умолчанию: None | Словарь метаданных для дальнейшего фильтрации. Элементы этого словаря могут быть дополнительными словарями. |
| interface (добавлено в 2.3) |
| Тип URL конечной точки для получения из каталога служб. псевдонимы: endpoint_type |
| key | Путь к клиентскому ключу для использования в рамках транзакции SSL. | |
| name обязательно | Имя или ID проекта | |
| region_name | Имя региона. | |
| timeout | По умолчанию: 180 | Сколько времени Ansible должно ждать запрашиваемого ресурса. |
| verify |
| Нужно ли проверять запросы API SSL. До версии 2.3 по умолчанию было True. псевдонимы: validate_certs |
| wait |
| Должен ли Ansible ждать, пока запрашиваемый ресурс не будет завершён. |
Примечания
Примечание
- Можно использовать стандартные переменные окружения 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
Примеры
# 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 сложный | всегда, но может быть null | Содержит все данные OpenStack о проектах | |
| id строка | успех | Уникальный UUID. | |
| enabled логическое значение | успех | Флаг, указывающий, включен ли проект | |
| domain_id логическое значение | успех | ID домена, содержащего проект (только облака keystone v3) | |
| name строка | успех | Наименование проекта. | |
| description строка | успех | Описание проекта | |
Статус
Этот модуль помечен как предварительный просмотр, что означает, что он не гарантирует обратную совместимость.
Автор
- Ricardo Carrillo Cruz (@rcarrillocruz)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/os_project_facts_module.html
