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 -		Секретный ключ 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, см. также примечания.
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]
Этот модуль поддерживается сообществом 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.7/modules/cs_domain_module.html