rax_clb – create / delete a load balancer in Rackspace Public Cloud

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	Choices/Defaults	Comments
algorithm -	Choices: RANDOM LEAST_CONNECTIONS ← ROUND_ROBIN WEIGHTED_LEAST_CONNECTIONS WEIGHTED_ROUND_ROBIN	algorithm for the balancer being created
api_key string		Rackspace API key, overrides credentials. aliases: password
auth_endpoint -	Default: "https://identity.api.rackspacecloud.com/v2.0/"	The URI of the authentication service.
credentials path		File to find the Rackspace credentials in. Ignored if api_key and username are provided. aliases: creds_file
env string		Environment as configured in ~/.pyrax.cfg, see https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration.
identity_type -	Default: "rackspace"	Authentication mechanism to use, such as rackspace or keystone.
meta -		A hash of metadata to associate with the instance
name -		Name to give the load balancer
port -	Default: 80	Port for the balancer being created
protocol -	Choices: DNS_TCP DNS_UDP FTP HTTP ← HTTPS IMAPS IMAPv4 LDAP LDAPS MYSQL POP3 POP3S SMTP TCP TCP_CLIENT_FIRST UDP UDP_STREAM SFTP	Protocol for the balancer being created
region string	Default: "DFW"	Region to create an instance in.
state -	Choices: present ← absent	Indicate desired state of the resource
tenant_id -		The tenant ID used for authentication.
tenant_name -		The tenant name used for authentication.
timeout -	Default: 30	timeout for communication between the balancer and the node
type -	Choices: PUBLIC ← SERVICENET	type of interface for the balancer being created
username string		Rackspace username, overrides credentials.
validate_certs boolean	Choices: no yes	Whether or not to require SSL validation of API endpoints. aliases: verify_ssl
vip_id -		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	Choices: no ← yes	wait for the balancer to be in state 'running' before returning
wait_timeout -	Default: 300	how long before wait gives up, in seconds

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: yes
        state: present
        meta:
          app: my-cool-app
      register: my_lb

Status

This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]

Authors

Christopher H. Laco (@claco)
Matt Martz (@sivel)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/rax_clb_module.html

Docs

Docs4dev

Title here