cs_vpn_gateway — Управляет шлюзами VPN между сайтами в облаках на основе Apache CloudStack.

Новая версия 2.4.

Обзор
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
- Автор

Обзор

Создаёт и удаляет шлюзы VPN между сайтами.

Требования

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

python >= 2.6
cs >= 0.6.10

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
account	Значение по умолчанию: None	Аккаунт, к которому относится шлюз 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, см. также раздел примечаний.
domain	Значение по умолчанию: None	Домен, к которому относится шлюз VPN.
poll_async	Значение по умолчанию: yes	Опрашивать асинхронные задачи до завершения.
project	Значение по умолчанию: None	Имя проекта, к которому относится шлюз VPN.
state	Варианты: present ← absent	Состояние шлюза VPN.
vpc обязательно		Имя VPC.
zone	Значение по умолчанию: None	Имя зоны, к которой относится 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.
Этот модуль поддерживает режим проверки.

Примеры

# Ensure a vpn gateway is present
- local_action:
    module: cs_vpn_gateway
    vpc: my VPC

# Ensure a vpn gateway is absent
- local_action:
    module: cs_vpn_gateway
    vpc: my VPC
    state: absent

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

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

Ключ	Возвращаемое значение	Описание
account строка	success	Аккаунт, к которому относится шлюз VPN между сайтами. Пример: example account
domain строка	success	Домен, к которому относится шлюз VPN между сайтами. Пример: example domain
id строка	success	UUID шлюза VPN между сайтами. Пример: 04589590-ac63-4ffc-93f5-b698b8ac38b6
project строка	success	Имя проекта, к которому относится шлюз VPN между сайтами. Пример: Production
public_ip строка	success	IP-адрес шлюза VPN между сайтами. Пример: 10.100.212.10
vpc строка	success	Имя VPC. Пример: My VPC

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантированно будет совместим со старыми версиями.

Автор

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.5/modules/cs_vpn_gateway_module.html