Spec-Zone.ru › Ansible 2.10

ngine_io.cloudstack.cs_vpn_connection – Управляет VPN-соединениями «сайт-сайт» на облаках, основанных на Apache CloudStack.

Примечание

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

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

Для использования в плейбуке укажите: ngine_io.cloudstack.cs_vpn_connection.

В версии 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, если не указано.
domain
строка
Домен, к которому относится VPN-соединение.
force
булево
    Варианты:
  • нет ←
  • да
Активировать шлюз VPN, если он еще не активирован при state=present.
См. также cs_vpn_gateway.
passive
булево
    Варианты:
  • нет ←
  • да
Состояние VPN-соединения.
Рассматривается только при state=present.
poll_async
булево
    Варианты:
  • нет
  • да ←
Опрос асинхронных задач до завершения работы задачи.
project
строка
Название проекта, к которому относится VPN-соединение.
state
строка
    Варианты:
  • present ←
  • absent
Состояние VPN-соединения.
vpc
строка / обязательно
Название VPC, к которому относится VPN-соединение.
vpn_customer_gateway
строка / обязательно
Название VPN-клиентского шлюза.
zone
строка
Имя зоны, к которой относится VPC.
Если не задано, используется зона по умолчанию.

Примечания

Примечание

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

- 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
    force: yes

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

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

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

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

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

Пример:
['10.10.10.0/24']
created
строка
успех
Дата создания соединения.

Пример:
2014-12-01T14:57:57+0100
domain
строка
успех
Домен, к которому относится VPN-соединение.

Пример:
домен пример
dpd
булево
успех
Включена ли проверка отсутствия ответа (dead pear detection).

Пример:
True
esp_lifetime
целое число
успех
Срок действия (в секундах) VPN-соединения фазы 2.

Пример:
86400
esp_policy
строка
успех
Политика IKE VPN-соединения.

Пример:
aes256-sha1;modp1536
force_encap
булево
успех
Принудительно ли настраивается инкапсуляция для прохождения NAT?

Пример:
True
gateway
строка
успех
IP-адрес VPN-клиентского шлюза.

Пример:
10.101.214.10
id
строка
успех
UUID VPN-соединения.

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

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

Пример:
aes256-sha1;modp1536
passive
булево
успех
Соединение пассивное или нет.
project
строка
успех
Название проекта, к которому относится VPN-соединение.

Пример:
Производство
public_ip
строка
успех
IP-адрес VPN-шлюза.

Пример:
10.100.212.10
state
строка
успех
Состояние VPN-соединения.

Пример:
Подключено
vpn_gateway_id
строка
успех
UUID VPN-шлюза.

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


Авторы

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

Spec-Zone.ru

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