Add a few new fields to firewalls, and use PATCH instead of PUT for updates, because it supports updating more fields.

This commit is contained in:
Dana Hoffman 2018-08-20 21:21:35 +00:00 committed by Alex Stephen
parent 2837b2f836
commit 4b78ed9b8f
2 changed files with 514 additions and 404 deletions

View file

@ -48,6 +48,49 @@ requirements:
- google-auth >= 1.3.0 - google-auth >= 1.3.0
options: options:
state: state:
description:
- Whether the given object should exist in GCP
choices: ['present', 'absent']
default: 'present'
allowed:
description:
- The list of ALLOW rules specified by this firewall. Each rule specifies a protocol
and port-range tuple that describes a permitted connection.
required: false
suboptions:
ip_protocol:
description:
- The IP protocol to which this rule applies. The protocol type is required when creating
a firewall rule. This value can either be one of the following well known protocol
strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
required: true
ports:
description:
- An optional list of ports to which this rule applies. This field is only applicable
for UDP or TCP protocol. Each entry must be either an integer or a range. If not
specified, this rule applies to connections through any port.
- 'Example inputs include: ["22"], ["80","443"], and ["12345-12349"].'
required: false
denied:
description:
- The list of DENY rules specified by this firewall. Each rule specifies a protocol
and port-range tuple that describes a denied connection.
required: false
version_added: 2.7
suboptions:
ip_protocol:
description:
- The IP protocol to which this rule applies. The protocol type is required when creating
a firewall rule. This value can either be one of the following well known protocol
strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
required: true
ports:
description:
- An optional list of ports to which this rule applies. This field is only applicable
for UDP or TCP protocol. Each entry must be either an integer or a range. If not
specified, this rule applies to connections through any port.
- 'Example inputs include: ["22"], ["80","443"], and ["12345-12349"].'
required: false
description: description:
- Whether the given object should exist in GCP - Whether the given object should exist in GCP
choices: choices:
@ -62,12 +105,54 @@ options:
suboptions: suboptions:
ip_protocol: ip_protocol:
description: description:
- The IP protocol to which this rule applies. The protocol type is required - An optional description of this resource. Provide this property when you create
when creating a firewall rule. This value can either be one of the following the resource.
well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol required: false
number. destination_ranges:
description:
- If destination ranges are specified, the firewall will apply only to traffic that
has destination IP address in these ranges. These ranges must be expressed in CIDR
format. Only IPv4 is supported.
required: false
version_added: 2.7
direction:
description:
- 'Direction of traffic to which this firewall applies; default is INGRESS. Note:
For INGRESS traffic, it is NOT supported to specify destinationRanges; For EGRESS
traffic, it is NOT supported to specify sourceRanges OR sourceTags.'
required: false
version_added: 2.7
choices: ['INGRESS', 'EGRESS']
name:
description:
- Name of the resource. Provided by the client when the resource is created. The name
must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`
which means the first character must be a lowercase letter, and all following characters
must be a dash, lowercase letter, or digit, except the last character, which cannot
be a dash.
required: true required: true
ports: network:
description:
- 'URL of the network resource for this firewall rule. If not specified when creating
a firewall rule, the default network is used: global/networks/default If you choose to
specify this property, you can specify the network as a full or partial URL. For
example, the following are all valid URLs:
U(https://www.googleapis.com/compute/v1/projects/myproject/global/)
networks/my-network projects/myproject/global/networks/my-network
global/networks/default .'
required: true
priority:
description:
- Priority for this rule. This is an integer between 0 and 65535, both inclusive.
When not specified, the value assumed is 1000. Relative priorities determine precedence
of conflicting rules. Lower value of priority implies higher precedence (eg, a rule
with priority 0 has higher precedence than a rule with priority 1). DENY rules take
precedence over ALLOW rules having equal priority.
required: false
default: 1000
version_added: 2.7
source_ranges:
description: description:
- An optional list of ports to which this rule applies. This field is only - An optional list of ports to which this rule applies. This field is only
applicable for UDP or TCP protocol. Each entry must be either an integer applicable for UDP or TCP protocol. Each entry must be either an integer
@ -75,21 +160,40 @@ options:
port. port.
- 'Example inputs include: ["22"], ["80","443"], and ["12345-12349"].' - 'Example inputs include: ["22"], ["80","443"], and ["12345-12349"].'
required: false required: false
denied: source_service_accounts:
description: description:
- The list of DENY rules specified by this firewall. Each rule specifies a protocol - If source service accounts are specified, the firewall will apply only to traffic
and port-range tuple that describes a denied connection. originating from an instance with a service account in this list. Source service
accounts cannot be used to control traffic to an instance's external IP address
because service accounts are associated with an instance, not an IP address. sourceRanges
can be set at the same time as sourceServiceAccounts. If both are set, the firewall
will apply to traffic that has source IP address within sourceRanges OR the source
IP belongs to an instance with service account listed in sourceServiceAccount. The
connection does not need to match both properties for the firewall to apply. sourceServiceAccounts
cannot be used at the same time as sourceTags or targetTags.
required: false required: false
version_added: 2.8 version_added: 2.7
suboptions: source_tags:
ip_protocol:
description: description:
- The IP protocol to which this rule applies. The protocol type is required - If source tags are specified, the firewall will apply only to traffic with source
when creating a firewall rule. This value can either be one of the following IP that belongs to a tag listed in source tags. Source tags cannot be used to control
well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol traffic to an instance's external IP address. Because tags are associated with an
number. instance, not an IP address. One or both of sourceRanges and sourceTags may be set.
required: true If both properties are set, the firewall will apply to traffic that has source IP
ports: address within sourceRanges OR the source IP that belongs to a tag listed in the
sourceTags property. The connection does not need to match both properties for the
firewall to apply.
required: false
target_service_accounts:
description:
- A list of service accounts indicating sets of instances located in the network that
may make network connections as specified in allowed[].
- targetServiceAccounts cannot be used at the same time as targetTags or sourceTags.
If neither targetServiceAccounts nor targetTags are specified, the firewall rule
applies to all instances on the specified network.
required: false
version_added: 2.7
target_tags:
description: description:
- An optional list of ports to which this rule applies. This field is only - An optional list of ports to which this rule applies. This field is only
applicable for UDP or TCP protocol. Each entry must be either an integer applicable for UDP or TCP protocol. Each entry must be either an integer
@ -146,9 +250,10 @@ options:
networks/my-network projects/myproject/global/networks/my-network global/networks/default 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 - 'This field represents a link to a Network resource in GCP. It can be specified
in two ways. First, you can place in the selfLink of the resource here as a in two ways. First, you can place a dictionary with key ''selfLink'' and value
string Alternatively, you can add `register: name-of-resource` to a gcp_compute_network of your resource''s selfLink Alternatively, you can add `register: name-of-resource`
task and then set this network field to "{{ name-of-resource }}"' to a gcp_compute_network task and then set this network field to "{{ name-of-resource
}}"'
required: false required: false
default: default:
selfLink: global/networks/default selfLink: global/networks/default
@ -214,14 +319,14 @@ options:
required: false required: false
extends_documentation_fragment: gcp extends_documentation_fragment: gcp
notes: notes:
- 'API Reference: U(https://cloud.google.com/compute/docs/reference/latest/firewalls)' - "API Reference: U(https://cloud.google.com/compute/docs/reference/latest/firewalls)"
- 'Official Documentation: U(https://cloud.google.com/vpc/docs/firewalls)' - "Official Documentation: U(https://cloud.google.com/vpc/docs/firewalls)"
''' '''
EXAMPLES = ''' EXAMPLES = '''
- name: create a firewall - name: create a firewall
gcp_compute_firewall: gcp_compute_firewall:
name: "test_object" name: test_object
allowed: allowed:
- ip_protocol: tcp - ip_protocol: tcp
ports: ports:
@ -231,14 +336,14 @@ EXAMPLES = '''
- staging-ssh-server - staging-ssh-server
source_tags: source_tags:
- test-ssh-clients - test-ssh-clients
project: "test_project" project: test_project
auth_kind: "serviceaccount" auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem" service_account_file: "/tmp/auth.pem"
state: present state: present
''' '''
RETURN = ''' RETURN = '''
allowed: allowed:
description: description:
- The list of ALLOW rules specified by this firewall. Each rule specifies a protocol - The list of ALLOW rules specified by this firewall. Each rule specifies a protocol
and port-range tuple that describes a permitted connection. and port-range tuple that describes a permitted connection.
@ -247,26 +352,25 @@ allowed:
contains: contains:
ip_protocol: ip_protocol:
description: description:
- The IP protocol to which this rule applies. The protocol type is required - The IP protocol to which this rule applies. The protocol type is required when creating
when creating a firewall rule. This value can either be one of the following a firewall rule. This value can either be one of the following well known protocol
well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
number.
returned: success returned: success
type: str type: str
ports: ports:
description: description:
- An optional list of ports to which this rule applies. This field is only applicable - An optional list of ports to which this rule applies. This field is only applicable
for UDP or TCP protocol. Each entry must be either an integer or a range. for UDP or TCP protocol. Each entry must be either an integer or a range. If not
If not specified, this rule applies to connections through any port. specified, this rule applies to connections through any port.
- 'Example inputs include: ["22"], ["80","443"], and ["12345-12349"].' - 'Example inputs include: ["22"], ["80","443"], and ["12345-12349"].'
returned: success returned: success
type: list type: list
creationTimestamp: creation_timestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
type: str type: str
denied: denied:
description: description:
- The list of DENY rules specified by this firewall. Each rule specifies a protocol - The list of DENY rules specified by this firewall. Each rule specifies a protocol
and port-range tuple that describes a denied connection. and port-range tuple that describes a denied connection.
@ -275,94 +379,85 @@ denied:
contains: contains:
ip_protocol: ip_protocol:
description: description:
- The IP protocol to which this rule applies. The protocol type is required - The IP protocol to which this rule applies. The protocol type is required when creating
when creating a firewall rule. This value can either be one of the following a firewall rule. This value can either be one of the following well known protocol
well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
number.
returned: success returned: success
type: str type: str
ports: ports:
description: description:
- An optional list of ports to which this rule applies. This field is only applicable - An optional list of ports to which this rule applies. This field is only applicable
for UDP or TCP protocol. Each entry must be either an integer or a range. for UDP or TCP protocol. Each entry must be either an integer or a range. If not
If not specified, this rule applies to connections through any port. specified, this rule applies to connections through any port.
- 'Example inputs include: ["22"], ["80","443"], and ["12345-12349"].' - 'Example inputs include: ["22"], ["80","443"], and ["12345-12349"].'
returned: success returned: success
type: list type: list
description: description:
description: description:
- An optional description of this resource. Provide this property when you create - An optional description of this resource. Provide this property when you create
the resource. the resource.
returned: success returned: success
type: str type: str
destinationRanges: destination_ranges:
description: description:
- If destination ranges are specified, the firewall will apply only to traffic that - If destination ranges are specified, the firewall will apply only to traffic that
has destination IP address in these ranges. These ranges must be expressed in has destination IP address in these ranges. These ranges must be expressed in CIDR
CIDR format. Only IPv4 is supported. format. Only IPv4 is supported.
returned: success returned: success
type: list type: list
direction: direction:
description: description:
- 'Direction of traffic to which this firewall applies; default is INGRESS. Note: - 'Direction of traffic to which this firewall applies; default is INGRESS. Note:
For INGRESS traffic, it is NOT supported to specify destinationRanges; For EGRESS For INGRESS traffic, it is NOT supported to specify destinationRanges; For EGRESS
traffic, it is NOT supported to specify sourceRanges OR sourceTags.' traffic, it is NOT supported to specify sourceRanges OR sourceTags.'
returned: success returned: success
type: str type: str
disabled: id:
description:
- Denotes whether the firewall rule is disabled, i.e not applied to the network
it is associated with. When set to true, the firewall rule is not enforced and
the network behaves as if it did not exist. If this is unspecified, the firewall
rule will be enabled.
returned: success
type: bool
id:
description: description:
- The unique identifier for the resource. - The unique identifier for the resource.
returned: success returned: success
type: int type: int
name: name:
description: description:
- Name of the resource. Provided by the client when the resource is created. The - Name of the resource. Provided by the client when the resource is created. The name
name must be 1-63 characters long, and comply with RFC1035. Specifically, the must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`
which means the first character must be a lowercase letter, and all following which means the first character must be a lowercase letter, and all following characters
characters must be a dash, lowercase letter, or digit, except the last character, must be a dash, lowercase letter, or digit, except the last character, which cannot
which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
network: network:
description: description:
- 'URL of the network resource for this firewall rule. If not specified when creating - 'URL of the network resource for this firewall rule. If not specified when creating
a firewall rule, the default network is used: global/networks/default If you choose a firewall rule, the default network is used: global/networks/default If you choose to
to specify this property, you can specify the network as a full or partial URL. specify this property, you can specify the network as a full or partial URL. For
For example, the following are all valid URLs: U(https://www.googleapis.com/compute/v1/projects/myproject/global/) example, the following are all valid URLs:
networks/my-network projects/myproject/global/networks/my-network global/networks/default U(https://www.googleapis.com/compute/v1/projects/myproject/global/)
.' networks/my-network projects/myproject/global/networks/my-network
global/networks/default .'
returned: success returned: success
type: str type: dict
priority: priority:
description: description:
- Priority for this rule. This is an integer between 0 and 65535, both inclusive. - Priority for this rule. This is an integer between 0 and 65535, both inclusive.
When not specified, the value assumed is 1000. Relative priorities determine precedence When not specified, the value assumed is 1000. Relative priorities determine precedence
of conflicting rules. Lower value of priority implies higher precedence (eg, a of conflicting rules. Lower value of priority implies higher precedence (eg, a rule
rule with priority 0 has higher precedence than a rule with priority 1). DENY with priority 0 has higher precedence than a rule with priority 1). DENY rules take
rules take precedence over ALLOW rules having equal priority. precedence over ALLOW rules having equal priority.
returned: success returned: success
type: int type: int
sourceRanges: source_ranges:
description: description:
- If source ranges are specified, the firewall will apply only to traffic that has - If source ranges are specified, the firewall will apply only to traffic that has
source IP address in these ranges. These ranges must be expressed in CIDR format. source IP address in these ranges. These ranges must be expressed in CIDR format.
One or both of sourceRanges and sourceTags may be set. If both properties are One or both of sourceRanges and sourceTags may be set. If both properties are set,
set, the firewall will apply to traffic that has source IP address within sourceRanges the firewall will apply to traffic that has source IP address within sourceRanges
OR the source IP that belongs to a tag listed in the sourceTags property. The OR the source IP that belongs to a tag listed in the sourceTags property. The connection
connection does not need to match both properties for the firewall to apply. Only does not need to match both properties for the firewall to apply. Only IPv4 is supported.
IPv4 is supported.
returned: success returned: success
type: list type: list
sourceServiceAccounts: source_service_accounts:
description: description:
- If source service accounts are specified, the firewall will apply only to traffic - If source service accounts are specified, the firewall will apply only to traffic
originating from an instance with a service account in this list. Source service originating from an instance with a service account in this list. Source service
@ -370,38 +465,38 @@ sourceServiceAccounts:
because service accounts are associated with an instance, not an IP address. sourceRanges because service accounts are associated with an instance, not an IP address. sourceRanges
can be set at the same time as sourceServiceAccounts. If both are set, the firewall can be set at the same time as sourceServiceAccounts. If both are set, the firewall
will apply to traffic that has source IP address within sourceRanges OR the source will apply to traffic that has source IP address within sourceRanges OR the source
IP belongs to an instance with service account listed in sourceServiceAccount. IP belongs to an instance with service account listed in sourceServiceAccount. The
The connection does not need to match both properties for the firewall to apply. connection does not need to match both properties for the firewall to apply. sourceServiceAccounts
sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags. cannot be used at the same time as sourceTags or targetTags.
returned: success returned: success
type: list type: list
sourceTags: source_tags:
description: description:
- If source tags are specified, the firewall will apply only to traffic with source - If source tags are specified, the firewall will apply only to traffic with source
IP that belongs to a tag listed in source tags. Source tags cannot be used to IP that belongs to a tag listed in source tags. Source tags cannot be used to control
control traffic to an instance's external IP address. Because tags are associated traffic to an instance's external IP address. Because tags are associated with an
with an instance, not an IP address. One or both of sourceRanges and sourceTags instance, not an IP address. One or both of sourceRanges and sourceTags may be set.
may be set. If both properties are set, the firewall will apply to traffic that If both properties are set, the firewall will apply to traffic that has source IP
has source IP address within sourceRanges OR the source IP that belongs to a tag address within sourceRanges OR the source IP that belongs to a tag listed in the
listed in the sourceTags property. The connection does not need to match both sourceTags property. The connection does not need to match both properties for the
properties for the firewall to apply. firewall to apply.
returned: success returned: success
type: list type: list
targetServiceAccounts: target_service_accounts:
description: description:
- A list of service accounts indicating sets of instances located in the network - A list of service accounts indicating sets of instances located in the network that
that may make network connections as specified in allowed[]. may make network connections as specified in allowed[].
- targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. - targetServiceAccounts cannot be used at the same time as targetTags or sourceTags.
If neither targetServiceAccounts nor targetTags are specified, the firewall rule If neither targetServiceAccounts nor targetTags are specified, the firewall rule
applies to all instances on the specified network. applies to all instances on the specified network.
returned: success returned: success
type: list type: list
targetTags: target_tags:
description: description:
- A list of instance tags indicating sets of instances located in the network that - A list of instance tags indicating sets of instances located in the network that
may make network connections as specified in allowed[]. may make network connections as specified in allowed[].
- If no targetTags are specified, the firewall rule applies to all instances on - If no targetTags are specified, the firewall rule applies to all instances on the
the specified network. specified network.
returned: success returned: success
type: list type: list
''' '''
@ -426,30 +521,26 @@ def main():
module = GcpModule( module = GcpModule(
argument_spec=dict( argument_spec=dict(
state=dict(default='present', choices=['present', 'absent'], type='str'), state=dict(default='present', choices=['present', 'absent'], type='str'),
allowed=dict(type='list', elements='dict', options=dict(ip_protocol=dict(required=True, type='str'), ports=dict(type='list', elements='str'))), allowed=dict(type='list', elements='dict', options=dict(
denied=dict(type='list', elements='dict', options=dict(ip_protocol=dict(required=True, type='str'), ports=dict(type='list', elements='str'))), ip_protocol=dict(required=True, type='str'),
ports=dict(type='list', elements='str')
)),
denied=dict(type='list', elements='dict', options=dict(
ip_protocol=dict(required=True, type='str'),
ports=dict(type='list', elements='str')
)),
description=dict(type='str'), description=dict(type='str'),
destination_ranges=dict(type='list', elements='str'), destination_ranges=dict(type='list', elements='str'),
direction=dict(type='str', choices=['INGRESS', 'EGRESS']), direction=dict(type='str', choices=['INGRESS', 'EGRESS']),
disabled=dict(type='bool'),
name=dict(required=True, type='str'), name=dict(required=True, type='str'),
network=dict(default=dict(selfLink='global/networks/default')), network=dict(required=True, type='dict'),
priority=dict(default=1000, type='int'), priority=dict(default=1000, type='int'),
source_ranges=dict(type='list', elements='str'), source_ranges=dict(type='list', elements='str'),
source_service_accounts=dict(type='list', elements='str'), source_service_accounts=dict(type='list', elements='str'),
source_tags=dict(type='list', elements='str'), source_tags=dict(type='list', elements='str'),
target_service_accounts=dict(type='list', elements='str'), target_service_accounts=dict(type='list', elements='str'),
target_tags=dict(type='list', elements='str'), target_tags=dict(type='list', elements='str')
), )
mutually_exclusive=[
['allowed', 'denied'],
['destination_ranges', 'source_ranges', 'source_tags'],
['destination_ranges', 'source_ranges'],
['source_service_accounts', 'source_tags', 'target_tags'],
['destination_ranges', 'source_service_accounts', 'source_tags', 'target_service_accounts'],
['source_tags', 'target_service_accounts', 'target_tags'],
['source_service_accounts', 'target_service_accounts', 'target_tags'],
],
) )
if not module.params['scopes']: if not module.params['scopes']:
@ -506,7 +597,6 @@ def resource_to_request(module):
u'description': module.params.get('description'), u'description': module.params.get('description'),
u'destinationRanges': module.params.get('destination_ranges'), u'destinationRanges': module.params.get('destination_ranges'),
u'direction': module.params.get('direction'), u'direction': module.params.get('direction'),
u'disabled': module.params.get('disabled'),
u'name': module.params.get('name'), u'name': module.params.get('name'),
u'network': replace_resource_dict(module.params.get(u'network', {}), 'selfLink'), u'network': replace_resource_dict(module.params.get(u'network', {}), 'selfLink'),
u'priority': module.params.get('priority'), u'priority': module.params.get('priority'),
@ -514,7 +604,7 @@ def resource_to_request(module):
u'sourceServiceAccounts': module.params.get('source_service_accounts'), u'sourceServiceAccounts': module.params.get('source_service_accounts'),
u'sourceTags': module.params.get('source_tags'), u'sourceTags': module.params.get('source_tags'),
u'targetServiceAccounts': module.params.get('target_service_accounts'), u'targetServiceAccounts': module.params.get('target_service_accounts'),
u'targetTags': module.params.get('target_tags'), u'targetTags': module.params.get('target_tags')
} }
request = encode_request(request, module) request = encode_request(request, module)
return_vals = {} return_vals = {}
@ -587,7 +677,6 @@ def response_to_hash(module, response):
u'description': response.get(u'description'), u'description': response.get(u'description'),
u'destinationRanges': response.get(u'destinationRanges'), u'destinationRanges': response.get(u'destinationRanges'),
u'direction': response.get(u'direction'), u'direction': response.get(u'direction'),
u'disabled': response.get(u'disabled'),
u'id': response.get(u'id'), u'id': response.get(u'id'),
u'name': module.params.get('name'), u'name': module.params.get('name'),
u'network': response.get(u'network'), u'network': response.get(u'network'),
@ -596,7 +685,7 @@ def response_to_hash(module, response):
u'sourceServiceAccounts': response.get(u'sourceServiceAccounts'), u'sourceServiceAccounts': response.get(u'sourceServiceAccounts'),
u'sourceTags': response.get(u'sourceTags'), u'sourceTags': response.get(u'sourceTags'),
u'targetServiceAccounts': response.get(u'targetServiceAccounts'), u'targetServiceAccounts': response.get(u'targetServiceAccounts'),
u'targetTags': response.get(u'targetTags'), u'targetTags': response.get(u'targetTags')
} }
@ -699,5 +788,38 @@ class FirewallDeniedArray(object):
return remove_nones_from_dict({u'IPProtocol': item.get(u'IPProtocol'), u'ports': item.get(u'ports')}) return remove_nones_from_dict({u'IPProtocol': item.get(u'IPProtocol'), u'ports': item.get(u'ports')})
class FirewallDeniedArray(object):
def __init__(self, request, module):
self.module = module
if request:
self.request = request
else:
self.request = []
def to_request(self):
items = []
for item in self.request:
items.append(self._request_for_item(item))
return items
def from_response(self):
items = []
for item in self.request:
items.append(self._response_from_item(item))
return items
def _request_for_item(self, item):
return remove_nones_from_dict({
u'IPProtocol': item.get('ip_protocol'),
u'ports': item.get('ports')
})
def _response_from_item(self, item):
return remove_nones_from_dict({
u'IPProtocol': item.get(u'ip_protocol'),
u'ports': item.get(u'ports')
})
if __name__ == '__main__': if __name__ == '__main__':
main() main()

View file

@ -49,13 +49,14 @@ extends_documentation_fragment: gcp
''' '''
EXAMPLES = ''' EXAMPLES = '''
- name: a firewall facts - name: " a firewall facts"
gcp_compute_firewall_facts: gcp_compute_firewall_facts:
filters: filters:
- name = test_object - name = test_object
project: test_project project: test_project
auth_kind: serviceaccount auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem" service_account_file: "/tmp/auth.pem"
state: facts
''' '''
RETURN = ''' RETURN = '''
@ -66,29 +67,27 @@ items:
contains: contains:
allowed: allowed:
description: description:
- The list of ALLOW rules specified by this firewall. Each rule specifies a - The list of ALLOW rules specified by this firewall. Each rule specifies a protocol
protocol and port-range tuple that describes a permitted connection. and port-range tuple that describes a permitted connection.
returned: success returned: success
type: complex type: complex
contains: contains:
ip_protocol: ip_protocol:
description: description:
- The IP protocol to which this rule applies. The protocol type is required - The IP protocol to which this rule applies. The protocol type is required when creating
when creating a firewall rule. This value can either be one of the following a firewall rule. This value can either be one of the following well known protocol
well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
protocol number.
returned: success returned: success
type: str type: str
ports: ports:
description: description:
- An optional list of ports to which this rule applies. This field is only - An optional list of ports to which this rule applies. This field is only applicable
applicable for UDP or TCP protocol. Each entry must be either an integer for UDP or TCP protocol. Each entry must be either an integer or a range. If not
or a range. If not specified, this rule applies to connections through specified, this rule applies to connections through any port.
any port.
- 'Example inputs include: ["22"], ["80","443"], and ["12345-12349"].' - 'Example inputs include: ["22"], ["80","443"], and ["12345-12349"].'
returned: success returned: success
type: list type: list
creationTimestamp: creation_timestamp:
description: description:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
@ -102,18 +101,16 @@ items:
contains: contains:
ip_protocol: ip_protocol:
description: description:
- The IP protocol to which this rule applies. The protocol type is required - The IP protocol to which this rule applies. The protocol type is required when creating
when creating a firewall rule. This value can either be one of the following a firewall rule. This value can either be one of the following well known protocol
well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
protocol number.
returned: success returned: success
type: str type: str
ports: ports:
description: description:
- An optional list of ports to which this rule applies. This field is only - An optional list of ports to which this rule applies. This field is only applicable
applicable for UDP or TCP protocol. Each entry must be either an integer for UDP or TCP protocol. Each entry must be either an integer or a range. If not
or a range. If not specified, this rule applies to connections through specified, this rule applies to connections through any port.
any port.
- 'Example inputs include: ["22"], ["80","443"], and ["12345-12349"].' - 'Example inputs include: ["22"], ["80","443"], and ["12345-12349"].'
returned: success returned: success
type: list type: list
@ -123,28 +120,20 @@ items:
the resource. the resource.
returned: success returned: success
type: str type: str
destinationRanges: destination_ranges:
description: description:
- If destination ranges are specified, the firewall will apply only to traffic - If destination ranges are specified, the firewall will apply only to traffic that
that has destination IP address in these ranges. These ranges must be expressed has destination IP address in these ranges. These ranges must be expressed in CIDR
in CIDR format. Only IPv4 is supported. format. Only IPv4 is supported.
returned: success returned: success
type: list type: list
direction: direction:
description: description:
- 'Direction of traffic to which this firewall applies; default is INGRESS. - 'Direction of traffic to which this firewall applies; default is INGRESS. Note:
Note: For INGRESS traffic, it is NOT supported to specify destinationRanges; For INGRESS traffic, it is NOT supported to specify destinationRanges; For EGRESS
For EGRESS traffic, it is NOT supported to specify sourceRanges OR sourceTags.' traffic, it is NOT supported to specify sourceRanges OR sourceTags.'
returned: success returned: success
type: str type: str
disabled:
description:
- Denotes whether the firewall rule is disabled, i.e not applied to the network
it is associated with. When set to true, the firewall rule is not enforced
and the network behaves as if it did not exist. If this is unspecified, the
firewall rule will be enabled.
returned: success
type: bool
id: id:
description: description:
- The unique identifier for the resource. - The unique identifier for the resource.
@ -152,85 +141,84 @@ items:
type: int type: int
name: name:
description: description:
- Name of the resource. Provided by the client when the resource is created. - Name of the resource. Provided by the client when the resource is created. The name
The name must be 1-63 characters long, and comply with RFC1035. Specifically, must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`
which means the first character must be a lowercase letter, and all following which means the first character must be a lowercase letter, and all following characters
characters must be a dash, lowercase letter, or digit, except the last character, must be a dash, lowercase letter, or digit, except the last character, which cannot
which cannot be a dash. be a dash.
returned: success returned: success
type: str type: str
network: network:
description: description:
- 'URL of the network resource for this firewall rule. If not specified when - 'URL of the network resource for this firewall rule. If not specified when
creating a firewall rule, the default network is used: global/networks/default creating a firewall rule, the default network is used: global/networks/default If
If you choose to specify this property, you can specify the network as a full you choose to specify this property, you can specify the network as a full or
or partial URL. For example, the following are all valid URLs: U(https://www.googleapis.com/compute/v1/projects/myproject/global/) partial URL. For example, the following are all valid URLs:
networks/my-network projects/myproject/global/networks/my-network global/networks/default U(https://www.googleapis.com/compute/v1/projects/myproject/global/)
.' networks/my-network projects/myproject/global/networks/my-network
global/networks/default .'
returned: success returned: success
type: str type: dict
priority: priority:
description: description:
- Priority for this rule. This is an integer between 0 and 65535, both inclusive. - Priority for this rule. This is an integer between 0 and 65535, both inclusive.
When not specified, the value assumed is 1000. Relative priorities determine When not specified, the value assumed is 1000. Relative priorities determine precedence
precedence of conflicting rules. Lower value of priority implies higher precedence of conflicting rules. Lower value of priority implies higher precedence (eg, a rule
(eg, a rule with priority 0 has higher precedence than a rule with priority with priority 0 has higher precedence than a rule with priority 1). DENY rules take
1). DENY rules take precedence over ALLOW rules having equal priority. precedence over ALLOW rules having equal priority.
returned: success returned: success
type: int type: int
sourceRanges: source_ranges:
description: description:
- If source ranges are specified, the firewall will apply only to traffic that - If source ranges are specified, the firewall will apply only to traffic that has
has source IP address in these ranges. These ranges must be expressed in CIDR source IP address in these ranges. These ranges must be expressed in CIDR format.
format. One or both of sourceRanges and sourceTags may be set. If both properties One or both of sourceRanges and sourceTags may be set. If both properties are set,
are set, the firewall will apply to traffic that has source IP address within the firewall will apply to traffic that has source IP address within sourceRanges
sourceRanges OR the source IP that belongs to a tag listed in the sourceTags OR the source IP that belongs to a tag listed in the sourceTags property. The connection
property. The connection does not need to match both properties for the firewall does not need to match both properties for the firewall to apply. Only IPv4 is supported.
to apply. Only IPv4 is supported.
returned: success returned: success
type: list type: list
sourceServiceAccounts: source_service_accounts:
description: description:
- If source service accounts are specified, the firewall will apply only to - If source service accounts are specified, the firewall will apply only to traffic
traffic originating from an instance with a service account in this list. originating from an instance with a service account in this list. Source service
Source service accounts cannot be used to control traffic to an instance's accounts cannot be used to control traffic to an instance's external IP address
external IP address because service accounts are associated with an instance, because service accounts are associated with an instance, not an IP address. sourceRanges
not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. can be set at the same time as sourceServiceAccounts. If both are set, the firewall
If both are set, the firewall will apply to traffic that has source IP address will apply to traffic that has source IP address within sourceRanges OR the source
within sourceRanges OR the source IP belongs to an instance with service account IP belongs to an instance with service account listed in sourceServiceAccount. The
listed in sourceServiceAccount. The connection does not need to match both connection does not need to match both properties for the firewall to apply. sourceServiceAccounts
properties for the firewall to apply. sourceServiceAccounts cannot be used cannot be used at the same time as sourceTags or targetTags.
at the same time as sourceTags or targetTags.
returned: success returned: success
type: list type: list
sourceTags: source_tags:
description: description:
- If source tags are specified, the firewall will apply only to traffic with - If source tags are specified, the firewall will apply only to traffic with source
source IP that belongs to a tag listed in source tags. Source tags cannot IP that belongs to a tag listed in source tags. Source tags cannot be used to control
be used to control traffic to an instance's external IP address. Because tags traffic to an instance's external IP address. Because tags are associated with an
are associated with an instance, not an IP address. One or both of sourceRanges instance, not an IP address. One or both of sourceRanges and sourceTags may be set.
and sourceTags may be set. If both properties are set, the firewall will apply If both properties are set, the firewall will apply to traffic that has source IP
to traffic that has source IP address within sourceRanges OR the source IP address within sourceRanges OR the source IP that belongs to a tag listed in the
that belongs to a tag listed in the sourceTags property. The connection does sourceTags property. The connection does not need to match both properties for the
not need to match both properties for the firewall to apply. firewall to apply.
returned: success returned: success
type: list type: list
targetServiceAccounts: target_service_accounts:
description: description:
- A list of service accounts indicating sets of instances located in the network - A list of service accounts indicating sets of instances located in the network that
that may make network connections as specified in allowed[]. may make network connections as specified in allowed[].
- targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. - targetServiceAccounts cannot be used at the same time as targetTags or sourceTags.
If neither targetServiceAccounts nor targetTags are specified, the firewall If neither targetServiceAccounts nor targetTags are specified, the firewall rule
rule applies to all instances on the specified network. applies to all instances on the specified network.
returned: success returned: success
type: list type: list
targetTags: target_tags:
description: description:
- A list of instance tags indicating sets of instances located in the network - A list of instance tags indicating sets of instances located in the network that
that may make network connections as specified in allowed[]. may make network connections as specified in allowed[].
- If no targetTags are specified, the firewall rule applies to all instances - If no targetTags are specified, the firewall rule applies to all instances on the
on the specified network. specified network.
returned: success returned: success
type: list type: list
''' '''
@ -257,7 +245,7 @@ def main():
items = items.get('items') items = items.get('items')
else: else:
items = [] items = []
return_value = {'items': items} return_value = {'resources': items}
module.exit_json(**return_value) module.exit_json(**return_value)