gcp_compute_target_vpn_gateway – Creates a GCP TargetVpnGateway
New in version 2.7.
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
Parameter | Choices/Defaults | Comments |
---|---|---|
auth_kind - / required |
| The type of credential used. |
description - | An optional description of this resource. | |
name - / required | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | |
network - / required | The network this VPN gateway is accepting traffic for. | |
project - | Default: null | The Google Cloud Platform project to use. |
region - / required | The region this gateway should sit in. | |
scopes - | Array of scopes to be used. | |
service_account_email - | An optional service account email address if machineaccount is selected and the user does not wish to use the default email. | |
service_account_file - | The path of a Service Account JSON file if serviceaccount is selected as type. | |
state - |
| Whether the given object should exist in GCP |
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_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 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 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 gcp_compute_target_vpn_gateway: name: "test_object" region: us-west1 network: "{{ network }}" project: "test_project" auth_kind: "service_account" 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:
Key | Returned | Description |
---|---|---|
creation_timestamp string | success | Creation timestamp in RFC3339 text format. |
description string | success | An optional description of this resource. |
forwarding_rules list | success | A list of references to the ForwardingRule resources associated to this VPN gateway. |
id integer | success | The unique identifier for the resource. |
name string | success | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. |
network dictionary | success | The network this VPN gateway is accepting traffic for. |
region string | success | The region this gateway should sit in. |
tunnels list | success | A list of references to VpnTunnel resources associated to this VPN gateway. |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Google Inc. (@googlecloudplatform)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 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_target_vpn_gateway_module.html