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 bool	Варианты: нет ← да	Активировать шлюз VPN, если он еще не активирован в `state=present`. См. также cs_vpn_gateway.
passive bool	Варианты: нет ← да	Состояние подключения VPN. Рассматривается только при `state=present`.
poll_async bool	Варианты: нет да ←	Опрос асинхронных задач до завершения.
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-соединения. Пример: Connected
vpn_gateway_id строка	успех	UUID VPN-шлюза. Пример: 04589590-ac63-93f5-4ffc-b698b8ac38b6

Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что его поддерживает сообщество Ansible. Подробнее см. Техническое обслуживание и поддержка модулей.

Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.

Автор

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