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	Имя раздела в файле конфигурации `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	Варианты: yes no	Включить функцию обнаружения отсутствия удалённого узла. Отключено по умолчанию API при создании, если не задано.
esp_lifetime		Срок действия фазы 2 VPN-соединения в секундах. По умолчанию 3600 API при создании, если не задано.
esp_policy		Политика ESP в формате, например, `aes256-sha1;modp1536`. Требуется, если `state=present`.
force_encap	Варианты: yes no	Принудительное использование инкапсуляции для прохождения 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	По умолчанию: yes	Ожидать завершения асинхронных задач.
project		Название проекта, к которому относится VPN-шлюз.
state	Варианты: present ← absent	Состояние VPN-шлюза клиента.

Примечания

Примечание

Ansible использует метод конфигурации библиотеки cs, если учетные данные не предоставлены аргументами api_url, api_key, api_secret. Конфигурация читается из нескольких источников в следующем порядке. Переменные среды CLOUDSTACK_ENDPOINT, CLOUDSTACK_KEY, CLOUDSTACK_SECRET и CLOUDSTACK_METHOD. Переменная среды 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
  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-блоков этого шлюза клиента. Пример: ['10.10.10.0/24']
domain строка	успех	Домен, к которому относится VPN-шлюз клиента. Пример: example domain
dpd логическое значение	успех	Включено ли обнаружение мертвых пар или нет. Пример: 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

Статус

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

Автор

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