google.cloud.gcp_compute_instance_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_instance_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/compute/docs/reference/rest/v1/instances/list

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

project

字符串

要使用的 Google Cloud Platform 项目。

scopes

列表 / 元素=字符串

要使用的作用域数组

service_account_contents

jsonarg

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

service_account_email

字符串

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

service_account_file

路径

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

zone

字符串 / 必需

机器所在的区域的引用。

备注

注意

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

返回值

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

键

描述

resources

复杂

资源列表

返回：始终

canIpForward

布尔值

允许此实例发送和接收与不匹配的目标或源 IP 的数据包。如果您计划使用此实例转发路由，则需要此功能。

返回：成功

confidentialInstanceConfig

复杂

机密计算的配置（需要将机器类型设置为任何 n2d-* 类型以及 pd-ssd 类型的启动磁盘）。

返回：成功

enableConfidentialCompute

布尔值

启用机密计算。

返回：成功

cpuPlatform

字符串

此实例使用的 CPU 平台。

返回：成功

creationTimestamp

字符串

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

返回：成功

deletionProtection

布尔值

资源是否应受到保护以防止删除。

返回：成功

disks

复杂

与从此模板创建的实例关联的磁盘数组。

返回：成功

autoDelete

布尔值

指定删除实例时是否会自动删除磁盘（但在磁盘与实例分离时不会删除）。

提示：应将磁盘设置为 autoDelete=true，以便在机器删除后不会留下剩余磁盘。

返回：成功

boot

布尔值

指示这是一个启动磁盘。虚拟机将使用磁盘的第一个分区作为其根文件系统。

返回：成功

deviceName

字符串

指定您选择的唯一设备名称，该名称将反映到 Linux 操作系统（在实例中运行）的 /dev/disk/by-id/google-* 树中。此名称可用于在实例内引用用于挂载、调整大小等的设备。

返回：成功

diskEncryptionKey

复杂

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

返回：成功

rawKey

字符串

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

返回：成功

rsaEncryptedKey

字符串

指定以 RFC 4648 base64 编码的、RSA 封装的 2048 位客户提供的加密密钥，用于加密或解密此资源。

返回：成功

sha256

字符串

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

返回：成功

index

整数

为该磁盘分配一个基于零的索引，其中 0 保留给启动磁盘。例如，如果您在实例上连接了多个磁盘，则每个磁盘都会有一个唯一的索引号。如果未指定，服务器将选择一个合适的值。

返回：成功

initializeParams

复杂

指定将与新实例一起创建的新磁盘的参数。使用初始化参数创建附加到新实例的启动磁盘或本地 SSD。

返回：成功

diskName

字符串

指定磁盘名称。如果未指定，则默认为使用实例的名称。

返回：成功

diskSizeGb

整数

指定磁盘大小（以 2 的幂次方 GB 为单位）。

返回：成功

diskType

字符串

磁盘类型的引用。

指定用于创建实例的磁盘类型。

如果未指定，则默认为 pd-standard。

返回：成功

sourceImage

字符串

创建此磁盘的源镜像。创建新实例时，需要 initializeParams.sourceImage 或 disks.source 之一。要使用公共操作系统镜像之一创建磁盘，请按其系列名称指定镜像。

返回：成功

sourceImageEncryptionKey

复杂

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

实例模板不存储客户提供的加密密钥，因此如果您使用自己的密钥加密源镜像，则无法为托管实例组中的实例创建磁盘。

返回：成功

rawKey

字符串

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

返回：成功

sha256

字符串

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

返回：成功

interface

字符串

指定用于附加此磁盘的磁盘接口，可以是 SCSI 或 NVME。默认为 SCSI。

持久性磁盘必须始终使用 SCSI，如果您尝试以 SCSI 以外的任何格式附加持久性磁盘，则请求将失败。

返回：成功

mode

字符串

附加此磁盘的模式，可以是 READ_WRITE 或 READ_ONLY。如果未指定，则默认为 READ_WRITE 模式附加磁盘。

返回：成功

source

字典

磁盘的引用。创建新实例时，需要 initializeParams.sourceImage 或 disks.source 之一。

如果需要，您也可以使用此属性附加现有的非根持久性磁盘。此字段仅适用于持久性磁盘。

返回：成功

type

字符串

指定磁盘的类型，可以是 SCRATCH 或 PERSISTENT。如果未指定，则默认为 PERSISTENT。

返回：成功

guestAccelerators

复杂

附加到实例的加速卡类型和数量列表。

返回：成功

acceleratorCount

整数

公开给此实例的客户加速卡的数量。

返回：成功

acceleratorType

字符串

要公开给此实例的加速器类型资源的完整或部分 URL。

返回：成功

hostname

字符串

要创建的实例的主机名。指定的主机名必须符合 RFC1035 规范。如果未指定主机名，则使用全局 DNS 时，默认主机名为 [INSTANCE_NAME].c.[PROJECT_ID].internal，使用区域 DNS 时，默认主机名为 [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal。

返回：成功

id

整数

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

返回：成功

labelFingerprint

字符串

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

返回：成功

labels

字典

要应用于此实例的标签。键值对列表。

返回：成功

machineType

字符串

对定义虚拟机类型的机器类型的引用。

返回：成功

metadata

字典

要分配给从此模板创建的实例的元数据键值对。这些对可以包含自定义元数据或预定义密钥。

返回：成功

minCpuPlatform

字符串

指定虚拟机实例的最低 CPU 平台。适用值是 CPU 平台的友好名称。

返回：成功

name

字符串

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

返回：成功

networkInterfaces

复杂

此接口的配置数组。这指定了此接口如何配置以与其他网络服务交互，例如连接到互联网。每个实例仅支持一个网络接口。

返回：成功

accessConfigs

复杂

此接口的配置数组。目前，只支持一个访问配置 ONE_TO_ONE_NAT。如果没有指定 accessConfigs，则此实例将没有外部互联网访问权限。

返回：成功

name

字符串

此访问配置的名称。默认推荐名称为 External NAT，但您可以使用任何您喜欢的任意字符串。例如，My external IP 或 Network Access。

返回：成功

natIP

字典

地址的引用。

与该实例关联的外部 IP 地址。

指定项目可用的未使用的静态外部 IP 地址，或将此字段留空以使用来自共享临时 IP 地址池的 IP。如果您指定静态外部 IP 地址，它必须位于与实例区域相同的区域。

返回：成功

networkTier

字符串

这表示用于配置此访问配置的网络层。如果指定了 AccessConfig 但没有有效的外部 IP 地址，则将使用此 networkTier 创建一个临时 IP。如果指定了具有有效外部 IP 地址的 AccessConfig，则它必须与拥有该 IP 的 Address 资源关联的 networkTier 相匹配。

返回：成功

publicPtrDomainName

字符串

公共 PTR 记录的 DNS 域名。只有在启用 setPublicPtr 字段时才能设置此字段。

返回：成功

setPublicPtr

布尔值

指定是否应创建公共 DNS PTR 记录以将实例的外部 IP 地址映射到 DNS 域名。

返回：成功

type

字符串

配置类型。默认且唯一选项是 ONE_TO_ONE_NAT。

返回：成功

aliasIpRanges

复杂

此网络接口的别名 IP 范围数组。只能为子网模式网络上的网络接口指定。

返回：成功

ipCidrRange

字符串

此别名 IP 范围表示的 IP CIDR 范围。

此 IP CIDR 范围必须属于指定的子网，并且不能包含系统保留的或其他网络接口使用的 IP 地址。此范围可以是单个 IP 地址（例如 10.2.3.4）、子网掩码（例如 /24）或 CIDR 格式字符串（例如 10.1.2.0/24）。

返回：成功

subnetworkRangeName

字符串

可选子网辅助范围名称，指定从中为该别名 IP 范围分配 IP CIDR 范围的辅助范围。如果未指定，将使用子网的主范围。

返回：成功

name

字符串

网络接口的名称，由服务器生成。对于网络设备，这些是 eth0、eth1 等。

返回：成功

network

字典

指定现有网络的标题。不设置网络标题将选择默认网络接口，该接口可能已配置 SSH。

返回：成功

networkIP

字符串

要为此网络接口分配给实例的 IPv4 内部网络地址。如果用户未指定，则系统将分配一个未使用的内部 IP。

返回：成功

subnetwork

字典

对 VPC 网络的引用。

如果网络资源处于传统模式，请不要提供此属性。如果网络处于自动子网模式，则提供子网是可选的。如果网络处于自定义子网模式，则应指定此字段。

返回：成功

scheduling

复杂

设置此实例的调度选项。

返回：成功

automaticRestart

布尔值

指定如果 Compute Engine 终止实例（并非用户终止），是否应自动重新启动实例。

您只能为标准实例设置自动重启选项。抢占式实例无法自动重启。

返回：成功

onHostMaintenance

字符串

定义此实例的维护行为。对于标准实例，默认行为是 MIGRATE。对于抢占式实例，默认行为且唯一可能的行为是 TERMINATE。

有关更多信息，请参阅设置实例调度选项。

返回：成功

preemptible

布尔值

定义实例是否为抢占式实例。这只能在创建实例期间设置，创建实例后无法设置或更改。

返回：成功

serviceAccounts

复杂

为此实例授权的服务帐户及其指定范围的列表。每个虚拟机实例仅支持一个服务帐户。

返回：成功

email

字符串

服务帐户的电子邮件地址。

返回：成功

scopes

列表 / 元素=字符串

要为此服务帐户提供的范围列表。

返回：成功

shieldedInstanceConfig

复杂

与屏蔽实例相关的各种参数的配置。

返回：成功

enableIntegrityMonitoring

布尔值

定义实例是否启用了完整性监控。

返回：成功

enableSecureBoot

布尔值

定义实例是否启用了安全启动。

返回：成功

enableVtpm

布尔值

定义实例是否启用了 vTPM。

返回：成功

status

字符串

实例的状态。以下值之一：PROVISIONING、STAGING、RUNNING、STOPPING、SUSPENDING、SUSPENDED 和 TERMINATED。

作为用户，使用 RUNNING 保持机器“开启”，使用 TERMINATED 关闭机器。

返回：成功

statusMessage

字符串

状态的可选人性化解释。

返回：成功

tags

复杂

要应用于此实例的标签列表。标签用于标识网络防火墙的有效源或目标，并在创建实例期间由客户端指定。标签可以通过 setTags 方法稍后修改。列表中的每个标签必须符合 RFC1035 规范。

返回：成功

fingerprint

字符串

为此请求指定指纹，它本质上是元数据内容的哈希值，用于乐观锁定。

指纹最初由 Compute Engine 生成，每次修改或更新元数据后都会发生变化。您必须始终提供最新的指纹哈希才能更新或更改元数据。

返回：成功

items

列表 / 元素=字符串

标签数组。每个标签必须为 1-63 个字符长，并符合 RFC1035 规范。

返回：成功

zone

字符串

机器所在的区域的引用。

返回：成功

作者

  • Google Inc. (@googlecloudplatform)