community.digitalocean.digital_ocean_balance_info module – Display DigitalOcean customer balance
Note
This module is part of the community.digitalocean collection (version 1.23.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_balance_info
.
New in community.digitalocean 1.2.0
Synopsis
This module can be used to display the DigitalOcean customer balance.
Parameters
Parameter |
Comments |
---|---|
DigitalOcean API base url. Default: |
|
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’ |
|
The timeout in seconds used for polling DigitalOcean’s API. Default: |
|
If set to This should only set to Choices:
|
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 |
Description |
---|---|
DigitalOcean customer balance Returned: success Sample: |