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 8.6.8).
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
.
DEPRECATED
- Removed in:
version 9.0.0
- Why:
This module relies on the deprecated package pyrax.
- Alternative:
Use the Openstack modules instead.
Synopsis
creates / deletes a Rackspace Public Cloud load balancer.
Aliases: cloud.rackspace.rax_clb
Requirements
The below requirements are needed on the host that executes this module.
pyrax
Parameters
Parameter |
Comments |
---|---|
algorithm for the balancer being created Choices:
|
|
Rackspace API key, overrides |
|
The URI of the authentication service. If not specified will be set to https://identity.api.rackspacecloud.com/v2.0/. |
|
Environment as configured in |
|
Authentication mechanism to use, such as rackspace or keystone. Default: |
|
A hash of metadata to associate with the instance Default: |
|
Name to give the load balancer |
|
Port for the balancer being created Default: |
|
Protocol for the balancer being created Choices:
|
|
Region to create an instance in. |
|
Indicate desired state of the resource Choices:
|
|
The tenant ID used for authentication. |
|
The tenant name used for authentication. |
|
timeout for communication between the balancer and the node Default: |
|
type of interface for the balancer being created Choices:
|
|
Rackspace username, overrides |
|
Whether or not to require SSL validation of API endpoints. Choices:
|
|
Virtual IP ID to use when creating the load balancer for purposes of sharing an IP with another load balancer of another protocol |
|
wait for the balancer to be in state ‘running’ before returning Choices:
|
|
how long before wait gives up, in seconds Default: |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: none |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Notes
Note
The following environment variables can be used,
RAX_USERNAME
,RAX_API_KEY
,RAX_CREDS_FILE
,RAX_CREDENTIALS
,RAX_REGION
.RAX_CREDENTIALS
andRAX_CREDS_FILE
point to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating.RAX_USERNAME
andRAX_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
andRAX_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
andRAX_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
Status
This module will be removed in version 9.0.0. [deprecated]
For more information see DEPRECATED.