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 and 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

字符串

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

返回： 成功

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

字符串

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

返回： 成功

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

字符串

对定义 VM 类型的机器类型的引用。

返回： 成功

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

字符串

此访问配置的名称。默认和推荐的名称是外部 NAT，但您可以使用任何您想要的任意字符串。例如，我的外部 IP 或网络访问。

返回： 成功

natIP

字典

引用地址。

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

指定一个可用于项目的未使用静态外部 IP 地址，或将此字段保留未定义，以使用共享临时 IP 地址池中的 IP。如果指定静态外部 IP 地址，则它必须与实例区域的区域位于同一区域中。

返回： 成功

networkTier

字符串

这表示用于配置此访问配置的网络层。如果指定了不带有效外部 IP 地址的 AccessConfig，则将使用此 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)