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 логическое	Варианты: нет да ←	Опрашивать асинхронные задачи, пока задача не завершится.
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
  cs_vpn_gateway:
    vpc: my VPC
  delegate_to: localhost

- name: Ensure a vpn gateway is absent
  cs_vpn_gateway:
    vpc: my VPC
    state: absent
  delegate_to: localhost

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

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

Ключ	Возвращаемое значение	Описание
account строка	успех	Аккаунт, к которому относится шлюз VPN «сайт-сайт». Пример: example account
domain строка	успех	Домен, к которому относится шлюз VPN «сайт-сайт». Пример: example domain
id строка	успех	UUID шлюза VPN «сайт-сайт». Пример: 04589590-ac63-4ffc-93f5-b698b8ac38b6
project строка	успех	Название проекта, к которому относится шлюз VPN «сайт-сайт». Пример: Production
public_ip строка	успех	IP-адрес шлюза VPN «сайт-сайт». Пример: 10.100.212.10
vpc строка	успех	Имя VPC. Пример: My 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.9/modules/cs_vpn_gateway_module.html