cs_region – Управляет регионами на облачных платформах на базе Apache CloudStack.

Новая версия с 2.3.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Обзор

Добавление, обновление и удаление регионов.

Требования

Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.

python >= 2.6
cs >= 0.6.10

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_http_method -	Варианты: get post	Метод 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 -		URL точки входа региона. Требуется, если `state=present`.
id - / обязательно		ID региона. Должно быть числом (int).
name -		Имя региона. Требуется, если `state=present`.
state -	Варианты: present ← absent	Состояние региона.

Примечания

Примечание

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 целое число	успех	ID региона. Пример: 1
name строка	успех	Имя региона. Пример: local
portable_ip_service_enabled логическое значение	успех	Включена ли служба portable IP или нет. Пример: True

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

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_region_module.html