ngine_io.cloudstack.cs_vpn_connection модуль — Управляет VPN-соединениями сайта-к-сайту в облаках на базе Apache CloudStack.
Примечание
Этот модуль входит в коллекцию ngine_io.cloudstack (версия 2.5.0).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить ее, используйте: ansible-galaxy collection install ngine_io.cloudstack. Для использования этого модуля требуются дополнительные требования, см. Требования для получения подробностей.
Чтобы использовать его в playbook, укажите: ngine_io.cloudstack.cs_vpn_connection.
Добавлен в ngine_io.cloudstack 0.1.0
Обзор
- Создание и удаление VPN-соединений.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- cs >= 0.9.0
Параметры
Параметр | Комментарии |
|---|---|
account строка | Аккаунт, к которому относится VPN соединение. |
api_http_method строка | Метод HTTP, используемый для запроса к API-точке. Если не задано, используется переменная среды Варианты:
|
api_key строка / обязательно | API-ключ CloudStack API. Если не задан, используется переменная среды |
api_secret строка / обязательно | Секретный ключ CloudStack API. Если не задан, используется переменная среды |
api_timeout целое число | Таймаут HTTP в секундах. Если не задан, используется переменная среды По умолчанию: |
api_url строка / обязательно | URL CloudStack API, например: https://cloud.example.com/client/api. Если не задан, используется переменная среды |
api_verify_ssl_cert строка | Проверка сертификата авторизации CA. Если не задано, используется переменная среды |
domain строка | Домен, к которому относится VPN соединение. |
force логическое | Активировать VPN шлюз, если он ещё не активирован в состоянии state=present. См. также ngine_io.cloudstack.cs_vpn_gateway. Варианты:
|
passive логическое | Состояние VPN соединения. Учитывается только при state=present. Варианты:
|
poll_async логическое | Следить за асинхронными заданиями до завершения. Варианты:
|
project строка | Имя проекта, к которому относится VPN соединение. |
state строка | Состояние VPN соединения. Варианты:
|
validate_certs логическое добавлен в ngine_io.cloudstack 2.4.0 | Если Если не задан, используется переменная среды Это следует использовать только на контролируемых сайтах с использованием самозаверенных сертификатов. Варианты:
|
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 string | Учетная запись, к которой относится VPN-соединение. Возвращается: success Пример: |
cidrs list / elements=string | Список CIDR шлюза клиента. Возвращается: success Пример: |
created string | Дата создания соединения. Возвращается: success Пример: |
domain string | Домен, к которому относится VPN-соединение. Возвращается: success Пример: |
dpd boolean | Включена ли проверка отсутствия связи (dead peer detection) или нет. Возвращается: success Пример: |
esp_lifetime integer | Время жизни в секундах VPN-соединения фазы 2. Возвращается: success Пример: |
esp_policy string | Политика IKE VPN-соединения. Возвращается: success Пример: |
force_encap boolean | Принуждается ли инкапсуляция для прохождения NAT или нет. Возвращается: success Пример: |
gateway string | IP-адрес VPN-шлюза клиента. Возвращается: success Пример: |
id string | UUID VPN-соединения. Возвращается: success Пример: |
ike_lifetime integer | Время жизни в секундах VPN-соединения фазы 1. Возвращается: success Пример: |
ike_policy string | Политика ESP VPN-соединения. Возвращается: success Пример: |
passive boolean | Является ли соединение пассивным или нет. Возвращается: success Пример: |
project string | Название проекта, к которому относится VPN-соединение. Возвращается: success Пример: |
public_ip string | IP-адрес VPN-шлюза. Возвращается: success Пример: |
state string | Состояние VPN-соединения. Возвращается: success Пример: |
vpn_gateway_id string | UUID VPN-шлюза. Возвращается: success Пример: |
Справочные ссылки
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ngine_io/cloudstack/cs_vpn_connection_module.html