google.cloud.gcp_compute_firewall_info – Gather info for GCP Firewall¶

Note

This plugin is part of the google.cloud collection (version 1.0.2).

To install it use: ansible-galaxy collection install google.cloud.

To use it in a playbook, specify: google.cloud.gcp_compute_firewall_info.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis ¶

Gather info for GCP Firewall

Requirements ¶

The below requirements are needed on the host that executes this module.

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

Parameters ¶

Parameter	Choices/Defaults	Comments
auth_kind string / required	Choices: application machineaccount serviceaccount	The type of credential used.
env_type string		Specifies which Ansible environment you're running this module within. This should not be set unless you know what you're doing. This only alters the User Agent string for any API requests.
filters list / elements=string		A list of filter value pairs. Available filters are listed here https://cloud.google.com/sdk/gcloud/reference/topic/filters. Each additional filter in the list will act be added as an AND condition (filter1 and filter2) .
project string		The Google Cloud Platform project to use.
scopes list / elements=string		Array of scopes to be used
service_account_contents jsonarg		The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it.
service_account_email string		An optional service account email address if machineaccount is selected and the user does not wish to use the default email.
service_account_file path		The path of a Service Account JSON file if serviceaccount is selected as type.

Notes ¶

Note

for authentication, you can set service_account_file using the gcp_service_account_file env variable.
for authentication, you can set service_account_contents using the GCP_SERVICE_ACCOUNT_CONTENTS env variable.
For authentication, you can set service_account_email using the GCP_SERVICE_ACCOUNT_EMAIL env variable.
For authentication, you can set auth_kind using the GCP_AUTH_KIND env variable.
For authentication, you can set scopes using the GCP_SCOPES env variable.
Environment variables values will only be used if the playbook values are not set.
The service_account_email and service_account_file options are mutually exclusive.

Examples ¶

- name: get info on a firewall
  gcp_compute_firewall_info:
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

Return Values ¶

Common return values are documented here, the following are the fields unique to this module:

Key			Returned	Description
resources complex			always	List of resources
	allowed complex		success	The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
		ip_protocol string	success	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, ipip, all), or the IP protocol number.
		ports list / elements=string	success	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"].
	creationTimestamp string		success	Creation timestamp in RFC3339 text format.
	denied complex		success	The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.
		ip_protocol string	success	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, ipip, all), or the IP protocol number.
		ports list / elements=string	success	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"].
	description string		success	An optional description of this resource. Provide this property when you create the resource.
	destinationRanges list / elements=string		success	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.
	direction string		success	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.
	disabled boolean		success	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.
	id integer		success	The unique identifier for the resource.
	logConfig complex		success	This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Cloud Logging.
		enable boolean	success	This field denotes whether to enable logging for a particular firewall rule. If logging is enabled, logs will be exported to Stackdriver.
		metadata string	success	This field denotes whether to include or exclude metadata for firewall logs.
	name string		success	Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
	network dictionary		success	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: https://www.googleapis.com/compute/v1/projects/myproject/global/ networks/my-network projects/myproject/global/networks/my-network global/networks/default .
	priority integer		success	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.
	sourceRanges list / elements=string		success	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. One or both of sourceRanges and sourceTags may be set. If both properties are set, 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 connection does not need to match both properties for the firewall to apply. Only IPv4 is supported.
	sourceServiceAccounts list / elements=string		success	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 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.
	sourceTags list / elements=string		success	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 control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, 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 connection does not need to match both properties for the firewall to apply.
	targetServiceAccounts list / elements=string		success	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.
	targetTags list / elements=string		success	A list of instance tags indicating sets of instances located in the network that may make network connections as specified in allowed[]. If no targetTags are specified, the firewall rule applies to all instances on the specified network.

Authors¶

Google Inc. (@googlecloudplatform)

google.cloud.gcp_compute_firewall_info – Gather info for GCP Firewall¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶