You are reading an older version of the Ansible documentation. Use the version selection to the left if you want the latest (stable) released version.

community.general.clc_loadbalancer module – Create, Delete shared loadbalancers in CenturyLink Cloud

Note

This module is part of the community.general collection (version 9.5.2).

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.general. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: community.general.clc_loadbalancer.

Synopsis

• An Ansible module to Create, Delete shared loadbalancers in CenturyLink Cloud.

Requirements

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

• python = 2.7

• requests >= 2.5.0

• clc-sdk

Parameters

Parameter	Comments
alias string / required	The alias of your CLC Account
description string	A description for the loadbalancer
location string / required	The location of the datacenter where the load balancer resides in
method string	-The balancing method for the load balancer pool Choices: "leastConnection" "roundRobin"
name string / required	The name of the loadbalancer
nodes list / elements=dictionary	A list of nodes that needs to be added to the load balancer pool Default: []
persistence string	The persistence method for the load balancer Choices: "standard" "sticky"
port string	Port to configure on the public-facing side of the load balancer pool Choices: "80" "443"
state string	Whether to create or delete the load balancer pool Choices: "present" ← (default) "absent" "port_absent" "nodes_present" "nodes_absent"
status string	The status of the loadbalancer Choices: "enabled" ← (default) "disabled"

Attributes

Attribute	Support	Description
check_mode	Support: full	Can run in check_mode and return changed status prediction without modifying target.
diff_mode	Support: none	Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Notes

Note

• To use this module, it is required to set the below environment variables which enables access to the Centurylink Cloud - CLC_V2_API_USERNAME, the account login id for the centurylink cloud - CLC_V2_API_PASSWORD, the account password for the centurylink cloud

• Alternatively, the module accepts the API token and account alias. The API token can be generated using the CLC account login and password via the HTTP api call @ https://api.ctl.io/v2/authentication/login - CLC_V2_API_TOKEN, the API token generated from https://api.ctl.io/v2/authentication/login - CLC_ACCT_ALIAS, the account alias associated with the centurylink cloud

• Users can set CLC_V2_API_URL to specify an endpoint for pointing to a different CLC environment.

Examples

# Note - You must set the CLC_V2_API_USERNAME And CLC_V2_API_PASSWD Environment variables before running these examples
- name: Create Loadbalancer
  hosts: localhost
  connection: local
  tasks:
    - name: Actually Create things
      community.general.clc_loadbalancer:
        name: test
        description: test
        alias: TEST
        location: WA1
        port: 443
        nodes:
          - ipAddress: 10.11.22.123
            privatePort: 80
        state: present

- name: Add node to an existing loadbalancer pool
  hosts: localhost
  connection: local
  tasks:
    - name: Actually Create things
      community.general.clc_loadbalancer:
        name: test
        description: test
        alias: TEST
        location: WA1
        port: 443
        nodes:
          - ipAddress: 10.11.22.234
            privatePort: 80
        state: nodes_present

- name: Remove node from an existing loadbalancer pool
  hosts: localhost
  connection: local
  tasks:
    - name: Actually Create things
      community.general.clc_loadbalancer:
        name: test
        description: test
        alias: TEST
        location: WA1
        port: 443
        nodes:
          - ipAddress: 10.11.22.234
            privatePort: 80
        state: nodes_absent

- name: Delete LoadbalancerPool
  hosts: localhost
  connection: local
  tasks:
    - name: Actually Delete things
      community.general.clc_loadbalancer:
        name: test
        description: test
        alias: TEST
        location: WA1
        port: 443
        nodes:
          - ipAddress: 10.11.22.123
            privatePort: 80
        state: port_absent

- name: Delete Loadbalancer
  hosts: localhost
  connection: local
  tasks:
    - name: Actually Delete things
      community.general.clc_loadbalancer:
        name: test
        description: test
        alias: TEST
        location: WA1
        port: 443
        nodes:
          - ipAddress: 10.11.22.123
            privatePort: 80
        state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

loadbalancer dictionary

The load balancer result object from CLC Returned: success Sample: {"description": "test-lb", "id": "ab5b18cb81e94ab9925b61d1ca043fb5", "ipAddress": "66.150.174.197", "links": [{"href": "/v2/sharedLoadBalancers/wfad/wa1/ab5b18cb81e94ab9925b61d1ca043fb5", "rel": "self", "verbs": ["GET", "PUT", "DELETE"]}, {"href": "/v2/sharedLoadBalancers/wfad/wa1/ab5b18cb81e94ab9925b61d1ca043fb5/pools", "rel": "pools", "verbs": ["GET", "POST"]}], "name": "test-lb", "pools": [], "status": "enabled"}

Authors

• CLC Runner (@clc-runner)

Collection links

• Issue Tracker
• Repository (Sources)
• Ask for help
• Submit a bug report
• Request a feature
• Communication