cs_region — Управление регионами на облачных платформах Apache CloudStack.
Новое в версии 2.3.
Обзор
- Добавление, обновление и удаление регионов.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- cs >= 0.6.10
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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, см. также примечания. | |
| endpoint | Значение по умолчанию: None | URL точки входа региона. Требуется, если state=present |
| id обязательно | Идентификатор региона. Должно быть числом (int). | |
| name | Значение по умолчанию: None | Имя региона. Требуется, если state=present |
| state |
| Состояние региона. |
Примечания
Примечание
- 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 region
- local_action:
module: cs_region
id: 2
name: geneva
endpoint: https://cloud.gva.example.com
# remove a region with ID 2
- local_action:
module: cs_region
id: 2
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны в документации. Ниже приведены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| endpoint строка | успех | Точка входа региона. Пример: http://cloud.example.com |
| gslb_service_enabled логическое значение | успех | Включена ли служба GSLB или нет. Пример: True |
| id целое число | успех | Идентификатор региона. Пример: 1 |
| name строка | успех | Имя региона. Пример: local |
| portable_ip_service_enabled логическое значение | успех | Включена ли служба переноса IP-адресов или нет. Пример: True |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантированно будет совместим со старыми версиями.
Автор
- 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_region_module.html