ngine_io.cloudstack.cs_region – Управляет регионами в облаках на основе Apache CloudStack.
Примечание
Этот плагин входит в коллекцию ngine_io.cloudstack (версия 1.1.0).
Для его установки используйте: ansible-galaxy collection install ngine_io.cloudstack.
Для использования в playbook, укажите: ngine_io.cloudstack.cs_region.
Новое в версии 0.1.0: модуля ngine_io.cloudstack
Обзор
- Добавление, обновление и удаление регионов.
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- cs >= 0.9.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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, см. также заметки. | |
| api_verify_ssl_cert строка | Файл сертификата CA. Если не задано, рассматривается переменная окружения CLOUDSTACK_VERIFY. В качестве последнего варианта используется значение из файла конфигурации ini, см. также заметки. Значение по умолчанию null если не указано. | |
| endpoint строка | URL точки входа региона. Требуется, если state=present
| |
| id целое число / обязательно | ID региона. Должно быть числом (int). | |
| name строка | Имя региона. Требуется, если 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.
- Этот модуль поддерживает режим проверки.
Примеры
- name: create a region
ngine_io.cloudstack.cs_region:
id: 2
name: geneva
endpoint: https://cloud.gva.example.com
- name: remove a region with ID 2
ngine_io.cloudstack.cs_region:
id: 2
state: absent
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| endpoint строка | success | Точка входа региона. Пример: http://cloud.example.com |
| gslb_service_enabled булево | success | Включен ли сервис GSLB или нет. Пример: True |
| id целое число | success | ID региона. Пример: 1 |
| name строка | success | Имя региона. Пример: local |
| portable_ip_service_enabled булево | success | Включен ли сервис portable 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.10/collections/ngine_io/cloudstack/cs_region_module.html