google.cloud.gcp_appengine_firewall_rule – Creates a GCP FirewallRule

Note

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

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

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

Synopsis

  • A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.

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
action
string / required
The action to take if this rule matches.
Some valid choices include: "UNSPECIFIED_ACTION", "ALLOW", "DENY"
auth_kind
string / required
    Choices:
  • application
  • machineaccount
  • serviceaccount
The type of credential used.
description
string
An optional string description of this rule.
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.
priority
integer
A positive integer that defines the order of rule evaluation.
Rules with the lowest priority are evaluated first.
A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.
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.
source_range
string / required
IP address or range, defined using CIDR notation, of requests that this rule applies to.
state
string
    Choices:
  • present
  • absent
Whether the given object should exist in GCP

Notes

Note

Examples

- name: create a firewall rule
  google.cloud.gcp_appengine_firewall_rule:
    priority: 1000
    source_range: 10.0.0.0
    action: ALLOW
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

Return Values

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

Key Returned Description
action
string
success
The action to take if this rule matches.

description
string
success
An optional string description of this rule.

priority
integer
success
A positive integer that defines the order of rule evaluation.
Rules with the lowest priority are evaluated first.
A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.

sourceRange
string
success
IP address or range, defined using CIDR notation, of requests that this rule applies to.



Authors

  • Google Inc. (@googlecloudplatform)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/google/cloud/gcp_appengine_firewall_rule_module.html