New in version 2.6.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| load_balancer_id |
Load balancer ID that can be used to identify and reference a load_balancer.
|
|
| 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
bool |
|
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. |
- name: Gather facts about all load balancers
digital_ocean_load_balancer_facts:
oauth_token: "{{ oauth_token }}"
- name: Gather facts about load balancer with given id
digital_ocean_load_balancer_facts:
oauth_token: "{{ oauth_token }}"
load_balancer_id: "4de7ac8b-495b-4884-9a69-1050c6793cd6"
- name: Get name from load balancer id
digital_ocean_load_balancer_facts:
register: resp_out
- set_fact:
load_balancer_name: "{{ item.name }}"
with_items: "{{ resp_out.data|json_query(name) }}"
vars:
name: "[?id=='4de7ac8b-495b-4884-9a69-1050c6793cd6']"
- debug: var=load_balancer_name
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
|
data
list
|
success |
DigitalOcean Load balancer facts
Sample:
[{'status': 'new', '...': None, 'name': 'example-lb-01', 'algorithm': 'round_robin', 'ip': '104.131.186.241', 'created_at': '2017-02-01T22:22:58Z', 'id': '4de7ac8b-495b-4884-9a69-1050c6793cd6'}]
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.