Documentation

gcp_compute_instance – Creates a GCP Instance

New in version 2.6.

Synopsis

  • An instance is a virtual machine (VM) hosted on Google’s infrastructure.

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
    Choices:
  • application
  • machineaccount
  • serviceaccount
The type of credential used.
can_ip_forward
boolean
    Choices:
  • no
  • yes
Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes.

aliases: ip_forward
disks
-
An array of disks that are associated with the instances that are created from this template.
auto_delete
boolean
    Choices:
  • 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
    Choices:
  • 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
-
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
-
Encrypts or decrypts a disk using a customer-supplied encryption key.
raw_key
-
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
rsa_encrypted_key
-
Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
index
-
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
-
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
-
Specifies the disk name. If not specified, the default is to use the name of the instance.
disk_size_gb
-
Specifies the size of the disk in base-2 GB.
disk_type
-
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
-
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.

aliases: image, image_family
source_image_encryption_key
-
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
-
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
interface
-
    Choices:
  • SCSI
  • NVME
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
-
    Choices:
  • READ_WRITE
  • READ_ONLY
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
-
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.
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 'selfLink' and value of your resource's selfLink Alternatively, you can add `register: name-of-resource` to a gcp_compute_disk task and then set this source field to "{{ name-of-resource }}"
type
-
    Choices:
  • SCRATCH
  • PERSISTENT
Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
guest_accelerators
-
List of the type and count of accelerator cards attached to the instance .
accelerator_count
-
The number of the guest accelerator cards exposed to this instance.
accelerator_type
-
Full or partial URL of the accelerator type resource to expose to this instance.
label_fingerprint
-
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.
machine_type
-
A reference to a machine type which defines VM kind.
metadata
-
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
-
Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms .
name
-
The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
network_interfaces
-
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
-
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
- / 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
-
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 "{{ name-of-resource }}"
type
- / required
    Choices:
  • ONE_TO_ONE_NAT
The type of configuration. The default and only option is ONE_TO_ONE_NAT.
alias_ip_ranges
-
An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks.
ip_cidr_range
-
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
-
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
-
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 "{{ name-of-resource }}"
network_ip
-
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
-
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 "{{ name-of-resource }}"
project
string
The Google Cloud Platform project to use.
scheduling
-
Sets the scheduling options for this instance.
automatic_restart
boolean
    Choices:
  • 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
-
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
    Choices:
  • 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.
scopes
list
Array of scopes to be used.
service_account_contents
string
A string representing the contents of a Service Account JSON file.
This should not be passed in as a dictionary, but a string that has the exact contents of a service account json file (valid JSON)
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.
service_accounts
-
A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.
email
-
Email address of the service account.
scopes
-
The list of scopes to be made available for this service account.
state
-
    Choices:
  • present ←
  • absent
Whether the given object should exist in GCP
status
-
added in 2.8
    Choices:
  • PROVISIONING
  • STAGING
  • RUNNING
  • STOPPING
  • SUSPENDING
  • SUSPENDED
  • TERMINATED
The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED.
As a user, use RUNNING to keep a machine "on" and TERMINATED to turn a machine off .
tags
-
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
-
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
-
An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
zone
- / required
A reference to the zone where the machine resides.

Notes

Note

  • For authentication, you can set service_account_file using the GCP_SERVICE_ACCOUNT_FILE env variable.
  • For authentication, you can set service_account_email using the GCP_SERVICE_ACCOUNT_EMAIL env variable.
  • For authentication, you can set service_account_contents using the GCP_SERVICE_ACCOUNT_CONTENTS 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 disk
  gcp_compute_disk:
    name: disk-instance
    size_gb: 50
    source_image: projects/ubuntu-os-cloud/global/images/family/ubuntu-1604-lts
    zone: us-central1-a
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: disk

- name: create a network
  gcp_compute_network:
    name: network-instance
    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-instance
    region: us-central1
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: address

- name: create a instance
  gcp_compute_instance:
    name: test_object
    machine_type: n1-standard-1
    disks:
    - auto_delete: 'true'
      boot: 'true'
      source: "{{ disk }}"
    metadata:
      startup-script-url: gs:://graphite-playground/bootstrap.sh
      cost-center: '12345'
    network_interfaces:
    - network: "{{ network }}"
      access_configs:
      - name: External NAT
        nat_ip: "{{ address }}"
        type: ONE_TO_ONE_NAT
    zone: us-central1-a
    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
canIpForward
boolean
success
Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes.

cpuPlatform
string
success
The CPU platform used by this instance.

creationTimestamp
string
success
Creation timestamp in RFC3339 text format.

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.

  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.

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

labelFingerprint
string
success
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.

machineType
string
success
A reference to a machine type which defines VM kind.

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 .

name
string
success
The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

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.

status
string
success
The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED.
As a user, use RUNNING to keep a machine "on" and TERMINATED to turn a machine off .

statusMessage
string
success
An optional, human-readable explanation of the status.

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.

zone
string
success
A reference to the zone where the machine resides.



Status

Authors

  • Google Inc. (@googlecloudplatform)

Hint

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