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-ключ API CloudStack. Если не указан, используется значение переменной среды `CLOUDSTACK_KEY`. В качестве последнего варианта, значение берется из конфигурационного файла ini, см. также примечания.
api_region	По умолчанию: cloudstack	Имя раздела ini в файле `cloustack.ini`. Если не указан, используется значение переменной среды `CLOUDSTACK_REGION`.
api_secret		Секретный ключ API CloudStack. Если не задан, используется значение переменной среды `CLOUDSTACK_SECRET`. В качестве последнего варианта, значение берется из конфигурационного файла ini, см. также примечания.
api_timeout		Таймаут HTTP-запроса в секундах. Если не указан, используется значение переменной среды `CLOUDSTACK_TIMEOUT`. В качестве последнего варианта, значение берется из конфигурационного файла ini, см. также примечания. Значение по умолчанию - 10 секунд, если не указано.
api_url		URL API CloudStack, например, https://cloud.example.com/client/api. Если не указан, используется значение переменной среды `CLOUDSTACK_ENDPOINT`. В качестве последнего варианта, значение берется из конфигурационного файла ini, см. также примечания.
domain		Домен, к которому относится подключение VPN.
force	Варианты: no ← yes	Активировать шлюз VPN, если он еще не активирован в `state=present`. См. также cs_vpn_gateway.
passive	Варианты: no ← yes	Состояние подключения VPN. Учитывается только при `state=present`.
poll_async	Варианты: no yes ←	Ожидать завершения асинхронных задач.
project		Имя проекта, к которому относится подключение VPN.
state	Варианты: present ← absent	Состояние подключения 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 булево значение	успешно	Включена ли функция обнаружения отсутствия ответа (Dead Peer Detection) или нет. Пример: 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/cs_vpn_connection_module.html