os_listener - Add/Delete a listener for a load balancer from OpenStack Cloud¶

New in version 2.7.

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

Synopsis ¶

Add or Remove a listener for a 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.
loadbalancer required		The name or id of the load balancer that this listener belongs to.
name required		Name that has to be given to the listener
protocol	Choices: HTTP ← HTTPS TCP TERMINATED_HTTPS	The protocol for the listener.
protocol_port	Default: 80	The protocol port number for the listener.
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
wait bool	Choices: no yes ←	If the module should wait for the load balancer to be ACTIVE.

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 listener, wait for the loadbalancer to be active.
- os_listener:
    cloud: mycloud
    endpoint_type: admin
    state: present
    name: test-listener
    loadbalancer: test-loadbalancer
    protocol: HTTP
    protocol_port: 8080

# Create a listener, do not wait for the loadbalancer to be active.
- os_listener:
    cloud: mycloud
    endpoint_type: admin
    state: present
    name: test-listener
    loadbalancer: test-loadbalancer
    protocol: HTTP
    protocol_port: 8080
    wait: no

# Delete a listener
- os_listener:
    cloud: mycloud
    endpoint_type: admin
    state: absent
    name: test-listener
    loadbalancer: test-loadbalancer

Return Values ¶

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

Key		Returned	Description
id string		On success when state is 'present'	The listener UUID. Sample: 39007a7e-ee4f-4d13-8283-b4da2e037c69
listener complex		On success when state is 'present'	Dictionary describing the listener.
	protocol string		The protocol for the listener. Sample: HTTP
	description string		The listener description. Sample: description
	provisioning_status string		The provisioning status of the listener. Sample: ACTIVE
	loadbalancers list		A list of load balancer IDs.. Sample: [{'id': 'b32eef7e-d2a6-4ea4-a301-60a873f89b3b'}]
	load_balancer_id string		The load balancer UUID this listener belongs to. Sample: b32eef7e-d2a6-4ea4-a301-60a873f89b3b
	is_admin_state_up bool		The administrative state of the listener. Sample: True
	protocol_port int		The protocol port number for the listener. Sample: 80
	id string		Unique UUID. Sample: 39007a7e-ee4f-4d13-8283-b4da2e037c69
	operating_status string		The operating status of the listener. Sample: ONLINE
	name string		Name given to the listener. Sample: test

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.