community.general.gce_tag – add or remove tag(s) to/from GCE instances

Note

This plugin is part of the community.general collection.

To install it use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.gce_tag.

Synopsis

Requirements

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

  • python >= 2.6

  • apache-libcloud >= 0.17.0

Parameters

Parameter Choices/Defaults Comments
instance_name
string
The name of the GCE instance to add/remove tags.
Required if instance_pattern is not specified.
instance_pattern
string
The pattern of GCE instance names to match for adding/removing tags. Full-Python regex is supported. See https://docs.python.org/2/library/re.html for details.
If instance_name is not specified, this field is required.
pem_file
string
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.
state
string
    Choices:
  • absent
  • present ←
Desired state of the tags.
tags
string / required
Comma-separated list of tags to add or remove.
zone
string
Default:
"us-central1-a"
The zone of the disk specified by source.

Notes

Note

  • Either instance_name or instance_pattern is required.

Examples

- name: Add tags to instance
  community.general.gce_tag:
    instance_name: staging-server
    tags: http-server,https-server,staging
    zone: us-central1-a
    state: present

- name: Remove tags from instance in default zone (us-central1-a)
  community.general.gce_tag:
    instance_name: test-server
    tags: foo,bar
    state: absent

- name: Add tags to instances in zone that match pattern
  community.general.gce_tag:
    instance_pattern: test-server-*
    tags: foo,bar
    zone: us-central1-a
    state: present

Authors