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 булево	Варианты: нет ← да	Активировать шлюз 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. Если не задано, используется зона по умолчанию.

Примечания

Примечание

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
  cs_vpn_connection:
    vpn_customer_gateway: my vpn connection
    vpc: my vpc
  delegate_to: localhost

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

- name: Remove a vpn connection
  cs_vpn_connection:
    vpn_customer_gateway: my vpn connection
    vpc: my vpc
    state: absent
  delegate_to: localhost

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
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

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом 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.9/modules/cs_vpn_connection_module.html