google.cloud.gcp_compute_target_vpn_gateway – Creates a GCP TargetVpnGateway¶
Note
This plugin is part of the google.cloud collection (version 1.0.2).
To install it use: ansible-galaxy collection install google.cloud
.
To use it in a playbook, specify: google.cloud.gcp_compute_target_vpn_gateway
.
Synopsis¶
Represents a VPN gateway running in GCP. This virtual device is managed by Google, but used only by you.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0
Parameters¶
Notes¶
Note
API Reference: https://cloud.google.com/compute/docs/reference/rest/v1/targetVpnGateways
for authentication, you can set service_account_file using the
gcp_service_account_file
env variable.for authentication, you can set service_account_contents using the
GCP_SERVICE_ACCOUNT_CONTENTS
env variable.For authentication, you can set service_account_email using the
GCP_SERVICE_ACCOUNT_EMAIL
env variable.For authentication, you can set auth_kind using the
GCP_AUTH_KIND
env variable.For authentication, you can set scopes using the
GCP_SCOPES
env variable.Environment variables values will only be used if the playbook values are not set.
The service_account_email and service_account_file options are mutually exclusive.
Examples¶
- name: create a address
google.cloud.gcp_compute_address:
name: address-vpngateway
region: us-west1
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
state: present
register: address
- name: create a network
google.cloud.gcp_compute_network:
name: network-vpngateway
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
state: present
register: network
- name: create a target vpn gateway
google.cloud.gcp_compute_target_vpn_gateway:
name: test_object
region: us-west1
network: "{{ network }}"
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Google Inc. (@googlecloudplatform)