New in version 2.0.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments |
---|---|---|
account | Account the rule is related to. | |
api_http_method |
| 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 | 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 | Default: cloudstack | Name of the ini section in the cloustack.ini file.If not given, the CLOUDSTACK_REGION env variable is considered. |
api_secret | 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 | 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 | 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. | |
domain | Domain the rule is related to. | |
ip_address | Public IP address from where the network traffic will be load balanced from. Only needed to find the rule if name is not unique.aliases: public_ip | |
name required | The name of the load balancer rule. | |
project | Name of the project the firewall rule is related to. | |
state |
| Should the VMs be present or absent from the rule. |
vms required | List of VMs to assign to or remove from the rule. aliases: vm | |
zone | Name of the zone in which the rule should be located. If not set, default zone is used. |
Note
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.# Add VMs to an existing load balancer - local_action: module: cs_loadbalancer_rule_member name: balance_http vms: - web01 - web02 # Remove a VM from an existing load balancer - local_action: module: cs_loadbalancer_rule_member name: balance_http vms: - web01 - web02 state: absent # Rolling upgrade of hosts - hosts: webservers serial: 1 pre_tasks: - name: Remove from load balancer local_action: module: cs_loadbalancer_rule_member name: balance_http vm: "{{ ansible_hostname }}" state: absent tasks: # Perform update post_tasks: - name: Add to load balancer local_action: module: cs_loadbalancer_rule_member name: balance_http vm: "{{ ansible_hostname }}" state: present
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. |
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 string | 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 string | success | Public port. Sample: 80 |
state string | success | State of the rule. Sample: Add |
tags dict | success | List of resource tags associated with the rule. Sample: [ { "key": "foo", "value": "bar" } ] |
vms list | success | Rule members. Sample: [ "web01", "web02" ] |
zone string | success | Name of zone the rule is related to. Sample: ch-gva-2 |
This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/cs_loadbalancer_rule_member_module.html