os_project - Управление проектами OpenStack
Новое в версии 2.0.
- Обзор
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Обзор
- Управление проектами OpenStack. Проекты могут быть созданы, обновлены или удалены с помощью этого модуля. Проект будет обновлен, если значение параметра name совпадает с существующим проектом, а параметр state задан. Значение параметра name нельзя обновить без удаления и повторного создания проекта.
Требования (к хосту, на котором выполняется модуль)
- 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 | Путь к пакету сертификатов CA, который может использоваться для проверки запросов SSL API. |
|
| cert |
нет | None | Путь к клиенту сертификат для использования в рамках SSL транзакции. |
|
| cloud |
нет | Используемое облако. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан параметр auth или присутствуют переменные окружения OpenStack OS_*. |
||
| description |
нет | None | Описание проекта |
|
| domain_id |
нет | None | Идентификатор домена для создания проекта, если облако поддерживает домены. Параметр domain_id требует shade >= 1.8.0
псевдонимы: domain |
|
| enabled |
нет | True | Включён ли проект |
|
| endpoint_type |
нет | public |
|
Тип URL конечной точки для извлечения из каталога служб. |
| key |
нет | None | Путь к ключу клиента для использования в рамках SSL транзакции. |
|
| name |
да | Имя проекта |
||
| region_name |
нет | Имя региона. |
||
| state |
нет | present |
|
Должен ли ресурс быть присутствующим или отсутствующим. |
| timeout |
нет | 180 | Сколько времени Ansible должен ждать запрошенного ресурса. |
|
| validate_certs |
нет | Необходимо ли проверять запросы SSL API. До версии 2.3 по умолчанию было True.
псевдонимы: verify |
||
| wait |
нет | yes |
|
Должен ли Ansible ждать, пока запрошенный ресурс не будет завершен. |
Примеры
# Create a project
- os_project:
cloud: mycloud
state: present
name: demoproject
description: demodescription
domain_id: demoid
enabled: True
# Delete a project
- os_project:
cloud: mycloud
state: absent
name: demoproject
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для этого модуля:
| имя | описание | возвращается | тип | пример | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| project | Словарь, описывающий проект. |
При успехе, когда I(state) равен 'present' | сложный | ||||||||||||||||||||||||||
| содержит: |
|
||||||||||||||||||||||||||||
Примечания
Примечание
- Стандартные переменные окружения OpenStack, такие как
OS_USERNAME, могут быть использованы вместо явного указания значений. - Информация об авторизации управляется os-client-config, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения, и, наконец, явными параметрами в play. Более подробную информацию можно найти по адресу 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_module.html
