Spec-Zone.ru › Ansible

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

Примечание

Этот модуль является частью коллекции ngine_io.cloudstack (версия 2.5.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install ngine_io.cloudstack. Вам потребуются дополнительные требования для использования этого модуля, см. Требования для получения подробной информации.

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

Новое в ngine_io.cloudstack 0.1.0

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

Краткое описание

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

Требования

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

  • python >= 2.6
  • cs >= 0.9.0

Параметры

Параметр

Комментарии

account

string

Учетная запись, с которой связан VPN-шлюз клиента.

api_http_method

string

HTTP-метод, используемый для запроса к конечной точке API.

Если не указано, используется переменная окружения CLOUDSTACK_METHOD.

Варианты:

  • "get" ← (default)
  • "post"

api_key

string / required

API-ключ CloudStack API.

Если не указано, используется переменная окружения CLOUDSTACK_KEY.

api_secret

string / required

Секретный ключ CloudStack API.

Если не задано, используется переменная окружения CLOUDSTACK_SECRET.

api_timeout

integer

Таймаут HTTP в секундах.

Если не указано, используется переменная окружения CLOUDSTACK_TIMEOUT.

По умолчанию: 10

api_url

string / required

URL CloudStack API, например, https://cloud.example.com/client/api.

Если не указано, используется переменная окружения CLOUDSTACK_ENDPOINT.

api_verify_ssl_cert

string

Проверить файл сертификата центра сертификации.

Если не указано, используется переменная окружения CLOUDSTACK_VERIFY.

cidrs

aliases: cidr

list / elements=string

Список CIDR-адресов гостей за шлюзом.

Обязательно, если state=present.

domain

string

Домен, с которым связан VPN-шлюз клиента.

dpd

boolean

Включить обнаружение неработающего узла (Dead Peer Detection).

По умолчанию API отключает при создании, если не задано.

Варианты:

  • false
  • true

esp_lifetime

integer

Время жизни соединения VPN фазы 2 в секундах.

По умолчанию API устанавливает 3600 при создании, если не задано.

esp_policy

string

Политика ESP в формате, например, aes256-sha1;modp1536.

Обязательно, если state=present.

force_encap

boolean

Принудительная инкапсуляция для обхода NAT.

По умолчанию API отключает при создании, если не задано.

Варианты:

  • false
  • true

gateway

string

Публичный IP-адрес шлюза.

Обязательно, если state=present.

ike_lifetime

integer

Время жизни соединения VPN фазы 1 в секундах.

По умолчанию API устанавливает 86400 при создании, если не задано.

ike_policy

string

Политика IKE в формате, например, aes256-sha1;modp1536.

Обязательно, если state=present.

ipsec_psk

string

Предопределённый ключ IPsec (IPsec Preshared-Key).

Не может содержать символы новой строки или двойные кавычки.

Обязательно, если state=present.

name

string / required

Имя шлюза.

poll_async

boolean

Опрашивать асинхронные задания до завершения.

Варианты:

  • false
  • true ← (default)

project

string

Имя проекта, с которым связан VPN-шлюз.

state

string

Состояние VPN-шлюза клиента.

Варианты:

  • "present" ← (default)
  • "absent"

validate_certs

boolean

added in ngine_io.cloudstack 2.4.0

Если false, SSL сертификаты не будут проверены.

Если не указано, используется переменная окружения CLOUDSTACK_DANGEROUS_NO_TLS_VERIFY.

Это следует использовать только на лично контролируемых сайтах с самоподписанными сертификатами.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Подробное руководство по модулям 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

string

Учетная запись, с которой связан шлюз VPN-клиента.

Возвращается: успех

Пример: "example account"

cidrs

list / elements=string

Список CIDR этого шлюза клиента.

Возвращается: успех

Пример: ["10.10.10.0/24"]

domain

string

Домен, с которым связан шлюз VPN-клиента.

Возвращается: успех

Пример: "example domain"

dpd

boolean

Включено ли обнаружение неработающего соединения или нет.

Возвращается: успех

Пример: true

esp_lifetime

integer

Время жизни в секундах соединения VPN фазы 2.

Возвращается: успех

Пример: 86400

esp_policy

string

Политика IKE шлюза VPN-клиента.

Возвращается: успех

Пример: "aes256-sha1;modp1536"

force_encap

boolean

Принуждается ли инкапсуляция для обхода NAT или нет.

Возвращается: успех

Пример: true

gateway

string

IP-адрес шлюза VPN-клиента.

Возвращается: успех

Пример: "10.100.212.10"

id

string

UUID шлюза VPN-клиента.

Возвращается: успех

Пример: "04589590-ac63-4ffc-93f5-b698b8ac38b6"

ike_lifetime

integer

Время жизни в секундах соединения VPN фазы 1.

Возвращается: успех

Пример: 86400

ike_policy

string

Политика ESP шлюза VPN-клиента.

Возвращается: успех

Пример: "aes256-sha1;modp1536"

name

string

Имя этого шлюза клиента.

Возвращается: успех

Пример: "my vpn customer gateway"

project

string

Имя проекта, с которым связан шлюз VPN-клиента.

Возвращается: успех

Пример: "Production"

Авторы

  • René Moser (@resmo)

Ссылки на коллекцию

  • Система отслеживания ошибок
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ngine_io/cloudstack/cs_vpn_customer_gateway_module.html

Spec-Zone.ru

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