google.cloud.gcp_compute_forwarding_rule 模块 – 创建一个 GCP 转发规则

注意

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

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

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

要在剧本中使用它，请指定：google.cloud.gcp_compute_forwarding_rule。

注意

由于违反了 Ansible 包含要求，google.cloud 集合将从 Ansible 12 中删除。该集合有 未解决的健全性测试失败。有关更多信息，请参阅 讨论主题。

概要

• 转发规则资源。转发规则资源指定如果数据包匹配给定的 [IPAddress, IPProtocol, portRange] 元组，则将该数据包转发到哪个目标虚拟机池。

要求

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

• python >= 2.6

• requests >= 2.18.4

• google-auth >= 1.3.0

参数

参数	注释
access_token 字符串	如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。
all_ports 布尔值	对于内部 TCP/UDP 负载均衡（即负载均衡方案为 INTERNAL 且协议为 TCP/UDP），将此设置为 true 以允许寻址到任何端口的数据包转发到使用此转发规则配置的后端。与后端服务一起使用。如果设置了端口或端口范围，则不能设置此项。 选择 false true
allow_global_access 布尔值	如果为 true，则客户端可以从所有区域访问 ILB。 否则，只允许从 ILB 所在的本地区域访问。 选择 false true
auth_kind 字符串 / 必填	使用的凭据类型。 选择 "application" "machineaccount" "serviceaccount" "accesstoken"
backend_service 字典	接收匹配流量的后端服务。这仅用于内部负载均衡。 此字段表示指向 GCP 中后端服务资源的链接。可以通过两种方式指定它。首先，您可以放置一个字典，其中键为 ‘selfLink’，值为资源的 selfLink。或者，您可以向 gcp_compute_backend_service 任务添加 `register: name-of-resource`，然后将此 backend_service 字段设置为 “{{ name-of-resource }}”。
description 字符串	此资源的可选描述。创建资源时提供此属性。
env_type 字符串	指定您在其中运行此模块的 Ansible 环境。 除非您知道自己在做什么，否则不应设置此项。 这只会更改任何 API 请求的 User Agent 字符串。
ip_address 字符串	此转发规则代表其提供服务的 IP 地址。 地址会根据转发规则的负载均衡方案（EXTERNAL 或 INTERNAL）和范围（全局或区域）受到限制。 当负载均衡方案为 EXTERNAL 时，对于全局转发规则，地址必须是全局 IP；对于区域转发规则，地址必须与转发规则位于同一区域。如果此字段为空，则将分配来自同一范围（全局或区域）的临时 IPv4 地址。区域转发规则仅支持 IPv4。全局转发规则支持 IPv4 或 IPv6。 当负载均衡方案为 INTERNAL 时，这只能是属于为转发规则配置的网络/子网的 RFC 1918 IP 地址。默认情况下，如果此字段为空，则将从为此转发规则配置的子网或网络的 IP 范围中自动分配一个临时的内部 IP 地址。 可以通过字面 IP 地址或对现有地址资源的 URL 引用来指定地址。以下示例均有效：* 100.1.2.3 * https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address * projects/project/regions/region/addresses/address * regions/region/addresses/address * global/addresses/address * address 。
ip_protocol 字符串	此规则应用的 IP 协议。 当负载均衡方案为 INTERNAL 时，只有 TCP 和 UDP 有效。 一些有效的选择包括：“TCP”、“UDP”、“ESP”、“AH”、“SCTP”、“ICMP”
is_mirroring_collector 布尔值	指示此负载均衡器是否可以用作数据包镜像的收集器。为防止镜像循环，即使数据包镜像规则适用于此负载均衡器后面的实例，也不会镜像它们的数据流量。只有当负载均衡器的 loadBalancingScheme 设置为 INTERNAL 时，才能将其设置为 true。 选择 false true
load_balancing_scheme 字符串	这表示转发规则将用于什么，并且可以是 EXTERNAL、INTERNAL 或 INTERNAL_MANAGED。EXTERNAL 用于经典云 VPN 网关、从外部 IP 地址到 VM 的协议转发以及 HTTP(S)、SSL 代理、TCP 代理和网络 TCP/UDP 负载均衡器。 INTERNAL 用于从内部 IP 地址到 VM 的协议转发以及内部 TCP/UDP 负载均衡器。 INTERNAL_MANAGED 用于内部 HTTP(S) 负载均衡器。 一些有效的选择包括：“EXTERNAL”、“INTERNAL”、“INTERNAL_MANAGED”
name 字符串 / 必填	资源的名称；由客户端在创建资源时提供。名称必须是 1-63 个字符长，并符合 RFC1035。具体而言，名称必须是 1-63 个字符长，并与正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?` 匹配，这意味着第一个字符必须是小写字母，并且所有后续字符必须是破折号、小写字母或数字，但最后一个字符不能是破折号。
network 字典	对于内部负载均衡，此字段标识负载均衡 IP 应属于此转发规则的网络。如果未指定此字段，则将使用默认网络。 此字段仅用于内部负载均衡。 此字段表示指向 GCP 中网络资源的链接。它可以通过两种方式指定。首先，您可以放置一个字典，其中键为“selfLink”，值为您的资源的 selfLink。或者，您可以向 gcp_compute_network 任务添加 `register: name-of-resource`，然后将此网络字段设置为“{{ name-of-resource }}”
network_tier 字符串	用于配置此地址的网络层。如果未指定此字段，则假定为 PREMIUM。 一些有效的选项包括：“PREMIUM”、“STANDARD”
port_range 字符串	此字段与 TargetHttpProxy、TargetHttpsProxy、TargetSslProxy、TargetTcpProxy、TargetVpnGateway、TargetPool、TargetInstance 的 target 字段一起使用。 仅当 IPProtocol 为 TCP、UDP 或 SCTP 时适用，只有寻址到指定范围内的端口的数据包才会被转发到目标。 具有相同 [IPAddress, IPProtocol] 对的转发规则必须具有不相交的端口范围。 某些类型的转发目标对可接受的端口有限制：* TargetHttpProxy：80、8080 * TargetHttpsProxy：443 * TargetTcpProxy：25、43、110、143、195、443、465、587、700、993、995、1883、5222 * TargetSslProxy：25、43、110、143、195、443、465、587、700、993、995、1883、5222 * TargetVpnGateway：500、4500。
ports 列表 / 元素=字符串	此字段与内部负载平衡的 backend_service 字段一起使用。 当负载平衡方案为 INTERNAL 时，可以配置单个端口或以逗号分隔的端口列表。只有寻址到这些端口的数据包才会被转发到配置了此转发规则的后端。 您最多可以指定 5 个端口。
project 字符串	要使用的 Google Cloud Platform 项目。
region 字符串 / 必填	对区域转发规则所在的区域的引用。 此字段不适用于全局转发规则。
scopes 列表 / 元素=字符串	要使用的作用域数组
service_account_contents jsonarg	服务帐户 JSON 文件的内容，可以是字典形式或表示它的 JSON 字符串形式。
service_account_email 字符串	如果选择了 machineaccount 且用户不希望使用默认电子邮件，则可选的服务帐户电子邮件地址。
service_account_file path	如果选择 serviceaccount 作为类型，则服务帐户 JSON 文件的路径。
service_label 字符串	此转发规则的服务名称的可选前缀。 如果指定，将成为完全限定服务名称的第一个标签。 标签长度必须为 1-63 个字符，并符合 RFC1035。 具体而言，标签长度必须为 1-63 个字符，并与正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?` 匹配，这意味着第一个字符必须是小写字母，所有后续字符必须是短划线、小写字母或数字，但最后一个字符不能是短划线。 此字段仅用于内部负载均衡。
state 字符串	给定对象是否应存在于 GCP 中 选择 "present" ← (默认) "absent"
subnetwork 字典	此转发规则的负载均衡 IP 应属于的子网。此字段仅用于内部负载均衡。 如果指定的网络处于自动子网模式，则此字段是可选的。但是，如果网络处于自定义子网模式，则必须指定子网。 此字段表示指向 GCP 中子网资源的链接。它可以通过两种方式指定。首先，您可以放置一个字典，其中键为“selfLink”，值为您的资源的 selfLink。或者，您可以向 gcp_compute_subnetwork 任务添加 `register: name-of-resource`，然后将此子网字段设置为“{{ name-of-resource }}”
target 字符串	接收匹配流量的目标资源的 URL。 目标必须与转发规则位于同一区域。 转发的流量必须是适合目标对象的类型。

备注

注意

• API 参考：https://cloud.google.com/compute/docs/reference/v1/forwardingRules

• 官方文档：https://cloud.google.com/compute/docs/load-balancing/network/forwarding-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 address
  google.cloud.gcp_compute_address:
    name: address-forwardingrule
    region: us-west1
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: address

- name: create a target pool
  google.cloud.gcp_compute_target_pool:
    name: targetpool-forwardingrule
    region: us-west1
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: targetpool

- name: create a forwarding rule
  google.cloud.gcp_compute_forwarding_rule:
    name: test_object
    region: us-west1
    target: "{{ targetpool }}"
    ip_protocol: TCP
    port_range: 80-80
    ip_address: "{{ address.address }}"
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

返回值

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

键	描述
allowGlobalAccess 布尔值	如果为 true，则客户端可以从所有区域访问 ILB。 否则，只允许从 ILB 所在的本地区域访问。 返回： 成功
allPorts 布尔值	对于内部 TCP/UDP 负载均衡（即负载均衡方案为 INTERNAL 且协议为 TCP/UDP），将此设置为 true 以允许寻址到任何端口的数据包转发到使用此转发规则配置的后端。与后端服务一起使用。如果设置了端口或端口范围，则不能设置此项。 返回： 成功
backendService 字典	接收匹配流量的后端服务。这仅用于内部负载均衡。 返回： 成功
creationTimestamp 字符串	以 RFC3339 文本格式表示的创建时间戳。 返回： 成功
description 字符串	此资源的可选描述。创建资源时提供此属性。 返回： 成功
id integer	资源的唯一标识符。 返回： 成功
IPAddress 字符串	此转发规则代表其提供服务的 IP 地址。 地址会根据转发规则的负载均衡方案（EXTERNAL 或 INTERNAL）和范围（全局或区域）受到限制。 当负载均衡方案为 EXTERNAL 时，对于全局转发规则，地址必须是全局 IP；对于区域转发规则，地址必须与转发规则位于同一区域。如果此字段为空，则将分配来自同一范围（全局或区域）的临时 IPv4 地址。区域转发规则仅支持 IPv4。全局转发规则支持 IPv4 或 IPv6。 当负载均衡方案为 INTERNAL 时，这只能是属于为转发规则配置的网络/子网的 RFC 1918 IP 地址。默认情况下，如果此字段为空，则将从为此转发规则配置的子网或网络的 IP 范围中自动分配一个临时的内部 IP 地址。 可以通过字面 IP 地址或对现有地址资源的 URL 引用来指定地址。以下示例均有效：* 100.1.2.3 * https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address * projects/project/regions/region/addresses/address * regions/region/addresses/address * global/addresses/address * address 。 返回： 成功
IPProtocol 字符串	此规则应用的 IP 协议。 当负载均衡方案为 INTERNAL 时，只有 TCP 和 UDP 有效。 返回： 成功
isMirroringCollector 布尔值	指示此负载均衡器是否可以用作数据包镜像的收集器。为防止镜像循环，即使数据包镜像规则适用于此负载均衡器后面的实例，也不会镜像它们的数据流量。只有当负载均衡器的 loadBalancingScheme 设置为 INTERNAL 时，才能将其设置为 true。 返回： 成功
loadBalancingScheme 字符串	这表示转发规则将用于什么，并且可以是 EXTERNAL、INTERNAL 或 INTERNAL_MANAGED。EXTERNAL 用于经典云 VPN 网关、从外部 IP 地址到 VM 的协议转发以及 HTTP(S)、SSL 代理、TCP 代理和网络 TCP/UDP 负载均衡器。 INTERNAL 用于从内部 IP 地址到 VM 的协议转发以及内部 TCP/UDP 负载均衡器。 INTERNAL_MANAGED 用于内部 HTTP(S) 负载均衡器。 返回： 成功
name 字符串	资源的名称；由客户端在创建资源时提供。名称必须是 1-63 个字符长，并符合 RFC1035。具体而言，名称必须是 1-63 个字符长，并与正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?` 匹配，这意味着第一个字符必须是小写字母，并且所有后续字符必须是破折号、小写字母或数字，但最后一个字符不能是破折号。 返回： 成功
network 字典	对于内部负载均衡，此字段标识负载均衡 IP 应属于此转发规则的网络。如果未指定此字段，则将使用默认网络。 此字段仅用于内部负载均衡。 返回： 成功
networkTier 字符串	用于配置此地址的网络层。如果未指定此字段，则假定为 PREMIUM。 返回： 成功
portRange 字符串	此字段与 TargetHttpProxy、TargetHttpsProxy、TargetSslProxy、TargetTcpProxy、TargetVpnGateway、TargetPool、TargetInstance 的 target 字段一起使用。 仅当 IPProtocol 为 TCP、UDP 或 SCTP 时适用，只有寻址到指定范围内的端口的数据包才会被转发到目标。 具有相同 [IPAddress, IPProtocol] 对的转发规则必须具有不相交的端口范围。 某些类型的转发目标对可接受的端口有限制：* TargetHttpProxy：80、8080 * TargetHttpsProxy：443 * TargetTcpProxy：25、43、110、143、195、443、465、587、700、993、995、1883、5222 * TargetSslProxy：25、43、110、143、195、443、465、587、700、993、995、1883、5222 * TargetVpnGateway：500、4500。 返回： 成功
ports 列表 / 元素=字符串	此字段与内部负载平衡的 backend_service 字段一起使用。 当负载平衡方案为 INTERNAL 时，可以配置单个端口或以逗号分隔的端口列表。只有寻址到这些端口的数据包才会被转发到配置了此转发规则的后端。 您最多可以指定 5 个端口。 返回： 成功
region 字符串	对区域转发规则所在的区域的引用。 此字段不适用于全局转发规则。 返回： 成功
serviceLabel 字符串	此转发规则的服务名称的可选前缀。 如果指定，将成为完全限定服务名称的第一个标签。 标签长度必须为 1-63 个字符，并符合 RFC1035。 具体而言，标签长度必须为 1-63 个字符，并与正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?` 匹配，这意味着第一个字符必须是小写字母，所有后续字符必须是短划线、小写字母或数字，但最后一个字符不能是短划线。 此字段仅用于内部负载均衡。 返回： 成功
serviceName 字符串	此转发规则的内部完全限定服务名称。 此字段仅用于内部负载均衡。 返回： 成功
subnetwork 字典	此转发规则的负载均衡 IP 应属于的子网。此字段仅用于内部负载均衡。 如果指定的网络处于自动子网模式，则此字段是可选的。但是，如果网络处于自定义子网模式，则必须指定子网。 返回： 成功
target 字符串	接收匹配流量的目标资源的 URL。 目标必须与转发规则位于同一区域。 转发的流量必须是适合目标对象的类型。 返回： 成功

作者

• Google Inc. (@googlecloudplatform)

集合链接

• 问题跟踪器
• 主页
• 存储库（源代码）