ngine_io.cloudstack.cs_loadbalancer_rule – Manages load balancer rules on Apache CloudStack based clouds.
Note
This plugin is part of the ngine_io.cloudstack collection (version 2.2.2).
You might already have this collection installed if you are using the ansible package. 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 ngine_io.cloudstack.
To use it in a playbook, specify: ngine_io.cloudstack.cs_loadbalancer_rule.
New in version 0.1.0: of ngine_io.cloudstack
Synopsis
- Add, update and remove load balancer rules.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.6
- cs >= 0.9.0
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| account
string
|
Account the rule is related to.
|
|
| algorithm
string
|
|
Load balancer algorithm
Required when using state=present.
|
| api_http_method
string
|
|
HTTP method used to query the API endpoint.
If not given, the CLOUDSTACK_METHOD env variable is considered.
|
| api_key
string / required
|
API key of the CloudStack API.
If not given, the CLOUDSTACK_KEY env variable is considered.
|
|
| api_secret
string / required
|
Secret key of the CloudStack API.
If not set, the CLOUDSTACK_SECRET env variable is considered.
|
|
| api_timeout
integer
|
Default:
10
|
HTTP timeout in seconds.
If not given, the CLOUDSTACK_TIMEOUT env variable is considered.
|
| api_url
string / required
|
URL of the CloudStack API e.g. https://cloud.example.com/client/api.
If not given, the CLOUDSTACK_ENDPOINT env variable is considered.
|
|
| api_verify_ssl_cert
string
|
Verify CA authority cert file.
If not given, the CLOUDSTACK_VERIFY env variable is considered.
|
|
| cidr
string
|
CIDR (full notation) to be used for firewall rule if required.
|
|
| description
string
|
The description of the load balancer rule.
|
|
| domain
string
|
Domain the rule is related to.
|
|
| ip_address
string / required
|
Public IP address from where the network traffic will be load balanced from.
aliases: public_ip |
|
| name
string / required
|
The name of the load balancer rule.
|
|
| network
string
|
Name of the network.
|
|
| open_firewall
boolean
|
|
Whether the firewall rule for public port should be created, while creating the new rule.
Use M(cs_firewall) for managing firewall rules.
|
| poll_async
boolean
|
|
Poll async jobs until job has finished.
|
| private_port
integer
|
The private port of the private ip address/virtual machine where the network traffic will be load balanced to.
Required when using state=present.
Can not be changed once the rule exists due API limitation.
|
|
| project
string
|
Name of the project the load balancer IP address is related to.
|
|
| protocol
string
|
The protocol to be used on the load balancer
|
|
| public_port
integer
|
The public port from where the network traffic will be load balanced from.
Required when using state=present.
Can not be changed once the rule exists due API limitation.
|
|
| state
string
|
|
State of the rule.
|
| tags
list / elements=dictionary
|
List of tags. Tags are a list of dictionaries having keys key and value.
To delete all tags, set a empty list e.g. tags: [].
aliases: tag |
|
| vpc
string
|
Name of the VPC.
|
|
| zone
string
|
Name of the zone in which the rule should be created.
Required when the LB provider is ElasticLoadBalancerVm
|
Notes
Note
- A detailed guide about cloudstack modules can be found in the CloudStack Cloud Guide.
- This module supports check mode.
Examples
- name: Create a load balancer rule
ngine_io.cloudstack.cs_loadbalancer_rule:
name: balance_http
public_ip: 1.2.3.4
algorithm: leastconn
public_port: 80
private_port: 8080
- name: Update algorithm of an existing load balancer rule
ngine_io.cloudstack.cs_loadbalancer_rule:
name: balance_http
public_ip: 1.2.3.4
algorithm: roundrobin
public_port: 80
private_port: 8080
- name: Delete a load balancer rule
ngine_io.cloudstack.cs_loadbalancer_rule:
name: balance_http
public_ip: 1.2.3.4
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| account
string
|
success |
Account the rule is related to.
Sample:
example account
|
| algorithm
string
|
success |
Load balancer algorithm used.
Sample:
source
|
| cidr
string
|
success |
CIDR to forward traffic from.
Sample:
0.0.0.0/0
|
| description
string
|
success |
Description of the rule.
Sample:
http load balancer rule
|
| domain
string
|
success |
Domain the rule is related to.
Sample:
example domain
|
| id
string
|
success |
UUID of the rule.
Sample:
a6f7a5fc-43f8-11e5-a151-feff819cdc9f
|
| name
string
|
success |
Name of the rule.
Sample:
http-lb
|
| private_port
integer
|
success |
Private IP address.
Sample:
80
|
| project
string
|
success |
Name of project the rule is related to.
Sample:
Production
|
| protocol
string
|
success |
Protocol of the rule.
Sample:
tcp
|
| public_ip
string
|
success |
Public IP address.
Sample:
1.2.3.4
|
| public_port
integer
|
success |
Public port.
Sample:
80
|
| state
string
|
success |
State of the rule.
Sample:
Add
|
| tags
list / elements=string
|
success |
List of resource tags associated with the rule.
Sample:
[ { "key": "foo", "value": "bar" } ]
|
| zone
string
|
success |
Name of zone the rule is related to.
Sample:
ch-gva-2
|
Authors
- Darren Worrall (@dazworrall)
- René Moser (@resmo)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ngine_io/cloudstack/cs_loadbalancer_rule_module.html