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 访问令牌。 |
|
此防火墙指定的允许规则列表。每个规则都指定一个协议和端口范围元组，用于描述允许的连接。 |
|
此规则适用的 IP 协议。创建防火墙规则时需要协议类型。此值可以是以下众所周知的协议字符串之一（tcp、udp、icmp、esp、ah、sctp、ipip、all），也可以是 IP 协议编号。 |
|
此规则适用的端口的可选列表。此字段仅适用于 UDP 或 TCP 协议。每个条目必须是整数或范围。如果未指定，则此规则适用于通过任何端口的连接。 示例输入包括：[“22”]、[“80”、“443”] 和 [“12345-12349”]。 |
|
使用的凭据类型。 选项
|
|
此防火墙指定的拒绝规则列表。每个规则都指定一个协议和端口范围元组，用于描述拒绝的连接。 |
|
此规则适用的 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 请求的用户代理字符串。 |
|
此字段表示特定防火墙规则的日志记录选项。 如果启用了日志记录，则日志将导出到 Cloud Logging。 |
|
此字段表示是否为特定防火墙规则启用日志记录。如果启用了日志记录，则日志将导出到 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 都是有效的：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`，然后将此 network 字段设置为“{{ name-of-resource }}” 默认值： |
|
此规则的优先级。这是一个介于 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
返回值
常见返回值已在 此处 记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
此防火墙指定的允许规则列表。每个规则都指定一个协议和端口范围元组，用于描述允许的连接。 返回：success |
|
此规则适用的 IP 协议。创建防火墙规则时需要协议类型。此值可以是以下众所周知的协议字符串之一（tcp、udp、icmp、esp、ah、sctp、ipip、all），也可以是 IP 协议编号。 返回：success |
|
此规则适用的端口的可选列表。此字段仅适用于 UDP 或 TCP 协议。每个条目必须是整数或范围。如果未指定，则此规则适用于通过任何端口的连接。 示例输入包括：[“22”]、[“80”、“443”] 和 [“12345-12349”]。 返回：success |
|
RFC3339 文本格式的创建时间戳。 返回：success |
|
此防火墙指定的拒绝规则列表。每个规则都指定一个协议和端口范围元组，用于描述拒绝的连接。 返回：success |
|
此规则适用的 IP 协议。创建防火墙规则时需要协议类型。此值可以是以下众所周知的协议字符串之一（tcp、udp、icmp、esp、ah、sctp、ipip、all），也可以是 IP 协议编号。 返回：success |
|
此规则适用的端口的可选列表。此字段仅适用于 UDP 或 TCP 协议。每个条目必须是整数或范围。如果未指定，则此规则适用于通过任何端口的连接。 示例输入包括：[“22”]、[“80”、“443”] 和 [“12345-12349”]。 返回：success |
|
此资源的可选描述。创建资源时提供此属性。 返回：success |
|
如果指定了目标范围，则防火墙将仅应用于目标 IP 地址位于这些范围内的流量。这些范围必须以 CIDR 格式表示。仅支持 IPv4。 返回：success |
|
此防火墙适用的流量方向；默认为 INGRESS。注意：对于 INGRESS 流量，不支持指定 destinationRanges；对于 EGRESS 流量，不支持指定 sourceRanges 或 sourceTags。 返回：success |
|
表示防火墙规则是否被禁用，即未应用于与其关联的网络。设置为 true 时，防火墙规则不会强制执行，并且网络的行为就像它不存在一样。如果未指定，则防火墙规则将被启用。 返回：success |
|
资源的唯一标识符。 返回：success |
|
此字段表示特定防火墙规则的日志记录选项。 如果启用了日志记录，则日志将导出到 Cloud Logging。 返回：success |
|
此字段表示是否为特定防火墙规则启用日志记录。如果启用了日志记录，则日志将导出到 Stackdriver。 返回：success |
|
此字段表示是否包含或排除防火墙日志的元数据。 返回：success |
|
资源的名称。资源创建时由客户端提供。名称必须为 1-63 个字符长，并符合 RFC1035。具体来说，名称必须为 1-63 个字符长，并匹配正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?`，这意味着第一个字符必须是小写字母，所有后续字符必须是短划线、小写字母或数字，最后一个字符不能是短划线。 返回：success |
|
此防火墙规则的网络资源的 URL。创建防火墙规则时如果未指定，则使用默认网络：global/networks/default 如果您选择指定此属性，则可以将网络指定为完整或部分 URL。例如，以下所有 URL 都是有效的：https://www.googleapis.com/compute/v1/projects/myproject/global/ networks/my-network projects/myproject/global/networks/my-network global/networks/default。 返回：success |
|
此规则的优先级。这是一个介于 0 和 65535（包含）之间的整数。未指定时，假设值为 1000。相对优先级决定冲突规则的优先顺序。优先级值越低，优先级越高（例如，优先级为 0 的规则比优先级为 1 的规则优先级高）。拒绝 (DENY) 规则优先于具有相同优先级的允许 (ALLOW) 规则。 返回：success |
|
如果指定了源范围，则防火墙将仅应用于源 IP 地址在这些范围内的流量。这些范围必须以 CIDR 格式表示。可以设置 sourceRanges 和 sourceTags 中的一个或两个。如果同时设置这两个属性，则防火墙将应用于源 IP 地址在 sourceRanges 内或源 IP 属于 sourceTags 属性中列出的标签的流量。连接不需要同时匹配这两个属性才能应用防火墙。仅支持 IPv4。 返回：success |
|
如果指定了源服务帐户，则防火墙将仅应用于源自具有此列表中服务帐户的实例的流量。源服务帐户不能用于控制到实例外部 IP 地址的流量，因为服务帐户与实例相关联，而不是与 IP 地址相关联。sourceRanges 可以与 sourceServiceAccounts 同时设置。如果同时设置这两个属性，则防火墙将应用于源 IP 地址在 sourceRanges 内或源 IP 属于 sourceServiceAccount 中列出的服务帐户的实例的流量。连接不需要同时匹配这两个属性才能应用防火墙。sourceServiceAccounts 不能与 sourceTags 或 targetTags 同时使用。 返回：success |
|
如果指定了源标签，则防火墙将仅应用于源 IP 属于源标签中列出的标签的流量。源标签不能用于控制到实例外部 IP 地址的流量，因为标签与实例相关联，而不是与 IP 地址相关联。可以设置 sourceRanges 和 sourceTags 中的一个或两个。如果同时设置这两个属性，则防火墙将应用于源 IP 地址在 sourceRanges 内或源 IP 属于 sourceTags 属性中列出的标签的流量。连接不需要同时匹配这两个属性才能应用防火墙。 返回：success |
|
指示位于网络中可能根据 allowed[] 中指定的规则建立网络连接的实例集的服务帐户列表。 targetServiceAccounts 不能与 targetTags 或 sourceTags 同时使用。如果既未指定 targetServiceAccounts 也未指定 targetTags，则防火墙规则将应用于指定网络上的所有实例。 返回：success |
|
指示位于网络中可能根据 allowed[] 中指定的规则建立网络连接的实例集的实例标签列表。 如果没有指定 targetTags，则防火墙规则将应用于指定网络上的所有实例。 返回：success |