gcp_compute_instance_template – Creates a GCP InstanceTemplate

From Get docs
Ansible/docs/2.9/modules/gcp compute instance template module


gcp_compute_instance_template – Creates a GCP InstanceTemplate

New in version 2.6.


Synopsis

  • Defines an Instance Template resource that provides configuration settings for your virtual machine instances. Instance templates are not tied to the lifetime of an instance and can be used and reused as to deploy virtual machines. You can also use different templates to create different virtual machine configurations. Instance templates are required when you create a managed instance group.
  • Tip: Disks should be set to autoDelete=true so that leftover disks are not left behind on machine deletion.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6
  • requests >= 2.18.4
  • google-auth >= 1.3.0

Parameters

Parameter Choices/Defaults Comments

auth_kind

string / required

  • application
  • machineaccount
  • serviceaccount

The type of credential used.

description

string

An optional description of this resource. Provide this property when you create the resource.

env_type

string

Specifies which Ansible environment you're running this module within.

This should not be set unless you know what you're doing.

This only alters the User Agent string for any API requests.

name

string / required

Name of the resource. The name is 1-63 characters long and complies with RFC1035.

project

string

The Google Cloud Platform project to use.

properties

dictionary

The instance properties for this instance template.

can_ip_forward

boolean

  • no
  • yes

Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false.

description

string

An optional text description for the instances that are created from this instance template.

disks

list

An array of disks that are associated with the instances that are created from this template.

auto_delete

boolean

  • no
  • yes

Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

Tip: Disks should be set to autoDelete=true so that leftover disks are not left behind on machine deletion.

boot

boolean

  • no
  • yes

Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

device_name

string

Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.

disk_encryption_key

dictionary

Encrypts or decrypts a disk using a customer-supplied encryption key.

raw_key

string

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

rsa_encrypted_key

string

Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

index

integer

Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.

initialize_params

dictionary

Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.

disk_name

string

Specifies the disk name. If not specified, the default is to use the name of the instance.

disk_size_gb

integer

Specifies the size of the disk in base-2 GB.

disk_type

string

Reference to a disk type.

Specifies the disk type to use to create the instance.

If not specified, the default is pd-standard.

source_image

string

The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or disks.source is required. To create a disk with one of the public operating system images, specify the image by its family name.

source_image_encryption_key

dictionary

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

raw_key

string

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

interface

string

Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI.

Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI.

Some valid choices include: "SCSI", "NVME"

mode

string

The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.

Some valid choices include: "READ_WRITE", "READ_ONLY"

source

dictionary

Reference to a disk. When creating a new instance, one of initializeParams.sourceImage or disks.source is required.

If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

Note that for InstanceTemplate, specify the disk name, not the URL for the disk.

This field represents a link to a Disk resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'name' and value of your resource's name Alternatively, you can add `register: name-of-resource` to a gcp_compute_disk task and then set this source field to "Template:Name-of-resource"

type

string

Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

Some valid choices include: "SCRATCH", "PERSISTENT"

guest_accelerators

list

List of the type and count of accelerator cards attached to the instance .

accelerator_count

integer

The number of the guest accelerator cards exposed to this instance.

accelerator_type

string

Full or partial URL of the accelerator type resource to expose to this instance.

labels

dictionary

added in 2.9

Labels to apply to this address. A list of key->value pairs.

machine_type

string / required

The machine type to use in the VM instance template.

metadata

dictionary

The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys.

min_cpu_platform

string

Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms .

network_interfaces

list

An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Only one network interface is supported per instance.

access_configs

list

An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.

name

string / required

The name of this access configuration. The default and recommended name is External NAT but you can use any arbitrary string you would like. For example, My external IP or Network Access.

nat_ip

dictionary

Reference to an address.

An external IP address associated with this instance.

Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.

This field represents a link to a Address resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'address' and value of your resource's address Alternatively, you can add `register: name-of-resource` to a gcp_compute_address task and then set this nat_ip field to "Template:Name-of-resource"

type

string / required

The type of configuration. The default and only option is ONE_TO_ONE_NAT.

Some valid choices include: "ONE_TO_ONE_NAT"

alias_ip_ranges

list

An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks.

ip_cidr_range

string

The IP CIDR range represented by this alias IP range.

This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string (e.g. 10.1.2.0/24).

subnetwork_range_name

string

Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used.

network

dictionary

Specifies the title of an existing network. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred.

This field represents a link to a Network resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'selfLink' and value of your resource's selfLink Alternatively, you can add `register: name-of-resource` to a gcp_compute_network task and then set this network field to "Template:Name-of-resource"

network_ip

string

An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

subnetwork

dictionary

Reference to a VPC network.

If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified.

This field represents a link to a Subnetwork resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'selfLink' and value of your resource's selfLink Alternatively, you can add `register: name-of-resource` to a gcp_compute_subnetwork task and then set this subnetwork field to "Template:Name-of-resource"

scheduling

dictionary

Sets the scheduling options for this instance.

automatic_restart

boolean

  • no
  • yes

Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user).

You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.

on_host_maintenance

string

Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE.

For more information, see Setting Instance Scheduling Options.

preemptible

boolean

  • no
  • yes

Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created.

service_accounts

list

A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

email

string

Email address of the service account.

scopes

list

The list of scopes to be made available for this service account.

tags

dictionary

A list of tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.

fingerprint

string

Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking.

The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.

items

list

An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

scopes

list

Array of scopes to be used.

service_account_contents

jsonarg

The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it.

service_account_email

string

An optional service account email address if machineaccount is selected and the user does not wish to use the default email.

service_account_file

path

The path of a Service Account JSON file if serviceaccount is selected as type.

state

string

  • present

  • absent

Whether the given object should exist in GCP



Notes

Note

  • for authentication, you can set service_account_file using the c(gcp_service_account_file) env variable.
  • for authentication, you can set service_account_contents using the c(GCP_SERVICE_ACCOUNT_CONTENTS) env variable.
  • For authentication, you can set service_account_email using the GCP_SERVICE_ACCOUNT_EMAIL env variable.
  • For authentication, you can set auth_kind using the GCP_AUTH_KIND env variable.
  • For authentication, you can set scopes using the GCP_SCOPES env variable.
  • Environment variables values will only be used if the playbook values are not set.
  • The service_account_email and service_account_file options are mutually exclusive.


Examples

- name: create a network
  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
  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
  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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description

creationTimestamp

string

success

Creation timestamp in RFC3339 text format.


description

string

success

An optional description of this resource. Provide this property when you create the resource.


id

integer

success

The unique identifier for the resource. This identifier is defined by the server.


name

string

success

Name of the resource. The name is 1-63 characters long and complies with RFC1035.


properties

complex

success

The instance properties for this instance template.


canIpForward

boolean

success

Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false.


description

string

success

An optional text description for the instances that are created from this instance template.


disks

complex

success

An array of disks that are associated with the instances that are created from this template.


autoDelete

boolean

success

Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

Tip: Disks should be set to autoDelete=true so that leftover disks are not left behind on machine deletion.


boot

boolean

success

Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.


deviceName

string

success

Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.


diskEncryptionKey

complex

success

Encrypts or decrypts a disk using a customer-supplied encryption key.


rawKey

string

success

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.


rsaEncryptedKey

string

success

Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.


sha256

string

success

The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.


index

integer

success

Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.


initializeParams

complex

success

Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.


diskName

string

success

Specifies the disk name. If not specified, the default is to use the name of the instance.


diskSizeGb

integer

success

Specifies the size of the disk in base-2 GB.


diskType

string

success

Reference to a disk type.

Specifies the disk type to use to create the instance.

If not specified, the default is pd-standard.


sourceImage

string

success

The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or disks.source is required. To create a disk with one of the public operating system images, specify the image by its family name.


sourceImageEncryptionKey

complex

success

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.


rawKey

string

success

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.


sha256

string

success

The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.


interface

string

success

Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI.

Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI.


mode

string

success

The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.


source

dictionary

success

Reference to a disk. When creating a new instance, one of initializeParams.sourceImage or disks.source is required.

If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

Note that for InstanceTemplate, specify the disk name, not the URL for the disk.


type

string

success

Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.


guestAccelerators

complex

success

List of the type and count of accelerator cards attached to the instance .


acceleratorCount

integer

success

The number of the guest accelerator cards exposed to this instance.


acceleratorType

string

success

Full or partial URL of the accelerator type resource to expose to this instance.


labels

dictionary

success

Labels to apply to this address. A list of key->value pairs.


machineType

string

success

The machine type to use in the VM instance template.


metadata

dictionary

success

The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys.


minCpuPlatform

string

success

Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms .


networkInterfaces

complex

success

An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Only one network interface is supported per instance.


accessConfigs

complex

success

An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.


name

string

success

The name of this access configuration. The default and recommended name is External NAT but you can use any arbitrary string you would like. For example, My external IP or Network Access.


natIP

dictionary

success

Reference to an address.

An external IP address associated with this instance.

Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.


type

string

success

The type of configuration. The default and only option is ONE_TO_ONE_NAT.


aliasIpRanges

complex

success

An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks.


ipCidrRange

string

success

The IP CIDR range represented by this alias IP range.

This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string (e.g. 10.1.2.0/24).


subnetworkRangeName

string

success

Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used.


name

string

success

The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc .


network

dictionary

success

Specifies the title of an existing network. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred.


networkIP

string

success

An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.


subnetwork

dictionary

success

Reference to a VPC network.

If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified.


scheduling

complex

success

Sets the scheduling options for this instance.


automaticRestart

boolean

success

Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user).

You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.


onHostMaintenance

string

success

Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE.

For more information, see Setting Instance Scheduling Options.


preemptible

boolean

success

Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created.


serviceAccounts

complex

success

A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.


email

string

success

Email address of the service account.


scopes

list

success

The list of scopes to be made available for this service account.


tags

complex

success

A list of tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.


fingerprint

string

success

Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking.

The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.


items

list

success

An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.





Status

Authors

  • Google Inc. (@googlecloudplatform)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/gcp_compute_instance_template_module.html