digital_ocean_tag_facts – Gather facts about DigitalOcean tags

From Get docs
Ansible/docs/2.7/modules/digital ocean tag facts module


digital_ocean_tag_facts – Gather facts about DigitalOcean tags

New in version 2.6.


Synopsis

  • This module can be used to gather facts about DigitalOcean provided tags.

Requirements

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

  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments

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

tag_name

-

Tag name that can be used to identify and reference a tag.

timeout

-

Default:

30

The timeout in seconds used for polling DigitalOcean's API.

validate_certs

boolean

  • 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.



Examples

- name: Gather facts about all tags
  digital_ocean_tag_facts:
    oauth_token: "{{ oauth_token }}"

- name: Gather facts about tag with given name
  digital_ocean_tag_facts:
    oauth_token: "{{ oauth_token }}"
    tag_name: "extra_awesome_tag"

- name: Get resources from tag name
  digital_ocean_tag_facts:
  register: resp_out
- set_fact:
    resources: "{{ item.resources }}"
  with_items: "{{ resp_out.data|json_query(name) }}"
  vars:
    name: "[?name=='extra_awesome_tag']"
- debug: var=resources

Return Values

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

Key Returned Description

data

list

success

DigitalOcean tag facts


Sample:

[{'name': 'extra-awesome', 'resources': {'droplets': {'count': 1, '...': None}}}]




Status

Authors

  • Abhijeet Kasurde (@Akasurde)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/digital_ocean_tag_facts_module.html