gcp_compute_vpn_tunnel – Создаёт туннель VPN GCP
Новая версия с 2.7.
Синопсис
- Ресурс туннеля VPN.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind - / обязательно |
| Тип используемых учетных данных. |
| description - | Необязательное описание этого ресурса. | |
| ike_version - | Значение по умолчанию: 2 | Версия протокола IKE, используемая при установлении туннеля VPN с соседним шлюзом VPN. Допустимые версии IKE: 1 или 2. По умолчанию версия 2. |
| labels - | Метки, применяемые к этому VpnTunnel. | |
| local_traffic_selector - | Локальный селектор трафика, используемый при установлении туннеля VPN с соседним шлюзом VPN. Значение должно быть строкой в формате CIDR, например, `192.168.0.0/16`. Диапазоны должны быть непересекающимися. Поддерживается только IPv4. | |
| name - / обязательно | Имя ресурса. Длина имени должна составлять от 1 до 63 символов и соответствовать RFC1035. Точнее, длина имени должна составлять от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | |
| peer_ip - / обязательно | IP-адрес соседнего шлюза VPN. Поддерживается только IPv4. | |
| project - | Значение по умолчанию: null | Проект Google Cloud Platform, который нужно использовать. |
| region - / обязательно | Регион расположения туннеля. | |
| remote_traffic_selector - | Удаленный селектор трафика, используемый при установлении туннеля VPN с соседним шлюзом VPN. Значение должно быть строкой в формате CIDR, например, `192.168.0.0/16`. Диапазоны должны быть непересекающимися. Поддерживается только IPv4. | |
| router - | URL ресурса маршрутизатора, используемого для динамической маршрутизации. | |
| scopes - | Массив используемых областей. | |
| service_account_email - | Необязательный адрес электронной почты учетной записи сервиса, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file - | Путь к файлу JSON учетной записи сервиса, если в качестве типа выбран serviceaccount. | |
| shared_secret - / обязательно | Секретный ключ, используемый для настройки защищенного сеанса между шлюзом Cloud VPN и соседним шлюзом VPN. | |
| state - |
| Необходимо ли, чтобы заданный объект существовал в GCP |
| target_vpn_gateway - / обязательно | URL целевого шлюза VPN, с которым связан этот туннель VPN. |
Примечания
Примечание
- Ссылка на API: https://cloud.google.com/compute/docs/reference/rest/v1/vpnTunnels
- Обзор Cloud VPN: https://cloud.google.com/vpn/docs/concepts/overview
- Сети и маршрутизация туннелей: https://cloud.google.com/vpn/docs/concepts/choosing-networks-routing
- Для аутентификации можно установить service_account_file с помощью переменной среды
GCP_SERVICE_ACCOUNT_FILE. - Для аутентификации можно установить service_account_email с помощью переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно установить auth_kind с помощью переменной среды
GCP_AUTH_KIND. - Для аутентификации можно установить scopes с помощью переменной среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: create a network
gcp_compute_network:
name: "network-vpn_tunnel"
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
state: present
register: network
- name: create a router
gcp_compute_router:
name: "router-vpn_tunnel"
network: "{{ network }}"
bgp:
asn: 64514
advertise_mode: CUSTOM
advertised_groups:
- ALL_SUBNETS
advertised_ip_ranges:
- range: 1.2.3.4
- range: 6.7.0.0/16
region: us-central1
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
state: present
register: router
- name: create a target vpn gateway
gcp_compute_target_vpn_gateway:
name: "gateway-vpn_tunnel"
region: us-west1
network: "{{ network }}"
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
state: present
register: gateway
- name: create a vpn tunnel
gcp_compute_vpn_tunnel:
name: "test_object"
region: us-west1
target_vpn_gateway: "{{ gateway }}"
router: "{{ router }}"
shared_secret: super secret
project: "test_project"
auth_kind: "service_account"
service_account_file: "/tmp/auth.pem"
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| creation_timestamp строка | успех | Дата и время создания в формате RFC3339. |
| description строка | успех | Необязательное описание этого ресурса. |
| ike_version целое число | успех | Версия протокола IKE, используемая при установлении туннеля VPN с соседним шлюзом VPN. Допустимые версии IKE: 1 или 2. По умолчанию версия 2. |
| labels словарь | успех | Метки, применяемые к этому VpnTunnel. |
| local_traffic_selector список | успех | Локальный селектор трафика, используемый при установлении туннеля VPN с соседним шлюзом VPN. Значение должно быть строкой в формате CIDR, например, `192.168.0.0/16`. Диапазоны должны быть непересекающимися. Поддерживается только IPv4. |
| name строка | успех | Имя ресурса. Длина имени должна составлять от 1 до 63 символов и соответствовать RFC1035. Точнее, длина имени должна составлять от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. |
| peer_ip строка | успех | IP-адрес соседнего шлюза VPN. Поддерживается только IPv4. |
| region строка | успех | Регион расположения туннеля. |
| remote_traffic_selector список | успех | Удаленный селектор трафика, используемый при установлении туннеля VPN с соседним шлюзом VPN. Значение должно быть строкой в формате CIDR, например, `192.168.0.0/16`. Диапазоны должны быть непересекающимися. Поддерживается только IPv4. |
| router строка | успех | URL ресурса маршрутизатора, используемого для динамической маршрутизации. |
| shared_secret строка | успех | Секретный ключ, используемый для настройки защищенного сеанса между шлюзом Cloud VPN и соседним шлюзом VPN. |
| shared_secret_hash строка | успех | Хэш секретного ключа. |
| target_vpn_gateway словарь | успех | URL целевого шлюза VPN, с которым связан этот туннель VPN. |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Google Inc. (@googlecloudplatform)
Подсказка
Если вы заметите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/gcp_compute_vpn_tunnel_module.html