cs_project – Управляет проектами в облаках на базе Apache CloudStack.
Новое в версии 2.0.
Описание
- Создание, обновление, приостановка, активация и удаление проектов.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- cs >= 0.6.10
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| account - | Учетная запись, к которой относится проект. | |
| 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 - | Секретный ключ API 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 - | Текст для отображения проекта. Если не указано, используется name, как display_text. | |
| domain - | Домен, к которому относится проект. | |
| name - / обязательно | Имя проекта. | |
| poll_async boolean |
| Ожидать завершения асинхронных задач. |
| state - |
| Состояние проекта. |
| tags - добавлен в 2.2 | Список тегов. Теги — список словарей, содержащих ключи key и value. Если нужно удалить все теги, установите пустой список, например, tags: []. |
Примечания
Примечание
- Если учетные данные не предоставлены в аргументах
api_url,api_key,api_secret, Ansible использует метод конфигурации библиотекиcs. Конфигурация считывается из нескольких мест в указанном порядке: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 строка | успех | Учетная запись, к которой относится проект. Пример: example account |
| display_text строка | успех | Текст для отображения проекта. Пример: web project |
| domain строка | успех | Домен, к которому относится проект. Пример: example domain |
| id строка | успех | UUID проекта. Пример: 04589590-ac63-4ffc-93f5-b698b8ac38b6 |
| name строка | успех | Имя проекта. Пример: web project |
| state строка | успех | Состояние проекта. Пример: Активный |
| tags словарь | успех | Список тегов ресурсов, связанных с проектом. Пример: [ { "key": "foo", "value": "bar" } ] |
Статус
- Гарантируется отсутствие обратной несовместимости в будущем. [stableinterface]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.7/modules/cs_project_module.html