digital_ocean_account_facts – Gather facts about DigitalOcean User account¶
New in version 2.6.
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 |
|
|
timeout
-
|
Default: 30
|
The timeout in seconds used for polling DigitalOcean's API.
|
|
validate_certs
boolean
|
|
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 user account
digital_ocean_account_facts:
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 account facts
Sample:
{'droplet_limit': 10, 'email': '[email protected]', 'email_verified': True, 'floating_ip_limit': 3, 'status': 'active', 'status_message': '', 'uuid': 'aaaaaaaaaaaaaa'}
|
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Abhijeet Kasurde (@Akasurde)
Hint
If you notice any issues in this documentation you can edit this document to improve it.