google.cloud.gcp_compute_image_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_image_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

列表 / 元素=字符串

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

列表中的每个附加过滤器都将被添加为 AND 条件 (filter1 and filter2)。

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

返回值

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

键

描述

resources

复杂

资源列表

返回：始终

archiveSizeBytes

整数

存储在 Google Cloud Storage 中的镜像 tar.gz 存档的大小（以字节为单位）。

返回：成功

creationTimestamp

字符串

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

返回：成功

deprecated

复杂

与此镜像关联的弃用状态。

返回：成功

deleted

字符串

可选的 RFC3339 时间戳，在此时间戳之后，此资源的状态将更改为 DELETED。这仅供参考，除非客户端显式更改它，否则状态不会更改。

返回：成功

deprecated

字符串

可选的 RFC3339 时间戳，在此时间戳之后，此资源的状态将更改为 DEPRECATED。这仅供参考，除非客户端显式更改它，否则状态不会更改。

返回：成功

obsolete

字符串

可选的 RFC3339 时间戳，在此时间戳之后，此资源的状态将更改为 OBSOLETE。这仅供参考，除非客户端显式更改它，否则状态不会更改。

返回：成功

replacement

字符串

建议用于替换已弃用资源的 URL。

建议的替换资源必须与已弃用的资源属于相同的资源类型。

返回：成功

state

字符串

此资源的弃用状态。这可以是 DEPRECATED、OBSOLETE 或 DELETED。使用已弃用资源创建新资源的操作将成功返回，但会发出警告，指出已弃用的资源并推荐其替代资源。使用 OBSOLETE 或 DELETED 资源的操作将被拒绝并导致错误。

返回：成功

description

字符串

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

返回：成功

diskSizeGb

整数

将镜像还原到持久性磁盘时的尺寸（以 GB 为单位）。

返回：成功

family

字符串

此镜像所属的镜像系列的名称。您可以通过指定镜像系列而不是特定镜像名称来创建磁盘。镜像系列始终返回其最新的非弃用镜像。镜像系列的名称必须符合 RFC1035。

返回：成功

guestOsFeatures

复杂

在客户操作系统上启用功能的列表。

仅适用于可启动镜像。

返回：成功

类型

字符串

支持的功能类型。

返回：成功

ID

整数

资源的唯一标识符。此标识符由服务器定义。

返回：成功

imageEncryptionKey

复杂

使用客户提供的加密密钥加密镜像。

使用客户提供的密钥加密镜像后，如果稍后使用该镜像（例如，从镜像创建磁盘），则必须提供相同的密钥。

返回：成功

rawKey

字符串

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

返回：成功

sha256

字符串

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

返回：成功

labelFingerprint

字符串

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

返回：成功

标签

字典

应用于此镜像的标签。

返回：成功

许可证

列表 / 元素=字符串

任何适用的许可证 URI。

返回：成功

名称

字符串

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

返回：成功

rawDisk

复杂

原始磁盘镜像的参数。

返回：成功

containerType

字符串

用于编码和传输块设备的格式，应为 TAR。这只是一个容器和传输格式，而不是运行时格式。在创建磁盘镜像时由客户端提供。

返回：成功

sha1Checksum

字符串

解包前磁盘镜像的可选 SHA1 校验和。

在创建磁盘镜像时由客户端提供。

返回：成功

源

字符串

存储磁盘存储的完整 Google Cloud Storage URL。必须提供此属性或 sourceDisk 属性，但不能同时提供两者。

返回：成功

sourceDisk

字典

基于此创建镜像的源磁盘。

要创建镜像，必须提供此属性或 rawDisk.source 属性，但不能同时提供两者。

返回：成功

sourceDiskEncryptionKey

复杂

源磁盘的客户提供的加密密钥。如果源磁盘受客户提供的加密密钥保护，则需要此密钥。

返回：成功

rawKey

字符串

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

返回：成功

sha256

字符串

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

返回：成功

sourceDiskId

字符串

用于创建此镜像的磁盘的 ID 值。此值可用于确定镜像是取自给定磁盘名称的当前实例还是之前的实例。

返回：成功

sourceImage

字典

用于创建此镜像的源镜像的 URL。为了创建镜像，必须提供以下各项之一的完整或部分 URL：* selfLink URL * 此属性 * rawDisk.source URL * sourceDisk URL。

返回：成功

sourceSnapshot

字典

用于创建此镜像的源快照的 URL。

为了创建镜像，必须提供以下各项之一的完整或部分 URL：* selfLink URL * 此属性 * sourceImage URL * rawDisk.source URL * sourceDisk URL。

返回：成功

sourceType

字符串

用于创建此磁盘的镜像类型。默认值且唯一值为 RAW。

返回：成功

作者

  • Google Inc. (@googlecloudplatform)