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 для API CloudStack. Если не указано, используется переменная окружения `CLOUDSTACK_KEY`. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания.
api_region	Значение по умолчанию: "cloudstack"	Имя раздела в файле конфигурации `cloustack.ini`. Если не указано, используется переменная окружения `CLOUDSTACK_REGION`.
api_secret		Секретный ключ API для CloudStack API. Если не задано, используется переменная окружения `CLOUDSTACK_SECRET`. В качестве последнего варианта используется значение из файла ini, см. примечания.
api_timeout		Таймаут HTTP в секундах. Если не указано, используется переменная окружения `CLOUDSTACK_TIMEOUT`. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания. Значение по умолчанию 10 секунд, если не указано.
api_url		URL API CloudStack, например, https://cloud.example.com/client/api. Если не указано, используется переменная окружения `CLOUDSTACK_ENDPOINT`. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания.
cidrs		Список CIDR сетей гостевых сетей за шлюзом. Требуется, если `state=present`. псевдонимы: cidr
domain		Домен, к которому относится шлюз VPN для клиента.
dpd bool	Варианты: no yes	Включить функцию обнаружения отсутствия активности (Dead Peer Detection). Отключено по умолчанию API при создании, если не задано.
esp_lifetime		Срок действия соединения VPN фазы 2 в секундах. По умолчанию 3600 API при создании, если не задано.
esp_policy		Политика ESP в формате, например, `aes256-sha1;modp1536`. Требуется, если `state=present`.
force_encap bool	Варианты: no yes	Принудительная инкапсуляция для прохождения NAT. Отключено по умолчанию API при создании, если не задано.
gateway		Публичный IP-адрес шлюза. Требуется, если `state=present`.
ike_lifetime		Срок действия соединения VPN фазы 1 в секундах. По умолчанию 86400 API при создании, если не задано.
ike_policy		Политика IKE в формате, например, `aes256-sha1;modp1536`. Требуется, если `state=present`.
ipsec_psk		IPsec Preshared-Key. Не может содержать символы новой строки или двойные кавычки. Требуется, если `state=present`.
name обязательно		Имя шлюза.
poll_async	Значение по умолчанию: "yes"	Проверять асинхронные задания до завершения.
project		Имя проекта, к которому относится шлюз VPN.
state	Варианты: present ← absent	Состояние шлюза 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 Cloud Guide.
Этот модуль поддерживает режим проверки.

Примеры

- name: Create a vpn customer gateway
  local_action:
    module: 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"

- name: Remove a vpn customer gateway
  local_action:
    module: cs_vpn_customer_gateway
    name: my vpn customer gateway
    state: absent

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

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

Ключ	Возвращено	Описание
account строка	успех	Аккаунт, к которому относится шлюз VPN клиента. Пример: example account
cidrs список	успех	Список CIDR адресов данного шлюза VPN клиента. Пример: ['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. Подробнее см. Техническое обслуживание модулей и поддержка.

Список других модулей, поддерживаемых сообществом 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.6/modules/cs_vpn_customer_gateway_module.html