ngine_io.cloudstack.cs_vpn_customer_gateway – Управляет конфигурациями шлюзов VPN для сайта-сайта на облаках на основе Apache CloudStack.
Примечание
Этот плагин входит в коллекцию ngine_io.cloudstack (версия 2.0.0).
Чтобы установить его, используйте: ansible-galaxy collection install ngine_io.cloudstack.
Чтобы использовать его в книге задач, укажите: ngine_io.cloudstack.cs_vpn_customer_gateway.
Новое в версии 0.1.0: of ngine_io.cloudstack
Обзор
- Создание, обновление и удаление шлюзов VPN для клиентов.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- cs >= 0.9.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| account строка | Аккаунт, к которому относится шлюз VPN для клиентов. | |
| api_http_method строка |
| HTTP-метод, используемый для запроса к API-точке. Если не указано, используется переменная окружения CLOUDSTACK_METHOD. |
| api_key строка / обязательно | API-ключ CloudStack API. Если не указано, используется переменная окружения CLOUDSTACK_KEY. | |
| api_secret строка / обязательно | Секретный ключ CloudStack API. Если не указано, используется переменная окружения CLOUDSTACK_SECRET. | |
| api_timeout целое число | По умолчанию: 10 | Таймаут HTTP в секундах. Если не указано, используется переменная окружения CLOUDSTACK_TIMEOUT. |
| api_url строка / обязательно | URL CloudStack API, например https://cloud.example.com/client/api. Если не указано, используется переменная окружения CLOUDSTACK_ENDPOINT. | |
| api_verify_ssl_cert строка | Проверка сертификата авторитета CA. Если не указано, используется переменная окружения CLOUDSTACK_VERIFY. | |
| cidrs список / элементы=строка | Список CIDR-блоков гостевых сетей за шлюзом. Требуется, если state=present. псевдонимы: cidr | |
| domain строка | Домен, к которому относится шлюз VPN для клиентов. | |
| dpd булево |
| Включить функцию обнаружения отсутствия пары (Dead Peer Detection). Отключено по умолчанию API при создании, если не установлено. |
| esp_lifetime целое число | Срок службы соединения VPN фазы 2 в секундах. По умолчанию установлено в 3600 API при создании, если не установлено. | |
| esp_policy строка | Политика ESP в формате, например, aes256-sha1;modp1536.Требуется, если state=present. | |
| force_encap булево |
| Принудительное использование инкапсуляции для прохождения NAT. Отключено по умолчанию API при создании, если не установлено. |
| gateway строка | Публичный IP-адрес шлюза. Требуется, если state=present. | |
| ike_lifetime целое число | Срок службы соединения VPN фазы 1 в секундах. По умолчанию установлено в 86400 API при создании, если не установлено. | |
| ike_policy строка | Политика IKE в формате, например, aes256-sha1;modp1536.Требуется, если state=present. | |
| ipsec_psk строка | IPsec предварительно заданный ключ. Не может содержать символы новой строки или двойные кавычки. Требуется, если state=present. | |
| name строка / обязательно | Имя шлюза. | |
| poll_async булево |
| Проверять асинхронные задачи, пока задача не завершится. |
| project строка | Имя проекта, к которому относится шлюз VPN. | |
| state строка |
| Состояние шлюза VPN для клиента. |
Примечания
Примечание
- Подробное руководство по модулям cloudstack можно найти в руководстве по облаку CloudStack.
- Этот модуль поддерживает режим проверки.
Примеры
- name: Create a vpn customer gateway
ngine_io.cloudstack.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
ngine_io.cloudstack.cs_vpn_customer_gateway:
name: my vpn customer gateway
state: absent
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| account строка | success | Аккаунт, к которому относится шлюз VPN для клиентов. Пример: example account |
| cidrs список / элементы=строка | success | Список CIDR-блоков для этого шлюза. Пример: ['10.10.10.0/24'] |
| domain строка | success | Домен, к которому относится шлюз VPN для клиентов. Пример: example domain |
| dpd булево | success | Включено ли обнаружение отсутствия пары (Dead Peer Detection) или нет. Пример: True |
| esp_lifetime целое число | success | Срок службы соединения VPN фазы 2 в секундах. Пример: 86400 |
| esp_policy строка | success | Политика IKE шлюза VPN для клиентов. Пример: aes256-sha1;modp1536 |
| force_encap булево | success | Принудительно ли используется инкапсуляция для прохождения NAT или нет. Пример: True |
| gateway строка | success | IP-адрес шлюза VPN для клиентов. Пример: 10.100.212.10 |
| id строка | success | UUID шлюза VPN для клиентов. Пример: 04589590-ac63-4ffc-93f5-b698b8ac38b6 |
| ike_lifetime целое число | success | Срок службы соединения VPN фазы 1 в секундах. Пример: 86400 |
| ike_policy строка | success | Политика ESP шлюза VPN для клиентов. Пример: aes256-sha1;modp1536 |
| name строка | success | Имя этого шлюза. Пример: my vpn customer gateway |
| project строка | success | Имя проекта, к которому относится шлюз VPN для клиентов. Пример: Production |
Авторы
- René Moser (@resmo)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ngine_io/cloudstack/cs_vpn_customer_gateway_module.html