cs_domain — Управление доменами в облаках на основе Apache CloudStack.

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

Обзор
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое сопровождение
- Автор

Обзор

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

Требования

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

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, также см. примечания.
clean_up	Значение по умолчанию: "no"	Удалить все ресурсы домена, такие как дочерние домены и учетные записи. Применяется в `state=absent`.
network_domain		Домен сети для сетей в данном домене.
path обязательно		Путь к домену. Префикс `ROOT/` или `/ROOT/` в пути необязателен.
poll_async	Значение по умолчанию: "yes"	Проверка асинхронных задач до их завершения.
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
  local_action:
    module: cs_domain
    path: ROOT/customers
    network_domain: customers.example.com

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

- name: Remove a domain
  local_action:
    module: cs_domain
    path: ROOT/customers/xy
    state: absent

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

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

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

Статус

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

Техническое сопровождение

Этот модуль помечен как community, что означает, что он поддерживается сообществом 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_domain_module.html