google.cloud.gcp_compute_region_disk_info 模块 – 收集 GCP RegionDisk 信息

注意

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

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

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

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

注意

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

概要 

收集 GCP RegionDisk 信息

要求 

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

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 列表 / 元素=字符串	过滤器值对的列表。可用的过滤器列在 https://cloud.google.com/sdk/gcloud/reference/topic/filters。列表中的每个附加过滤器都将作为 AND 条件添加 (filter1 和 filter2)。
project 字符串	要使用的 Google Cloud Platform 项目。
region 字符串 / 必需	磁盘所在的区域的引用。
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 a region disk
  gcp_compute_region_disk_info:
    region: us-central1
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值 

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

键	描述
resources 复杂类型	资源列表返回：始终
creationTimestamp 字符串	RFC3339 文本格式的创建时间戳。返回：成功
description 字符串	此资源的可选描述。创建资源时提供此属性。返回：成功
diskEncryptionKey 复杂类型	使用客户提供的加密密钥加密磁盘。使用客户提供的密钥加密磁盘后，如果稍后使用磁盘（例如，创建磁盘快照或映像，或将磁盘附加到虚拟机），则必须提供相同的密钥。客户提供的加密密钥无法保护对磁盘元数据的访问。如果创建磁盘时不提供加密密钥，则将使用自动生成的密钥加密磁盘，并且以后无需提供密钥即可使用磁盘。返回：成功
rawKey 字符串	指定一个 256 位客户提供的加密密钥，以 RFC 4648 base64 编码，用于加密或解密此资源。返回：成功
sha256 字符串	保护此资源的客户提供的加密密钥的 RFC 4648 base64 编码 SHA-256 哈希值。返回：成功
id 整数	资源的唯一标识符。返回：成功
labelFingerprint 字符串	用于此资源的乐观锁定的指纹。在更新期间内部使用。返回：成功
labels 字典	要应用于此磁盘的标签。键值对列表。返回：成功
lastAttachTimestamp 字符串	RFC3339 文本格式的上次附加时间戳。返回：成功
lastDetachTimestamp 字符串	RFC3339 文本格式的上次分离时间戳。返回：成功
licenses 列表 / 元素=字符串	任何适用的公开可见许可证。返回：成功
name 字符串	资源名称。资源创建时由客户端提供。名称长度必须为 1-63 个字符，并符合 RFC1035 规范。具体来说，名称长度必须为 1-63 个字符，并匹配正则表达式 `[a-z]([-a-z0-9][a-z0-9])?`，这意味着第一个字符必须是小写字母，所有后续字符必须是短横线、小写字母或数字，但最后一个字符不能是短横线。返回：*成功
physicalBlockSizeBytes 整数	持久性磁盘的物理块大小（以字节为单位）。如果请求中未提供，则使用默认值。当前支持的大小为 4096 和 16384，将来可能会添加其他大小。如果请求了不支持的值，错误消息将列出调用者项目的支持值。返回：成功
region 字符串	磁盘所在的区域的引用。返回：成功
replicaZones 列表 / 元素=字符串	应将磁盘复制到的区域的 URL。返回：成功
sizeGb 整数	持久性磁盘的大小（以 GB 为单位）。使用 sourceImage 或 sourceSnapshot 参数创建持久性磁盘时，您可以指定此字段；或者单独指定它以创建一个空持久性磁盘。如果同时指定此字段和 sourceImage 或 sourceSnapshot，则 sizeGb 的值不得小于 sourceImage 的大小或快照的大小。返回：成功
sourceSnapshot 字典	用于创建此磁盘的源快照。您可以将其作为指向资源的完整或部分 URL 提供。返回：成功
sourceSnapshotEncryptionKey 复杂类型	客户提供的源快照加密密钥。如果源快照受客户提供的加密密钥保护，则需要此密钥。返回：成功
rawKey 字符串	指定一个 256 位客户提供的加密密钥，以 RFC 4648 base64 编码，用于加密或解密此资源。返回：成功
sha256 字符串	保护此资源的客户提供的加密密钥的 RFC 4648 base64 编码 SHA-256 哈希值。返回：成功
sourceSnapshotId 字符串	用于创建此磁盘的快照的唯一 ID。此值标识用于创建此持久性磁盘的精确快照。例如，如果您从后来被删除并在同名下重新创建的快照创建了持久性磁盘，则源快照 ID 将标识使用的快照的精确版本。返回：成功
type 字符串	磁盘类型资源的 URL，描述用于创建磁盘的磁盘类型。创建磁盘时提供此信息。返回：成功
users 列表 / 元素=字符串	磁盘用户的链接（已附加的实例），格式为：project/zones/zone/instances/instance。返回：成功

作者

Google Inc. (@googlecloudplatform)