os_project_facts – Получение фактов о проектах OpenStack
Новое в версии 2.1.
Обзор
- Получение фактов о проектах OpenStack
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- openstacksdk
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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 - | Имя или ID домена, содержащего проект, если облако поддерживает домены. | |
| filters - | Словарь метаданных для дальнейшего фильтрации. Элементы этого словаря могут быть дополнительными словарями. | |
| interface - добавлен в 2.3 |
| Тип URL конечной точки для получения из каталога служб. Псевдонимы: endpoint_type |
| key - | Путь к клиентскому ключу для использования в рамках SSL-транзакции. | |
| name - / обязательно | Имя или ID проекта | |
| region_name - | Имя региона. | |
| timeout - | По умолчанию: 180 | Сколько времени Ansible должно ждать запрашиваемый ресурс. |
| verify boolean |
| Требовать или нет проверку запросов API SSL. До версии 2.3 по умолчанию было True. Псевдонимы: validate_certs |
| wait boolean |
| Должен ли 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 о проектах | |
| description строка | успех | Описание проекта | |
| domain_id boolean | успех | ID домена, содержащего проект (только облака keystone v3) | |
| enabled boolean | успех | Флаг, указывающий, активен ли проект | |
| id строка | успех | Уникальный UUID. | |
| name строка | успех | Имя проекта. | |
Статус
- Интерфейс этого модуля не гарантирует обратной совместимости. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.7/modules/os_project_facts_module.html
