ec2_vpc_vpn - Создание, изменение и удаление подключений EC2 VPN.
Новая версия 2.4.
- Описание
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
Описание
- Этот модуль создаёт, изменяет и удаляет VPN-соединения. Идемпотентность достигается с помощью параметра фильтров или указания идентификатора VPN-соединения.
Требования (к хосту, на котором выполняется модуль)
- boto3
- botocore
Параметры
| Параметр | Обязателен | Значение по умолчанию | Варианты | Комментарии | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| connection_type | нет | ipsec.1 |
| Тип VPN-соединения. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| customer_gateway_id | нет | ID шлюза клиента. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| filters | нет | Альтернатива использованию vpn_connection_id. Если найдено несколько совпадений, требуется vpn_connection_id. Если один из следующих подпараметров является списком элементов для фильтрации, достаточно соответствия одному элементу для нахождения соответствующего VPN-соединения. Например, если фильтр 'cidr' имеет значения ['194.168.2.0/24', '192.168.2.0/24'], а маршрут VPN содержит только целевой блок CIDR '192.168.2.0/24', он будет найден с помощью этого фильтра (при условии, что нет нескольких VPN, соответствующих этому фильтру). Другой пример, если фильтр 'vpn' равен ['vpn-ccf7e7ad', 'vpn-cb0ae2a2'] и одно из VPN-соединений имеет состояние удаленного (существует, но не может быть изменено), а другое существует и не удалено, оно будет найдено с помощью этого фильтра. См. примеры. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| purge_routes | нет | Удалять ли маршруты VPN-соединений, не указанные в задаче. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| purge_tags | нет |
| Удалять ли теги VPN-соединений, связанные с соединением, но не указанные в задаче. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| routes | нет | Маршруты для добавления в соединение. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| state | нет | present |
| Желаемое состояние VPN-соединения. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| static_only | нет | Указывает, использует ли VPN-соединение только статические маршруты. Статические маршруты должны использоваться для устройств, не поддерживающих BGP. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| tags | нет | Теги для прикрепления к VPN-соединению. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| vpn_connection_id | нет | Идентификатор VPN-соединения. Требуется для изменения или удаления соединения, если параметр filters не предоставляет уникального совпадения. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| vpn_gateway_id | нет | Идентификатор виртуального частного шлюза. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Примеры
# Note: None of these examples set aws_access_key, aws_secret_key, or region.
# It is assumed that their matching environment variables are set.
- name: create a VPN connection
ec2_vpc_vpn:
state: present
vpn_gateway_id: vgw-XXXXXXXX
customer_gateway_id: cgw-XXXXXXXX
- name: modify VPN connection tags
ec2_vpc_vpn:
state: present
vpn_connection_id: vpn-XXXXXXXX
tags:
Name: ansible-tag-1
Other: ansible-tag-2
- name: delete a connection
ec2_vpc_vpn:
vpn_connection_id: vpn-XXXXXXXX
state: absent
- name: modify VPN tags (identifying VPN by filters)
ec2_vpc_vpn:
state: present
filters:
cidr: 194.168.1.0/24
tag-keys:
- Ansible
- Other
tags:
New: Tag
purge_tags: true
static_only: true
- name: add routes and remove any preexisting ones
ec2_vpc_vpn:
state: present
filters:
vpn: vpn-XXXXXXXX
routes:
- 195.168.2.0/24
- 196.168.2.0/24
purge_routes: true
- name: remove all routes
ec2_vpc_vpn:
state: present
vpn_connection_id: vpn-XXXXXXXX
routes: []
purge_routes: true
- name: delete a VPN identified by filters
ec2_vpc_vpn:
state: absent
filters:
tags:
Ansible: Tag
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для этого модуля:
| Имя | Описание | Возвращается | Тип | Пример | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| changed | Если VPN-соединение изменилось. | всегда | bool | {'changed': True} | ||||||||||
| customer_gateway_configuration | Конфигурация VPN-соединения. | I(state=present) | str | |||||||||||
| customer_gateway_id | Шлюз клиента, подключенный через соединение. | I(state=present) | str | {'customer_gateway_id': 'cgw-1220c87b'} | ||||||||||
| options | Параметры VPN-соединения (в настоящее время содержит только static_routes_only). | I(state=present) | сложный | |||||||||||
| contains: |
| |||||||||||||
| routes | Маршруты VPN-соединения. | I(state=present) | список | {'routes': [{'state': 'available', 'destination_cidr_block': '192.168.1.0/24'}]} | ||||||||||
| state | Статус VPN-соединения. | I(state=present) | строка | {'state': 'available'} | ||||||||||
| tags | Теги, связанные с соединением. | I(state=present) | словарь | {'tags': {'other': 'тег', 'name': 'ansible-test'}} | ||||||||||
| type | Тип VPN-соединения (в настоящее время доступен только ipsec.1). | I(state=present) | str | {'type': 'ipsec.1'} | ||||||||||
| vgw_telemetry | Телеметрия VPN-туннеля. | I(state=present) | список | {'vgw_telemetry': [{'status': 'up', 1: None, 'last_status_change': 'datetime(2015', 'outside_ip_address': 'строка', '1)': None, 'status_message': 'строка', 'accepted_route_count': 123}]} | ||||||||||
| vpn_connection_id | Идентификатор VPN-соединения. | I(state=present) | str | {'vpn_connection_id': 'vpn-781e0e19'} | ||||||||||
| vpn_gateway_id | Виртуальный частный шлюз, подключенный через соединение. | I(state=present) | str | {'vpn_gateway_id': 'vgw-cb0ae2a2'} | ||||||||||
Статус
Этот модуль помечен как preview, что означает, что он не гарантирует обратной совместимости интерфейса.
Для получения помощи в разработке модулей, если вам это нужно, пожалуйста, прочитайте Справочная информация сообщества и участие, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/ec2_vpc_vpn_module.html
