google.cloud.gcp_appengine_firewall_rule 模块 – 创建 GCP 防火墙规则

注意

此模块是 google.cloud 集合 (版本 1.4.1) 的一部分。

如果您正在使用 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install google.cloud。您需要其他要求才能使用此模块，请参阅要求以了解详情。

要在 playbook 中使用它，请指定： google.cloud.gcp_appengine_firewall_rule。

注意

由于违反了 Ansible 包含要求，google.cloud 集合将在 Ansible 12 中移除。该集合存在未解决的完整性测试失败。请参阅讨论主题以了解更多信息。

概要 

一个单独的防火墙规则，用于评估传入流量并提供对匹配请求采取的操作。

要求 

执行此模块的主机需要以下要求。

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

参数 

参数	注释
access_token 字符串	如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。
action 字符串 / 必需	如果此规则匹配，则要采取的操作。一些有效的选项包括：“UNSPECIFIED_ACTION”、“ALLOW”、“DENY”
auth_kind 字符串 / 必需	使用的凭据类型。选项 `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
description 字符串	此规则的可选字符串描述。
env_type 字符串	指定您在哪个 Ansible 环境中运行此模块。除非您知道自己在做什么，否则不应设置此项。这只会更改任何 API 请求的用户代理字符串。
priority 整数	定义规则评估顺序的正整数。优先级最低的规则首先进行评估。当没有先前的规则匹配时，优先级为 Int32.MaxValue 的默认规则匹配所有 IPv4 和 IPv6 流量。用户只能修改此规则的操作。
project 字符串	要使用的 Google Cloud Platform 项目。
scopes 列表 / 元素=字符串	要使用的作用域数组
service_account_contents jsonarg	服务帐户 JSON 文件的内容，可以是字典或表示它的 JSON 字符串。
service_account_email 字符串	如果选择 machineaccount 并且用户不希望使用默认电子邮件，则为可选的服务帐户电子邮件地址。
service_account_file 路径	如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。
source_range 字符串 / 必需	使用 CIDR 表示法定义的此规则适用的请求的 IP 地址或范围。
state 字符串	给定对象是否应该存在于 GCP 中选项 `"present"` ← (默认) `"absent"`

备注 

注意

API 参考： https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.firewall.ingressRules
官方文档： https://cloud.google.com/appengine/docs/standard/python/creating-firewalls#creating_firewall_rules
对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_FILE 环境变量设置 service_account_file。
对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_CONTENTS 环境变量设置 service_account_contents。
对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_EMAIL 环境变量设置 service_account_email。
对于身份验证，您可以使用 GCP_ACCESS_TOKEN 环境变量设置 access_token。
对于身份验证，您可以使用 GCP_AUTH_KIND 环境变量设置 auth_kind。
对于身份验证，您可以使用 GCP_SCOPES 环境变量设置 scopes。
如果 playbook 中未设置值，则只使用环境变量值。
service_account_email 和 service_account_file 选项是互斥的。

示例 

- 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

返回值 

常见的返回值已记录在此处，以下是此模块特有的字段

键	描述
action 字符串	如果此规则匹配，则要采取的操作。返回：成功
description 字符串	此规则的可选字符串描述。返回：成功
priority 整数	定义规则评估顺序的正整数。优先级最低的规则首先进行评估。当没有先前的规则匹配时，优先级为 Int32.MaxValue 的默认规则匹配所有 IPv4 和 IPv6 流量。用户只能修改此规则的操作。返回：成功
sourceRange 字符串	使用 CIDR 表示法定义的此规则适用的请求的 IP 地址或范围。返回：成功

作者

Google Inc. (@googlecloudplatform)