google.cloud.gcp_compute_target_https_proxy_info 模块 – 收集 GCP TargetHttpsProxy 的信息

注意

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

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

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

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

注意

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

概要

  • 收集 GCP TargetHttpsProxy 的信息

要求

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

  • 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 target HTTPS proxy
  gcp_compute_target_https_proxy_info:
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值

通用返回值已在 此处 记录，以下是此模块独有的字段

键

描述

resources

复杂

资源列表

返回： 始终

creationTimestamp

字符串

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

返回： 成功

description

字符串

此资源的可选描述。

返回： 成功

id

整数

资源的唯一标识符。

返回： 成功

name

字符串

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

返回： 成功

proxyBind

布尔值

此字段仅在引用此目标代理的转发规则的 loadBalancingScheme 设置为 INTERNAL_SELF_MANAGED 时适用。

返回： 成功

quicOverride

字符串

指定此资源的 QUIC 覆盖策略。这决定了负载均衡器是否尝试与客户端协商 QUIC。可以指定 NONE、ENABLE 或 DISABLE 之一。如果指定 NONE，则使用没有用户覆盖的 QUIC 策略，这等效于 DISABLE。

返回： 成功

sslCertificates

列表 / elements=字符串

用于验证用户和负载均衡器之间连接的 SslCertificate 资源列表。必须至少指定一个 SSL 证书。

返回： 成功

sslPolicy

字典

对将与 TargetHttpsProxy 资源关联的 SslPolicy 资源的引用。如果未设置，TargetHttpsProxy 资源将不会配置任何 SSL 策略。

返回： 成功

urlMap

字典

对定义从 URL 到 BackendService 的映射的 UrlMap 资源的引用。

返回： 成功

作者

  • Google Inc. (@googlecloudplatform)