community.digitalocean.digital_ocean_balance_info – Display DigitalOcean customer balance

Note

This plugin is part of the community.digitalocean collection (version 1.9.0).

To install it use: ansible-galaxy collection install community.digitalocean.

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

New in version 1.2.0: of community.digitalocean

Synopsis

  • This module can be used to display the DigitalOcean customer balance.

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
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 customer balance
  community.digitalocean.digital_ocean_balance_info:
    oauth_token: "{{ oauth_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 customer balance

Sample:
{'account_balance': '-27.52', 'generated_at': '2021-04-11T05:08:24Z', 'month_to_date_balance': '-27.40', 'month_to_date_usage': '0.00'}


Authors

  • Mark Mercado (@mamercad)