community.digitalocean.digital_ocean_database_info – Gather information about DigitalOcean databases
Note
This plugin is part of the community.digitalocean collection (version 1.13.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_database_info
.
New in version 1.3.0: of community.digitalocean
Parameters
Parameter |
Comments |
---|---|
A unique ID that can be used to identify and reference a database cluster. |
|
A unique, human-readable name for the database cluster. |
|
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: 30 |
|
If set to This should only set to Choices:
|
Examples
- name: Gather all DigitalOcean databases
community.digitalocean.digital_ocean_database_info:
oauth_token: "{{ lookup('ansible.builtin.env', 'DO_API_KEY') }}"
register: my_databases
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
List of DigitalOcean databases Returned: success Sample: [{“connection”: {“database”: “”, “host”: “testdatabase1-do-user-3097135-0.b.db.ondigitalocean.com”, “password”: “REDACTED”, “port”: 25061, “protocol”: “rediss”, “ssl”: true, “uri”: “rediss://default:REDACTED@testdatabase1-do-user-3097135-0.b.db.ondigitalocean.com:25061”, “user”: “default”}, “created_at”: “2021-04-21T15:41:14Z”, “db_names”: null, “engine”: “redis”, “id”: “37de10e4-808b-4f4b-b25f-7b5b3fd194ac”, “maintenance_window”: {“day”: “monday”, “hour”: “11:33:47”, “pending”: false}, “name”: “testdatabase1”, “num_nodes”: 1, “private_connection”: {“database”: “”, “host”: “private-testdatabase1-do-user-3097135-0.b.db.ondigitalocean.com”, “password”: “REDACTED”, “port”: 25061, “protocol”: “rediss”, “ssl”: true, “uri”: “rediss://default:REDACTED@private-testdatabase1-do-user-3097135-0.b.db.ondigitalocean.com:25061”, “user”: “default”}, “private_network_uuid”: “0db3519b-9efc-414a-8868-8f2e6934688c”, “region”: “nyc1”, “size”: “db-s-1vcpu-1gb”, “status”: “online”, “tags”: null, “users”: null, “version”: “6”}, “…”] |
Authors
Mark Mercado (@mamercad)