ansible.builtin.gce_labels (v2.9.27) — module

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

Create, Update or Destroy GCE Labels on instances, disks, snapshots, etc. When specifying the GCE resource, users may specify the full URL for the resource (its 'self_link'), or the individual parameters of the resource (type, location, name). Examples for the two options can be seen in the documentation. See U(https://cloud.google.com/compute/docs/label-or-tag-resources) for more information about GCE Labels. Labels are gradually being added to more GCE resources, so this module will need to be updated as new resources are added to the GCE (v1) API.

Requirements

• python >= 2.6
• google-api-python-client >= 1.6.2
• google-auth >= 1.0.0
• google-auth-httplib2 >= 0.0.2

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Add labels on an existing instance (using resource_url)
  gce_labels:
    service_account_email: "{{ service_account_email }}"
    credentials_file: "{{ credentials_file }}"
    project_id: "{{ project_id }}"
    labels:
      webserver-frontend: homepage
      environment: test
      experiment-name: kennedy
    resource_url: https://www.googleapis.com/compute/beta/projects/myproject/zones/us-central1-f/instances/example-instance
    state: present

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Add labels on an image (using resource params)
  gce_labels:
    service_account_email: "{{ service_account_email }}"
    credentials_file: "{{ credentials_file }}"
    project_id: "{{ project_id }}"
    labels:
      webserver-frontend: homepage
      environment: test
      experiment-name: kennedy
    resource_type: images
    resource_location: global
    resource_name: my-custom-image
    state: present

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Remove specified labels from the GCE instance
  gce_labels:
    service_account_email: "{{ service_account_email }}"
    credentials_file: "{{ credentials_file }}"
    project_id: "{{ project_id }}"
    labels:
      environment: prod
      experiment-name: kennedy
    resource_url: https://www.googleapis.com/compute/beta/projects/myproject/zones/us-central1-f/instances/example-instance
    state: absent

Inputs

    
labels:
    description:
    - A list of labels (key/value pairs) to add or remove for the resource.
    required: false

resource_url:
    description:
    - The 'self_link' for the resource (instance, disk, snapshot, etc)
    required: false

resource_name:
    description:
    - The name of resource.
    required: false

resource_type:
    description:
    - The type of resource (instances, disks, snapshots, images)
    required: false

resource_location:
    description:
    - The location of resource (global, us-central1-f, etc.)
    required: false

Outputs

labels:
  description: List of labels that exist on the resource.
  returned: Always.
  sample:
  - environment: test
    environment-name: kennedy
    webserver-frontend: homepage
  type: dict
resource_location:
  description: The location of the GCE resource.
  returned: Always.
  sample: us-central1-f
  type: str
resource_name:
  description: The name of the GCE resource.
  returned: Always.
  sample: my-happy-little-instance
  type: str
resource_type:
  description: The type of the GCE resource.
  returned: Always.
  sample: instances
  type: str
resource_url:
  description: The 'self_link' of the GCE resource.
  returned: Always.
  sample: https://www.googleapis.com/compute/beta/projects/myproject/zones/us-central1-f/instances/example-instance
  type: str
state:
  description: state of the labels
  returned: Always.
  sample: present
  type: str