cs_project - Управляет проектами в облаках на базе Apache CloudStack.
Новая версия 2.0.
- Обзор
- Требования (для хоста, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Обзор
- Создание, обновление, приостановка, активация и удаление проектов.
Требования (для хоста, на котором выполняется модуль)
- python >= 2.6
- cs >= 0.6.10
Параметры
| параметр | обязательно | по умолчанию | выбор | примечания |
|---|---|---|---|---|
| account | нет | Аккаунт, к которому относится проект. | ||
| api_http_method | нет | get |
| Используемый HTTP-метод. |
| api_key | нет | API-ключ CloudStack API. | ||
| api_region | нет | cloudstack | Имя раздела ini в файле cloustack.ini. | |
| api_secret | нет | Секретный ключ CloudStack API. | ||
| api_timeout | нет | 10 | Таймаут HTTP. | |
| api_url | нет | URL CloudStack API, например, https://cloud.example.com/client/api. | ||
| display_text | нет | Текст для отображения проекта. Если не указано, будет использовано значение name, которое будет отображаться как display_text. | ||
| domain | нет | Домен, к которому относится проект. | ||
| name | да | Имя проекта. | ||
| poll_async | нет | True | Ожидать завершения асинхронных заданий. | |
| state | нет | present |
| Состояние проекта. |
| tags (добавлено в 2.2)
| нет | Список тегов. Теги представляют собой список словарей, имеющих ключи key и value.Если вы хотите удалить все теги, установите пустой список, например, tags: []. |
Примеры
# Create a project
- local_action:
module: cs_project
name: web
tags:
- { key: admin, value: john }
- { key: foo, value: bar }
# Rename a project
- local_action:
module: cs_project
name: web
display_text: my web project
# Suspend an existing project
- local_action:
module: cs_project
name: web
state: suspended
# Activate an existing project
- local_action:
module: cs_project
name: web
state: active
# Remove a project
- local_action:
module: cs_project
name: web
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для данного модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| account | Аккаунт, к которому относится проект. | успех | строка | примерный аккаунт |
| display_text | Текст для отображения проекта. | успех | строка | веб-проект |
| domain | Домен, к которому относится проект. | успех | строка | примерный домен |
| id | UUID проекта. | успех | строка | 04589590-ac63-4ffc-93f5-b698b8ac38b6 |
| name | Имя проекта. | успех | строка | веб-проект |
| state | Состояние проекта. | успех | строка | Активный |
| tags | Список тегов ресурсов, связанных с проектом. | успех | словарь | [ { "key": "foo", "value": "bar" } ] |
Примечания
Примечание
- Ansible использует метод конфигурации библиотеки
cs, если учетные данные не указаны в аргументахapi_url,api_key,api_secret. Конфигурация считывается из нескольких мест в следующем порядке: -CLOUDSTACK_ENDPOINT,CLOUDSTACK_KEY,CLOUDSTACK_SECRETиCLOUDSTACK_METHOD.CLOUDSTACK_TIMEOUTпеременные окружения. -CLOUDSTACK_CONFIGпеременная окружения, указывающая на файл.ini, - Файлcloudstack.iniв текущей рабочей директории. - Файл.cloudstack.iniв домашней директории пользователя. Допускается указание нескольких учетных данных и конечных точек с использованием разделов ini в файлеcloudstack.ini. Используйте аргументapi_regionдля выбора имени раздела, по умолчанию используетсяcloudstack. Более подробную информацию см. на https://github.com/exoscale/cs. - Подробное руководство по модулям cloudstack можно найти по адресу http://docs.ansible.com/ansible/guide_cloudstack.html
- Этот модуль поддерживает режим проверки.
Статус
Этот модуль помечен как stableinterface, что означает, что разработчики этого модуля гарантируют, что не будут вноситься несовместимые с предыдущими версиями изменения интерфейса.
Для помощи в разработке модулей, если вас это заинтересует, ознакомьтесь со статьями Информация о сообществе и участие в разработке, Тестирование 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/cs_project_module.html