google.cloud.gcp_compute_disk_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_disk_info。

注意

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

概要

  • 收集 GCP 磁盘信息

要求

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

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

参数

参数

注释

access_token

string

如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。

auth_kind

string / 必需

使用的凭据类型。

选择

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

env_type

string

指定您在哪个 Ansible 环境中运行此模块。

除非您知道自己在做什么，否则不应设置此项。

这只会更改任何 API 请求的用户代理字符串。

filters

list / elements=string

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

列表中每个附加的过滤器都将作为 AND 条件添加（filter1 和 filter2）。

project

string

要使用的 Google Cloud Platform 项目。

scopes

list / elements=string

要使用的作用域数组

service_account_contents

jsonarg

服务帐户 JSON 文件的内容，以字典形式或表示它的 JSON 字符串形式。

service_account_email

string

如果选择了 machineaccount 并且用户不希望使用默认电子邮件，则为可选的服务帐户电子邮件地址。

service_account_file

path

如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。

zone

string / 必需

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

注释

注意

  • 对于身份验证，您可以使用 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 disk
  gcp_compute_disk_info:
    zone: us-central1-a
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值

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

键

描述

resources

复杂

资源列表

返回： 始终

creationTimestamp

string

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

返回： 成功

description

string

此资源的可选描述。创建资源时提供此属性。

返回： 成功

diskEncryptionKey

复杂

使用客户提供的加密密钥加密磁盘。

在使用客户提供的密钥加密磁盘后，如果稍后使用该磁盘（例如，创建磁盘快照或映像，或将磁盘连接到虚拟机），则必须提供相同的密钥。

客户提供的加密密钥不保护对磁盘元数据的访问。

如果您在创建磁盘时未提供加密密钥，则将使用自动生成的密钥加密磁盘，并且您无需提供密钥即可稍后使用该磁盘。

返回： 成功

kmsKeyName

string

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

您项目的 Compute Engine 系统服务帐户（`service-{{PROJECT_NUMBER}}@compute-system.iam.gserviceaccount.com`) 必须具有 `roles/cloudkms.cryptoKeyEncrypterDecrypter` 才能使用此功能。

返回： 成功

kmsKeyServiceAccount

string

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

如果不存在，则使用 Compute Engine 服务代理服务帐户。

返回： 成功

rawKey

string

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

返回： 成功

sha256

string

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

返回： 成功

id

integer

资源的唯一标识符。

返回： 成功

labelFingerprint

string

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

返回： 成功

labels

dictionary

要应用于此磁盘的标签。键->值对的列表。

返回： 成功

lastAttachTimestamp

string

RFC3339 文本格式的最后附加时间戳。

返回： 成功

lastDetachTimestamp

string

RFC3339 文本格式的最后分离时间戳。

返回： 成功

licenses

list / elements=string

任何适用的公开可见许可证。

返回： 成功

名称

string

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

返回： 成功

physicalBlockSizeBytes

integer

持久磁盘的物理块大小，以字节为单位。如果请求中不存在，则使用默认值。目前支持的大小为 4096 和 16384，未来可能会添加其他大小。

如果请求了不支持的值，错误消息将列出调用者项目支持的值。

返回： 成功

provisionedIops

integer

指示必须为磁盘预配多少 IOPS。

返回： 成功

sizeGb

integer

持久磁盘的大小，以 GB 为单位指定。可以在使用 sourceImage 或 sourceSnapshot 参数创建持久磁盘时指定此字段，或者单独指定它以创建空的持久磁盘。

如果同时指定此字段和 sourceImage 或 sourceSnapshot，则 sizeGb 的值不得小于 sourceImage 的大小或快照的大小。

返回： 成功

sourceImage

string

用于创建此磁盘的源映像。如果源映像被删除，则不会设置此字段。

要使用公共操作系统映像之一创建磁盘，请按其系列名称指定映像。例如，指定 family/debian-9 以使用最新的 Debian 9 映像：projects/debian-cloud/global/images/family/debian-9 或者，使用公共操作系统映像的特定版本： projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD 要使用您创建的私有映像创建磁盘，请使用以下格式指定映像名称：global/images/my-private-image 您还可以按映像系列指定私有映像，这将返回该系列中最新版本的映像。将映像名称替换为 family/family-name： global/images/family/my-private-family 。

返回： 成功

sourceImageEncryptionKey

复杂

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

返回： 成功

kmsKeyName

string

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

返回： 成功

kmsKeyServiceAccount

string

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

如果不存在，则使用 Compute Engine 服务代理服务帐户。

返回： 成功

rawKey

string

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

返回： 成功

sha256

string

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

返回： 成功

sourceImageId

string

用于创建此磁盘的映像的 ID 值。此值标识用于创建此持久磁盘的确切映像。例如，如果您从后来删除并以相同名称重新创建的映像创建了持久磁盘，则源映像 ID 将标识所使用的映像的确切版本。

返回： 成功

sourceSnapshot

dictionary

用于创建此磁盘的源快照。您可以提供此资源的局部或完整 URL。

返回： 成功

sourceSnapshotEncryptionKey

复杂

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

返回： 成功

kmsKeyName

string

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

返回： 成功

kmsKeyServiceAccount

string

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

如果不存在，则使用 Compute Engine 服务代理服务帐户。

返回： 成功

rawKey

string

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

返回： 成功

sha256

string

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

返回： 成功

sourceSnapshotId

string

用于创建此磁盘的快照的唯一 ID。此值标识用于创建此持久磁盘的确切快照。例如，如果您从后来删除并以相同名称重新创建的快照创建了持久磁盘，则源快照 ID 将标识所使用的快照的确切版本。

返回： 成功

type

string

磁盘类型资源的 URL，描述创建磁盘时要使用的磁盘类型。创建磁盘时提供此项。

返回： 成功

users

list / elements=string

指向磁盘用户（已附加实例）的链接，格式为：project/zones/zone/instances/instance 。

返回： 成功

zone

string

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

返回： 成功

作者

  • Google Inc. (@googlecloudplatform)