cs_instancegroup – Управляет группами виртуальных машин в облаках на основе Apache CloudStack

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

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

Обзор

Создание и удаление групп виртуальных машин.

Требования

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

python >= 2.6
cs >= 0.6.10

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
account строка		Аккаунт, к которому относится группа виртуальных машин.
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, см. также примечания.
domain строка		Домен, к которому относится группа виртуальных машин.
name строка / обязательно		Имя группы виртуальных машин.
project строка		Проект, к которому относится группа виртуальных машин.
state строка	Варианты: present ← absent	Состояние группы виртуальных машин.

Примечания

Примечание

Ansible использует метод конфигурации библиотеки cs, если учетные данные не предоставлены аргументами api_url, api_key, api_secret. Конфигурация читается из нескольких источников в следующем порядке. Переменные среды CLOUDSTACK_ENDPOINT, CLOUDSTACK_KEY, CLOUDSTACK_SECRET и CLOUDSTACK_METHOD. Переменная среды CLOUDSTACK_TIMEOUT указывающая на файл .ini. Файл cloudstack.ini в текущей рабочей директории. Файл .cloudstack.ini в домашней директории пользователя. Допускается указание нескольких учетных данных и конечных точек с помощью разделов ini в файле cloudstack.ini. Используйте аргумент api_region для выбора имени раздела, по умолчанию раздел cloudstack. Дополнительную информацию см. на странице https://github.com/exoscale/cs.
Подробное руководство по модулям cloudstack можно найти в руководстве по облаку CloudStack.
Этот модуль поддерживает режим проверки.

Примеры

- name: Create an instance group
  cs_instancegroup:
    name: loadbalancers
  delegate_to: localhost

- name: Remove an instance group
  cs_instancegroup:
    name: loadbalancers
    state: absent
  delegate_to: localhost

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

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

Ключ	Возвращаемое значение	Описание
account строка	успех	Аккаунт, к которому относится группа виртуальных машин. Пример: пример аккаунта
created строка	успех	Дата создания группы виртуальных машин. Пример: 2015-05-03T15:05:51+0200
domain строка	успех	Домен, к которому относится группа виртуальных машин. Пример: пример домена
id строка	успех	UUID группы виртуальных машин. Пример: 04589590-ac63-4ffc-93f5-b698b8ac38b6
name строка	успех	Имя группы виртуальных машин. Пример: webservers
project строка	успех	Проект, к которому относится группа виртуальных машин. Пример: пример проекта

Статус

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

Авторы

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.8/modules/cs_instancegroup_module.html