community.digitalocean.digital_ocean_region_info – Gather information about DigitalOcean regions
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_region_info
.
Synopsis
This module can be used to gather information about regions.
This module was called
digital_ocean_region_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 |
Comments |
---|---|
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 information about all regions
community.digitalocean.digital_ocean_region_info:
oauth_token: "{{ oauth_token }}"
- name: Get Name of region where slug is known
community.digitalocean.digital_ocean_region_info:
oauth_token: "{{ oauth_token }}"
register: resp_out
- debug: var=resp_out
- set_fact:
region_slug: "{{ item.name }}"
loop: "{{ resp_out.data | community.general.json_query(name) }}"
vars:
name: "[?slug==`nyc1`]"
- debug:
var: region_slug
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
DigitalOcean regions information Returned: success Sample: [{“available”: true, “features”: [“private_networking”, “backups”, “ipv6”, “metadata”, “install_agent”, “storage”], “name”: “New York 1”, “sizes”: [“512mb”, “s-1vcpu-1gb”, “1gb”, “s-3vcpu-1gb”, “s-1vcpu-2gb”, “s-2vcpu-2gb”, “2gb”, “s-1vcpu-3gb”, “s-2vcpu-4gb”, “4gb”, “c-2”, “m-1vcpu-8gb”, “8gb”, “s-4vcpu-8gb”, “s-6vcpu-16gb”, “16gb”], “slug”: “nyc1”}] |
Authors
Abhijeet Kasurde (@Akasurde)