google.cloud.gcp_compute_global_forwarding_rule_info 模块 – 收集 GCP GlobalForwardingRule 的信息

注意

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

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

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

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

注意

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

概要

  • 收集 GCP GlobalForwardingRule 的信息

要求

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

  • 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 请求的用户代理字符串。

filters

列表 / elements=字符串

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

列表中的每个其他筛选器都将作为 AND 条件添加（filter1 和 filter2）。

project

字符串

要使用的 Google Cloud Platform 项目。

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 global forwarding rule
  gcp_compute_global_forwarding_rule_info:
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值

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

键

描述

resources

复杂

资源列表

已返回： 始终

creationTimestamp

字符串

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

已返回： 成功

description

字符串

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

已返回： 成功

id

整数

资源的唯一标识符。

已返回： 成功

IPAddress

字符串

此转发规则代表服务的 IP 地址。

地址根据转发规则的负载平衡方案（外部或内部）和范围（全局或区域）受到限制。

当负载平衡方案为 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_SELF_MANAGED 时，仅 TCP 有效。如果将全局地址配置为 PRIVATE_SERVICE_CONNECT 的目的且 addressType 为 INTERNAL，则不得设置此字段。

已返回： 成功

ipVersion

字符串

此全局转发规则将使用的 IP 版本。

已返回： 成功

loadBalancingScheme

字符串

这表示 GlobalForwardingRule 将用于什么。

INTERNAL_SELF_MANAGED 的值表示这将用于内部全局 HTTP(S) 负载均衡。 EXTERNAL 的值表示这将用于外部全局负载均衡（HTTP(S) 负载均衡、外部 TCP/UDP 负载均衡、SSL 代理）（[Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html) 仅限）。注意：如果全局地址配置为 PRIVATE_SERVICE_CONNECT 的目的且地址类型为 INTERNAL，则此字段必须设置为 “”。

已返回： 成功

metadataFilters

复杂

负载均衡器使用的不透明过滤器标准，用于将路由配置限制为一组有限的符合 xDS 的客户端。在发送给负载均衡器的 xDS 请求中，xDS 客户端会提供节点元数据。如果匹配成功，则相关的路由配置将提供给这些代理。

对于此列表中的每个 metadataFilter，如果其 filterMatchCriteria 设置为 MATCH_ANY，则至少一个 filterLabels 必须与元数据中提供的相应标签匹配。如果其 filterMatchCriteria 设置为 MATCH_ALL，则其所有 filterLabels 都必须与所提供元数据中的相应标签匹配。

此处指定的 metadataFilters 可以被此 ForwardingRule 引用的 UrlMap 中指定的元数据筛选器覆盖。

metadataFilters 仅适用于将其 loadBalancingScheme 设置为 INTERNAL_SELF_MANAGED 的负载均衡器。

已返回： 成功

filterLabels

复杂

必须根据 filterMatchCriteria 与提供的元数据中的标签匹配的标签值对列表。此列表不能为空，最多可以有 64 个条目。

已返回： 成功

name

字符串

元数据标签的名称。长度必须介于 1 到 1024 个字符之间（包括 1 和 1024）。

已返回： 成功

value

字符串

标签必须匹配的值。值的最大长度为 1024 个字符。

已返回： 成功

filterMatchCriteria

字符串

指定 filterLabels 列表中的各个 filterLabel 匹配如何对整体 metadataFilter 匹配做出贡献。

MATCH_ANY - 至少一个 filterLabels 必须在提供的元数据中具有匹配的标签。

MATCH_ALL - 所有 filterLabels 必须在提供的元数据中具有匹配的标签。

已返回： 成功

name

字符串

资源的名称；由客户端在创建资源时提供。名称必须为 1-63 个字符长，并符合 RFC1035。具体而言，名称必须为 1-63 个字符长，并与正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?` 匹配，这意味着第一个字符必须是小写字母，所有后续字符必须是破折号、小写字母或数字，但最后一个字符不能是破折号。

已返回： 成功

network

字典

此字段不用于外部负载均衡。

对于 INTERNAL_SELF_MANAGED 负载均衡，此字段标识此全局转发规则的负载均衡 IP 所属的网络。如果未指定此字段，则将使用默认网络。

已返回： 成功

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 。

已返回： 成功

target

字符串

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

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

对于 INTERNAL_SELF_MANAGED 负载均衡，只有 HTTP 和 HTTPS 目标有效。

（[Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html) 仅限）对于目的为 PRIVATE_SERVICE_CONNECT 且地址类型为 INTERNAL 的全局地址，只有“all-apis”和“vpc-sc”有效。

已返回： 成功

作者

  • Google Inc. (@googlecloudplatform)