google.cloud.gcp_compute_snapshot_info 模块 – 收集 GCP 快照信息

注意

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

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

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

要在 playbook 中使用它，请指定：google.cloud.gcp_compute_snapshot_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 请求的用户代理字符串。

filters

列表 / elements=string

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

列表中每个额外的筛选器都将作为 AND 条件添加（筛选器 1 和筛选器 2）。

project

字符串

要使用的 Google Cloud Platform 项目。

scopes

列表 / elements=string

要使用的作用域数组

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 snapshot
  gcp_compute_snapshot_info:
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值

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

键

描述

资源

复杂

资源列表

返回：始终

creationTimestamp

字符串

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

返回：成功

description

字符串

此资源的可选描述。

返回：成功

diskSizeGb

整数

快照的大小，以 GB 为单位指定。

返回：成功

id

整数

资源的唯一标识符。

返回：成功

labelFingerprint

字符串

用于此资源的乐观锁定的指纹。在更新期间在内部使用。

返回：成功

labels

字典

要应用于此快照的标签。

返回：成功

licenses

列表 / elements=string

应用于此快照的一系列公共可见许可证。这可能是因为原始图像附加了许可证（例如 Windows 图像）。snapshotEncryptionKey 嵌套对象使用客户提供的加密密钥加密快照。

返回：成功

name

字符串

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

返回：成功

snapshotEncryptionKey

复杂

快照的客户提供的加密密钥。如果源快照受客户提供的加密密钥保护，则为必填项。

返回：成功

kmsKeyName

字符串

存储在 Google Cloud KMS 中的加密密钥的名称。

返回：成功

kmsKeyServiceAccount

字符串

用于给定 KMS 密钥的加密请求的服务帐号。

如果未指定，则使用 Compute Engine 服务代理服务帐号。

返回：成功

rawKey

字符串

指定一个 256 位的客户提供的加密密钥，以 RFC 4648 base64 编码，用于加密或解密此资源。

返回：成功

sha256

字符串

保护此资源的客户提供的加密密钥的 RFC 4648 base64 编码的 SHA-256 哈希值。

返回：成功

sourceDisk

字典

对用于创建此快照的磁盘的引用。

返回：成功

sourceDiskEncryptionKey

复杂

源快照的客户提供的加密密钥。如果源快照受客户提供的加密密钥保护，则为必填项。

返回：成功

kmsKeyName

字符串

存储在 Google Cloud KMS 中的加密密钥的名称。

返回：成功

kmsKeyServiceAccount

字符串

用于给定 KMS 密钥的加密请求的服务帐号。

如果未指定，则使用 Compute Engine 服务代理服务帐号。

返回：成功

rawKey

字符串

指定一个 256 位的客户提供的加密密钥，以 RFC 4648 base64 编码，用于加密或解密此资源。

返回：成功

storageBytes

整数

快照使用的存储大小。由于快照共享存储，因此预计此数字会随着快照的创建/删除而变化。

返回：成功

storageLocations

列表 / elements=string

快照的 Cloud Storage 存储桶存储位置（区域性或多区域性）。

返回：成功

zone

字符串

对磁盘所在的区域的引用。

返回：成功

作者

  • Google Inc. (@googlecloudplatform)