google.cloud.gcp_compute_forwarding_rule_info 模块 – 收集 GCP ForwardingRule 的信息

注意

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

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

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

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

注意

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

概要

  • 收集 GCP ForwardingRule 的信息

要求

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

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

参数

参数

注释

access_token

字符串

如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。

auth_kind

字符串 / 必需

所用凭据的类型。

选项

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

env_type

字符串

指定您在此模块中运行的 Ansible 环境。

除非您知道自己在做什么，否则不应设置此项。

这只会更改任何 API 请求的 User Agent 字符串。

filters

列表 / elements=字符串

筛选值对的列表。此处列出了可用的过滤器 https://cloud.google.com/sdk/gcloud/reference/topic/filters。

列表中的每个附加过滤器都将添加为 AND 条件（过滤器 1 和过滤器 2）。

project

字符串

要使用的 Google Cloud Platform 项目。

region

字符串 / 必需

对区域转发规则所在的区域的引用。

此字段不适用于全局转发规则。

scopes

列表 / elements=字符串

要使用的范围数组

service_account_contents

jsonarg

服务帐户 JSON 文件的内容，可以是字典形式，也可以是表示它的 JSON 字符串。

service_account_email

字符串

如果选择了 machineaccount 并且用户不希望使用默认电子邮件，则可选的服务帐户电子邮件地址。

service_account_file

路径

如果选择 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 forwarding rule
  gcp_compute_forwarding_rule_info:
    region: us-west1
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值

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

键

描述

resources

复杂

资源列表

返回：始终

allowGlobalAccess

布尔值

如果为 true，则客户端可以从所有区域访问 ILB。

否则仅允许从 ILB 所在的本地区域访问。

返回：成功

allPorts

布尔值

对于内部 TCP/UDP 负载平衡（即负载平衡方案为 INTERNAL 并且协议为 TCP/UDP），请将此设置为 true 以允许将寻址到任何端口的数据包转发到使用此转发规则配置的后端。与后端服务一起使用。如果设置了端口或 portRange，则无法设置。

返回：成功

backendService

字典

用于接收匹配流量的后端服务。这仅用于内部负载平衡。

返回：成功

creationTimestamp

字符串

RFC3339 文本格式的创建时间戳。

返回：成功

description

字符串

此资源的可选描述。创建资源时提供此属性。

返回：成功

id

整数

资源的唯一标识符。

返回：成功

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

字符串

这表示 ForwardingRule 将用于什么，可以是 EXTERNAL、INTERNAL 或 INTERNAL_MANAGED。EXTERNAL 用于经典 Cloud 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 应属于的网络。如果未指定此字段，则将使用默认网络。

此字段仅用于 INTERNAL 负载均衡。

返回：成功

networkTier

字符串

用于配置此地址的网络层。如果未指定此字段，则假定为 PREMIUM。

返回：成功

portRange

字符串

此字段与 TargetHttpProxy、TargetHttpsProxy、TargetSslProxy、TargetTcpProxy、TargetVpnGateway、TargetPool、TargetInstance 的目标字段一起使用。

仅当 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

列表 / elements=字符串

此字段与内部负载均衡的 backend_service 字段一起使用。

当负载均衡方案为 INTERNAL 时，可以配置单个端口或以逗号分隔的端口列表。只有发送到这些端口的数据包才会转发到使用此转发规则配置的后端。

最多可以指定 5 个端口。

返回：成功

region

字符串

对区域转发规则所在的区域的引用。

此字段不适用于全局转发规则。

返回：成功

serviceLabel

字符串

此转发规则的服务名称的可选前缀。

如果指定，将是完全限定服务名称的第一个标签。

标签的长度必须为 1-63 个字符，并符合 RFC1035。

具体而言，标签的长度必须为 1-63 个字符，并且与正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?` 匹配，这意味着第一个字符必须是小写字母，所有后续字符必须是短划线、小写字母或数字，但最后一个字符不能是短划线。

此字段仅用于 INTERNAL 负载均衡。

返回：成功

serviceName

字符串

此转发规则的内部完全限定服务名称。

此字段仅用于 INTERNAL 负载均衡。

返回：成功

subnetwork

字典

此转发规则的负载均衡 IP 应属于的子网。此字段仅用于 INTERNAL 负载均衡。

如果指定的网络处于自动子网模式，则此字段是可选的。但是，如果网络处于自定义子网模式，则必须指定一个子网。

返回：成功

target

字符串

接收匹配流量的目标资源的 URL。

目标必须与转发规则位于同一区域。

转发的流量类型必须适合目标对象。

返回：成功

作者

  • Google Inc. (@googlecloudplatform)