cs_vpn_connection – Управляет подключениями 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"	Имя раздела ini в файле `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, см. также примечания.
domain -		Домен, к которому относится подключение VPN.
force boolean	Варианты: нет ← да	Активировать шлюз VPN, если он еще не активирован в `state=present`. См. также cs_vpn_gateway.
passive boolean	Варианты: нет ← да	Состояние подключения VPN. Учитывается только, когда `state=present`.
poll_async boolean	Варианты: нет да ←	Опрашивать асинхронные задачи до завершения работы.
project -		Имя проекта, к которому относится подключение VPN.
state -	Варианты: наличие ← отсутствует	Состояние подключения VPN.
vpc - / обязательно		Имя VPC, к которому относится подключение VPN.
vpn_customer_gateway - / обязательно		Имя 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.
Этот модуль поддерживает режим проверки.

Примеры

- name: Create a VPN connection with activated VPN gateway
  local_action:
    module: cs_vpn_connection
    vpn_customer_gateway: my vpn connection
    vpc: my vpc

- name: Create a VPN connection and force VPN gateway activation
  local_action:
    module: cs_vpn_connection
    vpn_customer_gateway: my vpn connection
    vpc: my vpc
    force: yes

- name: Remove a vpn connection
  local_action:
    module: cs_vpn_connection
    vpn_customer_gateway: my vpn connection
    vpc: my vpc
    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

Состояние

Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
Данный модуль поддерживается сообществом Ansible. [community]

Авторы

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.7/modules/cs_vpn_connection_module.html