- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# gcp_compute_image – Creates a GCP Image

New in version 2.6.

- Synopsis

- Requirements

- Parameters

- Notes

- Examples

- Return Values

- Status

## Synopsis

- Represents an Image resource.

- Google Compute Engine uses operating system images to create the root persistent disks for your instances. You specify an image when you create an instance. Images contain a boot loader, an operating system, and a root file system. Linux operating system images are also capable of running containers on Compute Engine.

- Images can be either public or custom.

- Public images are provided and maintained by Google, open-source communities, and third-party vendors. By default, all projects have access to these images and can use them to create instances. Custom images are available only to your project. You can create a custom image from root persistent disks and other images. Then, use the custom image to create an instance.

## 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.
description string |  | An optional description of this resource. Provide this property when you create the resource.
disk_size_gb integer |  | Size of the image when restored onto a persistent disk (in GB).
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.
family string |  | The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.
guest_os_features list |  | A list of features to enable on the guest OS. Applicable for bootable images only. Currently, only one feature can be enabled, VIRTIO_SCSI_MULTIQUEUE, which allows each virtual CPU to have its own queue. For Windows images, you can only enable VIRTIO_SCSI_MULTIQUEUE on images with driver version 1.2.0.1621 or higher. Linux images with kernel versions 3.17 and higher will support VIRTIO_SCSI_MULTIQUEUE. For new Windows images, the server might also populate this field with the value WINDOWS, to indicate that this is a Windows image. This value is purely informational and does not enable or disable any features.
| type string |  | The type of supported feature. Currently only VIRTIO_SCSI_MULTIQUEUE is supported. For newer Windows images, the server might also populate this property with the value WINDOWS to indicate that this is a Windows image. This value is purely informational and does not enable or disable any features. Some valid choices include: "VIRTIO_SCSI_MULTIQUEUE"
image_encryption_key dictionary |  | Encrypts the image using a customer-supplied encryption key. After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image) .
| raw_key string |  | Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
labels dictionary added in 2.8 |  | Labels to apply to this Image.
licenses list |  | Any applicable license URI.
name string / required |  | Name of the resource; provided by the client when the resource is created. The 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.
project string |  | The Google Cloud Platform project to use.
raw_disk dictionary |  | The parameters of the raw disk image.
| container_type string |  | The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created. Some valid choices include: "TAR"
| sha1_checksum string |  | An optional SHA1 checksum of the disk image before unpackaging. This is provided by the client when the disk image is created.
| source string / required |  | The full Google Cloud Storage URL where disk storage is stored You must provide either this property or the sourceDisk property but not both.
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.
source_disk dictionary |  | The source disk to create this image based on. You must provide either this property or the rawDisk.source property but not both to create an image. 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_disk field to "{{ name-of-resource }}"
source_disk_encryption_key dictionary |  | The customer-supplied encryption key of the source disk. Required if the source disk is protected by 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.
source_disk_id string |  | The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
source_type string |  | The type of the image used to create this disk. The default and only value is RAW . Some valid choices include: "RAW"
state string | Choices: present ← absent | Whether the given object should exist in GCP

## Notes

Note

- API Reference: https://cloud.google.com/compute/docs/reference/v1/images

- Official Documentation: https://cloud.google.com/compute/docs/images

- 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 disk
      gcp_compute_disk:
        name: disk-image
        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 image
      gcp_compute_image:
        name: test_object
        source_disk: "{{ disk }}"
        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
--- | --- | ---
archiveSizeBytes integer | success | Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
creationTimestamp string | success | Creation timestamp in RFC3339 text format.
deprecated complex | success | The deprecation status associated with this image.
| deleted string | success | An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it.
| deprecated string | success | An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it.
| obsolete string | success | An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it.
| replacement string | success | The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
| state string | success | The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
description string | success | An optional description of this resource. Provide this property when you create the resource.
diskSizeGb integer | success | Size of the image when restored onto a persistent disk (in GB).
family string | success | The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.
guestOsFeatures complex | success | A list of features to enable on the guest OS. Applicable for bootable images only. Currently, only one feature can be enabled, VIRTIO_SCSI_MULTIQUEUE, which allows each virtual CPU to have its own queue. For Windows images, you can only enable VIRTIO_SCSI_MULTIQUEUE on images with driver version 1.2.0.1621 or higher. Linux images with kernel versions 3.17 and higher will support VIRTIO_SCSI_MULTIQUEUE. For new Windows images, the server might also populate this field with the value WINDOWS, to indicate that this is a Windows image. This value is purely informational and does not enable or disable any features.
| type string | success | The type of supported feature. Currently only VIRTIO_SCSI_MULTIQUEUE is supported. For newer Windows images, the server might also populate this property with the value WINDOWS to indicate that this is a Windows image. This value is purely informational and does not enable or disable any features.
id integer | success | The unique identifier for the resource. This identifier is defined by the server.
imageEncryptionKey complex | success | Encrypts the image using a customer-supplied encryption key. After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image) .
| 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.
labelFingerprint string | success | The fingerprint used for optimistic locking of this resource. Used internally during updates.
labels dictionary | success | Labels to apply to this Image.
licenses list | success | Any applicable license URI.
name string | success | Name of the resource; provided by the client when the resource is created. The 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.
rawDisk complex | success | The parameters of the raw disk image.
| containerType string | success | The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
| sha1Checksum string | success | An optional SHA1 checksum of the disk image before unpackaging. This is provided by the client when the disk image is created.
| source string | success | The full Google Cloud Storage URL where disk storage is stored You must provide either this property or the sourceDisk property but not both.
sourceDisk dictionary | success | The source disk to create this image based on. You must provide either this property or the rawDisk.source property but not both to create an image.
sourceDiskEncryptionKey complex | success | The customer-supplied encryption key of the source disk. Required if the source disk is protected by 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.
| sha256 string | success | The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
sourceDiskId string | success | The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
sourceType string | success | The type of the image used to create this disk. The default and only value is RAW .

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]

- This module is maintained by the Ansible Community. [community]

### Authors

- Google Inc. (@googlecloudplatform)

Hint

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