ngine_io.cloudstack.cs_loadbalancer_rule module – Manages load balancer rules on Apache CloudStack based clouds.

Note

This module is part of the ngine_io.cloudstack collection (version 2.2.4).

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. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: ngine_io.cloudstack.cs_loadbalancer_rule.

New in ngine_io.cloudstack 0.1.0

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

Comments

account

string

Account the rule is related to.

algorithm

string

Load balancer algorithm

Required when using state=present.

Choices:

  • "source" ← (default)

  • "roundrobin"

  • "leastconn"

api_http_method

string

HTTP method used to query the API endpoint.

If not given, the CLOUDSTACK_METHOD env variable is considered.

Choices:

  • "get" ← (default)

  • "post"

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

HTTP timeout in seconds.

If not given, the CLOUDSTACK_TIMEOUT env variable is considered.

Default: 10

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

aliases: public_ip

string / required

Public IP address from where the network traffic will be load balanced from.

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 ngine_io.cloudstack.cs_firewall for managing firewall rules.

Choices:

  • false ← (default)

  • true

poll_async

boolean

Poll async jobs until job has finished.

Choices:

  • false

  • true ← (default)

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.

Choices:

  • "present" ← (default)

  • "absent"

tags

aliases: tag

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: [].

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

Description

account

string

Account the rule is related to.

Returned: success

Sample: "example account"

algorithm

string

Load balancer algorithm used.

Returned: success

Sample: "source"

cidr

string

CIDR to forward traffic from.

Returned: success

Sample: "0.0.0.0/0"

description

string

Description of the rule.

Returned: success

Sample: "http load balancer rule"

domain

string

Domain the rule is related to.

Returned: success

Sample: "example domain"

id

string

UUID of the rule.

Returned: success

Sample: "a6f7a5fc-43f8-11e5-a151-feff819cdc9f"

name

string

Name of the rule.

Returned: success

Sample: "http-lb"

private_port

integer

Private IP address.

Returned: success

Sample: 80

project

string

Name of project the rule is related to.

Returned: success

Sample: "Production"

protocol

string

Protocol of the rule.

Returned: success

Sample: "tcp"

public_ip

string

Public IP address.

Returned: success

Sample: "1.2.3.4"

public_port

integer

Public port.

Returned: success

Sample: 80

state

string

State of the rule.

Returned: success

Sample: "Add"

tags

list / elements=string

List of resource tags associated with the rule.

Returned: success

Sample: ["[ { \"key\": \"foo\"", " \"value\": \"bar\" } ]"]

zone

string

Name of zone the rule is related to.

Returned: success

Sample: "ch-gva-2"

Authors

  • Darren Worrall (@dazworrall)

  • René Moser (@resmo)