google.cloud.gcp_compute_snapshot 模块 – 创建 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。

注意

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

摘要

• 表示持久性磁盘快照资源。

• 使用快照备份持久性磁盘中的数据。快照不同于主要用于创建实例或配置实例模板的公共映像和自定义映像。快照对于定期备份持久性磁盘上的数据非常有用。即使持久性磁盘已附加到正在运行的实例，您也可以从中创建快照。

• 快照是增量的，因此与定期创建磁盘的完整映像相比，您可以更快、更低成本地定期创建持久性磁盘上的快照。

要求

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

• python >= 2.6

• requests >= 2.18.4

• google-auth >= 1.3.0

参数

参数	注释
access_token 字符串	如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。
auth_kind 字符串 / 必需	使用的凭据类型。 选项 "application" "machineaccount" "serviceaccount" "accesstoken"
description 字符串	此资源的可选描述。
env_type 字符串	指定您在此模块中运行的 Ansible 环境。 除非您知道自己在做什么，否则不应设置此项。 这只会更改任何 API 请求的用户代理字符串。
labels 字典	应用于此快照的标签。
name 字符串 / 必需	资源的名称；在创建资源时由客户端提供。名称必须是 1-63 个字符长，并符合 RFC1035。具体来说，名称必须是 1-63 个字符长，并匹配正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?`，这意味着第一个字符必须是小写字母，所有后续字符必须是连字符、小写字母或数字，最后一个字符不能是连字符。
project 字符串	要使用的 Google Cloud Platform 项目。
scopes 列表 / 元素=字符串	要使用的范围数组
service_account_contents jsonarg	服务帐户 JSON 文件的内容，可以是字典或表示它的 JSON 字符串。
service_account_email 字符串	如果选择了 machineaccount 并且用户不想使用默认电子邮件，则为可选的服务帐户电子邮件地址。
service_account_file 路径	如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。
snapshot_encryption_key 字典	快照的客户提供的加密密钥。如果源快照受客户提供的加密密钥保护，则需要此密钥。
kms_key_name 字符串	存储在 Google Cloud KMS 中的加密密钥的名称。
kms_key_service_account 字符串	用于给定 KMS 密钥的加密请求的服务帐户。 如果缺失，则使用 Compute Engine 服务代理服务帐户。
raw_key 字符串	指定一个 256 位客户提供的加密密钥，使用 RFC 4648 base64 编码来加密或解密此资源。
source_disk 字典 / 必需	用于创建此快照的磁盘的引用。 此字段表示 GCP 中磁盘资源的链接。它可以通过两种方式指定。首先，您可以放置一个字典，其中键为“name”，值为资源的名称。或者，您可以将 `register: name-of-resource` 添加到 gcp_compute_disk 任务，然后将此 source_disk 字段设置为“{{ name-of-resource }}”
source_disk_encryption_key 字典	源快照的客户提供的加密密钥。如果源快照受客户提供的加密密钥保护，则需要此密钥。
kms_key_name 字符串	存储在 Google Cloud KMS 中的加密密钥的名称。
kms_key_service_account 字符串	用于给定 KMS 密钥的加密请求的服务帐户。 如果缺失，则使用 Compute Engine 服务代理服务帐户。
raw_key 字符串	指定一个 256 位客户提供的加密密钥，使用 RFC 4648 base64 编码来加密或解密此资源。
state 字符串	给定对象是否应该存在于 GCP 中 选项 "present" ← (默认) "absent"
storage_locations 列表 / 元素=字符串	快照的云存储存储桶位置（区域或多区域）。
区域 字符串	磁盘所在区域的引用。

备注

注意

• API 参考：https://cloud.google.com/compute/docs/reference/rest/v1/snapshots

• 官方文档：https://cloud.google.com/compute/docs/disks/create-snapshots

• 对于身份验证，您可以使用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: create a disk
  google.cloud.gcp_compute_disk:
    name: disk-snapshot
    zone: us-central1-a
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: disk

- name: create a snapshot
  google.cloud.gcp_compute_snapshot:
    name: test_object
    source_disk: "{{ disk }}"
    zone: us-central1-a
    labels:
      my_label: value
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

返回值

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

键	描述
creationTimestamp 字符串	RFC3339 文本格式的创建时间戳。 返回：成功
description 字符串	此资源的可选描述。 返回：成功
diskSizeGb 整数	快照的大小，以 GB 为单位。 返回：成功
id 整数	资源的唯一标识符。 返回：成功
labelFingerprint 字符串	用于此资源乐观锁定的指纹。在更新期间内部使用。 返回：成功
labels 字典	应用于此快照的标签。 返回：成功
licenses 列表 / 元素=字符串	应用于此快照的公开可见许可证列表。这可能是因为原始映像附加了许可证（例如 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 列表 / 元素=字符串	快照的云存储存储桶位置（区域或多区域）。 返回：成功
区域 字符串	磁盘所在区域的引用。 返回：成功

作者

• Google Inc. (@googlecloudplatform)

资源链接

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