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

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

Описание

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

Требования

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

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 булево	Варианты: нет ← да	Удалить все ресурсы домена, такие как дочерние домены и учетные записи. Рассматривается при 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
  cs_domain:
    path: ROOT/customers
    network_domain: customers.example.com
  delegate_to: localhost

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

- name: Remove a domain
  cs_domain:
    path: ROOT/customers/xy
    state: absent
  delegate_to: localhost

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

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

Ключ	Возвращаемое значение	Описание
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.9/modules/cs_domain_module.html