Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: ngine_io.cloudstack.vpn_customer_gateway.

Добавлено в ngine_io.cloudstack 0.1.0

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

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

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

Псевдонимы: cs_vpn_customer_gateway

Требования

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

  • python >= 2.6
  • cs >= 0.9.0

Параметры

Параметр

Комментарии

account

string

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

api_http_method

string

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

Если значение не задано, используется переменная среды CLOUDSTACK_METHOD.

Варианты:

  • "get" ← (по умолчанию)
  • "post"

api_key

string / обязательный

Ключ API CloudStack.

Если значение не задано, используется переменная среды CLOUDSTACK_KEY.

api_secret

string / обязательный

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

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

api_timeout

integer

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

Если значение не задано, используется переменная среды CLOUDSTACK_TIMEOUT.

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

api_url

string / обязательный

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

Если значение не задано, используется переменная среды CLOUDSTACK_ENDPOINT.

api_verify_ssl_cert

string

Проверка файла сертификата удостоверяющего центра.

Если значение не задано, используется переменная среды CLOUDSTACK_VERIFY.

cidrs

псевдонимы: cidr

list / элементы=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.

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

Обязательный параметр, если state=present.

name

string / обязательный

Имя шлюза.

poll_async

boolean

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

Варианты:

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

project

string

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

state

string

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

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

validate_certs

boolean

добавлено в 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.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.vpn_customer_gateway:
    name: my vpn customer gateway
    state: absent

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

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

Ключ

Описание

account

string

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

Возвращается: при успешном выполнении

Пример: "example account"

cidrs

list / элементы=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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/ngine_io/cloudstack/vpn_customer_gateway_module.html

Spec-Zone.ru

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