community.google.gce_img module – utilize GCE image resources

Note

This module is part of the community.google collection (version 1.0.0).

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 community.google.

To use it in a playbook, specify: community.google.gce_img.

Synopsis

Requirements

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

  • python >= 2.6

  • apache-libcloud

Parameters

Parameter

Comments

description

string

an optional description

family

string

an optional family name

name

string / required

the name of the image to create or delete

pem_file

path

path to the pem file associated with the service account email

project_id

string

your GCE project ID

service_account_email

string

service account email

source

string

the source disk or the Google Cloud Storage URI to create the image from

state

string

desired state of the image

Choices:

  • present ← (default)

  • absent

timeout

integer

timeout for the operation

Default: 180

zone

string

the zone of the disk specified by source

Default: “us-central1-a”

Examples

- name: Create an image named test-image from the disk 'test-disk' in zone us-central1-a
  community.google.gce_img:
    name: test-image
    source: test-disk
    zone: us-central1-a
    state: present

- name: Create an image named test-image from a tarball in Google Cloud Storage
  community.google.gce_img:
    name: test-image
    source: https://storage.googleapis.com/bucket/path/to/image.tgz

- name: Alternatively use the gs scheme
  community.google.gce_img:
    name: test-image
    source: gs://bucket/path/to/image.tgz

- name: Delete an image named test-image
  community.google.gce_img:
    name: test-image
    state: absent

Authors

  • Tom Melendez (@supertom)