ngine_io.cloudstack.cs_domain – Управляет доменами в облаках на основе Apache CloudStack.

Примечание

Этот плагин входит в коллекцию ngine_io.cloudstack (версия 1.1.0).

Для его установки используйте: ansible-galaxy collection install ngine_io.cloudstack.

Чтобы использовать его в playbook, укажите: ngine_io.cloudstack.cs_domain.

Добавлен в версии 0.1.0: модуля ngine_io.cloudstack

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

Обзор

Создание, обновление и удаление доменов.

Требования

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

python >= 2.6
cs >= 0.9.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
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, см. также примечания.
api_verify_ssl_cert строка		Файл сертификата CA. Если не задано, рассматривается переменная окружения `CLOUDSTACK_VERIFY`. В качестве последнего варианта значение берется из файла конфигурации ini, см. также примечания. Значение по умолчанию – `null`, если не указано.
clean_up булево	Варианты: нет ← да	Очистить все ресурсы домена, такие как дочерние домены и учетные записи. Рассматривается при state=absent.
network_domain строка		Домен сети для сетей в домене.
path строка / обязательно		Путь к домену. Префикс `ROOT/` или `/ROOT/` в пути необязателен.
poll_async булево	Варианты: нет да ←	Проверять асинхронные задачи до завершения.
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 domain
  ngine_io.cloudstack.cs_domain:
    path: ROOT/customers
    network_domain: customers.example.com

- name: Create another subdomain
  ngine_io.cloudstack.cs_domain:
    path: ROOT/customers/xy
    network_domain: xy.customers.example.com

- name: Remove a domain
  ngine_io.cloudstack.cs_domain:
    path: ROOT/customers/xy
    state: absent

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

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

Ключ	Возвращенное значение	Описание
id строка	успех	UUID домена. Пример: 87b1e0ce-4e01-11e4-bb66-0050569e64b8
name строка	успех	Имя домена. Пример: клиенты
network_domain строка	успех	Домен сети домена. Пример: example.local
parent_domain строка	успех	Родительский домен домена. Пример: ROOT
path строка	успех	Путь домена. Пример: /ROOT/клиенты

Авторы

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.10/collections/ngine_io/cloudstack/cs_domain_module.html