Spec-Zone.ru › Ansible 2.7

cs_vpn_customer_gateway – Управляет конфигурациями шлюзов 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, см. также примечания.
cidrs
-
Список CIDR-блоков гостевых сетей за шлюзом.
Требуется, если state=present.

псевдонимы: cidr
domain
-
Домен, к которому относится шлюз VPN клиента.
dpd
boolean
    Варианты:
  • no
  • yes
Включить обнаружение отсутствия ответных пакетов (Dead Peer Detection).
Отключено по умолчанию API при создании, если не задано.
esp_lifetime
-
Срок действия фазы 2 VPN-соединения в секундах.
Установлено по умолчанию в 3600 API при создании, если не задано.
esp_policy
-
Политика ESP в формате, например aes256-sha1;modp1536.
Требуется, если state=present.
force_encap
boolean
    Варианты:
  • no
  • yes
Принудительное использование инкапсуляции для прохождения NAT.
Отключено по умолчанию API при создании, если не задано.
gateway
-
Общедоступный IP-адрес шлюза.
Требуется, если state=present.
ike_lifetime
-
Срок действия фазы 1 VPN-соединения в секундах.
Установлено по умолчанию в 86400 API при создании, если не задано.
ike_policy
-
Политика IKE в формате, например aes256-sha1;modp1536.
Требуется, если state=present.
ipsec_psk
-
IPsec предварительно согласованный ключ.
Не должно содержать символов перевода строки или двойных кавычек.
Требуется, если state=present.
name
- / обязательно
Имя шлюза.
poll_async
-
По умолчанию:
"yes"
Выполнять асинхронные задачи до завершения.
project
-
Имя проекта, к которому относится шлюз VPN.
state
-
    Варианты:
  • present ←
  • absent
Состояние шлюза VPN клиента.

Примечания

Примечание

  • Ansible использует метод конфигурации библиотеки cs, если учетные данные не предоставлены аргументами api_url, api_key, api_secret. Конфигурация читается из нескольких источников в следующем порядке. Переменные среды CLOUDSTACK_ENDPOINT, CLOUDSTACK_KEY, CLOUDSTACK_SECRET и CLOUDSTACK_METHOD. Переменная среды CLOUDSTACK_TIMEOUT, указывающая на файл CLOUDSTACK_CONFIG конфигурации. Файл cloudstack.ini в текущей рабочей директории. Файл .cloudstack.ini в домашней директории пользователя. Допускается указание нескольких учетных данных и конечных точек с использованием разделов ini в cloudstack.ini. Используйте аргумент api_region для выбора имени раздела, по умолчанию используется cloudstack. Для получения дополнительной информации обратитесь к https://github.com/exoscale/cs.
  • Подробное руководство по модулям cloudstack можно найти в руководстве по облакам CloudStack.
  • Этот модуль поддерживает режим проверки.

Примеры

- name: Create a vpn customer gateway
  local_action:
    module: cs_vpn_customer_gateway
    name: my vpn customer gateway
    cidrs:
    - 192.168.123.0/24
    - 192.168.124.0/24
    esp_policy: aes256-sha1;modp1536
    gateway: 10.10.1.1
    ike_policy: aes256-sha1;modp1536
    ipsec_psk: "S3cr3Tk3Y"

- name: Remove a vpn customer gateway
  local_action:
    module: cs_vpn_customer_gateway
    name: my vpn customer gateway
    state: absent

Возвращаемые значения

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

Ключ Результат Описание
account
строка
 успех
Аккаунт, к которому относится шлюз VPN-клиента.

Пример:
example account
cidrs
список
 успех
Список CIDR-блоков этого шлюза VPN-клиента.

Пример:
['10.10.10.0/24']
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.100.212.10
id
строка
 успех
UUID шлюза VPN-клиента.

Пример:
04589590-ac63-4ffc-93f5-b698b8ac38b6
ike_lifetime
целое число
 успех
Время жизни (в секундах) фазы 1 VPN-соединения.

Пример:
86400
ike_policy
строка
 успех
Политика ESP шлюза VPN-клиента.

Пример:
aes256-sha1;modp1536
name
строка
 успех
Имя этого шлюза клиента.

Пример:
my vpn customer gateway
project
строка
 успех
Название проекта, к которому относится шлюз VPN-клиента.

Пример:
Production


Статус

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API