W3cubDocs

/Ansible

community.digitalocean.digital_ocean_tag – Create and remove tag(s) to DigitalOcean resource.

Note

This plugin is part of the community.digitalocean collection (version 1.11.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.digitalocean.

To use it in a playbook, specify: community.digitalocean.digital_ocean_tag.

Synopsis

  • Create and remove tag(s) to DigitalOcean resource.

Requirements

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

  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments
name
string / required
The name of the tag. The supported characters for names include alphanumeric characters, dashes, and underscores.
oauth_token
string
DigitalOcean OAuth token.
There are several other environment variables which can be used to provide this value.
i.e., - 'DO_API_TOKEN', 'DO_API_KEY', 'DO_OAUTH_TOKEN' and 'OAUTH_TOKEN'

aliases: api_token
resource_id
string
The ID of the resource to operate on.
The data type of resource_id is changed from integer to string since Ansible 2.5.

aliases: droplet_id
resource_type
string
    Choices:
  • droplet ←
The type of resource to operate on. Currently, only tagging of droplets is supported.
state
string
    Choices:
  • present ←
  • absent
Whether the tag should be present or absent on the resource.
timeout
integer
Default:
30
The timeout in seconds used for polling DigitalOcean's API.
validate_certs
boolean
    Choices:
  • no
  • yes ←
If set to no, the SSL certificates will not be validated.
This should only set to no used on personally controlled sites using self-signed certificates.

Notes

Note

  • Two environment variables can be used, DO_API_KEY and DO_API_TOKEN. They both refer to the v2 token.
  • As of Ansible 2.0, Version 2 of the DigitalOcean API is used.

Examples

- name: Create a tag
  community.digitalocean.digital_ocean_tag:
    name: production
    state: present

- name: Tag a resource; creating the tag if it does not exist
  community.digitalocean.digital_ocean_tag:
    name: "{{ item }}"
    resource_id: "73333005"
    state: present
  loop:
    - staging
    - dbserver

- name: Untag a resource
  community.digitalocean.digital_ocean_tag:
    name: staging
    resource_id: "73333005"
    state: absent

# Deleting a tag also untags all the resources that have previously been
# tagged with it
- name: Remove a tag
  community.digitalocean.digital_ocean_tag:
    name: dbserver
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
data
dictionary
success and no resource constraint
a DigitalOcean Tag resource

Sample:
{'tag': {'name': 'awesome', 'resources': {'droplets': {'count': 0, 'last_tagged': None}}}}


Authors

  • Victor Volle (@kontrafiktion)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/digitalocean/digital_ocean_tag_module.html