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

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

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата
Состояние

Обзор

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

Требования

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

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. Если не задано, используется значение переменной среды `CLOUDSTACK_SECRET`. В качестве последнего варианта значение берется из файла конфигурации ini, см. также примечания.
api_timeout целое число		Таймаут HTTP в секундах. Если не задано, используется значение переменной среды `CLOUDSTACK_TIMEOUT`. В качестве последнего варианта значение берется из файла конфигурации ini, см. также примечания. Значение по умолчанию — 10 секунд, если не указано.
api_url строка		URL CloudStack API, например, https://cloud.example.com/client/api. Если не задано, используется значение переменной среды `CLOUDSTACK_ENDPOINT`. В качестве последнего варианта значение берется из файла конфигурации ini, см. также примечания.
dhcp_provider строка		DHCP-провайдер для зоны.
dns1 строка		Первый DNS для зоны. Требуется, если state=present
dns1_ipv6 строка		Первый DNS для IPv6 для зоны.
dns2 строка		Второй DNS для зоны.
dns2_ipv6 строка		Второй DNS для IPv6 для зоны.
domain строка		Домен, к которому относится зона. Зона является публичной, если не задано.
guest_cidr_address строка		Адрес Guest CIDR для зоны.
id строка		uuid существующей зоны.
internal_dns1 строка		Первый внутренний DNS для зоны. Если не задано, используется dns1 при state=present.
internal_dns2 строка		Второй внутренний DNS для зоны.
local_storage_enabled логическое	Варианты: no yes	Включить или выключить локальное хранилище для зоны.
name строка / обязательно		Название зоны.
network_domain строка		Домен сети для зоны.
network_type строка	Варианты: Базовый ← Расширенный	Тип сети зоны.
securitygroups_enabled логическое	Варианты: no yes	Включена ли поддержка групп безопасности для зоны.
state строка	Варианты: present ← enabled disabled 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: Ensure a zone is present
  cs_zone:
    name: ch-zrh-ix-01
    dns1: 8.8.8.8
    dns2: 8.8.4.4
    network_type: basic
  delegate_to: localhost

- name: Ensure a zone is disabled
  cs_zone:
    name: ch-zrh-ix-01
    state: disabled
  delegate_to: localhost

- name: Ensure a zone is enabled
  cs_zone:
    name: ch-zrh-ix-01
    state: enabled
  delegate_to: localhost

- name: Ensure a zone is absent
  cs_zone:
    name: ch-zrh-ix-01
    state: absent
  delegate_to: localhost

Значения возврата

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

Ключ	Возвращаемое значение	Описание
allocation_state строка	успех	Состояние зоны. Пример: Включено
dhcp_provider строка	успех	DHCP-провайдер для зоны Пример: VirtualRouter
dns1 строка	успех	Первый DNS для зоны. Пример: 8.8.8.8
dns1_ipv6 строка	успех	Первый IPv6 DNS для зоны. Пример: 2001:4860:4860::8888
dns2 строка	успех	Второй DNS для зоны. Пример: 8.8.4.4
dns2_ipv6 строка	успех	Второй IPv6 DNS для зоны. Пример: 2001:4860:4860::8844
domain строка	успех	Домен, к которому относится зона. Пример: ROOT
guest_cidr_address строка	успех	Guest CIDR-адрес для зоны Пример: 10.1.1.0/24
id строка	успех	UUID зоны. Пример: 04589590-ac63-4ffc-93f5-b698b8ac38b6
internal_dns1 строка	успех	Первый внутренний DNS для зоны. Пример: 8.8.8.8
internal_dns2 строка	успех	Второй внутренний DNS для зоны. Пример: 8.8.4.4
local_storage_enabled булево	успех	Включено предоставление локального хранения.
name строка	успех	Имя зоны. Пример: zone01
network_domain строка	успех	Сеть домен для зоны. Пример: example.com
network_type строка	успех	Тип сети для зоны. Пример: basic
securitygroups_enabled булево	успех	Поддержка групп безопасности включена.
tags словарь	успех	Список тегов ресурсов, связанных с зоной. Пример: [{'key': 'foo', 'value': 'bar'}]
zone_token строка	успех	Токен зоны Пример: ccb0a60c-79c8-3230-ab8b-8bdbe8c45bb7

Статус

Для данного модуля гарантированы отсутствие обратной совместимости изменений интерфейса в дальнейшем. [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.8/modules/cs_zone_module.html