ngine_io.cloudstack.lb_internal_member module – Manages internal load balancer members on Apache CloudStack based clouds.

Note

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

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

New in ngine_io.cloudstack 3.3.0

Synopsis

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 internal load balancer is related to.

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.

domain

string

Domain the internal load balancer is related to.

name

string / required

Name of the internal load balancer the instances are assigned to.

network

string / required

Name of the VPC tier the internal load balancer balances traffic to.

poll_async

boolean

Poll async jobs until job has finished.

Choices:

  • false

  • true ← (default)

project

string

Name of the project the internal load balancer is related to.

state

string

Whether the instances should be assigned to or removed from the internal load balancer.

Choices:

  • "present" ← (default)

  • "absent"

validate_certs

boolean

added in ngine_io.cloudstack 2.4.0

If false, SSL certificates will not be validated.

If not given, the CLOUDSTACK_DANGEROUS_NO_TLS_VERIFY env variable is considered.

This should only be used on personally controlled sites using self-signed certificates.

Choices:

  • false

  • true ← (default)

vms

aliases: vm

list / elements=string / required

List of instance names the internal load balancer balances traffic to.

vpc

string

Name of the VPC the network belongs to.

zone

string / required

Name of the zone the internal load balancer belongs to.

Notes

Note

  • The instances must be members of the same VPC tier the internal load balancer balances traffic to.

  • The InternalLbVm system instance is only deployed by CloudStack once the first member has been assigned. It can be managed using ngine_io.cloudstack.internal_lb_vm.

  • A detailed guide about cloudstack modules can be found in the CloudStack Cloud Guide.

  • This module supports check mode.

Examples

- name: Ensure instances are assigned to the internal load balancer
  ngine_io.cloudstack.lb_internal_member:
    name: web-ilb
    vpc: my-vpc
    network: web-tier
    zone: zone01
    vms:
      - web-01
      - web-02

- name: Ensure an instance is removed from the internal load balancer
  ngine_io.cloudstack.lb_internal_member:
    name: web-ilb
    vpc: my-vpc
    network: web-tier
    zone: zone01
    vm: web-02
    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 internal load balancer is related to.

Returned: when available

Sample: "example-account"

algorithm

string

Load balancing algorithm used.

Returned: success

Sample: "roundrobin"

domain

string

Domain the internal load balancer is related to.

Returned: when available

Sample: "ROOT"

id

string

UUID of the internal load balancer.

Returned: success

Sample: "a5396f25-945f-4968-854e-8400af7bee97"

instance_port

integer

Port on the balanced instances traffic is forwarded to.

Returned: success

Sample: 8080

name

string

Name of the internal load balancer.

Returned: success

Sample: "web-ilb"

network_id

string

UUID of the network the internal load balancer balances traffic to.

Returned: success

Sample: "e83f0010-4e08-493f-acc8-f5205d83b30d"

project

string

Name of the project the internal load balancer is related to.

Returned: when available

Sample: "Production"

source_ip

string

Source IP address of the internal load balancer.

Returned: success

Sample: "10.10.1.247"

source_port

integer

Source port the internal load balancer listens on.

Returned: success

Sample: 80

vms

list / elements=string

List of instance names assigned to the internal load balancer.

Returned: success

Sample: ["web-01", "web-02"]

zone

string

Name of the zone the internal load balancer belongs to.

Returned: success

Sample: "zone01"

Authors

  • Mitch Drage (@MitchDrage)