google.cloud.gcp_compute_target_tcp_proxy_info 模块 – 收集 GCP TargetTcpProxy 的信息

注意

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

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

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

要在 Playbook 中使用它，请指定：google.cloud.gcp_compute_target_tcp_proxy_info。

注意

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

概要 

收集 GCP TargetTcpProxy 的信息

要求 

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

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 列表 / 元素=字符串	过滤器值对的列表。此处列出了可用的过滤器 https://cloud.google.com/sdk/gcloud/reference/topic/filters。列表中的每个附加过滤器都将作为 AND 条件添加 (filter1 和 filter2)。
project 字符串	要使用的 Google Cloud Platform 项目。
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 TCP proxy
  gcp_compute_target_tcp_proxy_info:
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值 

常见返回值已在此处文档中说明，以下是此模块独有的字段

键	描述
资源复杂	资源列表返回值：总是
creationTimestamp 字符串	RFC3339 文本格式的创建时间戳。返回值：成功
description 字符串	此资源的可选描述。返回值：成功
id 整数	资源的唯一标识符。返回值：成功
name 字符串	资源的名称。由客户端在创建资源时提供。名称的长度必须为 1-63 个字符，并符合 RFC1035。具体而言，名称的长度必须为 1-63 个字符，并与正则表达式 `[a-z]([-a-z0-9][a-z0-9])?` 匹配，这意味着第一个字符必须是小写字母，所有后续字符必须是短划线、小写字母或数字，但最后一个字符不能是短划线。返回值：* 成功
proxyBind 布尔值	仅当引用此目标代理的转发规则的 loadBalancingScheme 设置为 INTERNAL_SELF_MANAGED 时，此字段才适用。返回值：成功
proxyHeader 字符串	指定在将数据发送到后端之前要附加的代理标头的类型。返回值：成功
service 字典	对 BackendService 资源的引用。返回值：成功

作者

Google Inc. (@googlecloudplatform)