community.general.rax_clb_nodes module – Add, modify and remove nodes from a Rackspace Cloud Load Balancer
Note
This module is part of the community.general collection (version 6.6.9).
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_nodes
.
DEPRECATED
- Removed in:
version 9.0.0
- Why:
This module relies on the deprecated package pyrax.
- Alternative:
Use the Openstack modules instead.
Synopsis
Adds, modifies and removes nodes from a Rackspace Cloud Load Balancer
Requirements
The below requirements are needed on the host that executes this module.
pyrax
Parameters
Parameter |
Comments |
---|---|
IP address or domain name of the node |
|
Rackspace API key, overrides |
|
The URI of the authentication service. If not specified will be set to https://identity.api.rackspacecloud.com/v2.0/. |
|
Condition for the node, which determines its role within the load balancer Choices:
|
|
Environment as configured in |
|
Authentication mechanism to use, such as rackspace or keystone. Default: |
|
Load balancer id |
|
Node id |
|
Port number of the load balanced service on the node |
|
Region to create an instance in. |
|
Indicate desired state of the node Choices:
|
|
The tenant ID used for authentication. |
|
The tenant name used for authentication. |
|
Type of node Choices:
|
|
Rackspace username, overrides |
|
Whether or not to require SSL validation of API endpoints. Choices:
|
|
Virtualenv to execute this module in |
|
Wait for the load balancer to become active before returning Choices:
|
|
How long to wait before giving up and returning an error Default: |
|
Weight of node |
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: Add a new node to the load balancer
local_action:
module: rax_clb_nodes
load_balancer_id: 71
address: 10.2.2.3
port: 80
condition: enabled
type: primary
wait: true
credentials: /path/to/credentials
- name: Drain connections from a node
local_action:
module: rax_clb_nodes
load_balancer_id: 71
node_id: 410
condition: draining
wait: true
credentials: /path/to/credentials
- name: Remove a node from the load balancer
local_action:
module: rax_clb_nodes
load_balancer_id: 71
node_id: 410
state: absent
wait: true
credentials: /path/to/credentials
Status
This module will be removed in version 9.0.0. [deprecated]
For more information see DEPRECATED.