Spec-Zone.ru › Ansible 2.4

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

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

  • Обзор
  • Требования (на хосте, выполняющем модуль)
  • Параметры
  • Примеры
  • Возвращаемые значения
  • Примечания
    • Статус

Обзор

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

Требования (на хосте, выполняющем модуль)

  • python >= 2.6
  • cs >= 0.6.10

Параметры

параметр обязательно по умолчанию варианты комментарии
api_http_method
нет get
  • get
  • post
Используемый метод HTTP.
api_key
нет
Ключ API для CloudStack API.
api_region
нет cloudstack
Имя раздела ini в файле cloustack.ini.
api_secret
нет
Секретный ключ для CloudStack API.
api_timeout
нет 10
Таймаут HTTP.
api_url
нет
URL CloudStack API, например, https://cloud.example.com/client/api.
clean_up
нет
Очистить все ресурсы домена, такие как дочерние домены и аккаунты.
Рассматривается в state=absent.
network_domain
нет
Домен сети для сетей в домене.
path
да
Путь до домена.
Префикс ROOT/ или /ROOT/ в пути является необязательным.
poll_async
нет True
Ожидать завершения асинхронных задач.
state
нет present
  • present
  • absent
Состояние домена.

Примеры

- 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
Имя домена.
успех строка клиенты
network_domain
Домен сети домена.
успех строка example.local
parent_domain
Родительский домен домена.
успех строка ROOT
path
Путь до домена.
успех строка /ROOT/клиенты

Примечания

Примечание

  • 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 можно найти по адресу http://docs.ansible.com/ansible/guide_cloudstack.html
  • Этот модуль поддерживает режим проверки.

Статус

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

Для помощи в разработке модулей, если вам это интересно, пожалуйста, ознакомьтесь с Информация о сообществе и участие, Тестирование Ansible и Разработка модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/cs_domain_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API