community.digitalocean.digital_ocean_load_balancer_info – Gather information about DigitalOcean load balancers
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_load_balancer_info.
Synopsis
- This module can be used to gather information about DigitalOcean provided load balancers.
 - This module was called 
digital_ocean_load_balancer_factsbefore 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 | 
|---|---|---|
|   load_balancer_id    string    |    Load balancer ID that can be used to identify and reference a load_balancer.   |  |
|   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    |   
  |    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 all load balancers
  community.digitalocean.digital_ocean_load_balancer_info:
    oauth_token: "{{ oauth_token }}"
- name: Gather information about load balancer with given id
  community.digitalocean.digital_ocean_load_balancer_info:
    oauth_token: "{{ oauth_token }}"
    load_balancer_id: "4de7ac8b-495b-4884-9a69-1050c6793cd6"
- name: Get name from load balancer id
  community.digitalocean.digital_ocean_load_balancer_info:
  register: resp_out
- set_fact:
    load_balancer_name: "{{ item.name }}"
  loop: "{{ resp_out.data | community.general.json_query(name) }}"
  vars:
    name: "[?id=='4de7ac8b-495b-4884-9a69-1050c6793cd6']"
- debug:
    var: load_balancer_name
   Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | 
|---|---|---|
|   data    list / elements=string    |  success |   DigitalOcean Load balancer information  Sample:  [{'...': None, 'algorithm': 'round_robin', 'created_at': '2017-02-01T22:22:58Z', 'id': '4de7ac8b-495b-4884-9a69-1050c6793cd6', 'ip': '104.131.186.241', 'name': 'example-lb-01', 'status': 'new'}]   |  
Authors
- Abhijeet Kasurde (@Akasurde)
 
    © 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
    https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_load_balancer_info_module.html