community.general.digital_ocean_load_balancer_facts (0.1.4) — module

Install collection

Install with ansible-galaxy collection install community.general:==0.1.4

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.4

Description

This module can be used to gather information about DigitalOcean provided load balancers.

This module was called C(digital_ocean_load_balancer_facts) before Ansible 2.9. The usage did not change.

Requirements

• python >= 2.6

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Gather information about all load balancers
  digital_ocean_load_balancer_info:
    oauth_token: "{{ oauth_token }}"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Gather information about load balancer with given id
  digital_ocean_load_balancer_info:
    oauth_token: "{{ oauth_token }}"
    load_balancer_id: "4de7ac8b-495b-4884-9a69-1050c6793cd6"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Get name from load balancer id
  digital_ocean_load_balancer_info:
  register: resp_out

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- set_fact:
    load_balancer_name: "{{ item.name }}"
  loop: "{{ resp_out.data|json_query(name) }}"
  vars:
    name: "[?id=='4de7ac8b-495b-4884-9a69-1050c6793cd6']"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- debug: var=load_balancer_name

Inputs

    
timeout:
    default: 30
    description:
    - The timeout in seconds used for polling DigitalOcean's API.
    type: int

oauth_token:
    aliases:
    - api_token
    description:
    - 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'
    type: str

validate_certs:
    default: true
    description:
    - If set to C(no), the SSL certificates will not be validated.
    - This should only set to C(no) used on personally controlled sites using self-signed
      certificates.
    type: bool

load_balancer_id:
    description:
    - Load balancer ID that can be used to identify and reference a load_balancer.
    required: false

Outputs

data:
  description: DigitalOcean Load balancer information
  returned: success
  sample:
  - '...': null
    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
  type: list