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
required
    Choices:
  • machineaccount
  • serviceaccount
  • application
The type of credential used.
can_ip_forward
bool
    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.
disks
An array of disks that are associated with the instances that are created from this template.
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.
auto_delete
bool
    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
bool
    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.
source
Reference to a gcompute_disk resource. 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.
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.
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.
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_type
Reference to a gcompute_disk_type resource.
Specifies the disk type to use to create the instance.
If not specified, the default is pd-standard.
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.
sha256
The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
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.
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.
type
    Choices:
  • SCRATCH
  • PERSISTENT
Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
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.
sha256
The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects 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.
guest_accelerators
List of the type and count of accelerator cards attached to the instance .
accelerator_type
Full or partial URL of the accelerator type resource to expose to this instance.
accelerator_count
The number of the guest accelerator cards exposed 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.
name
The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc .
alias_ip_ranges
An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks.
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.
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).
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.
type
required
    Choices:
  • ONE_TO_ONE_NAT
The type of configuration. The default and only option is ONE_TO_ONE_NAT.
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
Specifies the title of a gcompute_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.
subnetwork
Reference to a gcompute_subnetwork resource.
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.
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.
network
Specifies the title of an existing gcompute_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.
project Default:
None
The Google Cloud Platform project to use.
scheduling
Sets the scheduling options for this instance.
automatic_restart
bool
    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.
preemptible
bool
    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.
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.
scopes
Array of scopes to be used.
service_account_email
An optional service account email address if machineaccount is selected and the user does not wish to use the default email.
service_account_file
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.
scopes
The list of scopes to be made available for this service account.
email
Email address of the service account.
state
    Choices:
  • present ←
  • absent
Whether the given object should exist in GCP
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.
items
An array of tags. Each tag must be 1-63 characters long, and 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.
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 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: "service_account"
      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
can_ip_forward
bool
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.

cpu_platform
str
success
The CPU platform used by this instance.

creation_timestamp
str
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.

  index
int
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.

  auto_delete
bool
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
bool
success
Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

  device_name
str
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.

  source
dict
success
Reference to a gcompute_disk resource. 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.

  mode
str
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.

  interface
str
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.

  initialize_params
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.

    disk_type
str
success
Reference to a gcompute_disk_type resource.
Specifies the disk type to use to create the instance.
If not specified, the default is pd-standard.

    source_image_encryption_key
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.

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

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

    source_image
str
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.

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

    disk_size_gb
int
success
Specifies the size of the disk in base-2 GB.

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

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

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

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

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

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

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

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

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

label_fingerprint
str
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.

machine_type
str
success
A reference to a machine type which defines VM kind.

metadata
dict
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.

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

name
str
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.

network_interfaces
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.

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

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

    subnetwork_range_name
str
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.

    ip_cidr_range
str
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).

  access_configs
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.

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

    name
str
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.

    nat_ip
dict
success
Specifies the title of a gcompute_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.

  subnetwork
dict
success
Reference to a gcompute_subnetwork resource.
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.

  network_ip
str
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.

  network
dict
success
Specifies the title of an existing gcompute_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.

scheduling
complex
success
Sets the scheduling options for this instance.

  automatic_restart
bool
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.

  preemptible
bool
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.

  on_host_maintenance
str
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.

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

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

  email
str
success
Email address of the service account.

status
str
success
The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED.

status_message
str
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.

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

  fingerprint
str
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.

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



Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Google Inc. (@googlecloudplatform)

Hint

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