community.digitalocean.digital_ocean_account_info – Gather information about DigitalOcean User account

From Get docs
Ansible/docs/2.11/collections/community/digitalocean/digital ocean account info module


community.digitalocean.digital_ocean_account_info – Gather information about DigitalOcean User account

Note

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

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

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


Synopsis

  • This module can be used to gather information about User account.
  • This module was called digital_ocean_account_facts before Ansible 2.9. The usage did not change.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6

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

  • 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: Gather information about user account
  community.digitalocean.digital_ocean_account_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 account information


Sample:

{'droplet_limit': 10, 'email': '[email protected]', 'email_verified': True, 'floating_ip_limit': 3, 'status': 'active', 'status_message': , 'uuid': 'aaaaaaaaaaaaaa'}




Authors

  • Abhijeet Kasurde (@Akasurde)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/digitalocean/digital_ocean_account_info_module.html