cs_vpn_customer_gateway – Управляет конфигурациями шлюзов VPN между сайтами для клиентов в облаках на базе Apache CloudStack

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

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

Обзор

Создание, обновление и удаление шлюзов VPN для клиентов.

Требования

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

python >= 2.6
cs >= 0.6.10

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
account строка		Аккаунт, к которому относится шлюз VPN для клиентов.
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, см. также примечания.
cidrs список		Список CIDR-блоков гостевых сетей за шлюзом. Требуется, если state=present. псевдонимы: cidr
domain строка		Домен, к которому относится шлюз VPN для клиентов.
dpd булево	Варианты: нет да	Включить обнаружение неактивных узлов. Отключено по умолчанию API при создании, если не установлено.
esp_lifetime целое число		Срок действия фазы 2 подключения VPN в секундах. По умолчанию 3600 устанавливается API при создании, если не задано.
esp_policy строка		Политика ESP в формате, например, `aes256-sha1;modp1536`. Требуется, если state=present.
force_encap булево	Варианты: нет да	Принудительно использовать инкапсуляцию для прохождения NAT. Отключено по умолчанию API при создании, если не установлено.
gateway строка		Общедоступный IP-адрес шлюза. Требуется, если state=present.
ike_lifetime целое число		Срок действия фазы 1 подключения VPN в секундах. По умолчанию 86400 устанавливается API при создании, если не задано.
ike_policy строка		Политика IKE в формате, например, `aes256-sha1;modp1536`. Требуется, если state=present.
ipsec_psk строка		Предварительный ключ IPsec. Не может содержать символы новой строки или двойные кавычки. Требуется, если state=present.
name строка / обязательно		Имя шлюза.
poll_async булево	Варианты: нет да ←	Опрашивать асинхронные задачи до завершения.
project строка		Имя проекта, к которому относится шлюз VPN.
state строка	Варианты: присутствует ← отсутствует	Состояние шлюза VPN для клиентов.

Примечания

Примечание

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 vpn customer gateway
  cs_vpn_customer_gateway:
    name: my vpn customer gateway
    cidrs:
    - 192.168.123.0/24
    - 192.168.124.0/24
    esp_policy: aes256-sha1;modp1536
    gateway: 10.10.1.1
    ike_policy: aes256-sha1;modp1536
    ipsec_psk: "S3cr3Tk3Y"
  delegate_to: localhost

- name: Remove a vpn customer gateway
  cs_vpn_customer_gateway:
    name: my vpn customer gateway
    state: absent
  delegate_to: localhost

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

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

Ключ	Возвращаемое значение	Описание
account строка	успех	Аккаунт, к которому относится VPN шлюз клиента. Пример: example account
cidrs список	успех	Список CIDR адресов этого шлюза клиента. Пример: ['10.10.10.0/24']
domain строка	успех	Домен, к которому относится VPN шлюз клиента. Пример: example domain
dpd булево	успех	Включена ли проверка на отказ (dead pear detection). Пример: True
esp_lifetime целое число	успех	Время жизни фазы 2 VPN соединения в секундах. Пример: 86400
esp_policy строка	успех	Политика IKE VPN шлюза клиента. Пример: aes256-sha1;modp1536
force_encap булево	успех	Принудительно ли используется инкапсуляция для прохождения NAT? Пример: True
gateway строка	успех	IP-адрес VPN шлюза клиента. Пример: 10.100.212.10
id строка	успех	UUID VPN шлюза клиента. Пример: 04589590-ac63-4ffc-93f5-b698b8ac38b6
ike_lifetime целое число	успех	Время жизни фазы 1 VPN соединения в секундах. Пример: 86400
ike_policy строка	успех	Политика ESP VPN шлюза клиента. Пример: aes256-sha1;modp1536
name строка	успех	Имя этого шлюза клиента. Пример: my vpn customer gateway
project строка	успех	Имя проекта, к которому относится VPN шлюз клиента. Пример: Production

Статус

Данный модуль не гарантирует обратную совместимость. [превью]
Данный модуль поддерживается сообществом Ansible. [сообщество]

Авторы

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_vpn_customer_gateway_module.html