cs_loadbalancer_rule – Manages load balancer rules on Apache CloudStack based clouds

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.6.10

Parameters

Parameter Choices/Defaults Comments
account
string
Account the rule is related to.
algorithm
string
    Choices:
  • source ←
  • roundrobin
  • leastconn
Load balancer algorithm
Required when using state=present.
api_http_method
string
    Choices:
  • get
  • post
HTTP method used to query the API endpoint.
If not given, the CLOUDSTACK_METHOD env variable is considered.
As the last option, the value is taken from the ini config file, also see the notes.
Fallback value is get if not specified.
api_key
string
API key of the CloudStack API.
If not given, the CLOUDSTACK_KEY env variable is considered.
As the last option, the value is taken from the ini config file, also see the notes.
api_region
string
Default:
"cloudstack"
Name of the ini section in the cloustack.ini file.
If not given, the CLOUDSTACK_REGION env variable is considered.
api_secret
string
Secret key of the CloudStack API.
If not set, the CLOUDSTACK_SECRET env variable is considered.
As the last option, the value is taken from the ini config file, also see the notes.
api_timeout
integer
HTTP timeout in seconds.
If not given, the CLOUDSTACK_TIMEOUT env variable is considered.
As the last option, the value is taken from the ini config file, also see the notes.
Fallback value is 10 seconds if not specified.
api_url
string
URL of the CloudStack API e.g. https://cloud.example.com/client/api.
If not given, the CLOUDSTACK_ENDPOINT env variable is considered.
As the last option, the value is taken from the ini config file, also see the notes.
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
added in 2.9
Name of the network.
open_firewall
boolean
    Choices:
  • no ←
  • yes
Whether the firewall rule for public port should be created, while creating the new rule.
Use cs_firewall for managing firewall rules.
poll_async
boolean
    Choices:
  • no
  • yes ←
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 / required
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
    Choices:
  • present ←
  • absent
State of the rule.
tags
list
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
added in 2.9
Name of the VPC.
zone
string
Name of the zone in which the rule should be created.
If not set, default zone is used.

Notes

Note

  • Ansible uses the cs library’s configuration method if credentials are not provided by the arguments api_url, api_key, api_secret. Configuration is read from several locations, in the following order. The CLOUDSTACK_ENDPOINT, CLOUDSTACK_KEY, CLOUDSTACK_SECRET and CLOUDSTACK_METHOD. CLOUDSTACK_TIMEOUT environment variables. A CLOUDSTACK_CONFIG environment variable pointing to an .ini file. A cloudstack.ini file in the current working directory. A .cloudstack.ini file in the users home directory. Optionally multiple credentials and endpoints can be specified using ini sections in cloudstack.ini. Use the argument api_region to select the section name, default section is cloudstack. See https://github.com/exoscale/cs for more information.

  • 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
  cs_loadbalancer_rule:
    name: balance_http
    public_ip: 1.2.3.4
    algorithm: leastconn
    public_port: 80
    private_port: 8080
  delegate_to: localhost

- name: Update algorithm of an existing load balancer rule
  cs_loadbalancer_rule:
    name: balance_http
    public_ip: 1.2.3.4
    algorithm: roundrobin
    public_port: 80
    private_port: 8080
  delegate_to: localhost

- name: Delete a load balancer rule
  cs_loadbalancer_rule:
    name: balance_http
    public_ip: 1.2.3.4
    state: absent
  delegate_to: localhost

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
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


Status

Authors

  • Darren Worrall (@dazworrall)

  • René Moser (@resmo)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.