cs_project - Управляет проектами на облачных платформах Apache CloudStack.
Новое в версии 2.0.
Описание
- Создание, обновление, приостановка, активация и удаление проектов.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- cs >= 0.6.10
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| account | По умолчанию: None |
Аккаунт, к которому относится проект. |
| api_http_method |
|
Метод HTTP, используемый для запроса к API-точке.
Если не указано, используется значение переменной среды CLOUDSTACK_METHOD.
В качестве последнего варианта, значение берется из файла конфигурации ini, см. примечания.
Значение по умолчанию — get, если не указано. |
| api_key | Ключ API CloudStack API. Если не указан, используется значение переменной среды CLOUDSTACK_KEY. В качестве последнего варианта, значение берется из файла конфигурации ini, см. примечания. |
|
| api_region | По умолчанию: cloudstack |
Имя раздела ini в файле cloustack.ini. Если не указано, используется значение переменной среды CLOUDSTACK_REGION. |
| api_secret | Секретный ключ CloudStack API. Если не указан, используется значение переменной среды CLOUDSTACK_SECRET. В качестве последнего варианта, значение берется из файла конфигурации ini, см. примечания. |
|
| api_timeout | Таймаут HTTP в секундах. Если не указано, используется значение переменной среды CLOUDSTACK_TIMEOUT. В качестве последнего варианта, значение берется из файла конфигурации ini, см. примечания. Значение по умолчанию — 10 секунд, если не указано. |
|
| api_url | URL CloudStack API, например, https://cloud.example.com/client/api. Если не указан, используется значение переменной среды CLOUDSTACK_ENDPOINT. В качестве последнего варианта, значение берется из файла конфигурации ini, см. примечания. |
|
| display_text | По умолчанию: None |
Текст для отображения проекта. Если не указан, будет использоваться name как display_text. |
| domain | По умолчанию: None |
Домен, к которому относится проект. |
| name обязательно |
Имя проекта. | |
| poll_async | По умолчанию: yes |
Ожидать завершения асинхронных задач. |
| state |
|
Состояние проекта. |
| tags (добавлено в 2.2) |
По умолчанию: None |
Список тегов. Теги — список словарей с ключами key и value. Если нужно удалить все теги, установите пустой список, например, tags: [] |
Примечания
Примечание
- 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 можно найти в Руководстве по облаку CloudStack.
- Этот модуль поддерживает режим проверки.
Примеры
# 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 строка |
success | Аккаунт, к которому относится проект. Пример: example account |
| display_text строка |
success | Текст для отображения проекта. Пример: web project |
| domain строка |
success | Домен, к которому относится проект. Пример: example domain |
| id строка |
success | UUID проекта. Пример: 04589590-ac63-4ffc-93f5-b698b8ac38b6 |
| name строка |
success | Имя проекта. Пример: web project |
| state строка |
success | Состояние проекта. Пример: Active |
| tags словарь |
success | Список тегов ресурсов, связанных с проектом. Пример: [ { "key": "foo", "value": "bar" } ] |
Статус
Этот модуль помечен как stableinterface, что означает, что авторы этого модуля гарантируют отсутствие несовместимых с предыдущими версиями изменений интерфейса.
Автор
- René Moser (@resmo)
Подсказка
Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать его, чтобы улучшить его.
© 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/cs_project_module.html