Documentation

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 (on host that executes module)

  • python >= 2.6
  • pyrax

Options

parameter required default choices comments
address
 no
    IP address or domain name of the node
    api_key
    		 no
      Rackspace API key (overrides credentials)

      aliases: password
      condition
      		 no
      • enabled
      • disabled
      • draining
      Condition for the node, which determines its role within the load balancer
      credentials
      		 no
        File to find the Rackspace credentials in (ignored if api_key and username are provided)

        aliases: creds_file
        env
        (added in 1.5)
        		 no
          load_balancer_id
          		 yes
            Load balancer id
            node_id
            		 no
              Node id
              port
              		 no
                Port number of the load balanced service on the node
                region
                		 no DFW
                  Region to create an instance in
                  state
                  		 no present
                  • present
                  • absent
                  Indicate desired state of the node
                  type
                  		 no
                  • primary
                  • secondary
                  Type of node
                  username
                  		 no
                    Rackspace username (overrides credentials)
                    verify_ssl
                    (added in 1.5)
                    		 no
                      Whether or not to require SSL validation of API endpoints
                      wait
                      		 no no
                      • yes
                      • no
                      Wait for the load balancer to become active before returning
                      wait_timeout
                      		 no 30
                        How long to wait before giving up and returning an error
                        weight
                        		 no
                          Weight of node

                          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

                          Notes

                          Note

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

                          Note

                          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

                          Note

                          RAX_USERNAME and RAX_API_KEY obviate the use of a credentials file

                          Note

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

                          This is a Core Module

                          For more information on what this means please read Core Modules

                          For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.