community.general.rax_clb_nodes (6.6.8) — module

Install collection

Install with ansible-galaxy collection install community.general:==6.6.8

Add to requirements.yml

  collections:
    - name: community.general
      version: 6.6.8

Description

Adds, modifies and removes nodes from a Rackspace Cloud Load Balancer.

This module relies on the C(pyrax) package which is deprecated in favour of using Openstack API.

Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0.

Requirements

• pyrax
• python >= 2.6

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

    
env:
    description:
    - Environment as configured in I(~/.pyrax.cfg), see U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration).
    type: str

port:
    description:
    - Port number of the load balanced service on the node
    required: false
    type: int

type:
    choices:
    - primary
    - secondary
    description:
    - Type of node
    required: false
    type: str

wait:
    default: false
    description:
    - Wait for the load balancer to become active before returning
    required: false
    type: bool

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Indicate desired state of the node
    required: false
    type: str

region:
    description:
    - Region to create an instance in.
    type: str

weight:
    description:
    - Weight of node
    required: false
    type: int

address:
    description:
    - IP address or domain name of the node
    required: false
    type: str

api_key:
    aliases:
    - password
    description:
    - Rackspace API key, overrides I(credentials).
    type: str

node_id:
    description:
    - Node id
    required: false
    type: int

username:
    description:
    - Rackspace username, overrides I(credentials).
    type: str

condition:
    choices:
    - enabled
    - disabled
    - draining
    description:
    - Condition for the node, which determines its role within the load balancer
    required: false
    type: str

tenant_id:
    description:
    - The tenant ID used for authentication.
    type: str

virtualenv:
    description:
    - Virtualenv to execute this module in
    type: path

credentials:
    aliases:
    - creds_file
    description:
    - File to find the Rackspace credentials in. Ignored if I(api_key) and I(username)
      are provided.
    type: path

tenant_name:
    description:
    - The tenant name used for authentication.
    type: str

wait_timeout:
    default: 30
    description:
    - How long to wait before giving up and returning an error
    required: false
    type: int

auth_endpoint:
    description:
    - The URI of the authentication service.
    - If not specified will be set to U(https://identity.api.rackspacecloud.com/v2.0/)
    type: str

identity_type:
    default: rackspace
    description:
    - Authentication mechanism to use, such as rackspace or keystone.
    type: str

validate_certs:
    aliases:
    - verify_ssl
    description:
    - Whether or not to require SSL validation of API endpoints.
    type: bool

load_balancer_id:
    description:
    - Load balancer id
    required: true
    type: int