google.cloud.gcp_compute_instance module – Creates a GCP Instance
Note
This module is part of the google.cloud collection (version 1.4.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install google.cloud
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: google.cloud.gcp_compute_instance
.
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 |
Comments |
---|---|
An OAuth2 access token if credential type is accesstoken. |
|
The type of credential used. Choices:
|
|
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. Choices:
|
|
Configuration for confidential computing (requires setting the machine type to any of the n2d-* types and a boot disk of type pd-ssd). |
|
Enables confidential computing. Choices:
|
|
Whether the resource should be protected against deletion. Choices:
|
|
An array of disks that are associated with the instances that are created from this template. |
|
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. Choices:
|
|
Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. Choices:
|
|
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. |
|
Encrypts or decrypts a disk using a customer-supplied encryption key. |
|
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. |
|
Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. |
|
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. |
|
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. |
|
Specifies the disk name. If not specified, the default is to use the name of the instance. |
|
Specifies the size of the disk in base-2 GB. |
|
Reference to a disk type. Specifies the disk type to use to create the instance. If not specified, the default is pd-standard. |
|
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. |
|
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. |
|
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. |
|
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” |
|
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” |
|
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 }}” |
|
Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. Some valid choices include: “SCRATCH”, “PERSISTENT” |
|
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. |
|
List of the type and count of accelerator cards attached to the instance . |
|
The number of the guest accelerator cards exposed to this instance. |
|
Full or partial URL of the accelerator type resource to expose to this instance. |
|
The hostname of the instance to be created. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS. |
|
Labels to apply to this instance. A list of key->value pairs. |
|
A reference to a machine type which defines VM kind. |
|
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. |
|
Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms . |
|
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. |
|
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. |
|
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. |
|
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. |
|
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 }}” |
|
This signifies the networking tier used for configuring this access configuration. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP. Some valid choices include: “PREMIUM”, “STANDARD” |
|
The DNS domain name for the public PTR record. You can set this field only if the setPublicPtr field is enabled. |
|
Specifies whether a public DNS PTR record should be created to map the external IP address of the instance to a DNS domain name. Choices:
|
|
The type of configuration. The default and only option is ONE_TO_ONE_NAT. Some valid choices include: “ONE_TO_ONE_NAT” |
|
An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks. |
|
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). |
|
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. |
|
Specifies the title of an existing network. Not setting the network title will select the default network interface, which could have SSH already configured . 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 }}” |
|
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. |
|
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 }}” |
|
The Google Cloud Platform project to use. |
|
Sets the scheduling options for this instance. |
|
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. Choices:
|
|
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. |
|
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. Choices:
|
|
Array of scopes to be used |
|
The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. |
|
An optional service account email address if machineaccount is selected and the user does not wish to use the default email. |
|
The path of a Service Account JSON file if serviceaccount is selected as type. |
|
A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. |
|
Email address of the service account. |
|
The list of scopes to be made available for this service account. |
|
Configuration for various parameters related to shielded instances. |
|
Defines whether the instance has integrity monitoring enabled. Choices:
|
|
Defines whether the instance has Secure Boot enabled. Choices:
|
|
Defines whether the instance has the vTPM enabled. Choices:
|
|
Whether the given object should exist in GCP Choices:
|
|
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 . Some valid choices include: “PROVISIONING”, “STAGING”, “RUNNING”, “STOPPING”, “SUSPENDING”, “SUSPENDED”, “TERMINATED” |
|
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. |
|
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. |
|
An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. |
|
A reference to the zone where the machine resides. |
Examples
- name: create a disk
google.cloud.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
google.cloud.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
google.cloud.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
google.cloud.gcp_compute_instance:
name: test_object
machine_type: n1-standard-1
disks:
- auto_delete: 'true'
boot: 'true'
source: "{{ disk }}"
- auto_delete: 'true'
interface: NVME
type: SCRATCH
initialize_params:
disk_type: local-ssd
metadata:
startup-script-url: gs:://graphite-playground/bootstrap.sh
cost-center: '12345'
labels:
environment: production
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 |
Description |
---|---|
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. Returned: success |
|
Configuration for confidential computing (requires setting the machine type to any of the n2d-* types and a boot disk of type pd-ssd). Returned: success |
|
Enables confidential computing. Returned: success |
|
The CPU platform used by this instance. Returned: success |
|
Creation timestamp in RFC3339 text format. Returned: success |
|
Whether the resource should be protected against deletion. Returned: success |
|
An array of disks that are associated with the instances that are created from this template. Returned: 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. Returned: success |
|
Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. Returned: 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. Returned: success |
|
Encrypts or decrypts a disk using a customer-supplied encryption key. Returned: success |
|
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. Returned: success |
|
Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. Returned: success |
|
The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. Returned: 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. Returned: 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. Returned: success |
|
Specifies the disk name. If not specified, the default is to use the name of the instance. Returned: success |
|
Specifies the size of the disk in base-2 GB. Returned: success |
|
Reference to a disk type. Specifies the disk type to use to create the instance. If not specified, the default is pd-standard. Returned: 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. Returned: 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. Returned: success |
|
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. Returned: success |
|
The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. Returned: 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. Returned: 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. Returned: 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. Returned: success |
|
Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. Returned: success |
|
List of the type and count of accelerator cards attached to the instance . Returned: success |
|
The number of the guest accelerator cards exposed to this instance. Returned: success |
|
Full or partial URL of the accelerator type resource to expose to this instance. Returned: success |
|
The hostname of the instance to be created. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS. Returned: success |
|
The unique identifier for the resource. This identifier is defined by the server. Returned: success |
|
The fingerprint used for optimistic locking of this resource. Used internally during updates. Returned: success |
|
Labels to apply to this instance. A list of key->value pairs. Returned: success |
|
A reference to a machine type which defines VM kind. See https://cloud.google.com/compute/docs/machine-types for a list of current valid machine types. Returned: 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. Returned: success |
|
Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms . Returned: 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. Returned: 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. Returned: 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. Returned: 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. Returned: 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. Returned: success |
|
This signifies the networking tier used for configuring this access configuration. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP. Returned: success |
|
The DNS domain name for the public PTR record. You can set this field only if the setPublicPtr field is enabled. Returned: success |
|
Specifies whether a public DNS PTR record should be created to map the external IP address of the instance to a DNS domain name. Returned: success |
|
The type of configuration. The default and only option is ONE_TO_ONE_NAT. Returned: success |
|
An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks. Returned: 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). Returned: 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. Returned: success |
|
The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc . Returned: success |
|
Specifies the title of an existing network. Not setting the network title will select the default network interface, which could have SSH already configured . Returned: 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. Returned: 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. Returned: success |
|
Sets the scheduling options for this instance. Returned: 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. Returned: 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. Returned: 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. Returned: success |
|
A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. Returned: success |
|
Email address of the service account. Returned: success |
|
The list of scopes to be made available for this service account. Returned: success |
|
Configuration for various parameters related to shielded instances. Returned: success |
|
Defines whether the instance has integrity monitoring enabled. Returned: success |
|
Defines whether the instance has Secure Boot enabled. Returned: success |
|
Defines whether the instance has the vTPM enabled. Returned: 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 . Returned: success |
|
An optional, human-readable explanation of the status. Returned: 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. Returned: 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. Returned: success |
|
An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. Returned: success |
|
A reference to the zone where the machine resides. Returned: success |