google.cloud.gcp_redis_instance_info 模块 – 收集 GCP 实例信息

注意

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

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

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

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

注意

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

概要

  • 收集 GCP 实例信息

要求

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

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

project

字符串

要使用的 Google Cloud Platform 项目。

region

字符串 / 必填

实例的 Redis 区域名称。

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 an instance
  gcp_redis_instance_info:
    region: us-central1
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值

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

键

描述

resources

复杂类型

资源列表

返回： 始终

alternativeLocationId

字符串

仅适用于 STANDARD_HA 层，该层通过在两个区域中配置实例来保护实例免受区域故障的影响。

如果提供，则必须与 [locationId] 中提供的区域不同。

返回： 成功

authEnabled

布尔值

可选。指示是否为实例启用了 OSS Redis AUTH。如果设置为“true”，则在实例上启用 AUTH。

默认值为“false”，表示 AUTH 已禁用。

返回： 成功

authorizedNetwork

字符串

实例连接到的 Google Compute Engine 网络的全名。如果未指定，则将使用默认网络。

返回： 成功

connectMode

字符串

Redis 实例的连接模式。

返回： 成功

createTime

字符串

实例创建的时间，采用 RFC3339 UTC “Zulu” 格式，精确到纳秒。

返回： 成功

currentLocationId

字符串

放置 Redis 端点的当前区域。

对于基本层实例，这将始终与用户在创建时提供的 [locationId] 相同。对于标准层实例，这可以是 [locationId] 或 [alternativeLocationId]，并且在故障转移事件后可能会发生更改。

返回： 成功

displayName

字符串

实例的任意且可选的用户提供的名称。

返回： 成功

host

字符串

客户端用于连接到服务的公开 Redis 端点的主机名或 IP 地址。

返回： 成功

labels

字典

表示用户提供的元数据的资源标签。

返回： 成功

locationId

字符串

实例将在此区域配置。如果未提供，服务将为实例选择一个区域。对于 STANDARD_HA 层，实例将在两个区域中创建，以防止区域性故障。如果也提供了 [alternativeLocationId]，则它必须与 [locationId] 不同。

返回： 成功

memorySizeGb

整数

Redis 内存大小（GiB）。

返回： 成功

name

字符串

实例的 ID 或实例的完全限定标识符。

返回： 成功

persistenceIamIdentity

字符串

仅输出。导入/导出操作用于将数据传输到/从 Cloud Storage 的 Cloud IAM 身份。格式为“serviceAccount:”。

对于给定实例，此值可能会随时间变化，因此应在每次导入/导出操作之前进行检查。

返回： 成功

port

整数

公开的 Redis 端点的端口号。

返回： 成功

redisConfigs

字典

Redis 配置参数，根据 https://redis.ac.cn/topics/config。

请查看 Memorystore 文档以了解受支持的参数列表： https://cloud.google.com/memorystore/docs/redis/reference/rest/v1/projects.locations.instances#Instance.FIELDS.redis_configs。

返回： 成功

redisVersion

字符串

Redis 软件的版本。如果未提供，将使用最新支持的版本。请查看顶部链接的 API 文档以了解最新的有效值。

返回： 成功

region

字符串

实例的 Redis 区域名称。

返回： 成功

reservedIpRange

字符串

为此实例保留的内部地址的 CIDR 范围。如果未提供，服务将选择一个未使用的 /29 块，例如 10.0.0.0/29 或 192.168.0.0/29。范围必须唯一，并且与授权网络中现有子网不重叠。

返回： 成功

serverCaCerts

复杂类型

实例的服务器 CA 证书列表。

返回： 成功

cert

字符串

从证书中提取的序列号。

返回： 成功

createTime

字符串

创建证书的时间。

返回： 成功

expireTime

字符串

证书过期时间。

返回： 成功

serialNumber

字符串

从证书中提取的序列号。

返回： 成功

sha1Fingerprint

字符串

证书的 Sha1 指纹。

返回： 成功

tier

字符串

实例的服务层。必须是以下值之一： - BASIC：独立实例 - STANDARD_HA：高可用性主/副本实例。

返回： 成功

transitEncryptionMode

字符串

Redis 实例的 TLS 模式，如果未提供，则实例的 TLS 将被禁用。

  • SERVER_AUTHENTICATION：启用服务器身份验证的客户端到服务器流量加密。

返回： 成功

作者

  • Google Inc. (@googlecloudplatform)