google.cloud.gcp_sql_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_sql_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 项目。
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_sql_instance_info:
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值

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

键	描述
resources 复杂	资源列表 返回：始终
backendType 字符串	* FIRST_GEN：第一代实例。仅限 MySQL。 * SECOND_GEN：第二代实例或 PostgreSQL 实例。 * EXTERNAL：不由 Google 管理的数据库服务器。 返回：成功
connectionName 字符串	连接字符串中使用的 Cloud SQL 实例的连接名称。 返回：成功
databaseVersion 字符串	数据库引擎类型和版本。对于第一代实例，可以是 MYSQL_5_5 或 MYSQL_5_6。对于第二代实例，可以是 MYSQL_5_6 或 MYSQL_5_7。默认为 MYSQL_5_6。 PostgreSQL 实例：POSTGRES_9_6 数据库版本属性在实例创建后无法更改。 返回：成功
diskEncryptionConfiguration 复杂	磁盘加密设置。 返回：成功
kmsKeyName 字符串	用于加密 Cloud SQL 实例的 KMS 密钥。 返回：成功
diskEncryptionStatus 复杂	磁盘加密状态。 返回：成功
kmsKeyVersionName 字符串	用于加密 Cloud SQL 实例的 KMS 密钥版本。 返回：成功
failoverReplica 复杂	故障转移副本的名称和状态。此属性仅适用于第二代实例。 返回：成功
available 布尔值	故障转移副本的可用性状态。false 状态表示故障转移副本不同步。只有当状态为 true 时，主实例才能故障转移到故障转移副本。 返回：成功
name 字符串	故障转移副本的名称。如果在实例创建时指定，则会为实例创建故障转移副本。名称不包含项目 ID。此属性仅适用于第二代实例。 返回：成功
gceZone 字符串	实例当前从中提供服务的 Compute Engine 区域。如果实例已故障转移到其辅助区域，则此值可能与实例创建时指定的区域不同。 返回：成功
instanceType 字符串	实例类型。可以是以下之一。 * CLOUD_SQL_INSTANCE：一个未从主实例复制的 Cloud SQL 实例。 * ON_PREMISES_INSTANCE：运行在客户本地环境中的实例。 * READ_REPLICA_INSTANCE：配置为只读副本的 Cloud SQL 实例。 返回：成功
ipAddresses 复杂	分配给实例的 IP 地址。 返回：成功
ipAddress 字符串	分配的 IP 地址。 返回：成功
timeToRetire 字符串	此 IP 预计停用的时间，采用 RFC 3339 格式，例如 2012-11-15T16:19:00.094Z。只有在计划停用 IP 时，此字段才可用。 返回：成功
type 字符串	此 IP 地址的类型。PRIMARY 地址是可以接受传入连接的地址。OUTGOING 地址是实例发起的连接的源地址（如果支持）。 返回：成功
ipv6Address 字符串	分配给实例的 IPv6 地址。此属性仅适用于第一代实例。 返回：成功
masterInstanceName 字符串	在复制设置中充当主实例的实例名称。 返回：成功
maxDiskSize 整数	实例的最大磁盘大小（以字节为单位）。 返回：成功
name 字符串	Cloud SQL 实例的名称。不包含项目 ID。 返回：成功
region 字符串	地理区域。根据实例类型（第一代或第二代/PostgreSQL）默认为 us-central 或 us-central1。 返回：成功
replicaConfiguration 复杂	特定于故障转移副本和只读副本的配置。 返回：成功
failoverTarget 布尔值	指定副本是否为故障转移目标。如果此字段设置为 true，则该副本将被指定为故障转移副本。 如果主实例发生故障，副本实例将被提升为新的主实例。 只能将一个副本指定为故障转移目标，并且该副本必须与主实例位于不同的区域。 返回：成功
mysqlReplicaConfiguration 复杂	从本地 MySQL 主实例复制时的 MySQL 特定配置。复制配置信息（例如用户名、密码、证书和密钥）不会存储在实例元数据中。配置信息仅用于设置复制连接，并由 MySQL 存储在数据目录中的名为 master.info 的文件中。 返回：成功
caCertificate 字符串	受信任 CA 的 x509 证书的 PEM 表示形式。 返回：成功
clientCertificate 字符串	副本的 x509 证书的 PEM 表示形式。 返回：成功
clientKey 字符串	副本私钥的 PEM 表示形式。相应的公钥编码在客户端证书中。 返回：成功
connectRetryInterval 整数	连接重试之间等待的秒数。MySQL 的默认值为 60 秒。 返回：成功
dumpFilePath 字符串	指向 Google Cloud Storage 中 SQL 转储文件的路径，从中创建副本实例。URI 格式为 gs://bucketName/fileName。也支持压缩的 gzip 文件（.gz）。转储应包含应从其开始复制的 binlog 坐标。这可以通过在使用 mysqldump 时将 –master-data 设置为 1 来实现。 返回：成功
masterHeartbeatPeriod 整数	复制心跳之间的间隔（以毫秒为单位）。 返回：成功
password 字符串	复制连接的密码。 返回：成功
sslCipher 字符串	用于 SSL 加密的允许密码列表。 返回：成功
username 字符串	复制连接的用户名。 返回：成功
verifyServerCertificate 布尔值	是否检查主实例在 SSL 握手期间发送的证书中的“通用名称”值。 返回：成功
replicaNames 列表 / 元素=字符串	实例的副本。 返回：成功
serviceAccountEmailAddress 字符串	分配给实例的服务帐号电子邮件地址。此属性仅适用于第二代实例。 返回：成功
serverCaCert 复杂	SSL 配置。 返回：成功
cert 字符串	X.509 证书的 PEM 表示形式。 返回：成功
certSerialNumber 字符串	从证书中提取的序列号。 返回：成功
commonName 字符串	用户提供的名称。限制为 [a-zA-Z.-_ ]+。 返回：成功
createTime 字符串	证书创建的时间，采用 RFC 3339 格式，例如 2012-11-15T16:19:00.094Z。 返回：成功
expirationTime 字符串	证书过期的时间，采用 RFC 3339 格式，例如 2012-11-15T16:19:00.094Z。 返回：成功
sha1Fingerprint 字符串	证书的 SHA-1 指纹。 返回：成功
settings 复杂	用户设置。 返回：成功
availabilityType 字符串	availabilityType 定义您的 postgres 实例是在区域运行还是在区域运行。 返回：成功
backupConfiguration 复杂	实例的每日备份配置。 返回：成功
binaryLogEnabled 布尔值	是否启用了二进制日志。如果禁用备份配置，则也必须禁用二进制日志。仅限 MySQL。 返回：成功
enabled 布尔值	为您的实例启用自动备份。 返回：成功
startTime 字符串	定义备份开始时间（UTC）（HH:MM）。 返回：成功
databaseFlags 复杂	启动时传递给实例的数据库标志。 返回：成功
name 字符串	标志的名称。这些标志在实例启动时传递，因此包括 MySQL 的服务器选项和系统变量。标志应使用下划线而不是连字符指定。 返回：成功
value 字符串	标志的值。布尔值应设置为 on 表示 true，设置为 off 表示 false。如果标志不接受值，则必须省略此字段。 返回：成功
ipConfiguration 复杂	IP 管理设置。这允许启用或禁用实例 IP 并管理哪些外部网络可以连接到实例。对于第二代实例，无法禁用 IPv4 地址。 返回：成功
authorizedNetworks 复杂	允许使用 IP 连接到实例的外部网络列表。采用 CIDR 表示法，也称为“斜杠”表示法（例如 192.168.100.0/24）。 返回：成功
expirationTime 字符串	此访问控制条目过期的日期和时间，采用 RFC 3339 格式，例如 2012-11-15T16:19:00.094Z。 返回：成功
name 字符串	用于标识此条目的可选标签。 返回：成功
value 字符串	访问控制列表的允许值。例如，要授予来自外部 IP（IPv4 或 IPv6）地址或子网的客户端的访问权限，请在此处使用该地址或子网。 返回：成功
ipv4Enabled 布尔值	实例是否应分配 IP 地址。 返回：成功
privateNetwork 字符串	可以从其访问 Cloud SQL 实例以获得专用 IP 的 VPC 网络的资源链接（例如 /projects/myProject/global/networks/default） 返回：成功
requireSsl 布尔值	mysqld 是否应默认为“REQUIRE X509”以供通过 IP 连接的用户使用。 返回：成功
settingsVersion 整数	实例设置的版本。这是更新方法的必填字段，用于确保正确处理并发更新。 在更新期间，请使用此实例的最新 settingsVersion 值，不要尝试更新此值。 返回：成功
tier 字符串	此实例的分层结构或机器类型，例如 db-n1-standard-1。对于 MySQL 实例，此字段决定实例是第二代（推荐）还是第一代。 返回：成功
userLabels 字典	用户提供的标签，表示为字典，其中每个标签都是一个键值对。 返回：成功
state 字符串	数据库实例当前的服务状态。 返回：成功

作者

• Google Inc. (@googlecloudplatform)

收集链接

• 问题追踪器
• 主页
• 代码库（源代码）