Spec-Zone.ru › Ansible 2.5

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 API CloudStack.
Если не указано, используется переменная среды CLOUDSTACK_KEY.
В качестве последнего варианта, значение берется из файла конфигурации ini, см. также примечания.
api_region Значение по умолчанию:
cloudstack
Имя раздела в файле cloustack.ini.
Если не указано, используется переменная среды CLOUDSTACK_REGION.
api_secret
Секретный ключ API CloudStack.
Если не задано, используется переменная среды CLOUDSTACK_SECRET.
В качестве последнего варианта, значение берется из файла конфигурации ini, см. также примечания.
api_timeout
Таймаут HTTP в секундах.
Если не указано, используется переменная среды CLOUDSTACK_TIMEOUT.
В качестве последнего варианта, значение берется из файла конфигурации ini, см. также примечания.
Значение по умолчанию — 10 секунд, если не указано.
api_url
URL API CloudStack, например, 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. Файл 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
строка
success
UUID домена.

Пример:
87b1e0ce-4e01-11e4-bb66-0050569e64b8
name
строка
success
Имя домена.

Пример:
customers
network_domain
строка
success
Домен сети домена.

Пример:
example.local
parent_domain
строка
success
Родительский домен домена.

Пример:
ROOT
path
строка
success
Путь домена.

Пример:
/ROOT/customers


Статус

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

Автор

  • 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.5/modules/cs_domain_module.html

Spec-Zone.ru

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