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		Секретный ключ для 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. Дополнительную информацию см. в Поддержка и техническое обслуживание модулей.

Список других модулей, поддерживаемых сообществом 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.6/modules/cs_region_module.html