ansible-collections/google.cloud
1
0
Fork 0
mirror of https://github.com/ansible-collections/google.cloud.git synced 2025-04-06 02:40:29 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Better resourceref flexibility (#149)

Browse source 
<!-- This change is generated by MagicModules. -->
/cc @rambleraptor
This commit is contained in:
The Magician 2018-12-14 13:00:18 -08:00 • committed by Alex Stephen
parent 3496923252
commit 982933cfe8
64 changed files with 569 additions and 526 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

126
plugins/module_utils/gcp_utils.py
View file

@ -70,8 +70,7 @@ def replace_resource_dict(item, value):
new_item = ast.literal_eval(item)
return replace_resource_dict(new_item, value)
except ValueError:
return item
return new_item
# Handles all authentication and HTTP sessions for GCP API calls.
class GcpSession(object):
@ -225,12 +224,16 @@ class GcpModule(AnsibleModule):
return new
# This class takes in two dictionaries `a` and `b`.
# These are dictionaries of arbitrary depth, but made up of standard Python
# types only.
# This differ will compare all values in `a` to those in `b`.
# Note: Only keys in `a` will be compared. Extra keys in `b` will be ignored.
# Note: On all lists, order does matter.
# This class does difference checking according to a set of GCP-specific rules.
# This will be primarily used for checking dictionaries.
# In an equivalence check, the left-hand dictionary will be the request and
# the right-hand side will be the response.
# Rules:
# Extra keys in response will be ignored.
# Ordering of lists does not matter.
# - exception: lists of dictionaries are
# assumed to be in sorted order.
class GcpRequest(object):
def __init__(self, request):
self.request = request
@ -241,31 +244,48 @@ class GcpRequest(object):
def __ne__(self, other):
return not self.__eq__(other)
# Returns the difference between `self.request` and `b`
def difference(self, b):
return self._compare_dicts(self.request, b.request)
# Returns the difference between a request + response.
# While this is used under the hood for __eq__ and __ne__,
# it is useful for debugging.
def difference(self, response):
return self._compare_value(self.request, response.request)
def _compare_dicts(self, dict1, dict2):
def _compare_dicts(self, req_dict, resp_dict):
difference = {}
for key in dict1:
difference[key] = self._compare_value(dict1.get(key), dict2.get(key))
for key in req_dict:
if resp_dict.get(key):
difference[key] = self._compare_value(req_dict.get(key), resp_dict.get(key))
# Remove all empty values from difference.
difference2 = {}
sanitized_difference = {}
for key in difference:
if difference[key]:
difference2[key] = difference[key]
sanitized_difference[key] = difference[key]
return difference2
return sanitized_difference
# Takes in two lists and compares them.
def _compare_lists(self, list1, list2):
# All things in the list should be identical (even if a dictionary)
def _compare_lists(self, req_list, resp_list):
# Have to convert each thing over to unicode.
# Python doesn't handle equality checks between unicode + non-unicode well.
difference = []
for index in range(len(list1)):
value1 = list1[index]
if index < len(list2):
value2 = list2[index]
difference.append(self._compare_value(value1, value2))
new_req_list = self._convert_value(req_list)
new_resp_list = self._convert_value(resp_list)
# We have to compare each thing in the request to every other thing
# in the response.
# This is because the request value will be a subset of the response value.
# The assumption is that these lists will be small enough that it won't
# be a performance burden.
for req_item in new_req_list:
found_item = False
for resp_item in new_resp_list:
# Looking for a None value here.
if not self._compare_value(req_item, resp_item):
found_item = True
if not found_item:
difference.append(req_item)
difference2 = []
for value in difference:
@ -274,25 +294,69 @@ class GcpRequest(object):
return difference2
def _compare_value(self, value1, value2):
# Compare two values of arbitrary types.
def _compare_value(self, req_value, resp_value):
diff = None
# If a None is found, a difference does not exist.
# Only differing values matter.
if not value2:
if not resp_value:
return None
# Can assume non-None types at this point.
try:
if isinstance(value1, list):
diff = self._compare_lists(value1, value2)
elif isinstance(value2, dict):
diff = self._compare_dicts(value1, value2)
if isinstance(req_value, list):
diff = self._compare_lists(req_value, resp_value)
elif isinstance(req_value, dict):
diff = self._compare_dicts(req_value, resp_value)
elif isinstance(req_value, bool):
diff = self._compare_boolean(req_value, resp_value)
# Always use to_text values to avoid unicode issues.
elif to_text(value1) != to_text(value2):
diff = value1
elif to_text(req_value) != to_text(resp_value):
diff = req_value
# to_text may throw UnicodeErrors.
# These errors shouldn't crash Ansible and should be hidden.
except UnicodeError:
pass
return diff
# Compare two boolean values.
def _compare_boolean(self, req_value, resp_value):
try:
# Both True
if req_value and isinstance(resp_value, bool) and resp_value:
return None
# Value1 True, resp_value 'true'
elif req_value and to_text(resp_value) == 'true':
return None
# Both False
elif not req_value and isinstance(resp_value, bool) and not resp_value:
return None
# Value1 False, resp_value 'false'
elif not req_value and to_text(resp_value) == 'false':
return None
else:
return resp_value
# to_text may throw UnicodeErrors.
# These errors shouldn't crash Ansible and should be hidden.
except UnicodeError:
return None
# Python (2 esp.) doesn't do comparisons between unicode + non-unicode well.
# This leads to a lot of false positives when diffing values.
# The Ansible to_text() function is meant to get all strings
# into a standard format.
def _convert_value(self, value):
if isinstance(value, list):
new_list = []
for item in value:
new_list.append(self._convert_value(item))
return new_list
elif isinstance(value, dict):
new_dict = {}
for key in value:
new_dict[key] = self._convert_value(value[key])
return new_dict
else:
return to_text(value)

13
plugins/modules/gcp_compute_address.py
View file

@ -101,10 +101,9 @@ options:
- This field can only be used with INTERNAL type with GCE_ENDPOINT/DNS_RESOLVER
purposes.
- 'This field represents a link to a Subnetwork resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_compute_subnetwork
task and then set this subnetwork field to "{{ name-of-resource }}" Alternatively,
you can set this subnetwork to a dictionary with the selfLink key where the
value is the selfLink of your Subnetwork'
in two ways. First, you can place in the selfLink of the resource here as a
string Alternatively, you can add `register: name-of-resource` to a gcp_compute_subnetwork
task and then set this subnetwork field to "{{ name-of-resource }}"'
required: false
version_added: 2.7
region:
@ -182,7 +181,7 @@ subnetwork:
- This field can only be used with INTERNAL type with GCE_ENDPOINT/DNS_RESOLVER
purposes.
returned: success
type: dict
type: str
users:
description:
- The URLs of the resources that are using this address.
@ -220,8 +219,8 @@ def main():
description=dict(type='str'),
name=dict(required=True, type='str'),
network_tier=dict(type='str', choices=['PREMIUM', 'STANDARD']),
subnetwork=dict(type='dict'),
region=dict(required=True, type='str'),
subnetwork=dict(),
region=dict(required=True, type='str')
)
)

2
plugins/modules/gcp_compute_address_facts.py
View file

@ -121,7 +121,7 @@ items:
- This field can only be used with INTERNAL type with GCE_ENDPOINT/DNS_RESOLVER
purposes.
returned: success
type: dict
type: str
users:
description:
- The URLs of the resources that are using this address.

65
plugins/modules/gcp_compute_backend_service.py
View file

@ -96,10 +96,10 @@ options:
- When the BackendService has load balancing scheme INTERNAL, the instance
group must be in a zone within the same region as the BackendService.
- 'This field represents a link to a InstanceGroup resource in GCP. It can
be specified in two ways. You can add `register: name-of-resource` to a
gcp_compute_instance_group task and then set this group field to "{{ name-of-resource
}}" Alternatively, you can set this group to a dictionary with the selfLink
key where the value is the selfLink of your InstanceGroup'
be specified in two ways. First, you can place in the selfLink of the resource
here as a string Alternatively, you can add `register: name-of-resource`
to a gcp_compute_instance_group task and then set this group field to "{{
name-of-resource }}"'
required: false
max_connections:
description:
@ -389,7 +389,7 @@ backends:
- When the BackendService has load balancing scheme INTERNAL, the instance group
must be in a zone within the same region as the BackendService.
returned: success
type: dict
type: str
maxConnections:
description:
- The max number of simultaneous connections for the group. Can be used with
@ -623,38 +623,29 @@ def main():
argument_spec=dict(
state=dict(default='present', choices=['present', 'absent'], type='str'),
affinity_cookie_ttl_sec=dict(type='int'),
backends=dict(
type='list',
elements='dict',
options=dict(
balancing_mode=dict(default='UTILIZATION', type='str', choices=['UTILIZATION', 'RATE', 'CONNECTION']),
capacity_scaler=dict(default=1.0, type='str'),
description=dict(type='str'),
group=dict(type='str'),
max_connections=dict(type='int'),
max_connections_per_instance=dict(type='int'),
max_rate=dict(type='int'),
max_rate_per_instance=dict(type='str'),
max_utilization=dict(default=0.8, type='str'),
),
),
cdn_policy=dict(
type='dict',
options=dict(
cache_key_policy=dict(
type='dict',
options=dict(
include_host=dict(type='bool'),
include_protocol=dict(type='bool'),
include_query_string=dict(type='bool'),
query_string_blacklist=dict(type='list', elements='str'),
query_string_whitelist=dict(type='list', elements='str'),
),
),
signed_url_cache_max_age_sec=dict(default=3600, type='int'),
),
),
connection_draining=dict(type='dict', options=dict(draining_timeout_sec=dict(default=300, type='int'))),
backends=dict(type='list', elements='dict', options=dict(
balancing_mode=dict(type='str', choices=['UTILIZATION', 'RATE', 'CONNECTION']),
capacity_scaler=dict(type='str'),
description=dict(type='str'),
group=dict(),
max_connections=dict(type='int'),
max_connections_per_instance=dict(type='int'),
max_rate=dict(type='int'),
max_rate_per_instance=dict(type='str'),
max_utilization=dict(type='str')
)),
cdn_policy=dict(type='dict', options=dict(
cache_key_policy=dict(type='dict', options=dict(
include_host=dict(type='bool'),
include_protocol=dict(type='bool'),
include_query_string=dict(type='bool'),
query_string_blacklist=dict(type='list', elements='str'),
query_string_whitelist=dict(type='list', elements='str')
))
)),
connection_draining=dict(type='dict', options=dict(
draining_timeout_sec=dict(type='int')
)),
description=dict(type='str'),
enable_cdn=dict(type='bool'),
health_checks=dict(required=True, type='list', elements='str'),

2
plugins/modules/gcp_compute_backend_service_facts.py
View file

@ -114,7 +114,7 @@ items:
- When the BackendService has load balancing scheme INTERNAL, the instance
group must be in a zone within the same region as the BackendService.
returned: success
type: dict
type: str
maxConnections:
description:
- The max number of simultaneous connections for the group. Can be used

26
plugins/modules/gcp_compute_disk.py
View file

@ -156,10 +156,9 @@ options:
- The source snapshot used to create this disk. You can provide this as a partial
or full URL to the resource.
- 'This field represents a link to a Snapshot resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_compute_snapshot
task and then set this source_snapshot field to "{{ name-of-resource }}" Alternatively,
you can set this source_snapshot to a dictionary with the selfLink key where
the value is the selfLink of your Snapshot'
in two ways. First, you can place in the selfLink of the resource here as a
string Alternatively, you can add `register: name-of-resource` to a gcp_compute_snapshot
task and then set this source_snapshot field to "{{ name-of-resource }}"'
required: false
source_snapshot_encryption_key:
description:
@ -350,7 +349,7 @@ sourceSnapshot:
- The source snapshot used to create this disk. You can provide this as a partial
or full URL to the resource.
returned: success
type: dict
type: str
sourceSnapshotEncryptionKey:
description:
- The customer-supplied encryption key of the source snapshot. Required if the source
@ -410,10 +409,19 @@ def main():
type=dict(type='str'),
source_image=dict(type='str'),
zone=dict(required=True, type='str'),
source_image_encryption_key=dict(type='dict', options=dict(raw_key=dict(type='str'), kms_key_name=dict(type='str'))),
disk_encryption_key=dict(type='dict', options=dict(raw_key=dict(type='str'), kms_key_name=dict(type='str'))),
source_snapshot=dict(type='dict'),
source_snapshot_encryption_key=dict(type='dict', options=dict(raw_key=dict(type='str'), kms_key_name=dict(type='str'))),
source_image_encryption_key=dict(type='dict', options=dict(
raw_key=dict(type='str'),
sha256=dict(type='str')
)),
disk_encryption_key=dict(type='dict', options=dict(
raw_key=dict(type='str'),
sha256=dict(type='str')
)),
source_snapshot=dict(),
source_snapshot_encryption_key=dict(type='dict', options=dict(
raw_key=dict(type='str'),
sha256=dict(type='str')
))
)
)

2
plugins/modules/gcp_compute_disk_facts.py
View file

@ -223,7 +223,7 @@ items:
- The source snapshot used to create this disk. You can provide this as a partial
or full URL to the resource.
returned: success
type: dict
type: str
sourceSnapshotEncryptionKey:
description:
- The customer-supplied encryption key of the source snapshot. Required if the

11
plugins/modules/gcp_compute_firewall.py
View file

@ -146,10 +146,9 @@ options:
networks/my-network projects/myproject/global/networks/my-network global/networks/default
.'
- 'This field represents a link to a Network resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_compute_network
task and then set this network field to "{{ name-of-resource }}" Alternatively,
you can set this network to a dictionary with the selfLink key where the value
is the selfLink of your Network'
in two ways. First, you can place in the selfLink of the resource here as a
string Alternatively, you can add `register: name-of-resource` to a gcp_compute_network
task and then set this network field to "{{ name-of-resource }}"'
required: false
default:
selfLink: global/networks/default
@ -342,7 +341,7 @@ network:
networks/my-network projects/myproject/global/networks/my-network global/networks/default
.'
returned: success
type: dict
type: str
priority:
description:
- Priority for this rule. This is an integer between 0 and 65535, both inclusive.
@ -440,7 +439,7 @@ def main():
direction=dict(type='str', choices=['INGRESS', 'EGRESS']),
disabled=dict(type='bool'),
name=dict(required=True, type='str'),
network=dict(default={'selfLink': 'global/networks/default'}, type='dict'),
network=dict(default={'selfLink': 'global/networks/default'}),
priority=dict(default=1000, type='int'),
source_ranges=dict(type='list', elements='str'),
source_service_accounts=dict(type='list', elements='str'),

2
plugins/modules/gcp_compute_firewall_facts.py
View file

@ -169,7 +169,7 @@ items:
networks/my-network projects/myproject/global/networks/my-network global/networks/default
.'
returned: success
type: dict
type: str
priority:
description:
- Priority for this rule. This is an integer between 0 and 65535, both inclusive.

45
plugins/modules/gcp_compute_forwarding_rule.py
View file

@ -95,10 +95,10 @@ options:
- This is used for internal load balancing.
- "(not used for external load balancing) ."
- 'This field represents a link to a BackendService resource in GCP. It can be
specified in two ways. You can add `register: name-of-resource` to a gcp_compute_backend_service
task and then set this backend_service field to "{{ name-of-resource }}" Alternatively,
you can set this backend_service to a dictionary with the selfLink key where
the value is the selfLink of your BackendService'
specified in two ways. First, you can place in the selfLink of the resource
here as a string Alternatively, you can add `register: name-of-resource` to
a gcp_compute_backend_service task and then set this backend_service field to
"{{ name-of-resource }}"'
required: false
ip_version:
description:
@ -135,10 +135,9 @@ options:
specified, the default network will be used.
- This field is not used for external load balancing.
- 'This field represents a link to a Network resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_compute_network
task and then set this network field to "{{ name-of-resource }}" Alternatively,
you can set this network to a dictionary with the selfLink key where the value
is the selfLink of your Network'
in two ways. First, you can place in the selfLink of the resource here as a
string Alternatively, you can add `register: name-of-resource` to a gcp_compute_network
task and then set this network field to "{{ name-of-resource }}"'
required: false
port_range:
description:
@ -171,10 +170,9 @@ options:
if the network is in custom subnet mode, a subnetwork must be specified.
- This field is not used for external load balancing.
- 'This field represents a link to a Subnetwork resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_compute_subnetwork
task and then set this subnetwork field to "{{ name-of-resource }}" Alternatively,
you can set this subnetwork to a dictionary with the selfLink key where the
value is the selfLink of your Subnetwork'
in two ways. First, you can place in the selfLink of the resource here as a
string Alternatively, you can add `register: name-of-resource` to a gcp_compute_subnetwork
task and then set this subnetwork field to "{{ name-of-resource }}"'
required: false
target:
description:
@ -185,10 +183,9 @@ options:
target object.
- This field is not used for internal load balancing.
- 'This field represents a link to a TargetPool resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_compute_target_pool
task and then set this target field to "{{ name-of-resource }}" Alternatively,
you can set this target to a dictionary with the selfLink key where the value
is the selfLink of your TargetPool'
in two ways. First, you can place in the selfLink of the resource here as a
string Alternatively, you can add `register: name-of-resource` to a gcp_compute_target_pool
task and then set this target field to "{{ name-of-resource }}"'
required: false
version_added: 2.7
network_tier:
@ -300,7 +297,7 @@ backendService:
- This is used for internal load balancing.
- "(not used for external load balancing) ."
returned: success
type: dict
type: str
ipVersion:
description:
- The IP Version that will be used by this forwarding rule. Valid options are IPV4
@ -333,7 +330,7 @@ network:
the default network will be used.
- This field is not used for external load balancing.
returned: success
type: dict
type: str
portRange:
description:
- This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy,
@ -366,7 +363,7 @@ subnetwork:
if the network is in custom subnet mode, a subnetwork must be specified.
- This field is not used for external load balancing.
returned: success
type: dict
type: str
target:
description:
- A reference to a TargetPool resource to receive the matched traffic.
@ -376,7 +373,7 @@ target:
target object.
- This field is not used for internal load balancing.
returned: success
type: dict
type: str
networkTier:
description:
- 'The networking tier used for configuring this address. This field can take the
@ -414,15 +411,15 @@ def main():
description=dict(type='str'),
ip_address=dict(type='str'),
ip_protocol=dict(type='str', choices=['TCP', 'UDP', 'ESP', 'AH', 'SCTP', 'ICMP']),
backend_service=dict(type='dict'),
backend_service=dict(),
ip_version=dict(type='str', choices=['IPV4', 'IPV6']),
load_balancing_scheme=dict(type='str', choices=['INTERNAL', 'EXTERNAL']),
name=dict(required=True, type='str'),
network=dict(type='dict'),
network=dict(),
port_range=dict(type='str'),
ports=dict(type='list', elements='str'),
subnetwork=dict(type='dict'),
target=dict(type='dict'),
subnetwork=dict(),
target=dict(),
network_tier=dict(type='str', choices=['PREMIUM', 'STANDARD']),
region=dict(required=True, type='str')
)

8
plugins/modules/gcp_compute_forwarding_rule_facts.py
View file

@ -122,7 +122,7 @@ items:
- This is used for internal load balancing.
- "(not used for external load balancing) ."
returned: success
type: dict
type: str
ipVersion:
description:
- The IP Version that will be used by this forwarding rule. Valid options are
@ -155,7 +155,7 @@ items:
specified, the default network will be used.
- This field is not used for external load balancing.
returned: success
type: dict
type: str
portRange:
description:
- This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy,
@ -190,7 +190,7 @@ items:
if the network is in custom subnet mode, a subnetwork must be specified.
- This field is not used for external load balancing.
returned: success
type: dict
type: str
target:
description:
- A reference to a TargetPool resource to receive the matched traffic.
@ -200,7 +200,7 @@ items:
to the target object.
- This field is not used for internal load balancing.
returned: success
type: dict
type: str
networkTier:
description:
- 'The networking tier used for configuring this address. This field can take

35
plugins/modules/gcp_compute_global_forwarding_rule.py
View file

@ -97,10 +97,10 @@ options:
- This is used for internal load balancing.
- "(not used for external load balancing) ."
- 'This field represents a link to a BackendService resource in GCP. It can be
specified in two ways. You can add `register: name-of-resource` to a gcp_compute_backend_service
task and then set this backend_service field to "{{ name-of-resource }}" Alternatively,
you can set this backend_service to a dictionary with the selfLink key where
the value is the selfLink of your BackendService'
specified in two ways. First, you can place in the selfLink of the resource
here as a string Alternatively, you can add `register: name-of-resource` to
a gcp_compute_backend_service task and then set this backend_service field to
"{{ name-of-resource }}"'
required: false
ip_version:
description:
@ -137,10 +137,9 @@ options:
specified, the default network will be used.
- This field is not used for external load balancing.
- 'This field represents a link to a Network resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_compute_network
task and then set this network field to "{{ name-of-resource }}" Alternatively,
you can set this network to a dictionary with the selfLink key where the value
is the selfLink of your Network'
in two ways. First, you can place in the selfLink of the resource here as a
string Alternatively, you can add `register: name-of-resource` to a gcp_compute_network
task and then set this network field to "{{ name-of-resource }}"'
required: false
port_range:
description:
@ -173,10 +172,9 @@ options:
if the network is in custom subnet mode, a subnetwork must be specified.
- This field is not used for external load balancing.
- 'This field represents a link to a Subnetwork resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_compute_subnetwork
task and then set this subnetwork field to "{{ name-of-resource }}" Alternatively,
you can set this subnetwork to a dictionary with the selfLink key where the
value is the selfLink of your Subnetwork'
in two ways. First, you can place in the selfLink of the resource here as a
string Alternatively, you can add `register: name-of-resource` to a gcp_compute_subnetwork
task and then set this subnetwork field to "{{ name-of-resource }}"'
required: false
target:
description:
@ -320,7 +318,7 @@ backendService:
- This is used for internal load balancing.
- "(not used for external load balancing) ."
returned: success
type: dict
type: str
ipVersion:
description:
- The IP Version that will be used by this forwarding rule. Valid options are IPV4
@ -353,7 +351,7 @@ network:
the default network will be used.
- This field is not used for external load balancing.
returned: success
type: dict
type: str
portRange:
description:
- This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy,
@ -386,7 +384,7 @@ subnetwork:
if the network is in custom subnet mode, a subnetwork must be specified.
- This field is not used for external load balancing.
returned: success
type: dict
type: str
region:
description:
- A reference to the region where the regional forwarding rule resides.
@ -424,12 +422,15 @@ def main():
description=dict(type='str'),
ip_address=dict(type='str'),
ip_protocol=dict(type='str', choices=['TCP', 'UDP', 'ESP', 'AH', 'SCTP', 'ICMP']),
backend_service=dict(),
ip_version=dict(type='str', choices=['IPV4', 'IPV6']),
load_balancing_scheme=dict(type='str', choices=['INTERNAL_SELF_MANAGED', 'EXTERNAL']),
name=dict(required=True, type='str'),
network=dict(type='dict'),
network=dict(),
port_range=dict(type='str'),
target=dict(required=True, type='str'),
ports=dict(type='list', elements='str'),
subnetwork=dict(),
target=dict(type='str')
)
)

6
plugins/modules/gcp_compute_global_forwarding_rule_facts.py
View file

@ -116,7 +116,7 @@ items:
- This is used for internal load balancing.
- "(not used for external load balancing) ."
returned: success
type: dict
type: str
ipVersion:
description:
- The IP Version that will be used by this forwarding rule. Valid options are
@ -149,7 +149,7 @@ items:
specified, the default network will be used.
- This field is not used for external load balancing.
returned: success
type: dict
type: str
portRange:
description:
- This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy,
@ -184,7 +184,7 @@ items:
if the network is in custom subnet mode, a subnetwork must be specified.
- This field is not used for external load balancing.
returned: success
type: dict
type: str
region:
description:
- A reference to the region where the regional forwarding rule resides.

25
plugins/modules/gcp_compute_image.py
View file

@ -152,10 +152,9 @@ options:
- Refers to a gcompute_disk object You must provide either this property or the
rawDisk.source property but not both to create an image.
- 'This field represents a link to a Disk resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_compute_disk
task and then set this source_disk field to "{{ name-of-resource }}" Alternatively,
you can set this source_disk to a dictionary with the selfLink key where the
value is the selfLink of your Disk'
in two ways. First, you can place in the selfLink of the resource here as a
string Alternatively, you can add `register: name-of-resource` to a gcp_compute_disk
task and then set this source_disk field to "{{ name-of-resource }}"'
required: false
source_disk_encryption_key:
description:
@ -377,7 +376,7 @@ sourceDisk:
- Refers to a gcompute_disk object You must provide either this property or the
rawDisk.source property but not both to create an image.
returned: success
type: dict
type: str
sourceDiskEncryptionKey:
description:
- The customer-supplied encryption key of the source disk. Required if the source
@ -440,12 +439,16 @@ def main():
labels=dict(type='dict'),
licenses=dict(type='list', elements='str'),
name=dict(required=True, type='str'),
raw_disk=dict(
type='dict',
options=dict(container_type=dict(type='str', choices=['TAR']), sha1_checksum=dict(type='str'), source=dict(required=True, type='str')),
),
source_disk=dict(type='dict'),
source_disk_encryption_key=dict(type='dict', options=dict(raw_key=dict(type='str'))),
raw_disk=dict(type='dict', options=dict(
container_type=dict(type='str', choices=['TAR']),
sha1_checksum=dict(type='str'),
source=dict(type='str')
)),
source_disk=dict(),
source_disk_encryption_key=dict(type='dict', options=dict(
raw_key=dict(type='str'),
sha256=dict(type='str')
)),
source_disk_id=dict(type='str'),
source_type=dict(type='str', choices=['RAW']),
)

2
plugins/modules/gcp_compute_image_facts.py
View file

@ -231,7 +231,7 @@ items:
- Refers to a gcompute_disk object You must provide either this property or
the rawDisk.source property but not both to create an image.
returned: success
type: dict
type: str
sourceDiskEncryptionKey:
description:
- The customer-supplied encryption key of the source disk. Required if the source

101
plugins/modules/gcp_compute_instance.py
View file

@ -181,10 +181,9 @@ options:
- If desired, you can also attach existing non-root persistent disks using
this property. This field is only applicable for persistent disks.
- 'This field represents a link to a Disk resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_compute_disk
task and then set this source field to "{{ name-of-resource }}" Alternatively,
you can set this source to a dictionary with the selfLink key where the
value is the selfLink of your Disk'
in two ways. First, you can place in the selfLink of the resource here as
a string Alternatively, you can add `register: name-of-resource` to a gcp_compute_disk
task and then set this source field to "{{ name-of-resource }}"'
required: false
type:
description:
@ -267,10 +266,10 @@ options:
address pool. If you specify a static external IP address, it must live
in the same region as the zone of the instance.
- 'This field represents a link to a Address resource in GCP. It can be
specified in two ways. You can add `register: name-of-resource` to a
gcp_compute_address task and then set this nat_ip field to "{{ name-of-resource
}}" Alternatively, you can set this nat_ip to a dictionary with the
address key where the value is the address of your Address'
specified in two ways. First, you can place in the address of the resource
here as a string Alternatively, you can add `register: name-of-resource`
to a gcp_compute_address task and then set this nat_ip field to "{{
name-of-resource }}"'
required: false
type:
description:
@ -310,10 +309,9 @@ options:
global/networks/default is used; if the network is not specified but the
subnetwork is specified, the network is inferred.
- 'This field represents a link to a Network resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_compute_network
task and then set this network field to "{{ name-of-resource }}" Alternatively,
you can set this network to a dictionary with the selfLink key where the
value is the selfLink of your Network'
in two ways. First, you can place in the selfLink of the resource here as
a string Alternatively, you can add `register: name-of-resource` to a gcp_compute_network
task and then set this network field to "{{ name-of-resource }}"'
required: false
network_ip:
description:
@ -328,10 +326,10 @@ options:
If the network is in auto subnet mode, providing the subnetwork is optional.
If the network is in custom subnet mode, then this field should be specified.
- 'This field represents a link to a Subnetwork resource in GCP. It can be
specified in two ways. You can add `register: name-of-resource` to a gcp_compute_subnetwork
task and then set this subnetwork field to "{{ name-of-resource }}" Alternatively,
you can set this subnetwork to a dictionary with the selfLink key where
the value is the selfLink of your Subnetwork'
specified in two ways. First, you can place in the selfLink of the resource
here as a string Alternatively, you can add `register: name-of-resource`
to a gcp_compute_subnetwork task and then set this subnetwork field to "{{
name-of-resource }}"'
required: false
scheduling:
description:
@ -629,7 +627,7 @@ disks:
- If desired, you can also attach existing non-root persistent disks using this
property. This field is only applicable for persistent disks.
returned: success
type: dict
type: str
type:
description:
- Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified,
@ -725,7 +723,7 @@ networkInterfaces:
address pool. If you specify a static external IP address, it must live
in the same region as the zone of the instance.
returned: success
type: dict
type: str
type:
description:
- The type of configuration. The default and only option is ONE_TO_ONE_NAT.
@ -767,7 +765,7 @@ networkInterfaces:
global/networks/default is used; if the network is not specified but the subnetwork
is specified, the network is inferred.
returned: success
type: dict
type: str
networkIP:
description:
- An IPv4 internal network address to assign to the instance for this network
@ -782,7 +780,7 @@ networkInterfaces:
the network is in auto subnet mode, providing the subnetwork is optional.
If the network is in custom subnet mode, then this field should be specified.
returned: success
type: dict
type: str
scheduling:
description:
- Sets the scheduling options for this instance.
@ -891,33 +889,36 @@ def main():
module = GcpModule(
argument_spec=dict(
state=dict(default='present', choices=['present', 'absent'], type='str'),
can_ip_forward=dict(type='bool', aliases=['ip_forward']),
disks=dict(
type='list',
elements='dict',
options=dict(
auto_delete=dict(type='bool'),
boot=dict(type='bool'),
device_name=dict(type='str'),
disk_encryption_key=dict(type='dict', options=dict(raw_key=dict(type='str'), rsa_encrypted_key=dict(type='str'))),
index=dict(type='int'),
initialize_params=dict(
type='dict',
options=dict(
disk_name=dict(type='str'),
disk_size_gb=dict(type='int'),
disk_type=dict(type='str'),
source_image=dict(type='str', aliases=['image', 'image_family']),
source_image_encryption_key=dict(type='dict', options=dict(raw_key=dict(type='str'))),
),
),
interface=dict(type='str', choices=['SCSI', 'NVME']),
mode=dict(type='str', choices=['READ_WRITE', 'READ_ONLY']),
source=dict(type='dict'),
type=dict(type='str', choices=['SCRATCH', 'PERSISTENT']),
),
),
guest_accelerators=dict(type='list', elements='dict', options=dict(accelerator_count=dict(type='int'), accelerator_type=dict(type='str'))),
can_ip_forward=dict(type='bool'),
disks=dict(type='list', elements='dict', options=dict(
auto_delete=dict(type='bool'),
boot=dict(type='bool'),
device_name=dict(type='str'),
disk_encryption_key=dict(type='dict', options=dict(
raw_key=dict(type='str'),
rsa_encrypted_key=dict(type='str'),
sha256=dict(type='str')
)),
index=dict(type='int'),
initialize_params=dict(type='dict', options=dict(
disk_name=dict(type='str'),
disk_size_gb=dict(type='int'),
disk_type=dict(type='str'),
source_image=dict(type='str'),
source_image_encryption_key=dict(type='dict', options=dict(
raw_key=dict(type='str'),
sha256=dict(type='str')
))
)),
interface=dict(type='str', choices=['SCSI', 'NVME']),
mode=dict(type='str', choices=['READ_WRITE', 'READ_ONLY']),
source=dict(),
type=dict(type='str', choices=['SCRATCH', 'PERSISTENT'])
)),
guest_accelerators=dict(type='list', elements='dict', options=dict(
accelerator_count=dict(type='int'),
accelerator_type=dict(type='str')
)),
label_fingerprint=dict(type='str'),
metadata=dict(type='dict'),
machine_type=dict(type='str'),
@ -926,7 +927,7 @@ def main():
network_interfaces=dict(type='list', elements='dict', options=dict(
access_configs=dict(type='list', elements='dict', options=dict(
name=dict(required=True, type='str'),
nat_ip=dict(type='dict'),
nat_ip=dict(),
type=dict(required=True, type='str', choices=['ONE_TO_ONE_NAT'])
)),
alias_ip_ranges=dict(type='list', elements='dict', options=dict(
@ -934,9 +935,9 @@ def main():
subnetwork_range_name=dict(type='str')
)),
name=dict(type='str'),
network=dict(type='dict'),
network=dict(),
network_ip=dict(type='str'),
subnetwork=dict(type='dict')
subnetwork=dict()
)),
scheduling=dict(type='dict', options=dict(
automatic_restart=dict(type='bool'),

8
plugins/modules/gcp_compute_instance_facts.py
View file

@ -225,7 +225,7 @@ items:
- If desired, you can also attach existing non-root persistent disks using
this property. This field is only applicable for persistent disks.
returned: success
type: dict
type: str
type:
description:
- Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified,
@ -323,7 +323,7 @@ items:
IP address pool. If you specify a static external IP address, it must
live in the same region as the zone of the instance.
returned: success
type: dict
type: str
type:
description:
- The type of configuration. The default and only option is ONE_TO_ONE_NAT.
@ -365,7 +365,7 @@ items:
default network global/networks/default is used; if the network is not
specified but the subnetwork is specified, the network is inferred.
returned: success
type: dict
type: str
networkIP:
description:
- An IPv4 internal network address to assign to the instance for this network
@ -380,7 +380,7 @@ items:
If the network is in auto subnet mode, providing the subnetwork is optional.
If the network is in custom subnet mode, then this field should be specified.
returned: success
type: dict
type: str
scheduling:
description:
- Sets the scheduling options for this instance.

29
plugins/modules/gcp_compute_instance_group.py
View file

@ -83,10 +83,9 @@ options:
description:
- The network to which all instances in the instance group belong.
- 'This field represents a link to a Network resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_compute_network
task and then set this network field to "{{ name-of-resource }}" Alternatively,
you can set this network to a dictionary with the selfLink key where the value
is the selfLink of your Network'
in two ways. First, you can place in the selfLink of the resource here as a
string Alternatively, you can add `register: name-of-resource` to a gcp_compute_network
task and then set this network field to "{{ name-of-resource }}"'
required: false
region:
description:
@ -96,10 +95,9 @@ options:
description:
- The subnetwork to which all instances in the instance group belong.
- 'This field represents a link to a Subnetwork resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_compute_subnetwork
task and then set this subnetwork field to "{{ name-of-resource }}" Alternatively,
you can set this subnetwork to a dictionary with the selfLink key where the
value is the selfLink of your Subnetwork'
in two ways. First, you can place in the selfLink of the resource here as a
string Alternatively, you can add `register: name-of-resource` to a gcp_compute_subnetwork
task and then set this subnetwork field to "{{ name-of-resource }}"'
required: false
zone:
description:
@ -190,7 +188,7 @@ network:
description:
- The network to which all instances in the instance group belong.
returned: success
type: dict
type: str
region:
description:
- The region where the instance group is located (for regional resources).
@ -200,7 +198,7 @@ subnetwork:
description:
- The subnetwork to which all instances in the instance group belong.
returned: success
type: dict
type: str
zone:
description:
- A reference to the zone where the instance group resides.
@ -239,12 +237,15 @@ def main():
state=dict(default='present', choices=['present', 'absent'], type='str'),
description=dict(type='str'),
name=dict(type='str'),
named_ports=dict(type='list', elements='dict', options=dict(name=dict(type='str'), port=dict(type='int'))),
network=dict(type='dict'),
named_ports=dict(type='list', elements='dict', options=dict(
name=dict(type='str'),
port=dict(type='int')
)),
network=dict(),
region=dict(type='str'),
subnetwork=dict(type='dict'),
subnetwork=dict(),
zone=dict(required=True, type='str'),
instances=dict(type='list', elements='dict')
instances=dict(type='list')
)
)

4
plugins/modules/gcp_compute_instance_group_facts.py
View file

@ -117,7 +117,7 @@ items:
description:
- The network to which all instances in the instance group belong.
returned: success
type: dict
type: str
region:
description:
- The region where the instance group is located (for regional resources).
@ -127,7 +127,7 @@ items:
description:
- The subnetwork to which all instances in the instance group belong.
returned: success
type: dict
type: str
zone:
description:
- A reference to the zone where the instance group resides.

21
plugins/modules/gcp_compute_instance_group_manager.py
View file

@ -70,10 +70,10 @@ options:
group uses this template to create all new instances in the managed instance
group.
- 'This field represents a link to a InstanceTemplate resource in GCP. It can
be specified in two ways. You can add `register: name-of-resource` to a gcp_compute_instance_template
task and then set this instance_template field to "{{ name-of-resource }}" Alternatively,
you can set this instance_template to a dictionary with the selfLink key where
the value is the selfLink of your InstanceTemplate'
be specified in two ways. First, you can place in the selfLink of the resource
here as a string Alternatively, you can add `register: name-of-resource` to
a gcp_compute_instance_template task and then set this instance_template field
to "{{ name-of-resource }}"'
required: true
name:
description:
@ -261,13 +261,13 @@ instanceGroup:
description:
- The instance group being managed.
returned: success
type: dict
type: str
instanceTemplate:
description:
- The instance template that is specified for this managed instance group. The group
uses this template to create all new instances in the managed instance group.
returned: success
type: dict
type: str
name:
description:
- The name of the managed instance group. The name must be 1-63 characters long,
@ -339,10 +339,13 @@ def main():
state=dict(default='present', choices=['present', 'absent'], type='str'),
base_instance_name=dict(required=True, type='str'),
description=dict(type='str'),
instance_template=dict(required=True, type='dict'),
instance_template=dict(required=True),
name=dict(required=True, type='str'),
named_ports=dict(type='list', elements='dict', options=dict(name=dict(type='str'), port=dict(type='int'))),
target_pools=dict(type='list', elements='dict'),
named_ports=dict(type='list', elements='dict', options=dict(
name=dict(type='str'),
port=dict(type='int')
)),
target_pools=dict(type='list'),
target_size=dict(type='int'),
zone=dict(required=True, type='str'),
)

4
plugins/modules/gcp_compute_instance_group_manager_facts.py
View file

@ -161,14 +161,14 @@ items:
description:
- The instance group being managed.
returned: success
type: dict
type: str
instanceTemplate:
description:
- The instance template that is specified for this managed instance group. The
group uses this template to create all new instances in the managed instance
group.
returned: success
type: dict
type: str
name:
description:
- The name of the managed instance group. The name must be 1-63 characters long,

50
plugins/modules/gcp_compute_instance_template.py
View file

@ -211,10 +211,10 @@ options:
- Note that for InstanceTemplate, specify the disk name, not the URL for
the disk.
- 'This field represents a link to a Disk resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_compute_disk
task and then set this source field to "{{ name-of-resource }}" Alternatively,
you can set this source to a dictionary with the name key where the
value is the name of your Disk'
in two ways. First, you can place in the name of the resource here as
a string Alternatively, you can add `register: name-of-resource` to
a gcp_compute_disk task and then set this source field to "{{ name-of-resource
}}"'
required: false
type:
description:
@ -283,11 +283,10 @@ options:
IP address pool. If you specify a static external IP address, it
must live in the same region as the zone of the instance.
- 'This field represents a link to a Address resource in GCP. It can
be specified in two ways. You can add `register: name-of-resource`
to a gcp_compute_address task and then set this nat_ip field to
"{{ name-of-resource }}" Alternatively, you can set this nat_ip
to a dictionary with the address key where the value is the address
of your Address'
be specified in two ways. First, you can place in the address of
the resource here as a string Alternatively, you can add `register:
name-of-resource` to a gcp_compute_address task and then set this
nat_ip field to "{{ name-of-resource }}"'
required: false
type:
description:
@ -328,10 +327,10 @@ options:
default network global/networks/default is used; if the network is not
specified but the subnetwork is specified, the network is inferred.
- 'This field represents a link to a Network resource in GCP. It can be
specified in two ways. You can add `register: name-of-resource` to a
gcp_compute_network task and then set this network field to "{{ name-of-resource
}}" Alternatively, you can set this network to a dictionary with the
selfLink key where the value is the selfLink of your Network'
specified in two ways. First, you can place in the selfLink of the resource
here as a string Alternatively, you can add `register: name-of-resource`
to a gcp_compute_network task and then set this network field to "{{
name-of-resource }}"'
required: false
network_ip:
description:
@ -346,11 +345,10 @@ options:
If the network is in auto subnet mode, providing the subnetwork is optional.
If the network is in custom subnet mode, then this field should be specified.
- 'This field represents a link to a Subnetwork resource in GCP. It can
be specified in two ways. You can add `register: name-of-resource` to
a gcp_compute_subnetwork task and then set this subnetwork field to
"{{ name-of-resource }}" Alternatively, you can set this subnetwork
to a dictionary with the selfLink key where the value is the selfLink
of your Subnetwork'
be specified in two ways. First, you can place in the selfLink of the
resource here as a string Alternatively, you can add `register: name-of-resource`
to a gcp_compute_subnetwork task and then set this subnetwork field
to "{{ name-of-resource }}"'
required: false
scheduling:
description:
@ -643,7 +641,7 @@ properties:
- Note that for InstanceTemplate, specify the disk name, not the URL for
the disk.
returned: success
type: dict
type: str
type:
description:
- Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified,
@ -716,7 +714,7 @@ properties:
IP address pool. If you specify a static external IP address, it must
live in the same region as the zone of the instance.
returned: success
type: dict
type: str
type:
description:
- The type of configuration. The default and only option is ONE_TO_ONE_NAT.
@ -758,7 +756,7 @@ properties:
default network global/networks/default is used; if the network is not
specified but the subnetwork is specified, the network is inferred.
returned: success
type: dict
type: str
networkIP:
description:
- An IPv4 internal network address to assign to the instance for this network
@ -773,7 +771,7 @@ properties:
If the network is in auto subnet mode, providing the subnetwork is optional.
If the network is in custom subnet mode, then this field should be specified.
returned: success
type: dict
type: str
scheduling:
description:
- Sets the scheduling options for this instance.
@ -893,7 +891,7 @@ def main():
)),
interface=dict(type='str', choices=['SCSI', 'NVME']),
mode=dict(type='str', choices=['READ_WRITE', 'READ_ONLY']),
source=dict(type='dict'),
source=dict(),
type=dict(type='str', choices=['SCRATCH', 'PERSISTENT'])
)),
machine_type=dict(required=True, type='str'),
@ -906,7 +904,7 @@ def main():
network_interfaces=dict(type='list', elements='dict', options=dict(
access_configs=dict(type='list', elements='dict', options=dict(
name=dict(required=True, type='str'),
nat_ip=dict(type='dict'),
nat_ip=dict(),
type=dict(required=True, type='str', choices=['ONE_TO_ONE_NAT'])
)),
alias_ip_ranges=dict(type='list', elements='dict', options=dict(
@ -914,9 +912,9 @@ def main():
subnetwork_range_name=dict(type='str')
)),
name=dict(type='str'),
network=dict(type='dict'),
network=dict(),
network_ip=dict(type='str'),
subnetwork=dict(type='dict')
subnetwork=dict()
)),
scheduling=dict(type='dict', options=dict(
automatic_restart=dict(type='bool'),

8
plugins/modules/gcp_compute_instance_template_facts.py
View file

@ -250,7 +250,7 @@ items:
- Note that for InstanceTemplate, specify the disk name, not the URL
for the disk.
returned: success
type: dict
type: str
type:
description:
- Specifies the type of the disk, either SCRATCH or PERSISTENT. If not
@ -326,7 +326,7 @@ items:
ephemeral IP address pool. If you specify a static external IP
address, it must live in the same region as the zone of the instance.
returned: success
type: dict
type: str
type:
description:
- The type of configuration. The default and only option is ONE_TO_ONE_NAT.
@ -370,7 +370,7 @@ items:
the default network global/networks/default is used; if the network
is not specified but the subnetwork is specified, the network is inferred.
returned: success
type: dict
type: str
networkIP:
description:
- An IPv4 internal network address to assign to the instance for this
@ -386,7 +386,7 @@ items:
optional. If the network is in custom subnet mode, then this field
should be specified.
returned: success
type: dict
type: str
scheduling:
description:
- Sets the scheduling options for this instance.

11
plugins/modules/gcp_compute_interconnect_attachment.py
View file

@ -65,10 +65,9 @@ options:
will automatically connect the Interconnect to the network & region within which
the Cloud Router is configured.
- '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'
in two ways. First, you can place in the selfLink of the resource here as a
string Alternatively, you can add `register: name-of-resource` to a gcp_compute_router
task and then set this router field to "{{ name-of-resource }}"'
required: true
name:
description:
@ -150,7 +149,7 @@ router:
automatically connect the Interconnect to the network & region within which the
Cloud Router is configured.
returned: success
type: dict
type: str
creationTimestamp:
description:
- Creation timestamp in RFC3339 text format.
@ -200,7 +199,7 @@ def main():
state=dict(default='present', choices=['present', 'absent'], type='str'),
interconnect=dict(required=True, type='str'),
description=dict(type='str'),
router=dict(required=True, type='dict'),
router=dict(required=True),
name=dict(required=True, type='str'),
region=dict(required=True, type='str')
)

2
plugins/modules/gcp_compute_interconnect_attachment_facts.py
View file

@ -119,7 +119,7 @@ items:
will automatically connect the Interconnect to the network & region within
which the Cloud Router is configured.
returned: success
type: dict
type: str
creationTimestamp:
description:
- Creation timestamp in RFC3339 text format.

11
plugins/modules/gcp_compute_region_disk.py
View file

@ -129,10 +129,9 @@ options:
- The source snapshot used to create this disk. You can provide this as a partial
or full URL to the resource.
- 'This field represents a link to a Snapshot resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_compute_snapshot
task and then set this source_snapshot field to "{{ name-of-resource }}" Alternatively,
you can set this source_snapshot to a dictionary with the selfLink key where
the value is the selfLink of your Snapshot'
in two ways. First, you can place in the selfLink of the resource here as a
string Alternatively, you can add `register: name-of-resource` to a gcp_compute_snapshot
task and then set this source_snapshot field to "{{ name-of-resource }}"'
required: false
source_snapshot_encryption_key:
description:
@ -288,7 +287,7 @@ sourceSnapshot:
- The source snapshot used to create this disk. You can provide this as a partial
or full URL to the resource.
returned: success
type: dict
type: str
sourceSnapshotEncryptionKey:
description:
- The customer-supplied encryption key of the source snapshot. Required if the source
@ -351,7 +350,7 @@ def main():
raw_key=dict(type='str'),
sha256=dict(type='str')
)),
source_snapshot=dict(type='dict'),
source_snapshot=dict(),
source_snapshot_encryption_key=dict(type='dict', options=dict(
raw_key=dict(type='str'),
sha256=dict(type='str')

2
plugins/modules/gcp_compute_region_disk_facts.py
View file

@ -185,7 +185,7 @@ items:
- The source snapshot used to create this disk. You can provide this as a partial
or full URL to the resource.
returned: success
type: dict
type: str
sourceSnapshotEncryptionKey:
description:
- The customer-supplied encryption key of the source snapshot. Required if the

11
plugins/modules/gcp_compute_route.py
View file

@ -86,10 +86,9 @@ options:
description:
- The network that this route applies to.
- 'This field represents a link to a Network resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_compute_network
task and then set this network field to "{{ name-of-resource }}" Alternatively,
you can set this network to a dictionary with the selfLink key where the value
is the selfLink of your Network'
in two ways. First, you can place in the selfLink of the resource here as a
string Alternatively, you can add `register: name-of-resource` to a gcp_compute_network
task and then set this network field to "{{ name-of-resource }}"'
required: true
priority:
description:
@ -184,7 +183,7 @@ network:
description:
- The network that this route applies to.
returned: success
type: dict
type: str
priority:
description:
- The priority of this route. Priority is used to break ties in cases where there
@ -255,7 +254,7 @@ def main():
dest_range=dict(required=True, type='str'),
description=dict(type='str'),
name=dict(required=True, type='str'),
network=dict(required=True, type='dict'),
network=dict(required=True),
priority=dict(type='int'),
tags=dict(type='list', elements='str'),
next_hop_gateway=dict(type='str'),

2
plugins/modules/gcp_compute_route_facts.py
View file

@ -90,7 +90,7 @@ items:
description:
- The network that this route applies to.
returned: success
type: dict
type: str
priority:
description:
- The priority of this route. Priority is used to break ties in cases where

31
plugins/modules/gcp_compute_router.py
View file

@ -63,10 +63,9 @@ options:
description:
- A reference to the network to which this router belongs.
- 'This field represents a link to a Network resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_compute_network
task and then set this network field to "{{ name-of-resource }}" Alternatively,
you can set this network to a dictionary with the selfLink key where the value
is the selfLink of your Network'
in two ways. First, you can place in the selfLink of the resource here as a
string Alternatively, you can add `register: name-of-resource` to a gcp_compute_network
task and then set this network field to "{{ name-of-resource }}"'
required: true
bgp:
description:
@ -182,7 +181,7 @@ network:
description:
- A reference to the network to which this router belongs.
returned: success
type: dict
type: str
bgp:
description:
- BGP information specific to this router.
@ -259,17 +258,17 @@ def main():
state=dict(default='present', choices=['present', 'absent'], type='str'),
name=dict(required=True, type='str'),
description=dict(type='str'),
network=dict(required=True, type='dict'),
bgp=dict(
type='dict',
options=dict(
asn=dict(required=True, type='int'),
advertise_mode=dict(default='DEFAULT', type='str', choices=['DEFAULT', 'CUSTOM']),
advertised_groups=dict(type='list', elements='str'),
advertised_ip_ranges=dict(type='list', elements='dict', options=dict(range=dict(type='str'), description=dict(type='str'))),
),
),
region=dict(required=True, type='str'),
network=dict(required=True),
bgp=dict(type='dict', options=dict(
asn=dict(required=True, type='int'),
advertise_mode=dict(default='DEFAULT', type='str', choices=['DEFAULT', 'CUSTOM']),
advertised_groups=dict(type='list', elements='str'),
advertised_ip_ranges=dict(type='list', elements='dict', options=dict(
range=dict(type='str'),
description=dict(type='str')
))
)),
region=dict(required=True, type='str')
)
)

2
plugins/modules/gcp_compute_router_facts.py
View file

@ -97,7 +97,7 @@ items:
description:
- A reference to the network to which this router belongs.
returned: success
type: dict
type: str
bgp:
description:
- BGP information specific to this router.

11
plugins/modules/gcp_compute_subnetwork.py
View file

@ -89,10 +89,9 @@ options:
- The network this subnet belongs to.
- Only networks that are in the distributed mode can have subnetworks.
- 'This field represents a link to a Network resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_compute_network
task and then set this network field to "{{ name-of-resource }}" Alternatively,
you can set this network to a dictionary with the selfLink key where the value
is the selfLink of your Network'
in two ways. First, you can place in the selfLink of the resource here as a
string Alternatively, you can add `register: name-of-resource` to a gcp_compute_network
task and then set this network field to "{{ name-of-resource }}"'
required: true
enable_flow_logs:
description:
@ -207,7 +206,7 @@ network:
- The network this subnet belongs to.
- Only networks that are in the distributed mode can have subnetworks.
returned: success
type: dict
type: str
enableFlowLogs:
description:
- Whether to enable flow logging for this subnetwork.
@ -277,7 +276,7 @@ def main():
description=dict(type='str'),
ip_cidr_range=dict(required=True, type='str'),
name=dict(required=True, type='str'),
network=dict(required=True, type='dict'),
network=dict(required=True),
enable_flow_logs=dict(type='bool'),
secondary_ip_ranges=dict(type='list', elements='dict', options=dict(
range_name=dict(required=True, type='str'),

2
plugins/modules/gcp_compute_subnetwork_facts.py
View file

@ -114,7 +114,7 @@ items:
- The network this subnet belongs to.
- Only networks that are in the distributed mode can have subnetworks.
returned: success
type: dict
type: str
enableFlowLogs:
description:
- Whether to enable flow logging for this subnetwork.

11
plugins/modules/gcp_compute_target_http_proxy.py
View file

@ -66,10 +66,9 @@ options:
- A reference to the UrlMap resource that defines the mapping from URL to the
BackendService.
- 'This field represents a link to a UrlMap resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_compute_url_map
task and then set this url_map field to "{{ name-of-resource }}" Alternatively,
you can set this url_map to a dictionary with the selfLink key where the value
is the selfLink of your UrlMap'
in two ways. First, you can place in the selfLink of the resource here as a
string Alternatively, you can add `register: name-of-resource` to a gcp_compute_url_map
task and then set this url_map field to "{{ name-of-resource }}"'
required: true
extends_documentation_fragment: gcp
notes:
@ -165,7 +164,7 @@ urlMap:
description:
- A reference to the UrlMap resource that defines the mapping from URL to the BackendService.
returned: success
type: dict
type: str
'''
################################################################################
@ -189,7 +188,7 @@ def main():
state=dict(default='present', choices=['present', 'absent'], type='str'),
description=dict(type='str'),
name=dict(required=True, type='str'),
url_map=dict(required=True, type='dict'),
url_map=dict(required=True)
)
)

2
plugins/modules/gcp_compute_target_http_proxy_facts.py
View file

@ -94,7 +94,7 @@ items:
- A reference to the UrlMap resource that defines the mapping from URL to the
BackendService.
returned: success
type: dict
type: str
'''
################################################################################

24
plugins/modules/gcp_compute_target_https_proxy.py
View file

@ -86,10 +86,9 @@ options:
resource. If not set, the TargetHttpsProxy resource will not have any SSL policy
configured.
- 'This field represents a link to a SslPolicy resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_compute_ssl_policy
task and then set this ssl_policy field to "{{ name-of-resource }}" Alternatively,
you can set this ssl_policy to a dictionary with the selfLink key where the
value is the selfLink of your SslPolicy'
in two ways. First, you can place in the selfLink of the resource here as a
string Alternatively, you can add `register: name-of-resource` to a gcp_compute_ssl_policy
task and then set this ssl_policy field to "{{ name-of-resource }}"'
required: false
version_added: 2.8
url_map:
@ -97,10 +96,9 @@ options:
- A reference to the UrlMap resource that defines the mapping from URL to the
BackendService.
- 'This field represents a link to a UrlMap resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_compute_url_map
task and then set this url_map field to "{{ name-of-resource }}" Alternatively,
you can set this url_map to a dictionary with the selfLink key where the value
is the selfLink of your UrlMap'
in two ways. First, you can place in the selfLink of the resource here as a
string Alternatively, you can add `register: name-of-resource` to a gcp_compute_url_map
task and then set this url_map field to "{{ name-of-resource }}"'
required: true
extends_documentation_fragment: gcp
notes:
@ -237,12 +235,12 @@ sslPolicy:
resource. If not set, the TargetHttpsProxy resource will not have any SSL policy
configured.
returned: success
type: dict
type: str
urlMap:
description:
- A reference to the UrlMap resource that defines the mapping from URL to the BackendService.
returned: success
type: dict
type: str
'''
################################################################################
@ -267,9 +265,9 @@ def main():
description=dict(type='str'),
name=dict(required=True, type='str'),
quic_override=dict(type='str', choices=['NONE', 'ENABLE', 'DISABLE']),
ssl_certificates=dict(required=True, type='list', elements='dict'),
ssl_policy=dict(type='dict'),
url_map=dict(required=True, type='dict')
ssl_certificates=dict(required=True, type='list'),
ssl_policy=dict(),
url_map=dict(required=True)
)
)

4
plugins/modules/gcp_compute_target_https_proxy_facts.py
View file

@ -111,13 +111,13 @@ items:
resource. If not set, the TargetHttpsProxy resource will not have any SSL
policy configured.
returned: success
type: dict
type: str
urlMap:
description:
- A reference to the UrlMap resource that defines the mapping from URL to the
BackendService.
returned: success
type: dict
type: str
'''
################################################################################

25
plugins/modules/gcp_compute_target_pool.py
View file

@ -61,10 +61,9 @@ options:
pool in the "force" mode, where traffic will be spread to the healthy instances
with the best effort, or to all instances when no instance is healthy.
- 'This field represents a link to a TargetPool resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_compute_target_pool
task and then set this backup_pool field to "{{ name-of-resource }}" Alternatively,
you can set this backup_pool to a dictionary with the selfLink key where the
value is the selfLink of your TargetPool'
in two ways. First, you can place in the selfLink of the resource here as a
string Alternatively, you can add `register: name-of-resource` to a gcp_compute_target_pool
task and then set this backup_pool field to "{{ name-of-resource }}"'
required: false
description:
description:
@ -91,10 +90,10 @@ options:
checks pass. If not specified it means all member instances will be considered
healthy at all times.
- 'This field represents a link to a HttpHealthCheck resource in GCP. It can be
specified in two ways. You can add `register: name-of-resource` to a gcp_compute_http_health_check
task and then set this health_check field to "{{ name-of-resource }}" Alternatively,
you can set this health_check to a dictionary with the selfLink key where the
value is the selfLink of your HttpHealthCheck'
specified in two ways. First, you can place in the selfLink of the resource
here as a string Alternatively, you can add `register: name-of-resource` to
a gcp_compute_http_health_check task and then set this health_check field to
"{{ name-of-resource }}"'
required: false
instances:
description:
@ -159,7 +158,7 @@ backupPool:
pool in the "force" mode, where traffic will be spread to the healthy instances
with the best effort, or to all instances when no instance is healthy.
returned: success
type: dict
type: str
creationTimestamp:
description:
- Creation timestamp in RFC3339 text format.
@ -192,7 +191,7 @@ healthCheck:
checks pass. If not specified it means all member instances will be considered
healthy at all times.
returned: success
type: dict
type: str
id:
description:
- The unique identifier for the resource.
@ -250,11 +249,11 @@ def main():
module = GcpModule(
argument_spec=dict(
state=dict(default='present', choices=['present', 'absent'], type='str'),
backup_pool=dict(type='dict'),
backup_pool=dict(),
description=dict(type='str'),
failover_ratio=dict(type='str'),
health_check=dict(type='dict'),
instances=dict(type='list', elements='dict'),
health_check=dict(),
instances=dict(type='list'),
name=dict(required=True, type='str'),
session_affinity=dict(type='str', choices=['NONE', 'CLIENT_IP', 'CLIENT_IP_PROTO']),
region=dict(required=True, type='str'),

4
plugins/modules/gcp_compute_target_pool_facts.py
View file

@ -83,7 +83,7 @@ items:
primary pool in the "force" mode, where traffic will be spread to the healthy
instances with the best effort, or to all instances when no instance is healthy.
returned: success
type: dict
type: str
creationTimestamp:
description:
- Creation timestamp in RFC3339 text format.
@ -116,7 +116,7 @@ items:
checks pass. If not specified it means all member instances will be considered
healthy at all times.
returned: success
type: dict
type: str
id:
description:
- The unique identifier for the resource.

25
plugins/modules/gcp_compute_target_ssl_proxy.py
View file

@ -73,10 +73,10 @@ options:
description:
- A reference to the BackendService resource.
- 'This field represents a link to a BackendService resource in GCP. It can be
specified in two ways. You can add `register: name-of-resource` to a gcp_compute_backend_service
task and then set this service field to "{{ name-of-resource }}" Alternatively,
you can set this service to a dictionary with the selfLink key where the value
is the selfLink of your BackendService'
specified in two ways. First, you can place in the selfLink of the resource
here as a string Alternatively, you can add `register: name-of-resource` to
a gcp_compute_backend_service task and then set this service field to "{{ name-of-resource
}}"'
required: true
ssl_certificates:
description:
@ -90,10 +90,9 @@ options:
resource. If not set, the TargetSslProxy resource will not have any SSL policy
configured.
- 'This field represents a link to a SslPolicy resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_compute_ssl_policy
task and then set this ssl_policy field to "{{ name-of-resource }}" Alternatively,
you can set this ssl_policy to a dictionary with the selfLink key where the
value is the selfLink of your SslPolicy'
in two ways. First, you can place in the selfLink of the resource here as a
string Alternatively, you can add `register: name-of-resource` to a gcp_compute_ssl_policy
task and then set this ssl_policy field to "{{ name-of-resource }}"'
required: false
version_added: 2.8
extends_documentation_fragment: gcp
@ -214,7 +213,7 @@ service:
description:
- A reference to the BackendService resource.
returned: success
type: dict
type: str
sslCertificates:
description:
- A list of SslCertificate resources that are used to authenticate connections between
@ -227,7 +226,7 @@ sslPolicy:
resource. If not set, the TargetSslProxy resource will not have any SSL policy
configured.
returned: success
type: dict
type: str
'''
################################################################################
@ -252,9 +251,9 @@ def main():
description=dict(type='str'),
name=dict(required=True, type='str'),
proxy_header=dict(type='str', choices=['NONE', 'PROXY_V1']),
service=dict(required=True, type='dict'),
ssl_certificates=dict(required=True, type='list', elements='dict'),
ssl_policy=dict(type='dict')
service=dict(required=True),
ssl_certificates=dict(required=True, type='list'),
ssl_policy=dict()
)
)

4
plugins/modules/gcp_compute_target_ssl_proxy_facts.py
View file

@ -99,7 +99,7 @@ items:
description:
- A reference to the BackendService resource.
returned: success
type: dict
type: str
sslCertificates:
description:
- A list of SslCertificate resources that are used to authenticate connections
@ -113,7 +113,7 @@ items:
resource. If not set, the TargetSslProxy resource will not have any SSL policy
configured.
returned: success
type: dict
type: str
'''
################################################################################

12
plugins/modules/gcp_compute_target_tcp_proxy.py
View file

@ -73,10 +73,10 @@ options:
description:
- A reference to the BackendService resource.
- 'This field represents a link to a BackendService resource in GCP. It can be
specified in two ways. You can add `register: name-of-resource` to a gcp_compute_backend_service
task and then set this service field to "{{ name-of-resource }}" Alternatively,
you can set this service to a dictionary with the selfLink key where the value
is the selfLink of your BackendService'
specified in two ways. First, you can place in the selfLink of the resource
here as a string Alternatively, you can add `register: name-of-resource` to
a gcp_compute_backend_service task and then set this service field to "{{ name-of-resource
}}"'
required: true
extends_documentation_fragment: gcp
notes:
@ -173,7 +173,7 @@ service:
description:
- A reference to the BackendService resource.
returned: success
type: dict
type: str
'''
################################################################################
@ -198,7 +198,7 @@ def main():
description=dict(type='str'),
name=dict(required=True, type='str'),
proxy_header=dict(type='str', choices=['NONE', 'PROXY_V1']),
service=dict(required=True, type='dict'),
service=dict(required=True)
)
)

2
plugins/modules/gcp_compute_target_tcp_proxy_facts.py
View file

@ -99,7 +99,7 @@ items:
description:
- A reference to the BackendService resource.
returned: success
type: dict
type: str
'''
################################################################################

13
plugins/modules/gcp_compute_target_vpn_gateway.py
View file

@ -65,10 +65,9 @@ options:
description:
- The network this VPN gateway is accepting traffic for.
- 'This field represents a link to a Network resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_compute_network
task and then set this network field to "{{ name-of-resource }}" Alternatively,
you can set this network to a dictionary with the selfLink key where the value
is the selfLink of your Network'
in two ways. First, you can place in the selfLink of the resource here as a
string Alternatively, you can add `register: name-of-resource` to a gcp_compute_network
task and then set this network field to "{{ name-of-resource }}"'
required: true
region:
description:
@ -140,7 +139,7 @@ network:
description:
- The network this VPN gateway is accepting traffic for.
returned: success
type: dict
type: str
tunnels:
description:
- A list of references to VpnTunnel resources associated to this VPN gateway.
@ -179,8 +178,8 @@ def main():
state=dict(default='present', choices=['present', 'absent'], type='str'),
description=dict(type='str'),
name=dict(required=True, type='str'),
network=dict(required=True, type='dict'),
region=dict(required=True, type='str'),
network=dict(required=True),
region=dict(required=True, type='str')
)
)

2
plugins/modules/gcp_compute_target_vpn_gateway_facts.py
View file

@ -98,7 +98,7 @@ items:
description:
- The network this VPN gateway is accepting traffic for.
returned: success
type: dict
type: str
tunnels:
description:
- A list of references to VpnTunnel resources associated to this VPN gateway.

50
plugins/modules/gcp_compute_url_map.py
View file

@ -52,10 +52,10 @@ options:
description:
- A reference to BackendService resource if none of the hostRules match.
- 'This field represents a link to a BackendService resource in GCP. It can be
specified in two ways. You can add `register: name-of-resource` to a gcp_compute_backend_service
task and then set this default_service field to "{{ name-of-resource }}" Alternatively,
you can set this default_service to a dictionary with the selfLink key where
the value is the selfLink of your BackendService'
specified in two ways. First, you can place in the selfLink of the resource
here as a string Alternatively, you can add `register: name-of-resource` to
a gcp_compute_backend_service task and then set this default_service field to
"{{ name-of-resource }}"'
required: true
description:
description:
@ -102,11 +102,10 @@ options:
- A reference to a BackendService resource. This will be used if none of the
pathRules defined by this PathMatcher is matched by the URL's path portion.
- 'This field represents a link to a BackendService resource in GCP. It can
be specified in two ways. You can add `register: name-of-resource` to a
gcp_compute_backend_service task and then set this default_service field
to "{{ name-of-resource }}" Alternatively, you can set this default_service
to a dictionary with the selfLink key where the value is the selfLink of
your BackendService'
be specified in two ways. First, you can place in the selfLink of the resource
here as a string Alternatively, you can add `register: name-of-resource`
to a gcp_compute_backend_service task and then set this default_service
field to "{{ name-of-resource }}"'
required: true
description:
description:
@ -132,11 +131,10 @@ options:
description:
- A reference to the BackendService resource if this rule is matched.
- 'This field represents a link to a BackendService resource in GCP. It
can be specified in two ways. You can add `register: name-of-resource`
to a gcp_compute_backend_service task and then set this service field
to "{{ name-of-resource }}" Alternatively, you can set this service
to a dictionary with the selfLink key where the value is the selfLink
of your BackendService'
can be specified in two ways. First, you can place in the selfLink of
the resource here as a string Alternatively, you can add `register:
name-of-resource` to a gcp_compute_backend_service task and then set
this service field to "{{ name-of-resource }}"'
required: true
tests:
description:
@ -161,10 +159,10 @@ options:
- A reference to expected BackendService resource the given URL should be
mapped to.
- 'This field represents a link to a BackendService resource in GCP. It can
be specified in two ways. You can add `register: name-of-resource` to a
gcp_compute_backend_service task and then set this service field to "{{
name-of-resource }}" Alternatively, you can set this service to a dictionary
with the selfLink key where the value is the selfLink of your BackendService'
be specified in two ways. First, you can place in the selfLink of the resource
here as a string Alternatively, you can add `register: name-of-resource`
to a gcp_compute_backend_service task and then set this service field to
"{{ name-of-resource }}"'
required: true
extends_documentation_fragment: gcp
'''
@ -227,7 +225,7 @@ defaultService:
description:
- A reference to BackendService resource if none of the hostRules match.
returned: success
type: dict
type: str
description:
description:
- An optional description of this resource. Provide this property when you create
@ -291,7 +289,7 @@ pathMatchers:
- A reference to a BackendService resource. This will be used if none of the
pathRules defined by this PathMatcher is matched by the URL's path portion.
returned: success
type: dict
type: str
description:
description:
- An optional description of this resource.
@ -320,7 +318,7 @@ pathMatchers:
description:
- A reference to the BackendService resource if this rule is matched.
returned: success
type: dict
type: str
tests:
description:
- The list of expected URL mappings. Requests to update this UrlMap will succeed
@ -348,7 +346,7 @@ tests:
- A reference to expected BackendService resource the given URL should be mapped
to.
returned: success
type: dict
type: str
'''
################################################################################
@ -370,7 +368,7 @@ def main():
module = GcpModule(
argument_spec=dict(
state=dict(default='present', choices=['present', 'absent'], type='str'),
default_service=dict(required=True, type='dict'),
default_service=dict(required=True),
description=dict(type='str'),
host_rules=dict(type='list', elements='dict', options=dict(
description=dict(type='str'),
@ -379,19 +377,19 @@ def main():
)),
name=dict(required=True, type='str'),
path_matchers=dict(type='list', elements='dict', options=dict(
default_service=dict(required=True, type='dict'),
default_service=dict(required=True),
description=dict(type='str'),
name=dict(required=True, type='str'),
path_rules=dict(type='list', elements='dict', options=dict(
paths=dict(required=True, type='list', elements='str'),
service=dict(required=True, type='dict')
service=dict(required=True)
))
)),
tests=dict(type='list', elements='dict', options=dict(
description=dict(type='str'),
host=dict(required=True, type='str'),
path=dict(required=True, type='str'),
service=dict(required=True, type='dict')
service=dict(required=True)
))
)
)

8
plugins/modules/gcp_compute_url_map_facts.py
View file

@ -73,7 +73,7 @@ items:
description:
- A reference to BackendService resource if none of the hostRules match.
returned: success
type: dict
type: str
description:
description:
- An optional description of this resource. Provide this property when you create
@ -138,7 +138,7 @@ items:
the pathRules defined by this PathMatcher is matched by the URL's path
portion.
returned: success
type: dict
type: str
description:
description:
- An optional description of this resource.
@ -167,7 +167,7 @@ items:
description:
- A reference to the BackendService resource if this rule is matched.
returned: success
type: dict
type: str
tests:
description:
- The list of expected URL mappings. Requests to update this UrlMap will succeed
@ -195,7 +195,7 @@ items:
- A reference to expected BackendService resource the given URL should be
mapped to.
returned: success
type: dict
type: str
'''
################################################################################

23
plugins/modules/gcp_compute_vpn_tunnel.py
View file

@ -63,19 +63,18 @@ options:
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'
be specified in two ways. First, you can place in the selfLink of the resource
here as a string Alternatively, 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 }}"'
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'
in two ways. First, you can place in the selfLink of the resource here as a
string Alternatively, you can add `register: name-of-resource` to a gcp_compute_router
task and then set this router field to "{{ name-of-resource }}"'
required: false
peer_ip:
description:
@ -198,12 +197,12 @@ targetVpnGateway:
description:
- URL of the Target VPN gateway with which this VPN tunnel is associated.
returned: success
type: dict
type: str
router:
description:
- URL of router resource to be used for dynamic routing.
returned: success
type: dict
type: str
peerIp:
description:
- IP address of the peer VPN gateway. Only IPv4 is supported.
@ -281,8 +280,8 @@ def main():
state=dict(default='present', choices=['present', 'absent'], type='str'),
name=dict(required=True, type='str'),
description=dict(type='str'),
target_vpn_gateway=dict(required=True, type='dict'),
router=dict(type='dict'),
target_vpn_gateway=dict(required=True),
router=dict(),
peer_ip=dict(required=True, type='str'),
shared_secret=dict(required=True, type='str'),
ike_version=dict(default=2, type='int'),

4
plugins/modules/gcp_compute_vpn_tunnel_facts.py
View file

@ -92,12 +92,12 @@ items:
description:
- URL of the Target VPN gateway with which this VPN tunnel is associated.
returned: success
type: dict
type: str
router:
description:
- URL of router resource to be used for dynamic routing.
returned: success
type: dict
type: str
peerIp:
description:
- IP address of the peer VPN gateway. Only IPv4 is supported.

31
plugins/modules/gcp_container_node_pool.py
View file

@ -203,10 +203,9 @@ options:
description:
- The cluster this node pool belongs to.
- 'This field represents a link to a Cluster resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_container_cluster
task and then set this cluster field to "{{ name-of-resource }}" Alternatively,
you can set this cluster to a dictionary with the name key where the value is
the name of your Cluster'
in two ways. First, you can place in the name of the resource here as a string
Alternatively, you can add `register: name-of-resource` to a gcp_container_cluster
task and then set this cluster field to "{{ name-of-resource }}"'
required: true
zone:
description:
@ -415,7 +414,7 @@ cluster:
description:
- The cluster this node pool belongs to.
returned: success
type: dict
type: str
zone:
description:
- The zone where the node pool is deployed.
@ -459,13 +458,21 @@ def main():
),
),
initial_node_count=dict(required=True, type='int'),
version=dict(type='str'),
autoscaling=dict(type='dict', options=dict(enabled=dict(type='bool'), min_node_count=dict(type='int'), max_node_count=dict(type='int'))),
management=dict(
type='dict', options=dict(auto_upgrade=dict(type='bool'), auto_repair=dict(type='bool'), upgrade_options=dict(type='dict', options=dict()))
),
cluster=dict(required=True, type='dict'),
location=dict(required=True, type='str', aliases=['region', 'zone']),
autoscaling=dict(type='dict', options=dict(
enabled=dict(type='bool'),
min_node_count=dict(type='int'),
max_node_count=dict(type='int')
)),
management=dict(type='dict', options=dict(
auto_upgrade=dict(type='bool'),
auto_repair=dict(type='bool'),
upgrade_options=dict(type='dict', options=dict(
auto_upgrade_start_time=dict(type='str'),
description=dict(type='str')
))
)),
cluster=dict(required=True),
zone=dict(required=True, type='str')
)
)

11
plugins/modules/gcp_container_node_pool_facts.py
View file

@ -49,10 +49,9 @@ options:
description:
- The cluster this node pool belongs to.
- 'This field represents a link to a Cluster resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_container_cluster
task and then set this cluster field to "{{ name-of-resource }}" Alternatively,
you can set this cluster to a dictionary with the name key where the value is
the name of your Cluster'
in two ways. First, you can place in the name of the resource here as a string
Alternatively, you can add `register: name-of-resource` to a gcp_container_cluster
task and then set this cluster field to "{{ name-of-resource }}"'
required: true
extends_documentation_fragment: gcp
'''
@ -249,7 +248,7 @@ items:
description:
- The cluster this node pool belongs to.
returned: success
type: dict
type: str
zone:
description:
- The zone where the node pool is deployed.
@ -272,7 +271,7 @@ def main():
module = GcpModule(
argument_spec=dict(
zone=dict(required=True, type='str'),
cluster=dict(required=True, type='dict')
cluster=dict(required=True)
)
)

11
plugins/modules/gcp_dns_resource_record_set.py
View file

@ -85,10 +85,9 @@ options:
- Identifies the managed zone addressed by this request.
- Can be the managed zone name or id.
- 'This field represents a link to a ManagedZone resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_dns_managed_zone
task and then set this managed_zone field to "{{ name-of-resource }}" Alternatively,
you can set this managed_zone to a dictionary with the name key where the value
is the name of your ManagedZone'
in two ways. First, you can place in the name of the resource here as a string
Alternatively, you can add `register: name-of-resource` to a gcp_dns_managed_zone
task and then set this managed_zone field to "{{ name-of-resource }}"'
required: true
extends_documentation_fragment: gcp
'''
@ -146,7 +145,7 @@ managed_zone:
- Identifies the managed zone addressed by this request.
- Can be the managed zone name or id.
returned: success
type: dict
type: str
'''
################################################################################
@ -174,7 +173,7 @@ def main():
type=dict(required=True, type='str', choices=['A', 'AAAA', 'CAA', 'CNAME', 'MX', 'NAPTR', 'NS', 'PTR', 'SOA', 'SPF', 'SRV', 'TLSA', 'TXT']),
ttl=dict(type='int'),
target=dict(type='list', elements='str'),
managed_zone=dict(required=True, type='dict'),
managed_zone=dict(required=True)
)
)

11
plugins/modules/gcp_dns_resource_record_set_facts.py
View file

@ -46,10 +46,9 @@ options:
- Identifies the managed zone addressed by this request.
- Can be the managed zone name or id.
- 'This field represents a link to a ManagedZone resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_dns_managed_zone
task and then set this managed_zone field to "{{ name-of-resource }}" Alternatively,
you can set this managed_zone to a dictionary with the name key where the value
is the name of your ManagedZone'
in two ways. First, you can place in the name of the resource here as a string
Alternatively, you can add `register: name-of-resource` to a gcp_dns_managed_zone
task and then set this managed_zone field to "{{ name-of-resource }}"'
required: true
extends_documentation_fragment: gcp
'''
@ -94,7 +93,7 @@ items:
- Identifies the managed zone addressed by this request.
- Can be the managed zone name or id.
returned: success
type: dict
type: str
'''
################################################################################
@ -111,7 +110,7 @@ import json
def main():
module = GcpModule(
argument_spec=dict(
managed_zone=dict(required=True, type='dict')
managed_zone=dict(required=True)
)
)

11
plugins/modules/gcp_iam_service_account_key.py
View file

@ -68,10 +68,9 @@ options:
description:
- The name of the serviceAccount.
- 'This field represents a link to a ServiceAccount resource in GCP. It can be
specified in two ways. You can add `register: name-of-resource` to a gcp_iam_service_account
task and then set this service_account field to "{{ name-of-resource }}" Alternatively,
you can set this service_account to a dictionary with the name key where the
value is the name of your ServiceAccount'
specified in two ways. First, you can place in the name of the resource here
as a string Alternatively, you can add `register: name-of-resource` to a gcp_iam_service_account
task and then set this service_account field to "{{ name-of-resource }}"'
required: false
path:
description:
@ -144,7 +143,7 @@ serviceAccount:
description:
- The name of the serviceAccount.
returned: success
type: dict
type: str
path:
description:
- The full name of the file that will hold the service account private key. The
@ -178,7 +177,7 @@ def main():
state=dict(default='present', choices=['present', 'absent'], type='str'),
private_key_type=dict(type='str', choices=['TYPE_UNSPECIFIED', 'TYPE_PKCS12_FILE', 'TYPE_GOOGLE_CREDENTIALS_FILE']),
key_algorithm=dict(type='str', choices=['KEY_ALG_UNSPECIFIED', 'KEY_ALG_RSA_1024', 'KEY_ALG_RSA_2048']),
service_account=dict(type='dict'),
service_account=dict(),
path=dict(type='path')
)
)

22
plugins/modules/gcp_pubsub_subscription.py
View file

@ -56,10 +56,9 @@ options:
description:
- A reference to a Topic resource.
- 'This field represents a link to a Topic resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_pubsub_topic
task and then set this topic field to "{{ name-of-resource }}" Alternatively,
you can set this topic to a dictionary with the name key where the value is
the name of your Topic'
in two ways. First, you can place in the name of the resource here as a string
Alternatively, you can add `register: name-of-resource` to a gcp_pubsub_topic
task and then set this topic field to "{{ name-of-resource }}"'
required: false
push_config:
description:
@ -127,7 +126,7 @@ topic:
description:
- A reference to a Topic resource.
returned: success
type: dict
type: str
pushConfig:
description:
- If push delivery is used with this subscription, this field is used to configure
@ -180,13 +179,12 @@ def main():
module = GcpModule(
argument_spec=dict(
state=dict(default='present', choices=['present', 'absent'], type='str'),
name=dict(required=True, type='str'),
topic=dict(required=True, type='dict'),
labels=dict(type='dict'),
push_config=dict(type='dict', options=dict(push_endpoint=dict(required=True, type='str'), attributes=dict(type='dict'))),
ack_deadline_seconds=dict(type='int'),
message_retention_duration=dict(default='604800s', type='str'),
retain_acked_messages=dict(type='bool'),
name=dict(type='str'),
topic=dict(),
push_config=dict(type='dict', options=dict(
push_endpoint=dict(type='str')
)),
ack_deadline_seconds=dict(type='int')
)
)

2
plugins/modules/gcp_pubsub_subscription_facts.py
View file

@ -67,7 +67,7 @@ items:
description:
- A reference to a Topic resource.
returned: success
type: dict
type: str
pushConfig:
description:
- If push delivery is used with this subscription, this field is used to configure

11
plugins/modules/gcp_spanner_database.py
View file

@ -64,10 +64,9 @@ options:
description:
- The instance to create the database on.
- 'This field represents a link to a Instance resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_spanner_instance
task and then set this instance field to "{{ name-of-resource }}" Alternatively,
you can set this instance to a dictionary with the name key where the value
is the name of your Instance'
in two ways. First, you can place in the name of the resource here as a string
Alternatively, you can add `register: name-of-resource` to a gcp_spanner_instance
task and then set this instance field to "{{ name-of-resource }}"'
required: true
extends_documentation_fragment: gcp
notes:
@ -120,7 +119,7 @@ instance:
description:
- The instance to create the database on.
returned: success
type: dict
type: str
'''
################################################################################
@ -143,7 +142,7 @@ def main():
state=dict(default='present', choices=['present', 'absent'], type='str'),
name=dict(required=True, type='str'),
extra_statements=dict(type='list', elements='str'),
instance=dict(required=True, type='dict'),
instance=dict(required=True)
)
)

11
plugins/modules/gcp_spanner_database_facts.py
View file

@ -45,10 +45,9 @@ options:
description:
- The instance to create the database on.
- 'This field represents a link to a Instance resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_spanner_instance
task and then set this instance field to "{{ name-of-resource }}" Alternatively,
you can set this instance to a dictionary with the name key where the value
is the name of your Instance'
in two ways. First, you can place in the name of the resource here as a string
Alternatively, you can add `register: name-of-resource` to a gcp_spanner_instance
task and then set this instance field to "{{ name-of-resource }}"'
required: true
extends_documentation_fragment: gcp
'''
@ -87,7 +86,7 @@ items:
description:
- The instance to create the database on.
returned: success
type: dict
type: str
'''
################################################################################
@ -104,7 +103,7 @@ import json
def main():
module = GcpModule(
argument_spec=dict(
instance=dict(required=True, type='dict')
instance=dict(required=True)
)
)

13
plugins/modules/gcp_sql_database.py
View file

@ -64,10 +64,9 @@ options:
description:
- The name of the Cloud SQL instance. This does not include the project ID.
- 'This field represents a link to a Instance resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_sql_instance
task and then set this instance field to "{{ name-of-resource }}" Alternatively,
you can set this instance to a dictionary with the name key where the value
is the name of your Instance'
in two ways. First, you can place in the name of the resource here as a string
Alternatively, you can add `register: name-of-resource` to a gcp_sql_instance
task and then set this instance field to "{{ name-of-resource }}"'
required: true
extends_documentation_fragment: gcp
'''
@ -121,7 +120,7 @@ instance:
description:
- The name of the Cloud SQL instance. This does not include the project ID.
returned: success
type: dict
type: str
'''
################################################################################
@ -145,8 +144,8 @@ def main():
state=dict(default='present', choices=['present', 'absent'], type='str'),
charset=dict(type='str'),
collation=dict(type='str'),
name=dict(required=True, type='str'),
instance=dict(required=True, type='str'),
name=dict(type='str'),
instance=dict(required=True)
)
)

11
plugins/modules/gcp_sql_database_facts.py
View file

@ -45,10 +45,9 @@ options:
description:
- The name of the Cloud SQL instance. This does not include the project ID.
- 'This field represents a link to a Instance resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_sql_instance
task and then set this instance field to "{{ name-of-resource }}" Alternatively,
you can set this instance to a dictionary with the name key where the value
is the name of your Instance'
in two ways. First, you can place in the name of the resource here as a string
Alternatively, you can add `register: name-of-resource` to a gcp_sql_instance
task and then set this instance field to "{{ name-of-resource }}"'
required: true
extends_documentation_fragment: gcp
'''
@ -88,7 +87,7 @@ items:
description:
- The name of the Cloud SQL instance. This does not include the project ID.
returned: success
type: dict
type: str
'''
################################################################################
@ -105,7 +104,7 @@ import json
def main():
module = GcpModule(
argument_spec=dict(
instance=dict(required=True, type='dict')
instance=dict(required=True)
)
)

13
plugins/modules/gcp_sql_user.py
View file

@ -61,10 +61,9 @@ options:
description:
- The name of the Cloud SQL instance. This does not include the project ID.
- 'This field represents a link to a Instance resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_sql_instance
task and then set this instance field to "{{ name-of-resource }}" Alternatively,
you can set this instance to a dictionary with the name key where the value
is the name of your Instance'
in two ways. First, you can place in the name of the resource here as a string
Alternatively, you can add `register: name-of-resource` to a gcp_sql_instance
task and then set this instance field to "{{ name-of-resource }}"'
required: true
password:
description:
@ -119,7 +118,7 @@ instance:
description:
- The name of the Cloud SQL instance. This does not include the project ID.
returned: success
type: dict
type: str
password:
description:
- The password for the user.
@ -148,8 +147,8 @@ def main():
state=dict(default='present', choices=['present', 'absent'], type='str'),
host=dict(required=True, type='str'),
name=dict(required=True, type='str'),
instance=dict(required=True, type='dict'),
password=dict(type='str'),
instance=dict(required=True),
password=dict(type='str')
)
)

11
plugins/modules/gcp_sql_user_facts.py
View file

@ -45,10 +45,9 @@ options:
description:
- The name of the Cloud SQL instance. This does not include the project ID.
- 'This field represents a link to a Instance resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_sql_instance
task and then set this instance field to "{{ name-of-resource }}" Alternatively,
you can set this instance to a dictionary with the name key where the value
is the name of your Instance'
in two ways. First, you can place in the name of the resource here as a string
Alternatively, you can add `register: name-of-resource` to a gcp_sql_instance
task and then set this instance field to "{{ name-of-resource }}"'
required: true
extends_documentation_fragment: gcp
'''
@ -84,7 +83,7 @@ items:
description:
- The name of the Cloud SQL instance. This does not include the project ID.
returned: success
type: dict
type: str
password:
description:
- The password for the user.
@ -106,7 +105,7 @@ import json
def main():
module = GcpModule(
argument_spec=dict(
instance=dict(required=True, type='dict')
instance=dict(required=True)
)
)

22
plugins/modules/gcp_storage_bucket.py
View file

@ -61,10 +61,9 @@ options:
description:
- The name of the bucket.
- 'This field represents a link to a Bucket resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_storage_bucket
task and then set this bucket field to "{{ name-of-resource }}" Alternatively,
you can set this bucket to a dictionary with the name key where the value
is the name of your Bucket'
in two ways. First, you can place in the name of the resource here as a
string Alternatively, you can add `register: name-of-resource` to a gcp_storage_bucket
task and then set this bucket field to "{{ name-of-resource }}"'
required: true
domain:
description:
@ -153,10 +152,9 @@ options:
description:
- The name of the bucket.
- 'This field represents a link to a Bucket resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_storage_bucket
task and then set this bucket field to "{{ name-of-resource }}" Alternatively,
you can set this bucket to a dictionary with the name key where the value
is the name of your Bucket'
in two ways. First, you can place in the name of the resource here as a
string Alternatively, you can add `register: name-of-resource` to a gcp_storage_bucket
task and then set this bucket field to "{{ name-of-resource }}"'
required: true
domain:
description:
@ -414,7 +412,7 @@ acl:
description:
- The name of the bucket.
returned: success
type: dict
type: str
domain:
description:
- The domain associated with the entity.
@ -508,7 +506,7 @@ defaultObjectAcl:
description:
- The name of the bucket.
returned: success
type: dict
type: str
domain:
description:
- The domain associated with the entity.
@ -792,7 +790,7 @@ def main():
argument_spec=dict(
state=dict(default='present', choices=['present', 'absent'], type='str'),
acl=dict(type='list', elements='dict', options=dict(
bucket=dict(required=True, type='dict'),
bucket=dict(required=True),
domain=dict(type='str'),
email=dict(type='str'),
entity=dict(required=True, type='str'),
@ -811,7 +809,7 @@ def main():
response_header=dict(type='list', elements='str')
)),
default_object_acl=dict(type='list', elements='dict', options=dict(
bucket=dict(required=True, type='dict'),
bucket=dict(required=True),
domain=dict(type='str'),
email=dict(type='str'),
entity=dict(required=True, type='str'),

11
plugins/modules/gcp_storage_bucket_access_control.py
View file

@ -60,10 +60,9 @@ options:
description:
- The name of the bucket.
- 'This field represents a link to a Bucket resource in GCP. It can be specified
in two ways. You can add `register: name-of-resource` to a gcp_storage_bucket
task and then set this bucket field to "{{ name-of-resource }}" Alternatively,
you can set this bucket to a dictionary with the name key where the value is
the name of your Bucket'
in two ways. First, you can place in the name of the resource here as a string
Alternatively, you can add `register: name-of-resource` to a gcp_storage_bucket
task and then set this bucket field to "{{ name-of-resource }}"'
required: true
entity:
description:
@ -132,7 +131,7 @@ bucket:
description:
- The name of the bucket.
returned: success
type: dict
type: str
domain:
description:
- The domain associated with the entity.
@ -204,7 +203,7 @@ def main():
module = GcpModule(
argument_spec=dict(
state=dict(default='present', choices=['present', 'absent'], type='str'),
bucket=dict(required=True, type='dict'),
bucket=dict(required=True),
entity=dict(required=True, type='str'),
entity_id=dict(type='str'),
project_team=dict(type='dict', options=dict(project_number=dict(type='str'), team=dict(type='str', choices=['editors', 'owners', 'viewers']))),