Spec-Zone.ru › Ansible 2.10

ngine_io.cloudstack.cs_vpn_customer_gateway – Управляет конфигурациями шлюзов VPN-клиентов сайт-сайт на облаках на базе Apache CloudStack.

Примечание

Этот плагин является частью коллекции ngine_io.cloudstack (версия 1.1.0).

Для его установки используйте: ansible-galaxy collection install ngine_io.cloudstack.

Для использования в книге задач укажите: ngine_io.cloudstack.cs_vpn_customer_gateway.

Новое в версии 0.1.0: модуля ngine_io.cloudstack

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Описание

  • Создание, обновление и удаление шлюзов VPN-клиентов.

Требования

Ниже перечислены требования, необходимые на хосте, который выполняет этот модуль.

  • python >= 2.6
  • cs >= 0.9.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
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, см. также примечания.
api_verify_ssl_cert
строка
Файл сертификата CA.
Если не задано, рассматривается переменная окружения CLOUDSTACK_VERIFY.
В качестве последнего варианта значение берётся из файла конфигурации ini, см. также примечания.
Значение по умолчанию – null если не указано.
cidrs
список / элементы=строка
Список гостевых CIDR-блоков за шлюзом.
Обязательно, если state=present.

псевдонимы: cidr
domain
строка
Домен, к которому относится шлюз VPN-клиента.
dpd
булево
    Варианты:
  • no
  • yes
Включить функцию обнаружения мертвого узла (Dead Peer Detection).
Отключено по умолчанию API при создании, если не указано.
esp_lifetime
целое число
Срок действия фазы 2 VPN-соединения в секундах.
По умолчанию 3600 API при создании, если не указано.
esp_policy
строка
Политика ESP в формате, например, aes256-sha1;modp1536.
Обязательно, если state=present.
force_encap
булево
    Варианты:
  • 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 Preshared-Key.
Не должно содержать символы новой строки или двойные кавычки.
Обязательно, если state=present.
name
строка / обязательно
Имя шлюза.
poll_async
булево
    Варианты:
  • no
  • да ←
Выполнять опрос асинхронных задач до завершения.
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
  ngine_io.cloudstack.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
  ngine_io.cloudstack.cs_vpn_customer_gateway:
    name: my vpn customer gateway
    state: absent

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

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

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

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

Пример:
['10.10.10.0/24']
domain
строка
успех
Домен, к которому относится VPN-шлюз клиента.

Пример:
example domain
dpd
логическое значение
успех
Включено ли обнаружение мертвых пар (dead pear 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


Авторы

  • 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.10/collections/ngine_io/cloudstack/cs_vpn_customer_gateway_module.html

Spec-Zone.ru

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