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.0.0).
To install it use: ansible-galaxy collection install community.digitalocean
.
To use it in a playbook, specify: community.digitalocean.digital_ocean_tag
.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 2.6
Parameters¶
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:
Authors¶
Victor Volle (@kontrafiktion)