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

Примечание

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

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

Для использования в книге задач укажите: ngine_io.cloudstack.cs_vpn_gateway.

Новое в версии 0.1.0: of 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-ключ CloudStack API. Если не задано, рассматривается переменная среды `CLOUDSTACK_KEY`. В качестве последнего варианта значение берется из файла конфигурации ini, также см. примечания.
api_region строка	По умолчанию: "cloudstack"	Имя раздела ini в файле `cloustack.ini`. Если не задано, рассматривается переменная среды `CLOUDSTACK_REGION`.
api_secret строка		Секретный ключ CloudStack API. Если не задано, рассматривается переменная среды `CLOUDSTACK_SECRET`. В качестве последнего варианта значение берется из файла конфигурации ini, также см. примечания.
api_timeout целое число		Таймаут HTTP в секундах. Если не задано, рассматривается переменная среды `CLOUDSTACK_TIMEOUT`. В качестве последнего варианта значение берется из файла конфигурации ini, также см. примечания. Значение по умолчанию — 10 секунд при отсутствии указания.
api_url строка		URL CloudStack API, например https://cloud.example.com/client/api. Если не задано, рассматривается переменная среды `CLOUDSTACK_ENDPOINT`. В качестве последнего варианта значение берется из файла конфигурации ini, также см. примечания.
api_verify_ssl_cert строка		Файл сертификата CA. Если не задано, рассматривается переменная среды `CLOUDSTACK_VERIFY`. В качестве последнего варианта значение берется из файла конфигурации ini, также см. примечания. Значение по умолчанию — `null` при отсутствии указания.
domain строка		Домен, к которому относится шлюз VPN.
poll_async булево	Варианты: 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.
Этот модуль поддерживает режим проверки.

Примеры

- name: Ensure a vpn gateway is present
  ngine_io.cloudstack.cs_vpn_gateway:
    vpc: my VPC

- name: Ensure a vpn gateway is absent
  ngine_io.cloudstack.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.10/collections/ngine_io/cloudstack/cs_vpn_gateway_module.html