community.general.rax_clb – create / delete a load balancer in Rackspace Public Cloud
community.general.rax_clb – create / delete a load balancer in Rackspace Public Cloud
Note
This plugin is part of the community.general collection (version 2.0.1).
To install it use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.rax_clb
.
Synopsis
- creates / deletes a Rackspace Public 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 |
---|---|---|
algorithm string |
|
algorithm for the balancer being created |
api_key string |
Rackspace API key, overrides credentials.
| |
auth_endpoint string |
The URI of the authentication service. If not specified will be set to https://identity.api.rackspacecloud.com/v2.0/ | |
credentials path |
File to find the Rackspace credentials in. Ignored if api_key and username are provided.
| |
env string |
Environment as configured in ~/.pyrax.cfg, see https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration. | |
identity_type string |
Default: "rackspace" |
Authentication mechanism to use, such as rackspace or keystone. |
meta dictionary |
A hash of metadata to associate with the instance | |
name string / required |
Name to give the load balancer | |
port integer |
Default: 80 |
Port for the balancer being created |
protocol string |
|
Protocol for the balancer being created |
region string |
Region to create an instance in. | |
state string |
|
Indicate desired state of the resource |
tenant_id string |
The tenant ID used for authentication. | |
tenant_name string |
The tenant name used for authentication. | |
timeout integer |
Default: 30 |
timeout for communication between the balancer and the node |
type string |
|
type of interface for the balancer being created |
username string |
Rackspace username, overrides credentials. | |
validate_certs boolean |
|
Whether or not to require SSL validation of API endpoints.
|
vip_id string |
Virtual IP ID to use when creating the load balancer for purposes of sharing an IP with another load balancer of another protocol | |
wait boolean |
|
wait for the balancer to be in state 'running' before returning |
wait_timeout integer |
Default: 300 |
how long before wait gives up, in seconds |
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#authenticatingRAX_USERNAME
andRAX_API_KEY
obviate the use of a credentials fileRAX_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#authenticatingRAX_USERNAME
andRAX_API_KEY
obviate the use of a credentials fileRAX_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: yes
state: present
meta:
app: my-cool-app
register: my_lb
Authors
- Christopher H. Laco (@claco)
- Matt Martz (@sivel)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/rax_clb_module.html