google.cloud.gcp_compute_target_pool_info 模块 – 收集 GCP TargetPool 信息

注意

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

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

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

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

注意

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

概要

  • 收集 GCP TargetPool 信息

需求

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

  • 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

列表 / 元素=字符串

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

列表中的每个附加过滤器都将作为 AND 条件添加 (filter1 and filter2)。

project

字符串

要使用的 Google Cloud Platform 项目。

region

字符串 / 必需

目标池所在的区域。

scopes

列表 / 元素=字符串

要使用的作用域数组

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 target pool
  gcp_compute_target_pool_info:
    region: us-west1
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值

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

键

描述

resources

复杂

资源列表

返回： 始终

backupPool

字典

此字段仅当包含的目标池作为主池为转发规则提供服务，并且其 failoverRatio 字段正确设置为 [0, 1] 之间的值时适用。

backupPool 和 failoverRatio 一起定义主目标池的回退行为：如果主池中健康实例的比率小于或等于 failoverRatio，则到达负载均衡 IP 的流量将被定向到备份池。

如果未设置 failoverRatio 和 backupPool，或者备份池中的所有实例都不健康，则流量将以“强制”模式定向回主池，其中流量将尽力分散到健康实例，或者在没有健康实例时分散到所有实例。

返回： 成功

creationTimestamp

字符串

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

返回： 成功

description

字符串

此资源的可选描述。

返回： 成功

failoverRatio

字符串

此字段仅当包含的目标池作为主池为转发规则提供服务（即，不作为其他目标池的备份池）时适用。字段的值必须在 [0, 1] 中。

如果设置，则也必须设置 backupPool。它们一起定义主目标池的回退行为：如果主池中健康实例的比率小于或等于此数字，则到达负载均衡 IP 的流量将被定向到备份池。

如果未设置 failoverRatio 或备份池中的所有实例都不健康，则流量将以“强制”模式定向回主池，其中流量将尽力分散到健康实例，或者在没有健康实例时分散到所有实例。

返回： 成功

healthCheck

字典

对 HttpHealthCheck 资源的引用。

只有当健康检查通过时，此池中的成员实例才被认为是健康的。如果未指定，则表示所有成员实例始终都被认为是健康的。

返回： 成功

id

整数

资源的唯一标识符。

返回： 成功

instances

列表 / 元素=字符串

为此池提供服务的虚拟机实例列表。

它们必须位于与该池位于同一区域的区域中。

返回： 成功

name

字符串

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

返回： 成功

region

字符串

目标池所在的区域。

返回： 成功

sessionAffinity

字符串

会话关联选项。必须是以下值之一：* NONE：来自同一客户端 IP 的连接可以转到池中的任何实例。

* CLIENT_IP：来自同一客户端 IP 的连接将在该实例保持健康状态时转到池中的同一实例。

* CLIENT_IP_PROTO：来自同一客户端 IP 且具有相同 IP 协议的连接将在该实例保持健康状态时转到池中的同一实例。

返回： 成功

作者

  • Google Inc. (@googlecloudplatform)