W3cubDocs

/Ansible

community.digitalocean.digital_ocean_cdn_endpoints_info – Display DigitalOcean CDN Endpoints

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

New in version 1.10.0: of community.digitalocean

Synopsis

  • Display DigitalOcean CDN Endpoints

Parameters

Parameter Choices/Defaults Comments
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
state
string
    Choices:
  • present
  • absent
The usual, present to create, absent to destroy
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.

Examples

- name: Display DigitalOcean CDN Endpoints
  community.digitalocean.digital_ocean_cdn_endpoints_info:
    oauth_token: "{{ lookup('ansible.builtin.env', 'DO_API_TOKEN') }}"

Return Values

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

Key Returned Description
data
dictionary
success
DigitalOcean CDN Endpoints

Sample:
{'data': {'endpoints': [{'created_at': '2021-09-05T13:47:23Z', 'endpoint': 'mamercad.nyc3.cdn.digitaloceanspaces.com', 'id': '01739563-3f50-4da4-a451-27f6d59d7573', 'origin': 'mamercad.nyc3.digitaloceanspaces.com', 'ttl': 3600}], 'meta': {'total': 1}}}


Authors

  • Mark Mercado (@mamercad)

© 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_cdn_endpoints_info_module.html