mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-06-18 14:21:06 -07:00
Alex Stephen
John R Barker
parent
c7c3ca1c41
commit
5ad5677b71
80 changed files with 14198 additions and 13862 deletions
|
|
@ -32,92 +32,94 @@ DOCUMENTATION = '''
|
|||
---
|
||||
module: gcp_compute_vpn_tunnel
|
||||
description:
|
||||
- VPN tunnel resource.
|
||||
- VPN tunnel resource.
|
||||
short_description: Creates a GCP VpnTunnel
|
||||
version_added: 2.7
|
||||
author: Google Inc. (@googlecloudplatform)
|
||||
requirements:
|
||||
- python >= 2.6
|
||||
- requests >= 2.18.4
|
||||
- google-auth >= 1.3.0
|
||||
- python >= 2.6
|
||||
- requests >= 2.18.4
|
||||
- google-auth >= 1.3.0
|
||||
options:
|
||||
state:
|
||||
description:
|
||||
- Whether the given object should exist in GCP
|
||||
choices: ['present', 'absent']
|
||||
default: 'present'
|
||||
name:
|
||||
description:
|
||||
- Name of the resource. 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.
|
||||
required: true
|
||||
state:
|
||||
description:
|
||||
description:
|
||||
- An optional description of this resource.
|
||||
required: false
|
||||
target_vpn_gateway:
|
||||
description:
|
||||
- URL of the Target VPN gateway with which this VPN tunnel is associated.
|
||||
- 'This field represents a link to a TargetVpnGateway resource in GCP. It can be specified
|
||||
in two ways. You can add `register: name-of-resource` to a gcp_compute_target_vpn_gateway
|
||||
task and then set this target_vpn_gateway field to "{{ name-of-resource }}" Alternatively,
|
||||
you can set this target_vpn_gateway to a dictionary with the selfLink key where
|
||||
the value is the selfLink of your TargetVpnGateway.'
|
||||
required: true
|
||||
router:
|
||||
description:
|
||||
- URL of router resource to be used for dynamic routing.
|
||||
- 'This field represents a link to a Router resource in GCP. It can be specified in
|
||||
two ways. You can add `register: name-of-resource` to a gcp_compute_router task
|
||||
and then set this router field to "{{ name-of-resource }}" Alternatively, you can
|
||||
set this router to a dictionary with the selfLink key where the value is the selfLink
|
||||
of your Router.'
|
||||
required: false
|
||||
peer_ip:
|
||||
description:
|
||||
- IP address of the peer VPN gateway. Only IPv4 is supported.
|
||||
required: true
|
||||
shared_secret:
|
||||
description:
|
||||
- Shared secret used to set the secure session between the Cloud VPN gateway and the
|
||||
peer VPN gateway.
|
||||
required: true
|
||||
ike_version:
|
||||
description:
|
||||
- IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway.
|
||||
- Acceptable IKE versions are 1 or 2. Default version is 2.
|
||||
required: false
|
||||
default: 2
|
||||
local_traffic_selector:
|
||||
description:
|
||||
- Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway.
|
||||
The value should be a CIDR formatted string, for example `192.168.0.0/16`. The ranges
|
||||
should be disjoint.
|
||||
- Only IPv4 is supported.
|
||||
required: false
|
||||
remote_traffic_selector:
|
||||
description:
|
||||
- Remote traffic selector to use when establishing the VPN tunnel with peer VPN gateway.
|
||||
The value should be a CIDR formatted string, for example `192.168.0.0/16`. The ranges
|
||||
should be disjoint.
|
||||
- Only IPv4 is supported.
|
||||
required: false
|
||||
labels:
|
||||
description:
|
||||
- Labels to apply to this VpnTunnel.
|
||||
required: false
|
||||
region:
|
||||
description:
|
||||
- The region where the tunnel is located.
|
||||
required: true
|
||||
- Whether the given object should exist in GCP
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
default: present
|
||||
name:
|
||||
description:
|
||||
- Name of the resource. 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.
|
||||
required: true
|
||||
description:
|
||||
description:
|
||||
- An optional description of this resource.
|
||||
required: false
|
||||
target_vpn_gateway:
|
||||
description:
|
||||
- URL of the Target VPN gateway with which this VPN tunnel is associated.
|
||||
- 'This field represents a link to a TargetVpnGateway resource in GCP. It can
|
||||
be specified in two ways. You can add `register: name-of-resource` to a gcp_compute_target_vpn_gateway
|
||||
task and then set this target_vpn_gateway field to "{{ name-of-resource }}"
|
||||
Alternatively, you can set this target_vpn_gateway to a dictionary with the
|
||||
selfLink key where the value is the selfLink of your TargetVpnGateway'
|
||||
required: true
|
||||
router:
|
||||
description:
|
||||
- URL of router resource to be used for dynamic routing.
|
||||
- 'This field represents a link to a Router resource in GCP. It can be specified
|
||||
in two ways. You can add `register: name-of-resource` to a gcp_compute_router
|
||||
task and then set this router field to "{{ name-of-resource }}" Alternatively,
|
||||
you can set this router to a dictionary with the selfLink key where the value
|
||||
is the selfLink of your Router'
|
||||
required: false
|
||||
peer_ip:
|
||||
description:
|
||||
- IP address of the peer VPN gateway. Only IPv4 is supported.
|
||||
required: true
|
||||
shared_secret:
|
||||
description:
|
||||
- Shared secret used to set the secure session between the Cloud VPN gateway and
|
||||
the peer VPN gateway.
|
||||
required: true
|
||||
ike_version:
|
||||
description:
|
||||
- IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway.
|
||||
- Acceptable IKE versions are 1 or 2. Default version is 2.
|
||||
required: false
|
||||
default: '2'
|
||||
local_traffic_selector:
|
||||
description:
|
||||
- Local traffic selector to use when establishing the VPN tunnel with peer VPN
|
||||
gateway. The value should be a CIDR formatted string, for example `192.168.0.0/16`.
|
||||
The ranges should be disjoint.
|
||||
- Only IPv4 is supported.
|
||||
required: false
|
||||
remote_traffic_selector:
|
||||
description:
|
||||
- Remote traffic selector to use when establishing the VPN tunnel with peer VPN
|
||||
gateway. The value should be a CIDR formatted string, for example `192.168.0.0/16`.
|
||||
The ranges should be disjoint.
|
||||
- Only IPv4 is supported.
|
||||
required: false
|
||||
labels:
|
||||
description:
|
||||
- Labels to apply to this VpnTunnel.
|
||||
required: false
|
||||
region:
|
||||
description:
|
||||
- The region where the tunnel is located.
|
||||
required: true
|
||||
extends_documentation_fragment: gcp
|
||||
notes:
|
||||
- "API Reference: U(https://cloud.google.com/compute/docs/reference/rest/v1/vpnTunnels)"
|
||||
- "Cloud VPN Overview: U(https://cloud.google.com/vpn/docs/concepts/overview)"
|
||||
- "Networks and Tunnel Routing: U(https://cloud.google.com/vpn/docs/concepts/choosing-networks-routing)"
|
||||
- 'API Reference: U(https://cloud.google.com/compute/docs/reference/rest/v1/vpnTunnels)'
|
||||
- 'Cloud VPN Overview: U(https://cloud.google.com/vpn/docs/concepts/overview)'
|
||||
- 'Networks and Tunnel Routing: U(https://cloud.google.com/vpn/docs/concepts/choosing-networks-routing)'
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
|
|
@ -174,89 +176,89 @@ EXAMPLES = '''
|
|||
'''
|
||||
|
||||
RETURN = '''
|
||||
creationTimestamp:
|
||||
description:
|
||||
- Creation timestamp in RFC3339 text format.
|
||||
returned: success
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the resource. 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.
|
||||
returned: success
|
||||
type: str
|
||||
description:
|
||||
description:
|
||||
- An optional description of this resource.
|
||||
returned: success
|
||||
type: str
|
||||
targetVpnGateway:
|
||||
description:
|
||||
- URL of the Target VPN gateway with which this VPN tunnel is associated.
|
||||
returned: success
|
||||
type: dict
|
||||
router:
|
||||
description:
|
||||
- URL of router resource to be used for dynamic routing.
|
||||
returned: success
|
||||
type: dict
|
||||
peerIp:
|
||||
description:
|
||||
- IP address of the peer VPN gateway. Only IPv4 is supported.
|
||||
returned: success
|
||||
type: str
|
||||
sharedSecret:
|
||||
description:
|
||||
- Shared secret used to set the secure session between the Cloud VPN gateway and the
|
||||
peer VPN gateway.
|
||||
returned: success
|
||||
type: str
|
||||
sharedSecretHash:
|
||||
description:
|
||||
- Hash of the shared secret.
|
||||
returned: success
|
||||
type: str
|
||||
ikeVersion:
|
||||
description:
|
||||
- IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway.
|
||||
- Acceptable IKE versions are 1 or 2. Default version is 2.
|
||||
returned: success
|
||||
type: int
|
||||
localTrafficSelector:
|
||||
description:
|
||||
- Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway.
|
||||
The value should be a CIDR formatted string, for example `192.168.0.0/16`. The ranges
|
||||
should be disjoint.
|
||||
- Only IPv4 is supported.
|
||||
returned: success
|
||||
type: list
|
||||
remoteTrafficSelector:
|
||||
description:
|
||||
- Remote traffic selector to use when establishing the VPN tunnel with peer VPN gateway.
|
||||
The value should be a CIDR formatted string, for example `192.168.0.0/16`. The ranges
|
||||
should be disjoint.
|
||||
- Only IPv4 is supported.
|
||||
returned: success
|
||||
type: list
|
||||
labels:
|
||||
description:
|
||||
- Labels to apply to this VpnTunnel.
|
||||
returned: success
|
||||
type: dict
|
||||
labelFingerprint:
|
||||
description:
|
||||
- The fingerprint used for optimistic locking of this resource. Used internally during
|
||||
updates.
|
||||
returned: success
|
||||
type: str
|
||||
region:
|
||||
description:
|
||||
- The region where the tunnel is located.
|
||||
returned: success
|
||||
type: str
|
||||
creationTimestamp:
|
||||
description:
|
||||
- Creation timestamp in RFC3339 text format.
|
||||
returned: success
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the resource. 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.
|
||||
returned: success
|
||||
type: str
|
||||
description:
|
||||
description:
|
||||
- An optional description of this resource.
|
||||
returned: success
|
||||
type: str
|
||||
targetVpnGateway:
|
||||
description:
|
||||
- URL of the Target VPN gateway with which this VPN tunnel is associated.
|
||||
returned: success
|
||||
type: dict
|
||||
router:
|
||||
description:
|
||||
- URL of router resource to be used for dynamic routing.
|
||||
returned: success
|
||||
type: dict
|
||||
peerIp:
|
||||
description:
|
||||
- IP address of the peer VPN gateway. Only IPv4 is supported.
|
||||
returned: success
|
||||
type: str
|
||||
sharedSecret:
|
||||
description:
|
||||
- Shared secret used to set the secure session between the Cloud VPN gateway and
|
||||
the peer VPN gateway.
|
||||
returned: success
|
||||
type: str
|
||||
sharedSecretHash:
|
||||
description:
|
||||
- Hash of the shared secret.
|
||||
returned: success
|
||||
type: str
|
||||
ikeVersion:
|
||||
description:
|
||||
- IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway.
|
||||
- Acceptable IKE versions are 1 or 2. Default version is 2.
|
||||
returned: success
|
||||
type: int
|
||||
localTrafficSelector:
|
||||
description:
|
||||
- Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway.
|
||||
The value should be a CIDR formatted string, for example `192.168.0.0/16`. The
|
||||
ranges should be disjoint.
|
||||
- Only IPv4 is supported.
|
||||
returned: success
|
||||
type: list
|
||||
remoteTrafficSelector:
|
||||
description:
|
||||
- Remote traffic selector to use when establishing the VPN tunnel with peer VPN
|
||||
gateway. The value should be a CIDR formatted string, for example `192.168.0.0/16`.
|
||||
The ranges should be disjoint.
|
||||
- Only IPv4 is supported.
|
||||
returned: success
|
||||
type: list
|
||||
labels:
|
||||
description:
|
||||
- Labels to apply to this VpnTunnel.
|
||||
returned: success
|
||||
type: dict
|
||||
labelFingerprint:
|
||||
description:
|
||||
- The fingerprint used for optimistic locking of this resource. Used internally
|
||||
during updates.
|
||||
returned: success
|
||||
type: str
|
||||
region:
|
||||
description:
|
||||
- The region where the tunnel is located.
|
||||
returned: success
|
||||
type: str
|
||||
'''
|
||||
|
||||
################################################################################
|
||||
|
|
@ -477,8 +479,6 @@ def wait_for_completion(status, op_result, module):
|
|||
while status != 'DONE':
|
||||
raise_if_errors(op_result, ['error', 'errors'], 'message')
|
||||
time.sleep(1.0)
|
||||
if status not in ['PENDING', 'RUNNING', 'DONE']:
|
||||
module.fail_json(msg="Invalid result %s" % status)
|
||||
op_result = fetch_resource(module, op_uri, 'compute#operation')
|
||||
status = navigate_hash(op_result, ['status'])
|
||||
return op_result
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue