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

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

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

Обзор

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

Требования

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

python >= 2.6
cs >= 0.6.10

Параметры

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

Примеры

# 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 строка	успех	Учётная запись, к которой относится шлюз VPN сайт-сайт. Пример: пример учётной записи
domain строка	успех	Домен, к которому относится шлюз VPN сайт-сайт. Пример: пример домена
id строка	успех	UUID шлюза VPN сайт-сайт. Пример: 04589590-ac63-4ffc-93f5-b698b8ac38b6
project строка	успех	Имя проекта, к которому относится шлюз VPN сайт-сайт. Пример: Производство
public_ip строка	успех	IP-адрес шлюза VPN сайт-сайт. Пример: 10.100.212.10
vpc строка	успех	Имя VPC. Пример: Моя VPC

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

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