google.cloud.gcp_compute_firewall 模块 – 创建 GCP 防火墙
注意
此模块是 google.cloud 集合（版本 1.4.1）的一部分。
如果您正在使用 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install google.cloud。您需要其他要求才能使用此模块，请参阅 要求 了解详细信息。
要在 playbook 中使用它，请指定：google.cloud.gcp_compute_firewall。
注意
由于违反了 Ansible 包含要求，google.cloud 集合将从 Ansible 12 中删除。该集合存在 未解决的健全性测试失败。有关更多信息，请参阅讨论线程。
概要
每个网络都有自己的防火墙，用于控制对实例的访问。
除非创建防火墙规则以允许流量，否则所有到实例的流量（即使来自其他实例）都会被防火墙阻止。
默认网络具有自动创建的防火墙规则，这些规则显示在默认防火墙规则中。除了默认的“允许”出站流量规则和默认的“拒绝”入站流量规则外，没有手动创建的网络具有自动创建的防火墙规则。对于除默认网络之外的所有网络，您必须创建所需的任何防火墙规则。
要求
执行此模块的主机上需要以下要求。
python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0
参数
参数 |
注释 |
|---|---|
如果凭证类型为 accesstoken，则为 OAuth2 访问令牌。 |
|
此防火墙指定的 ALLOW 规则列表。每个规则都指定一个协议和端口范围元组，该元组描述了允许的连接。 |
|
此规则应用的 IP 协议。创建防火墙规则时，协议类型是必需的。此值可以是以下众所周知的协议字符串之一（tcp、udp、icmp、esp、ah、sctp、ipip、all）或 IP 协议号。 |
|
此规则应用的端口的可选列表。此字段仅适用于 UDP 或 TCP 协议。每个条目必须是整数或范围。如果未指定，则此规则适用于通过任何端口的连接。 示例输入包括：[“22”]、[“80”、“443”] 和 [“12345-12349”]。 |
|
使用的凭证类型。 选择
|
|
此防火墙指定的 DENY 规则列表。每个规则都指定一个协议和端口范围元组，该元组描述了拒绝的连接。 |
|
此规则应用的 IP 协议。创建防火墙规则时，协议类型是必需的。此值可以是以下众所周知的协议字符串之一（tcp、udp、icmp、esp、ah、sctp、ipip、all）或 IP 协议号。 |
|
此规则应用的端口的可选列表。此字段仅适用于 UDP 或 TCP 协议。每个条目必须是整数或范围。如果未指定，则此规则适用于通过任何端口的连接。 示例输入包括：[“22”]、[“80”、“443”] 和 [“12345-12349”]。 |
|
此资源的可选描述。创建资源时提供此属性。 |
|
如果指定了目标范围，则防火墙将仅应用于目标 IP 地址位于这些范围内的流量。这些范围必须以 CIDR 格式表示。仅支持 IPv4。 |
|
此防火墙应用到的流量方向；默认值为 INGRESS。注意：对于 INGRESS 流量，不支持指定 destinationRanges；对于 EGRESS 流量，不支持指定 sourceRanges 或 sourceTags。 一些有效选择包括：“INGRESS”、“EGRESS” |
|
表示防火墙规则是否已禁用，即不应用于与其关联的网络。设置为 true 时，防火墙规则不强制执行，并且网络的行为就像它不存在一样。如果未指定，则将启用防火墙规则。 选择
|
|
指定您在其中运行此模块的 Ansible 环境。 除非您知道自己在做什么，否则不应设置此项。 这只会更改任何 API 请求的用户代理字符串。 |
|
此字段表示特定防火墙规则的日志记录选项。 如果启用日志记录，日志将导出到云日志记录。 |
|
此字段表示是否启用特定防火墙规则的日志记录。如果启用日志记录，日志将导出到 Stackdriver。 选择
|
|
此字段表示是否包含或排除防火墙日志的元数据。 一些有效选择包括：“EXCLUDE_ALL_METADATA”、“INCLUDE_ALL_METADATA” |
|
资源的名称。由客户端在创建资源时提供。名称的长度必须为 1-63 个字符，并且符合 RFC1035。具体来说，名称的长度必须为 1-63 个字符，并且与正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?` 匹配，这意味着第一个字符必须是小写字母，并且所有后续字符必须是破折号、小写字母或数字，但最后一个字符不能是破折号。 |
|
此防火墙规则的网络资源的 URL。如果创建防火墙规则时未指定，则使用默认网络：global/networks/default 如果您选择指定此属性，则可以将网络指定为完整 URL 或部分 URL。例如，以下都是有效的 URL：https://www.googleapis.com/compute/v1/projects/myproject/global/ networks/my-network projects/myproject/global/networks/my-network global/networks/default 。 此字段表示指向 GCP 中网络资源的链接。它可以以两种方式指定。首先，您可以放置一个带有键“selfLink”和您的资源 selfLink 值的字典。或者，您可以向 gcp_compute_network 任务添加 `register: name-of-resource`，然后将此网络字段设置为“{{ name-of-resource }}”。 默认值： |
|
此规则的优先级。这是一个介于 0 和 65535 之间的整数，包括 0 和 65535。如果未指定，则假定的值为 1000。相对优先级确定冲突规则的优先级。优先级值越低，优先级越高（例如，优先级为 0 的规则的优先级高于优先级为 1 的规则）。DENY 规则的优先级高于具有相等优先级的 ALLOW 规则。 默认值： |
|
要使用的 Google Cloud Platform 项目。 |
|
要使用的范围数组 |
|
服务帐户 JSON 文件的内容，以字典形式或表示它的 JSON 字符串形式。 |
|
如果选择了 machineaccount 且用户不希望使用默认电子邮件，则可以使用此可选的服务帐户电子邮件地址。 |
|
如果选择 serviceaccount 作为类型，则此处填写服务帐户 JSON 文件的路径。 |
|
如果指定了源范围，则防火墙将仅应用于源 IP 地址位于这些范围内的流量。这些范围必须以 CIDR 格式表示。可以设置 sourceRanges 和 sourceTags 中的一个或两个。如果两个属性都设置了，则防火墙将应用于源 IP 地址在 sourceRanges 内，或者源 IP 属于 sourceTags 属性中列出的标签的流量。连接无需匹配这两个属性，防火墙即可应用。仅支持 IPv4。 |
|
如果指定了源服务帐户，则防火墙将仅应用于来自此列表中具有服务帐户的实例的流量。源服务帐户不能用于控制到实例外部 IP 地址的流量，因为服务帐户与实例关联，而不是 IP 地址。sourceRanges 可以与 sourceServiceAccounts 同时设置。如果都设置了，防火墙将应用于源 IP 地址在 sourceRanges 内，或者源 IP 属于 sourceServiceAccount 中列出的具有服务帐户的实例的流量。连接无需匹配这两个属性，防火墙即可应用。sourceServiceAccounts 不能与 sourceTags 或 targetTags 同时使用。 |
|
如果指定了源标签，则防火墙将仅应用于源 IP 属于源标签中列出的标签的流量。源标签不能用于控制到实例外部 IP 地址的流量。因为标签与实例关联，而不是 IP 地址。可以设置 sourceRanges 和 sourceTags 中的一个或两个。如果两个属性都设置了，则防火墙将应用于源 IP 地址在 sourceRanges 内，或者源 IP 属于 sourceTags 属性中列出的标签的流量。连接无需匹配这两个属性，防火墙即可应用。 |
|
给定的对象是否应该存在于 GCP 中 选择
|
|
一个服务帐户列表，指示网络中可以按照 allowed[] 中指定的方式进行网络连接的实例集合。 targetServiceAccounts 不能与 targetTags 或 sourceTags 同时使用。如果既未指定 targetServiceAccounts 也未指定 targetTags，则防火墙规则将应用于指定网络上的所有实例。 |
|
一个实例标签列表，指示网络中可以按照 allowed[] 中指定的方式进行网络连接的实例集合。 如果未指定 targetTags，则防火墙规则将应用于指定网络上的所有实例。 |
备注
注意
API 参考：https://cloud.google.com/compute/docs/reference/v1/firewalls
对于身份验证，您可以使用
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
google.cloud.gcp_compute_firewall:
name: test_object
allowed:
- ip_protocol: tcp
ports:
- '22'
target_tags:
- test-ssh-server
- staging-ssh-server
source_tags:
- test-ssh-clients
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
返回值
常见的返回值记录在此处，以下是此模块独有的字段
键 |
描述 |
|---|---|
此防火墙指定的 ALLOW 规则列表。每个规则都指定一个协议和端口范围元组，该元组描述了允许的连接。 返回： 成功 |
|
此规则应用的 IP 协议。创建防火墙规则时，协议类型是必需的。此值可以是以下众所周知的协议字符串之一（tcp、udp、icmp、esp、ah、sctp、ipip、all）或 IP 协议号。 返回： 成功 |
|
此规则应用的端口的可选列表。此字段仅适用于 UDP 或 TCP 协议。每个条目必须是整数或范围。如果未指定，则此规则适用于通过任何端口的连接。 示例输入包括：[“22”]、[“80”、“443”] 和 [“12345-12349”]。 返回： 成功 |
|
RFC3339 文本格式的创建时间戳。 返回： 成功 |
|
此防火墙指定的 DENY 规则列表。每个规则都指定一个协议和端口范围元组，该元组描述了拒绝的连接。 返回： 成功 |
|
此规则应用的 IP 协议。创建防火墙规则时，协议类型是必需的。此值可以是以下众所周知的协议字符串之一（tcp、udp、icmp、esp、ah、sctp、ipip、all）或 IP 协议号。 返回： 成功 |
|
此规则应用的端口的可选列表。此字段仅适用于 UDP 或 TCP 协议。每个条目必须是整数或范围。如果未指定，则此规则适用于通过任何端口的连接。 示例输入包括：[“22”]、[“80”、“443”] 和 [“12345-12349”]。 返回： 成功 |
|
此资源的可选描述。创建资源时提供此属性。 返回： 成功 |
|
如果指定了目标范围，则防火墙将仅应用于目标 IP 地址位于这些范围内的流量。这些范围必须以 CIDR 格式表示。仅支持 IPv4。 返回： 成功 |
|
此防火墙应用到的流量方向；默认值为 INGRESS。注意：对于 INGRESS 流量，不支持指定 destinationRanges；对于 EGRESS 流量，不支持指定 sourceRanges 或 sourceTags。 返回： 成功 |
|
表示防火墙规则是否已禁用，即不应用于与其关联的网络。设置为 true 时，防火墙规则不强制执行，并且网络的行为就像它不存在一样。如果未指定，则将启用防火墙规则。 返回： 成功 |
|
资源的唯一标识符。 返回： 成功 |
|
此字段表示特定防火墙规则的日志记录选项。 如果启用日志记录，日志将导出到云日志记录。 返回： 成功 |
|
此字段表示是否启用特定防火墙规则的日志记录。如果启用日志记录，日志将导出到 Stackdriver。 返回： 成功 |
|
此字段表示是否包含或排除防火墙日志的元数据。 返回： 成功 |
|
资源的名称。由客户端在创建资源时提供。名称的长度必须为 1-63 个字符，并且符合 RFC1035。具体来说，名称的长度必须为 1-63 个字符，并且与正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?` 匹配，这意味着第一个字符必须是小写字母，并且所有后续字符必须是破折号、小写字母或数字，但最后一个字符不能是破折号。 返回： 成功 |
|
此防火墙规则的网络资源的 URL。如果创建防火墙规则时未指定，则使用默认网络：global/networks/default 如果您选择指定此属性，则可以将网络指定为完整 URL 或部分 URL。例如，以下都是有效的 URL：https://www.googleapis.com/compute/v1/projects/myproject/global/ networks/my-network projects/myproject/global/networks/my-network global/networks/default 。 返回： 成功 |
|
此规则的优先级。这是一个介于 0 和 65535 之间的整数，包括 0 和 65535。如果未指定，则假定的值为 1000。相对优先级确定冲突规则的优先级。优先级值越低，优先级越高（例如，优先级为 0 的规则的优先级高于优先级为 1 的规则）。DENY 规则的优先级高于具有相等优先级的 ALLOW 规则。 返回： 成功 |
|
如果指定了源范围，则防火墙将仅应用于源 IP 地址位于这些范围内的流量。这些范围必须以 CIDR 格式表示。可以设置 sourceRanges 和 sourceTags 中的一个或两个。如果两个属性都设置了，则防火墙将应用于源 IP 地址在 sourceRanges 内，或者源 IP 属于 sourceTags 属性中列出的标签的流量。连接无需匹配这两个属性，防火墙即可应用。仅支持 IPv4。 返回： 成功 |
|
如果指定了源服务帐户，则防火墙将仅应用于来自此列表中具有服务帐户的实例的流量。源服务帐户不能用于控制到实例外部 IP 地址的流量，因为服务帐户与实例关联，而不是 IP 地址。sourceRanges 可以与 sourceServiceAccounts 同时设置。如果都设置了，防火墙将应用于源 IP 地址在 sourceRanges 内，或者源 IP 属于 sourceServiceAccount 中列出的具有服务帐户的实例的流量。连接无需匹配这两个属性，防火墙即可应用。sourceServiceAccounts 不能与 sourceTags 或 targetTags 同时使用。 返回： 成功 |
|
如果指定了源标签，则防火墙将仅应用于源 IP 属于源标签中列出的标签的流量。源标签不能用于控制到实例外部 IP 地址的流量。因为标签与实例关联，而不是 IP 地址。可以设置 sourceRanges 和 sourceTags 中的一个或两个。如果两个属性都设置了，则防火墙将应用于源 IP 地址在 sourceRanges 内，或者源 IP 属于 sourceTags 属性中列出的标签的流量。连接无需匹配这两个属性，防火墙即可应用。 返回： 成功 |
|
一个服务帐户列表，指示网络中可以按照 allowed[] 中指定的方式进行网络连接的实例集合。 targetServiceAccounts 不能与 targetTags 或 sourceTags 同时使用。如果既未指定 targetServiceAccounts 也未指定 targetTags，则防火墙规则将应用于指定网络上的所有实例。 返回： 成功 |
|
一个实例标签列表，指示网络中可以按照 allowed[] 中指定的方式进行网络连接的实例集合。 如果未指定 targetTags，则防火墙规则将应用于指定网络上的所有实例。 返回： 成功 |