rax_clb_nodes - add, modify and remove nodes from a Rackspace Cloud Load Balancer
New in version 1.4.
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
- python >= 2.6
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
address |
IP address or domain name of the node
|
|
api_key |
Rackspace API key, overrides
credentials.
aliases: password |
|
auth_endpoint
(added in 1.5)
|
Default:
https://identity.api.rackspacecloud.com/v2.0/
|
The URI of the authentication service.
|
condition |
|
Condition for the node, which determines its role within the load balancer
|
credentials | Default:
None
|
File to find the Rackspace credentials in. Ignored if
api_key and
username are provided.
aliases: creds_file |
env
(added in 1.5)
|
Environment as configured in
~/.pyrax.cfg, see
https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration.
|
|
identity_type
(added in 1.5)
|
Default:
rackspace
|
Authentication mechanism to use, such as rackspace or keystone.
|
load_balancer_id
required
|
Load balancer id
|
|
node_id |
Node id
|
|
port |
Port number of the load balanced service on the node
|
|
region | Default:
DFW
|
Region to create an instance in.
|
state |
|
Indicate desired state of the node
|
tenant_id
(added in 1.5)
|
The tenant ID used for authentication.
|
|
tenant_name
(added in 1.5)
|
The tenant name used for authentication.
|
|
type |
|
Type of node
|
username |
Rackspace username, overrides
credentials.
|
|
verify_ssl
(added in 1.5)
|
Whether or not to require SSL validation of API endpoints.
|
|
wait |
|
Wait for the load balancer to become active before returning
|
wait_timeout | Default:
30
|
How long to wait before giving up and returning an error
|
weight |
Weight of node
|
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
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, ...) - 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
# 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: yes credentials: /path/to/credentials # Drain connections from a node - local_action: module: rax_clb_nodes load_balancer_id: 71 node_id: 410 condition: draining wait: yes credentials: /path/to/credentials # Remove a node from the load balancer - local_action: module: rax_clb_nodes load_balancer_id: 71 node_id: 410 state: absent wait: yes credentials: /path/to/credentials
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Author
- Lukasz Kawczynski (@neuroid)
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.5/modules/rax_clb_nodes_module.html