Spec-Zone.ru › Ansible

ngine_io.cloudstack.cs_vpn_connection модуль — Управляет 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_connection.

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

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

Обзор

  • Создание и удаление VPN-соединений.

Требования

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

  • python >= 2.6
  • cs >= 0.9.0

Параметры

Параметр

Комментарии

account

строка

Аккаунт, к которому относится VPN соединение.

api_http_method

строка

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

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

Варианты:

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

api_key

строка / обязательно

API-ключ CloudStack API.

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

api_secret

строка / обязательно

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

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

api_timeout

целое число

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

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

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

api_url

строка / обязательно

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

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

api_verify_ssl_cert

строка

Проверка сертификата авторизации CA.

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

domain

строка

Домен, к которому относится VPN соединение.

force

логическое

Активировать VPN шлюз, если он ещё не активирован в состоянии state=present.

См. также ngine_io.cloudstack.cs_vpn_gateway.

Варианты:

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

passive

логическое

Состояние VPN соединения.

Учитывается только при state=present.

Варианты:

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

poll_async

логическое

Следить за асинхронными заданиями до завершения.

Варианты:

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

project

строка

Имя проекта, к которому относится VPN соединение.

state

строка

Состояние VPN соединения.

Варианты:

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

validate_certs

логическое

добавлен в ngine_io.cloudstack 2.4.0

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

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

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

Варианты:

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

vpc

строка / обязательно

Имя VPC, к которому относится VPN соединение.

vpn_customer_gateway

строка / обязательно

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

zone

строка / обязательно

Имя зоны, к которой относится VPC.

Примечания

Примечание

  • Подробное руководство по модулям cloudstack можно найти в Руководстве по облаку CloudStack.
  • Этот модуль поддерживает режим проверки.

Примеры

- name: Create a VPN connection with activated VPN gateway
  ngine_io.cloudstack.cs_vpn_connection:
    vpn_customer_gateway: my vpn connection
    vpc: my vpc
    zone: zone01

- name: Create a VPN connection and force VPN gateway activation
  ngine_io.cloudstack.cs_vpn_connection:
    vpn_customer_gateway: my vpn connection
    vpc: my vpc
    zone: zone01
    force: yes

- name: Remove a vpn connection
  ngine_io.cloudstack.cs_vpn_connection:
    vpn_customer_gateway: my vpn connection
    vpc: my vpc
    zone: zone01
    state: absent

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

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

Ключ

Описание

account

string

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

Возвращается: success

Пример: "example account"

cidrs

list / elements=string

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

Возвращается: success

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

created

string

Дата создания соединения.

Возвращается: success

Пример: "2014-12-01T14:57:57+0100"

domain

string

Домен, к которому относится VPN-соединение.

Возвращается: success

Пример: "example domain"

dpd

boolean

Включена ли проверка отсутствия связи (dead peer detection) или нет.

Возвращается: success

Пример: true

esp_lifetime

integer

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

Возвращается: success

Пример: 86400

esp_policy

string

Политика IKE VPN-соединения.

Возвращается: success

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

force_encap

boolean

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

Возвращается: success

Пример: true

gateway

string

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

Возвращается: success

Пример: "10.101.214.10"

id

string

UUID VPN-соединения.

Возвращается: success

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

ike_lifetime

integer

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

Возвращается: success

Пример: 86400

ike_policy

string

Политика ESP VPN-соединения.

Возвращается: success

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

passive

boolean

Является ли соединение пассивным или нет.

Возвращается: success

Пример: false

project

string

Название проекта, к которому относится VPN-соединение.

Возвращается: success

Пример: "Production"

public_ip

string

IP-адрес VPN-шлюза.

Возвращается: success

Пример: "10.100.212.10"

state

string

Состояние VPN-соединения.

Возвращается: success

Пример: "Connected"

vpn_gateway_id

string

UUID VPN-шлюза.

Возвращается: success

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

Авторы

  • 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_connection_module.html

Spec-Zone.ru

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