New in version 2.2.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
|
name
required |
The name of the tag. The supported characters for names include alphanumeric characters, dashes, and underscores.
|
|
| oauth_token |
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 |
The ID of the resource to operate on.
The data type of resource_id is changed from integer to string, from version 2.5.
aliases: droplet_id |
|
| resource_type |
|
The type of resource to operate on. Currently, only tagging of droplets is supported.
|
| state |
|
Whether the tag should be present or absent on the resource.
|
| timeout |
Default: 30
|
The timeout in seconds used for polling DigitalOcean's API.
|
|
validate_certs
bool |
|
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. |
Note
- name: create a tag
digital_ocean_tag:
name: production
state: present
- name: tag a resource; creating the tag if it does not exist
digital_ocean_tag:
name: "{{ item }}"
resource_id: "73333005"
state: present
with_items:
- staging
- dbserver
- name: untag a resource
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
digital_ocean_tag:
name: dbserver
state: absent
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
|
data
dict
|
success and no resource constraint |
a DigitalOcean Tag resource
Sample:
{'tag': {'name': 'awesome', 'resources': {'droplets': {'count': 0, 'last_tagged': None}}}}
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.