Spec-Zone.ru › Ansible 2.4

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

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

  • Краткое описание
  • Требования (на хосте, на котором выполняется модуль)
  • Параметры
  • Примеры
  • Возвращаемые значения
  • Примечания
    • Статус

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

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

Требования (на хосте, на котором выполняется модуль)

  • python >= 2.6
  • cs >= 0.6.10

Параметры

параметр обязательно значение по умолчанию выбор комментарии
api_http_method
нет get
  • get
  • post
Используемый HTTP-метод.
api_key
нет
Ключ API CloudStack API.
api_region
нет cloudstack
Имя раздела ini в файле cloustack.ini.
api_secret
нет
Секретный ключ CloudStack API.
api_timeout
нет 10
Таймаут HTTP.
api_url
нет
URL CloudStack API, например https://cloud.example.com/client/api.
endpoint
нет
URL конечной точки региона.
Требуется, если state=present
id
да
ID региона.
Должен быть числом (int).
name
нет
Имя региона.
Требуется, если state=present
state
нет present
  • present
  • absent
Состояние региона.

Примеры

# 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
Включена или нет услуга портативного IP-адреса.
успех логическое True

Примечания

Примечание

  • 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 можно найти на http://docs.ansible.com/ansible/guide_cloudstack.html
  • Этот модуль поддерживает режим проверки.

Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.

Для получения помощи в разработке модулей, если у вас возникнет такое желание, прочитайте Справочная информация по сообществу и участие в разработке, Тестирование Ansible и Разработка модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/cs_region_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API