community.general.rax_clb module – Create / delete a load balancer in Rackspace Public Cloud

Note

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

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.rax_clb.

Synopsis

  • creates / deletes a Rackspace Public Cloud load balancer.

Requirements

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

  • pyrax

  • python >= 2.6

Parameters

Parameter

Comments

algorithm

string

algorithm for the balancer being created

Choices:

  • "RANDOM"

  • "LEAST_CONNECTIONS" ← (default)

  • "ROUND_ROBIN"

  • "WEIGHTED_LEAST_CONNECTIONS"

  • "WEIGHTED_ROUND_ROBIN"

api_key

aliases: password

string

Rackspace API key, overrides credentials.

auth_endpoint

string

The URI of the authentication service.

If not specified will be set to https://identity.api.rackspacecloud.com/v2.0/

credentials

aliases: creds_file

path

File to find the Rackspace credentials in. Ignored if api_key and username are provided.

env

string

Environment as configured in ~/.pyrax.cfg, see https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration.

identity_type

string

Authentication mechanism to use, such as rackspace or keystone.

Default: "rackspace"

meta

dictionary

A hash of metadata to associate with the instance

Default: {}

name

string / required

Name to give the load balancer

port

integer

Port for the balancer being created

Default: 80

protocol

string

Protocol for the balancer being created

Choices:

  • "DNS_TCP"

  • "DNS_UDP"

  • "FTP"

  • "HTTP" ← (default)

  • "HTTPS"

  • "IMAPS"

  • "IMAPv4"

  • "LDAP"

  • "LDAPS"

  • "MYSQL"

  • "POP3"

  • "POP3S"

  • "SMTP"

  • "TCP"

  • "TCP_CLIENT_FIRST"

  • "UDP"

  • "UDP_STREAM"

  • "SFTP"

region

string

Region to create an instance in.

state

string

Indicate desired state of the resource

Choices:

  • "present" ← (default)

  • "absent"

tenant_id

string

The tenant ID used for authentication.

tenant_name

string

The tenant name used for authentication.

timeout

integer

timeout for communication between the balancer and the node

Default: 30

type

string

type of interface for the balancer being created

Choices:

  • "PUBLIC" ← (default)

  • "SERVICENET"

username

string

Rackspace username, overrides credentials.

validate_certs

aliases: verify_ssl

boolean

Whether or not to require SSL validation of API endpoints.

Choices:

  • false

  • true

vip_id

string

Virtual IP ID to use when creating the load balancer for purposes of sharing an IP with another load balancer of another protocol

wait

boolean

wait for the balancer to be in state ‘running’ before returning

Choices:

  • false ← (default)

  • true

wait_timeout

integer

how long before wait gives up, in seconds

Default: 300

Notes

Note

  • The following environment variables can be used, RAX_USERNAME, RAX_API_KEY, RAX_CREDS_FILE, RAX_CREDENTIALS, RAX_REGION.

  • RAX_CREDENTIALS and RAX_CREDS_FILE points to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating

  • RAX_USERNAME and RAX_API_KEY obviate the use of a credentials file

  • RAX_REGION defines a Rackspace Public Cloud region (DFW, ORD, LON, …)

  • The following environment variables can be used, RAX_USERNAME, RAX_API_KEY, RAX_CREDS_FILE, RAX_CREDENTIALS, RAX_REGION.

  • RAX_CREDENTIALS and RAX_CREDS_FILE points to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating

  • RAX_USERNAME and RAX_API_KEY obviate the use of a credentials file

  • RAX_REGION defines a Rackspace Public Cloud region (DFW, ORD, LON, …)

Examples

- name: Build a Load Balancer
  gather_facts: false
  hosts: local
  connection: local
  tasks:
    - name: Load Balancer create request
      local_action:
        module: rax_clb
        credentials: ~/.raxpub
        name: my-lb
        port: 8080
        protocol: HTTP
        type: SERVICENET
        timeout: 30
        region: DFW
        wait: true
        state: present
        meta:
          app: my-cool-app
      register: my_lb

Authors

  • Christopher H. Laco (@claco)

  • Matt Martz (@sivel)