ngine_io.cloudstack.cs_vpn_connection – Управляет VPN-соединениями «сайт-сайт» в облаках на основе Apache CloudStack.
Примечание
Этот плагин является частью коллекции ngine_io.cloudstack (версия 2.0.0).
Для его установки используйте: ansible-galaxy collection install ngine_io.cloudstack.
Для использования в книге задач укажите: ngine_io.cloudstack.cs_vpn_connection.
Добавлен в версии 0.1.0: модуля 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 строка | Проверить сертификат удостоверяющего центра. Если не указано, рассматривается переменная среды CLOUDSTACK_VERIFY. | |
| domain строка | Домен, к которому относится VPN-соединение. | |
| force булево |
| Активировать шлюз VPN, если он еще не активирован в state=present. См. также cs_vpn_gateway. |
| passive булево |
| Состояние VPN-соединения. Рассматривается только при state=present. |
| poll_async булево |
| Опрашивать асинхронные задания до завершения работы. |
| project строка | Имя проекта, к которому относится VPN-соединение. | |
| state строка |
| Состояние VPN-соединения. |
| vpc строка / обязательно | Имя VPC, к которому относится VPN-соединение. | |
| vpn_customer_gateway строка / обязательно | Имя VPN-шлюза клиента. | |
| zone строка / обязательно | Имя зоны, к которой относится VPC. |
Примечания
Примечание
- Подробное руководство по модулям cloudstack можно найти в Руководстве по облакам CloudStack.
- Этот модуль поддерживает режим проверки.
Примеры
- name: Create a VPN connection with activated VPN gateway
ngine_io.cloudstack.cs_vpn_connection:
vpn_customer_gateway: my vpn connection
vpc: my vpc
zone: zone01
- name: Create a VPN connection and force VPN gateway activation
ngine_io.cloudstack.cs_vpn_connection:
vpn_customer_gateway: my vpn connection
vpc: my vpc
zone: zone01
force: yes
- name: Remove a vpn connection
ngine_io.cloudstack.cs_vpn_connection:
vpn_customer_gateway: my vpn connection
vpc: my vpc
zone: zone01
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны в здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| account строка | успех | Аккаунт, к которому относится VPN-соединение. Пример: example account |
| cidrs список / элементы=строка | успех | Список CIDR-блоков шлюза клиента. Пример: ['10.10.10.0/24'] |
| created строка | успех | Дата создания соединения. Пример: 2014-12-01T14:57:57+0100 |
| 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.101.214.10 |
| id строка | успех | UUID VPN-соединения. Пример: 04589590-ac63-4ffc-93f5-b698b8ac38b6 |
| ike_lifetime целое число | успех | Срок действия фазы 1 VPN-соединения в секундах. Пример: 86400 |
| ike_policy строка | успех | Политика ESP VPN-соединения. Пример: aes256-sha1;modp1536 |
| passive булево | успех | Является ли соединение пассивным или нет. |
| project строка | успех | Имя проекта, к которому относится VPN-соединение. Пример: Production |
| public_ip строка | успех | IP-адрес VPN-шлюза. Пример: 10.100.212.10 |
| state строка | успех | Состояние VPN-соединения. Пример: Подключено |
| vpn_gateway_id строка | успех | UUID VPN-шлюза. Пример: 04589590-ac63-93f5-4ffc-b698b8ac38b6 |
Авторы
- 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_connection_module.html
