google.cloud.gcp_compute_instance_template 模块 – 创建一个 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。

注意

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

概要

• 定义一个实例模板资源，为您的虚拟机实例提供配置设置。实例模板不与实例的生命周期绑定，可以重复使用以部署虚拟机。您还可以使用不同的模板来创建不同的虚拟机配置。创建托管实例组时，需要使用实例模板。

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

要求

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

• python >= 2.6

• requests >= 2.18.4

• google-auth >= 1.3.0

参数

参数	注释
access_token 字符串	如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。
auth_kind 字符串 / 必需	使用的凭据类型。 选项 "application" "machineaccount" "serviceaccount" "accesstoken"
description 字符串	此资源的可选描述。在创建资源时提供此属性。
env_type 字符串	指定您正在其中运行此模块的 Ansible 环境。 除非您知道自己在做什么，否则不应设置此项。 这只会更改任何 API 请求的 User Agent 字符串。
name 字符串 / 必需	资源名称。名称长度为 1-63 个字符，并符合 RFC1035。
project 字符串	要使用的 Google Cloud Platform 项目。
properties 字典	此实例模板的实例属性。
can_ip_forward 布尔值	使基于此模板创建的实例能够发送源 IP 地址不是其自身的、以及接收目标 IP 地址不是其自身的的数据包。如果这些实例将用作 IP 网关，或将设置为路由资源中的下一跳，请指定 true。如果不确定，请将其设置为 false。 选项 false true
description 字符串	从该实例模板创建的实例的可选文本描述。
disks 列表 / 元素=字典	与从此模板创建的实例关联的磁盘数组。
auto_delete 布尔值	指定当实例被删除时（而不是从实例分离磁盘时）是否会自动删除磁盘。 提示：应将磁盘设置为 autoDelete=true，以便在删除机器时不会留下剩余磁盘。 选项 false true
boot 布尔值	表示这是一个启动磁盘。虚拟机将使用磁盘的第一个分区作为其根文件系统。 选项 false true
device_name 字符串	指定您选择的唯一设备名称，该名称会反映到实例内运行的 Linux 操作系统的 /dev/disk/by-id/google-* 树中。此名称可用于从实例内部引用设备进行挂载、调整大小等操作。
disk_encryption_key 字典	使用客户提供的加密密钥加密或解密磁盘。
raw_key 字符串	指定一个 256 位客户提供的加密密钥，以 RFC 4648 base64 编码，用于加密或解密此资源。
rsa_encrypted_key 字符串	指定一个以 RFC 4648 base64 编码的、RSA 包装的 2048 位客户提供的加密密钥，用于加密或解密此资源。
index 整数	为该磁盘分配一个从零开始的索引，其中 0 保留给启动磁盘。例如，如果您的实例附加了许多磁盘，则每个磁盘都有一个唯一的索引号。如果未指定，服务器将选择适当的值。
initialize_params 字典	指定将与新实例一起创建的新磁盘的参数。使用初始化参数来创建附加到新实例的启动磁盘或本地 SSD。
disk_name 字符串	指定磁盘名称。如果未指定，则默认使用实例的名称。
disk_size_gb 整数	指定磁盘的大小（以 2 为底的 GB 为单位）。
disk_type 字符串	对磁盘类型的引用。 指定用于创建实例的磁盘类型。 如果未指定，则默认为 pd-standard。
source_image 字符串	用于创建此磁盘的源映像。创建新实例时，需要 initializeParams.sourceImage 或 disks.source 之一。要使用其中一个公共操作系统映像创建磁盘，请按其系列名称指定映像。
source_image_encryption_key 字典	源映像的客户提供的加密密钥。如果源映像受客户提供的加密密钥保护，则为必需。 实例模板不存储客户提供的加密密钥，因此如果源映像使用您自己的密钥加密，则无法为托管实例组中的实例创建磁盘。
raw_key 字符串	指定一个 256 位客户提供的加密密钥，以 RFC 4648 base64 编码，用于加密或解密此资源。
interface 字符串	指定用于附加此磁盘的磁盘接口，可以是 SCSI 或 NVME。默认为 SCSI。 持久磁盘必须始终使用 SCSI，如果您尝试以 SCSI 以外的任何其他格式附加持久磁盘，则请求将失败。 一些有效的选择包括：“SCSI”，“NVME”
模式 字符串	附加此磁盘的模式，可以是 READ_WRITE 或 READ_ONLY。如果未指定，则默认以 READ_WRITE 模式附加磁盘。 一些有效的选择包括：“READ_WRITE”，“READ_ONLY”
源 字典	引用磁盘。创建新实例时，必须指定 initializeParams.sourceImage 或 disks.source 其中之一。 如果需要，您也可以使用此属性附加现有的非根持久磁盘。此字段仅适用于持久磁盘。 请注意，对于 InstanceTemplate，请指定磁盘名称，而不是磁盘的 URL。 此字段表示指向 GCP 中磁盘资源的链接。可以通过两种方式指定。首先，您可以放置一个字典，其中键为“name”，值为您的资源名称。或者，您可以在 gcp_compute_disk 任务中添加 `register: name-of-resource`，然后将此 source 字段设置为“{{ name-of-resource }}”
类型 字符串	指定磁盘的类型，可以是 SCRATCH 或 PERSISTENT。如果未指定，则默认值为 PERSISTENT。 一些有效的选择包括：“SCRATCH”，“PERSISTENT”
guest_accelerators 列表 / 元素=字典	附加到实例的加速卡类型和数量列表。
accelerator_count 整数	公开给此实例的客户加速卡数量。
accelerator_type 字符串	要公开给此实例的加速器类型资源的完整或部分 URL。
标签 字典	要应用于此地址的标签。键值对列表。
machine_type 字符串 / 必需	虚拟机实例模板中要使用的机器类型。
元数据 字典	要分配给从此模板创建的实例的元数据键/值对。这些对可以包含自定义元数据或预定义的键。
min_cpu_platform 字符串	为虚拟机实例指定最小 CPU 平台。适用的值是 CPU 平台的友好名称。
network_interfaces 列表 / 元素=字典	此接口的配置数组。这指定此接口如何配置以与其他网络服务交互，例如连接到互联网。每个实例仅支持一个网络接口。
access_configs 列表 / 元素=字典	此接口的配置数组。目前，仅支持一个访问配置 ONE_TO_ONE_NAT。如果未指定 accessConfigs，则此实例将无法访问外部互联网。
name 字符串 / 必需	此访问配置的名称。默认和建议的名称是外部 NAT，但您可以使用任何您想要的任意字符串。例如，“我的外部 IP”或“网络访问”。
nat_ip 字典	引用一个地址。 与此实例关联的外部 IP 地址。 指定项目中可用的未使用的静态外部 IP 地址，或者保留此字段未定义，以使用来自共享临时 IP 地址池的 IP。如果指定静态外部 IP 地址，则它必须与实例的区域位于同一区域。 此字段表示指向 GCP 中地址资源的链接。可以通过两种方式指定。首先，您可以放置一个字典，其中键为“address”，值为您的资源地址。或者，您可以在 gcp_compute_address 任务中添加 `register: name-of-resource`，然后将此 nat_ip 字段设置为“{{ name-of-resource }}”
network_tier 字符串	这表示用于配置此访问配置的网络层级。如果指定了 AccessConfig 但没有有效的外部 IP 地址，则将使用此 networkTier 创建一个临时 IP。如果指定了具有有效外部 IP 地址的 AccessConfig，则它必须与拥有该 IP 的地址资源关联的 networkTier 匹配。 一些有效的选择包括：“PREMIUM”，“STANDARD”
public_ptr_domain_name 字符串	公共 PTR 记录的 DNS 域名。仅当启用了 setPublicPtr 字段时，才能设置此字段。
set_public_ptr 布尔值	指定是否应创建公共 DNS PTR 记录，以将实例的外部 IP 地址映射到 DNS 域名。 选项 false true
类型 字符串 / 必需	配置的类型。默认且唯一选项是 ONE_TO_ONE_NAT。 一些有效的选择包括：“ONE_TO_ONE_NAT”
alias_ip_ranges 列表 / 元素=字典	此网络接口的别名 IP 范围数组。只能为子网模式网络上的网络接口指定。
ip_cidr_range 字符串	此别名 IP 范围表示的 IP CIDR 范围。 此 IP CIDR 范围必须属于指定的子网，并且不能包含系统保留或被其他网络接口使用的 IP 地址。此范围可以是单个 IP 地址（例如 10.2.3.4）、子网掩码（例如 /24）或 CIDR 格式的字符串（例如 10.1.2.0/24）。
subnetwork_range_name 字符串	可选的子网辅助范围名称，指定从中为此别名 IP 范围分配 IP CIDR 范围的辅助范围。如果未指定，将使用子网的主范围。
网络 字典	指定现有网络的标题。创建实例时，如果未指定网络和子网，则使用默认网络 global/networks/default；如果未指定网络但指定了子网，则会推断网络。 此字段表示指向 GCP 中网络资源的链接。可以通过两种方式指定。首先，您可以放置一个字典，其中键为“selfLink”，值为您的资源的 selfLink。或者，您可以在 gcp_compute_network 任务中添加 `register: name-of-resource`，然后将此 network 字段设置为“{{ name-of-resource }}”
network_ip 字符串	要为此网络接口分配给实例的 IPv4 内部网络地址。如果用户未指定，系统会分配一个未使用的内部 IP。
子网 字典	引用 VPC 网络。 如果网络资源处于传统模式，则不要提供此属性。如果网络处于自动子网模式，则提供子网是可选的。如果网络处于自定义子网模式，则应指定此字段。 此字段表示指向 GCP 中子网资源的链接。可以通过两种方式指定。首先，您可以放置一个字典，其中键为“selfLink”，值为您的资源的 selfLink。或者，您可以在 gcp_compute_subnetwork 任务中添加 `register: name-of-resource`，然后将此 subnetwork 字段设置为“{{ name-of-resource }}”
调度 字典	设置此实例的调度选项。
automatic_restart 布尔值	指定如果实例被 Compute Engine 终止（不是由用户终止），是否应自动重启实例。 您只能为标准实例设置自动重启选项。抢占式实例无法自动重启。 选项 false true
on_host_maintenance 字符串	定义此实例的维护行为。对于标准实例，默认行为是 MIGRATE。对于抢占式实例，默认且唯一可能的行为是 TERMINATE。 有关更多信息，请参阅设置实例调度选项。
preemptible 布尔值	定义实例是否为抢占式。这只能在实例创建期间设置，在创建实例后无法设置或更改。 选项 false true
service_accounts 列表 / 元素=字典	服务帐户列表，及其为此实例授权的指定范围。每个虚拟机实例仅支持一个服务帐户。
email 字符串	服务帐户的电子邮件地址。
scopes list / elements=string	此服务帐户可用的范围列表。
标签 字典	要应用于此实例的标签列表。标签用于标识网络防火墙的有效来源或目标，并在实例创建期间由客户端指定。标签可以在以后通过 setTags 方法进行修改。列表中的每个标签都必须符合 RFC1035。
指纹 字符串	为此请求指定指纹，它本质上是元数据内容的哈希值，用于乐观锁定。 指纹最初由 Compute Engine 生成，并且在每次修改或更新元数据的请求后都会更改。您必须始终提供最新的指纹哈希值才能更新或更改元数据。
项目 list / elements=string	标签数组。每个标签的长度必须为 1-63 个字符，并符合 RFC1035。
scopes list / elements=string	要使用的范围数组
service_account_contents jsonarg	服务帐户 JSON 文件的内容，可以是字典形式，也可以是表示它的 JSON 字符串。
service_account_email 字符串	如果选择了 machineaccount 并且用户不希望使用默认电子邮件，则可选的服务帐户电子邮件地址。
service_account_file 路径	如果选择 serviceaccount 作为类型，则服务帐户 JSON 文件的路径。
状态 字符串	给定对象是否应存在于 GCP 中 选项 "present" ← (默认) "absent"

示例

- name: create a network
  google.cloud.gcp_compute_network:
    name: network-instancetemplate
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: network

- name: create a address
  google.cloud.gcp_compute_address:
    name: address-instancetemplate
    region: us-west1
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: address

- name: create a instance template
  google.cloud.gcp_compute_instance_template:
    name: test_object
    properties:
      disks:
      - auto_delete: 'true'
        boot: 'true'
        initialize_params:
          source_image: projects/ubuntu-os-cloud/global/images/family/ubuntu-1604-lts
      machine_type: n1-standard-1
      network_interfaces:
      - network: "{{ network }}"
        access_configs:
        - name: test-config
          type: ONE_TO_ONE_NAT
          nat_ip: "{{ address }}"
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

返回值

通用返回值记录在此处，以下是此模块特有的字段

键	描述
creationTimestamp 字符串	RFC3339 文本格式的创建时间戳。 返回：成功
description 字符串	此资源的可选描述。在创建资源时提供此属性。 返回：成功
id 整数	资源的唯一标识符。此标识符由服务器定义。 返回：成功
name 字符串	资源名称。名称长度为 1-63 个字符，并符合 RFC1035。 返回：成功
properties 复杂	此实例模板的实例属性。 返回：成功
canIpForward 布尔值	使基于此模板创建的实例能够发送源 IP 地址不是其自身的、以及接收目标 IP 地址不是其自身的的数据包。如果这些实例将用作 IP 网关，或将设置为路由资源中的下一跳，请指定 true。如果不确定，请将其设置为 false。 返回：成功
description 字符串	从该实例模板创建的实例的可选文本描述。 返回：成功
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 以外的任何其他格式附加持久磁盘，则请求将失败。 返回：成功
licenses list / elements=string	任何适用的许可证 URI。 返回：成功
模式 字符串	附加此磁盘的模式，可以是 READ_WRITE 或 READ_ONLY。如果未指定，则默认以 READ_WRITE 模式附加磁盘。 返回：成功
源 字典	引用磁盘。创建新实例时，必须指定 initializeParams.sourceImage 或 disks.source 其中之一。 如果需要，您也可以使用此属性附加现有的非根持久磁盘。此字段仅适用于持久磁盘。 请注意，对于 InstanceTemplate，请指定磁盘名称，而不是磁盘的 URL。 返回：成功
类型 字符串	指定磁盘的类型，可以是 SCRATCH 或 PERSISTENT。如果未指定，则默认值为 PERSISTENT。 返回：成功
guestAccelerators 复杂	附加到实例的加速卡类型和数量列表。 返回：成功
acceleratorCount 整数	公开给此实例的客户加速卡数量。 返回：成功
acceleratorType 字符串	要公开给此实例的加速器类型资源的完整或部分 URL。 返回：成功
标签 字典	要应用于此地址的标签。键值对列表。 返回：成功
machineType 字符串	虚拟机实例模板中要使用的机器类型。 返回：成功
元数据 字典	要分配给从此模板创建的实例的元数据键/值对。这些对可以包含自定义元数据或预定义的键。 返回：成功
minCpuPlatform 字符串	为虚拟机实例指定最小 CPU 平台。适用的值是 CPU 平台的友好名称。 返回：成功
networkInterfaces 复杂	此接口的配置数组。这指定此接口如何配置以与其他网络服务交互，例如连接到互联网。每个实例仅支持一个网络接口。 返回：成功
accessConfigs 复杂	此接口的配置数组。目前，仅支持一个访问配置 ONE_TO_ONE_NAT。如果未指定 accessConfigs，则此实例将无法访问外部互联网。 返回：成功
name 字符串	此访问配置的名称。默认和建议的名称是外部 NAT，但您可以使用任何您想要的任意字符串。例如，“我的外部 IP”或“网络访问”。 返回：成功
natIP 字典	引用一个地址。 与此实例关联的外部 IP 地址。 指定项目中可用的未使用的静态外部 IP 地址，或者保留此字段未定义，以使用来自共享临时 IP 地址池的 IP。如果指定静态外部 IP 地址，则它必须与实例的区域位于同一区域。 返回：成功
networkTier 字符串	这表示用于配置此访问配置的网络层级。如果指定了 AccessConfig 但没有有效的外部 IP 地址，则将使用此 networkTier 创建一个临时 IP。如果指定了具有有效外部 IP 地址的 AccessConfig，则它必须与拥有该 IP 的地址资源关联的 networkTier 匹配。 返回：成功
publicPtrDomainName 字符串	公共 PTR 记录的 DNS 域名。仅当启用了 setPublicPtr 字段时，才能设置此字段。 返回：成功
setPublicPtr 布尔值	指定是否应创建公共 DNS PTR 记录，以将实例的外部 IP 地址映射到 DNS 域名。 返回：成功
类型 字符串	配置的类型。默认且唯一选项是 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 等。 返回：成功
网络 字典	指定现有网络的标题。创建实例时，如果未指定网络和子网，则使用默认网络 global/networks/default；如果未指定网络但指定了子网，则会推断网络。 返回：成功
networkIP 字符串	要为此网络接口分配给实例的 IPv4 内部网络地址。如果用户未指定，系统会分配一个未使用的内部 IP。 返回：成功
子网 字典	引用 VPC 网络。 如果网络资源处于传统模式，则不要提供此属性。如果网络处于自动子网模式，则提供子网是可选的。如果网络处于自定义子网模式，则应指定此字段。 返回：成功
调度 复杂	设置此实例的调度选项。 返回：成功
automaticRestart 布尔值	指定如果实例被 Compute Engine 终止（不是由用户终止），是否应自动重启实例。 您只能为标准实例设置自动重启选项。抢占式实例无法自动重启。 返回：成功
onHostMaintenance 字符串	定义此实例的维护行为。对于标准实例，默认行为是 MIGRATE。对于抢占式实例，默认且唯一可能的行为是 TERMINATE。 有关更多信息，请参阅设置实例调度选项。 返回：成功
preemptible 布尔值	定义实例是否为抢占式。这只能在实例创建期间设置，在创建实例后无法设置或更改。 返回：成功
serviceAccounts 复杂	服务帐户列表，及其为此实例授权的指定范围。每个虚拟机实例仅支持一个服务帐户。 返回：成功
email 字符串	服务帐户的电子邮件地址。 返回：成功
scopes list / elements=string	此服务帐户可用的范围列表。 返回：成功
标签 复杂	要应用于此实例的标签列表。标签用于标识网络防火墙的有效来源或目标，并在实例创建期间由客户端指定。标签可以在以后通过 setTags 方法进行修改。列表中的每个标签都必须符合 RFC1035。 返回：成功
指纹 字符串	为此请求指定指纹，它本质上是元数据内容的哈希值，用于乐观锁定。 指纹最初由 Compute Engine 生成，并且在每次修改或更新元数据的请求后都会更改。您必须始终提供最新的指纹哈希值才能更新或更改元数据。 返回：成功
项目 list / elements=string	标签数组。每个标签的长度必须为 1-63 个字符，并符合 RFC1035。 返回：成功

作者

• Google Inc. (@googlecloudplatform)

集合链接

• 问题跟踪器
• 主页
• 存储库（来源）