os_loadbalancer - Add/Delete load balancer from OpenStack Cloud¶

New in version 2.7.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
Maintenance
- Author

Synopsis ¶

Add or Remove load balancer from the OpenStack load-balancer service.

Requirements ¶

The below requirements are needed on the host that executes this module.

openstacksdk
python >= 2.7

Parameters ¶

Parameter	Choices/Defaults	Comments
api_timeout		How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library.
auth		Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth_url, username, password, project_name and any information about domains if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS_* environment variables are present.
auth_type		Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly.
availability_zone		Ignored. Present for backwards compatibility
cacert		A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
cert		A path to a client certificate to use as part of the SSL transaction.
cloud		Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth_type. This parameter is not needed if auth is provided or if OpenStack OS_* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml.
interface (added in 2.3)	Choices: public ← internal admin	Endpoint URL type to fetch from the service catalog. aliases: endpoint_type
key		A path to a client key to use as part of the SSL transaction.
name required		Name that has to be given to the load balancer
region_name		Name of the region.
state	Choices: present ← absent	Should the resource be present or absent.
timeout	Default: 180	The amount of time the module should wait for the load balancer to get into ACTIVE state.
verify bool	Choices: no yes	Whether or not SSL API requests should be verified. Before 2.3 this defaulted to True. aliases: validate_certs
vip_address		IP address of the load balancer virtual IP.
vip_network		The name or id of the network for the virtual IP of the load balancer. One of vip_network, vip_subnet, or vip_port must be specified.
vip_port		The name or id of the load balancer virtual IP port. One of vip_network, vip_subnet, or vip_port must be specified.
vip_subnet		The name or id of the subnet for the virtual IP of the load balancer. One of vip_network, vip_subnet, or vip_port must be specified.
wait bool	Choices: no yes ←	If the module should wait for the load balancer to be created.

Notes ¶

Note

The standard OpenStack environment variables, such as OS_USERNAME may be used instead of providing explicit values.
Auth information is driven by os-client-config, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at http://docs.openstack.org/developer/os-client-config

Examples ¶

# Create a load balancer by specifying the VIP subnet.
- os_loadbalancer:
    auth:
      auth_url: https://identity.example.com
      username: admin
      password: passme
      project_name: admin
    state: present
    name: my_lb
    vip_subnet: my_subnet
    timeout: 150

# Create a load balancer by specifying the VIP network and the IP address.
- os_loadbalancer:
    auth:
      auth_url: https://identity.example.com
      username: admin
      password: passme
      project_name: admin
    state: present
    name: my_lb
    vip_network: my_network
    vip_address: 192.168.0.11

Return Values ¶

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
id string	success	Unique UUID.
is_admin_state_up bool	success	The administrative state of the load balancer.
listeners list	success	The associated listener IDs, if any.
name string	success	Name given to the load balancer.
operating_status string	success	The operating status of the load balancer.
pools list	success	The associated pool IDs, if any.
provisioning_status string	success	The provisioning status of the load balancer.
vip_address string	success	The load balancer virutal IP address.
vip_network_id string	success	Network ID the load balancer virutal IP port belongs in.
vip_port_id string	success	The load balancer virutal IP port ID.
vip_subnet_id string	success	Subnet ID the load balancer virutal IP port belongs in.

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance ¶

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.

Author ¶

Lingxian Kong (@lingxiankong)

Hint

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