cs_vpn_gateway - Управляет шлюзами VPN "сайт-сайт" в облаках на базе Apache CloudStack.
Новая версия 2.4.
Описание
- Создаёт и удаляет шлюзы VPN "сайт-сайт".
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- cs >= 0.6.10
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| account | Аккаунт, к которому относится шлюз VPN. | |
| api_http_method |
| Метод 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 bool |
| Проверять асинхронные задания, пока задание не завершится. |
| project | Название проекта, к которому относится шлюз VPN. | |
| state |
| Состояние шлюза VPN. |
| vpc обязательно | Имя VPC. | |
| zone | Имя зоны, к которой относится VPC. Если не указано, используется зона по умолчанию. |
Примечания
Примечание
- Ansible использует метод конфигурации библиотеки
cs, если учетные данные не предоставлены в аргументахapi_url,api_key,api_secret. Конфигурация считывается из нескольких мест в указанном ниже порядке. Переменные средыCLOUDSTACK_ENDPOINT,CLOUDSTACK_KEY,CLOUDSTACK_SECRETиCLOUDSTACK_METHOD.CLOUDSTACK_TIMEOUTпеременная среды, указывающая на файл.ini. Файлcloudstack.iniв текущей рабочей директории. Файл.cloudstack.iniв домашней директории пользователя. Можно указать несколько учетных данных и конечных точек, используя разделы ini вcloudstack.ini. Используйте аргументapi_regionдля выбора имени раздела, по умолчанию используется разделcloudstack. Более подробную информацию см. на https://github.com/exoscale/cs. - Подробное руководство по модулям cloudstack можно найти в руководстве по облаку 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. Более подробную информацию см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, которые также поддерживаются сообществом 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.6/modules/cs_vpn_gateway_module.html