cs_region – Управляет регионами на облаках на основе Apache CloudStack

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

Краткое описание

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

Требования

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

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 строка		Секретный ключ 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.
Этот модуль поддерживает режим проверки.

Примеры

- name: create a region
  cs_region:
    id: 2
    name: geneva
    endpoint: https://cloud.gva.example.com
  delegate_to: localhost

- name: remove a region with ID 2
  cs_region:
    id: 2
    state: absent
  delegate_to: localhost

Возвращаемые значения

Общие возвращаемые значения описаны в этом разделе, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
endpoint строка	успех	Точка входа региона. Пример: http://cloud.example.com
gslb_service_enabled логическое значение	успех	Включен ли сервис GSLB или нет. Пример: True
id целое число	успех	ID региона. Пример: 1
name строка	успех	Название региона. Пример: local
portable_ip_service_enabled логическое значение	успех	Включен ли сервис переноса 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.9/modules/cs_region_module.html