google.cloud.gcp_compute_instance_template_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_template_info。
注意
由于违反了 Ansible 包含要求，google.cloud 集合将从 Ansible 12 中删除。该集合存在 未解决的健全性测试失败。有关更多信息，请参阅 讨论主题。
概要
收集 GCP 实例模板的信息
要求
在执行此模块的主机上需要满足以下要求。
python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0
参数
参数 |
注释 |
|---|---|
如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。 |
|
所用凭据的类型。 选项
|
|
指定您在此模块中运行的 Ansible 环境。 除非您知道自己在做什么，否则不应设置此选项。 这只会更改任何 API 请求的 User Agent 字符串。 |
|
过滤器值对的列表。可用的过滤器在此处列出 https://cloud.google.com/sdk/gcloud/reference/topic/filters。 列表中的每个额外过滤器都将添加为 AND 条件（filter1 和 filter2）。 |
|
要使用的 Google Cloud Platform 项目。 |
|
要使用的作用域数组 |
|
服务帐户 JSON 文件的内容，可以是字典形式，也可以是表示它的 JSON 字符串形式。 |
|
如果选择了 machineaccount 并且用户不希望使用默认电子邮件，则可选的服务帐户电子邮件地址。 |
|
如果选择 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 instance template
gcp_compute_instance_template_info:
filters:
- name = test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
返回值
常见的返回值记录在 此处，以下是此模块独有的字段
键 |
描述 |
|---|---|
资源列表 返回：始终 |
|
以 RFC3339 文本格式表示的创建时间戳。 返回：成功 |
|
此资源的可选描述。创建资源时提供此属性。 返回：成功 |
|
资源的唯一标识符。此标识符由服务器定义。 返回：成功 |
|
资源的名称。名称长度为 1-63 个字符，并符合 RFC1035。 返回：成功 |
|
此实例模板的实例属性。 返回：成功 |
|
允许基于此模板创建的实例发送源 IP 地址不是它们自己的数据包，并接收目标 IP 地址不是它们自己的数据包。如果这些实例将用作 IP 网关或将设置为路由资源中的下一跳，请指定 true。如果不确定，请将其设置为 false。 返回：成功 |
|
从该实例模板创建的实例的可选文本描述。 返回：成功 |
|
与从该模板创建的实例关联的磁盘数组。 返回：成功 |
|
指定当实例被删除时（而不是当磁盘从实例分离时）是否自动删除磁盘。 提示：应将磁盘设置为 autoDelete=true，以便在机器删除后不会留下剩余磁盘。 返回：成功 |
|
表示这是启动磁盘。虚拟机将使用磁盘的第一个分区作为其根文件系统。 返回：成功 |
|
指定您选择的唯一设备名称，该名称会反映到实例中运行的 Linux 操作系统的 /dev/disk/by-id/google-* 树中。此名称可用于从实例内部引用设备进行挂载、调整大小等操作。 返回：成功 |
|
使用客户提供的加密密钥加密或解密磁盘。 返回：成功 |
|
指定一个 256 位客户提供的加密密钥，以 RFC 4648 base64 编码，用于加密或解密此资源。 返回：成功 |
|
指定一个 RFC 4648 base64 编码的 RSA 封装的 2048 位客户提供的加密密钥，用于加密或解密此资源。 返回：成功 |
|
客户提供的用于保护此资源的加密密钥的 RFC 4648 base64 编码的 SHA-256 哈希值。 返回：成功 |
|
为该磁盘分配一个从零开始的索引，其中 0 保留给启动磁盘。例如，如果一个实例连接了多个磁盘，每个磁盘将具有唯一的索引号。如果未指定，服务器将选择一个合适的值。 返回：成功 |
|
指定将与新实例一起创建的新磁盘的参数。使用初始化参数创建启动磁盘或附加到新实例的本地 SSD。 返回：成功 |
|
指定磁盘名称。如果未指定，则默认使用实例的名称。 返回：成功 |
|
指定磁盘的大小，以 2 为底的 GB 为单位。 返回：成功 |
|
引用磁盘类型。 指定用于创建实例的磁盘类型。 如果未指定，则默认为 pd-standard。 返回：成功 |
|
用于创建此磁盘的源映像。创建新实例时，需要 initializeParams.sourceImage 或 disks.source 其中之一。要使用公共操作系统映像之一创建磁盘，请按其系列名称指定映像。 返回：成功 |
|
源映像的客户提供的加密密钥。如果源映像受客户提供的加密密钥保护，则为必需项。 实例模板不存储客户提供的加密密钥，因此如果源映像使用您自己的密钥加密，则无法为托管实例组中的实例创建磁盘。 返回：成功 |
|
指定一个 256 位客户提供的加密密钥，以 RFC 4648 base64 编码，用于加密或解密此资源。 返回：成功 |
|
客户提供的用于保护此资源的加密密钥的 RFC 4648 base64 编码的 SHA-256 哈希值。 返回：成功 |
|
指定用于连接此磁盘的磁盘接口，可以是 SCSI 或 NVME。默认值为 SCSI。 永久磁盘必须始终使用 SCSI，如果您尝试以除 SCSI 之外的任何其他格式连接永久磁盘，请求将失败。 返回：成功 |
|
任何适用的许可 URI。 返回：成功 |
|
连接此磁盘的模式，可以是 READ_WRITE 或 READ_ONLY。如果未指定，则默认以 READ_WRITE 模式连接磁盘。 返回：成功 |
|
引用磁盘。创建新实例时，需要 initializeParams.sourceImage 或 disks.source 其中之一。 如果需要，您还可以使用此属性连接现有的非根永久磁盘。此字段仅适用于永久磁盘。 请注意，对于 InstanceTemplate，请指定磁盘名称，而不是磁盘的 URL。 返回：成功 |
|
指定磁盘的类型，可以是 SCRATCH 或 PERSISTENT。如果未指定，则默认为 PERSISTENT。 返回：成功 |
|
附加到实例的加速器卡的类型和数量列表。 返回：成功 |
|
向此实例公开的客户加速器卡的数量。 返回：成功 |
|
要向此实例公开的加速器类型资源的完整或部分 URL。 返回：成功 |
|
应用于此地址的标签。键值对列表。 返回：成功 |
|
要在 VM 实例模板中使用的机器类型。 返回：成功 |
|
要分配给从此模板创建的实例的元数据键/值对。这些对可以由自定义元数据或预定义的键组成。 返回：成功 |
|
指定 VM 实例的最小 CPU 平台。适用的值是 CPU 平台的友好名称。 返回：成功 |
|
此接口的配置数组。这指定了如何配置此接口以与其他网络服务（如连接到 Internet）进行交互。每个实例仅支持一个网络接口。 返回：成功 |
|
此接口的配置数组。当前仅支持一个访问配置，即 ONE_TO_ONE_NAT。如果未指定 accessConfigs，则此实例将没有外部 Internet 访问。 返回：成功 |
|
此访问配置的名称。默认和推荐的名称是 External NAT，但您可以使用任何您喜欢的任意字符串。例如，我的外部 IP 或网络访问。 返回：成功 |
|
引用地址。 与此实例关联的外部 IP 地址。 指定项目可用的未使用静态外部 IP 地址，或者将此字段保留为未定义以使用共享临时 IP 地址池中的 IP。如果指定静态外部 IP 地址，则它必须与实例所在区域的区域相同。 返回：成功 |
|
这表示用于配置此访问配置的网络层。如果指定了没有有效外部 IP 地址的 AccessConfig，则将使用此 networkTier 创建一个临时 IP。如果指定了具有有效外部 IP 地址的 AccessConfig，则它必须与拥有该 IP 的地址资源关联的 networkTier 相匹配。 返回：成功 |
|
公共 PTR 记录的 DNS 域名。仅当启用 setPublicPtr 字段时，才可以设置此字段。 返回：成功 |
|
指定是否应创建公共 DNS PTR 记录，以将实例的外部 IP 地址映射到 DNS 域名。 返回：成功 |
|
配置的类型。默认且唯一的选项是 ONE_TO_ONE_NAT。 返回：成功 |
|
此网络接口的别名 IP 范围数组。只能为子网模式网络上的网络接口指定。 返回：成功 |
|
此别名 IP 范围表示的 IP CIDR 范围。 此 IP CIDR 范围必须属于指定的子网，并且不能包含系统保留或被其他网络接口使用的 IP 地址。此范围可以是单个 IP 地址（例如 10.2.3.4）、子网掩码（例如 /24）或 CIDR 格式字符串（例如 10.1.2.0/24）。 返回：成功 |
|
可选的子网辅助范围名称，指定从中为该别名 IP 范围分配 IP CIDR 范围的辅助范围。如果未指定，将使用子网的主范围。 返回：成功 |
|
服务器生成的网络接口的名称。对于网络设备，这些是 eth0、eth1 等。 返回：成功 |
|
指定现有网络的标题。创建实例时，如果未指定网络或子网，则使用默认网络 global/networks/default；如果未指定网络但指定了子网，则会推断出网络。 返回：成功 |
|
要为此网络接口分配给实例的 IPv4 内部网络地址。如果用户未指定，系统将分配一个未使用的内部 IP。 返回：成功 |
|
引用 VPC 网络。 如果网络资源处于旧版模式，请不要提供此属性。如果网络处于自动子网模式，则提供子网是可选的。如果网络处于自定义子网模式，则应指定此字段。 返回：成功 |
|
设置此实例的计划选项。 返回：成功 |
|
指定如果实例被 Compute Engine 终止（而不是被用户终止），是否应自动重启该实例。 您只能为标准实例设置自动重启选项。抢占式实例不能自动重启。 返回：成功 |
|
定义此实例的维护行为。对于标准实例，默认行为是 MIGRATE。对于抢占式实例，默认且唯一的可能行为是 TERMINATE。 有关更多信息，请参阅设置实例计划选项。 返回：成功 |
|
定义实例是否可抢占。这只能在实例创建期间设置，创建实例后不能设置或更改。 返回：成功 |
|
此实例的授权服务帐户列表及其指定的范围。每个 VM 实例仅支持一个服务帐户。 返回：成功 |
|
服务帐户的电子邮件地址。 返回：成功 |
|
可用于此服务帐户的范围列表。 返回：成功 |
|
要应用于此实例的标签列表。标签用于标识网络防火墙的有效源或目标，并由客户端在实例创建期间指定。标签稍后可以使用 setTags 方法修改。列表中的每个标签都必须符合 RFC1035。 返回：成功 |
|
为此请求指定一个指纹，它本质上是元数据内容的哈希，用于乐观锁定。 指纹最初由 Compute Engine 生成，并且在每次修改或更新元数据的请求后都会更改。您必须始终提供最新的指纹哈希才能更新或更改元数据。 返回：成功 |
|
标签数组。每个标签的长度必须为 1-63 个字符，并且符合 RFC1035。 返回：成功 |