google.cloud.gcp_compute_firewall_info 模块 – 收集 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_info。
注意
由于违反了 Ansible 包含要求，google.cloud 集合将从 Ansible 12 中删除。该集合有未解决的健全性测试失败。有关更多信息，请参阅讨论主题。
概要
收集 GCP 防火墙信息
要求
执行此模块的主机需要以下要求。
python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0
参数
参数 |
注释 |
|---|---|
如果凭证类型为 accesstoken，则为 OAuth2 访问令牌。 |
|
使用的凭证类型。 选择
|
|
指定您在其中运行此模块的 Ansible 环境。 除非您知道自己在做什么，否则不应设置此选项。 这只会更改任何 API 请求的 User Agent 字符串。 |
|
筛选值对的列表。此处列出了可用的筛选器https://cloud.google.com/sdk/gcloud/reference/topic/filters。 列表中的每个其他筛选器都将作为 AND 条件添加（筛选器 1 和筛选器 2）。 |
|
要使用的 Google Cloud Platform 项目。 |
|
要使用的范围数组 |
|
服务帐户 JSON 文件的内容，可以是字典形式，也可以是表示它的 JSON 字符串。 |
|
如果选择了 machineaccount 且用户不希望使用默认电子邮件，则可选的服务帐户电子邮件地址。 |
|
如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。 |
备注
注意
对于身份验证，您可以使用
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: 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"
返回值
此处记录了常见的返回值这里，以下是此模块特有的字段
键 |
描述 |
|---|---|
资源列表 返回: 总是 |
|
此防火墙指定的 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 时，不会强制执行防火墙规则，并且网络的行为就像它不存在一样。如果未指定，则将启用防火墙规则。 返回: 成功 |
|
资源的唯一标识符。 返回: 成功 |
|
此字段表示特定防火墙规则的日志记录选项。 如果启用日志记录，日志将导出到 Cloud Logging。 返回: 成功 |
|
此字段表示是否为特定的防火墙规则启用日志记录。如果启用日志记录，日志将导出到 Stackdriver。 返回: 成功 |
|
此字段表示是否包含或排除防火墙日志的元数据。 返回: 成功 |
|
资源的名称。由客户端在创建资源时提供。名称长度必须为 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。 返回: 成功 |
|
此规则的优先级。这是一个介于 0 和 65535 之间的整数，包括 0 和 65535。如果未指定，则假定值为 1000。相对优先级决定冲突规则的优先级。优先级值越低，优先级越高（例如，优先级为 0 的规则比优先级为 1 的规则具有更高的优先级）。DENY 规则优先于具有相同优先级的 ALLOW 规则。 返回: 成功 |
|
如果指定了源范围，则防火墙将仅应用于具有这些范围内的源 IP 地址的流量。这些范围必须以 CIDR 格式表示。可以设置 sourceRanges 和 sourceTags 中的一个或两个。如果同时设置了这两个属性，则防火墙将应用于具有 sourceRanges 内的源 IP 地址或属于 sourceTags 属性中列出的标签的源 IP 的流量。连接不需要匹配这两个属性才能应用防火墙。仅支持 IPv4。 返回: 成功 |
|
如果指定了源服务账号，则防火墙将仅应用于来自具有此列表中服务账号的实例的流量。源服务账号不能用于控制到实例外部 IP 地址的流量，因为服务账号与实例关联，而不是 IP 地址。sourceRanges 可以与 sourceServiceAccounts 同时设置。如果同时设置了这两个属性，则防火墙将应用于具有 sourceRanges 内的源 IP 地址或属于 sourceServiceAccount 中列出的服务账号的实例的源 IP 的流量。连接不需要匹配这两个属性才能应用防火墙。sourceServiceAccounts 不能与 sourceTags 或 targetTags 同时使用。 返回: 成功 |
|
如果指定了源标签，则防火墙将仅应用于具有属于源标签中列出的标签的源 IP 的流量。源标签不能用于控制到实例外部 IP 地址的流量，因为标签与实例关联，而不是 IP 地址。可以设置 sourceRanges 和 sourceTags 中的一个或两个。如果同时设置了这两个属性，则防火墙将应用于具有 sourceRanges 内的源 IP 地址或属于 sourceTags 属性中列出的标签的源 IP 的流量。连接不需要匹配这两个属性才能应用防火墙。 返回: 成功 |
|
一个服务账号列表，指示网络中可能按照 allowed[] 中指定的方式进行网络连接的实例集合。 targetServiceAccounts 不能与 targetTags 或 sourceTags 同时使用。如果未指定 targetServiceAccounts 和 targetTags，则防火墙规则将应用于指定网络上的所有实例。 返回: 成功 |
|
一个实例标签列表，指示网络中可能按照 allowed[] 中指定的方式进行网络连接的实例集合。 如果未指定 targetTags，则防火墙规则将应用于指定网络上的所有实例。 返回: 成功 |