opentelekomcloud.cloud.loadbalancer_info – Get load balancer info

Note

This plugin is part of the opentelekomcloud.cloud collection (version 0.9.0).

To install it use: ansible-galaxy collection install opentelekomcloud.cloud.

To use it in a playbook, specify: opentelekomcloud.cloud.loadbalancer_info.

New in version 0.0.1: of opentelekomcloud.cloud

Synopsis

• Get Enhanced Load Balancer from the OTC load-balancer service(ELB).

Requirements

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

• openstacksdk

• openstacksdk >= 0.36.0

• otcextensions

• python >= 3.6

Parameters

Parameter	Choices/Defaults	Comments
api_timeout integer		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		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 (for example, os_user_domain_name or os_project_domain_name) 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 string		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.
ca_cert string		A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert
client_cert string		A path to a client certificate to use as part of the SSL transaction. aliases: cert
client_key string		A path to a client key to use as part of the SSL transaction. aliases: key
cloud raw		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 string	Choices: admin internal public ←	Endpoint URL type to fetch from the service catalog. aliases: endpoint_type
name string		Optional name of the loadbalancer.
region_name string		Name of the region.
timeout integer	Default: 180	How long should ansible wait for the requested resource.
validate_certs boolean	Choices: no ← yes	Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to yes. aliases: verify
wait boolean	Choices: no yes ←	Should ansible wait until the requested resource is complete.

Notes

Note

• The standard OpenStack environment variables, such as OS_USERNAME may be used instead of providing explicit values.

• Auth information is driven by openstacksdk, 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 https://docs.openstack.org/openstacksdk/

Examples

# Get a load balancer by specifying the VIP subnet.
- loadbalancer_info:
    auth:
      auth_url: https://identity.example.com
      username: admin
      password: passme
      project_name: admin
    name: my_lb
  register: lb_info

Return Values

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

Key		Returned	Description
loadbalancers complex		On Success.	Dictionary describing load balancers
	id string	success	Unique UUID. Sample: 39007a7e-ee4f-4d13-8283-b4da2e037c69
	is_admin_state_up boolean	success	The administrative state of the load balancer. Sample: True
	listeners list / elements=string	success	The associated listener IDs, if any. Sample: [{'id': '7aa1b380-beec-459c-a8a7-3a4fb6d30645'}, {'id': '692d06b8-c4f8-4bdb-b2a3-5a263cc23ba6'}]
	name string	success	Name given to the load balancer. Sample: elb_test
	operating_status string	success	The operating status of the load balancer. Sample: ONLINE
	pools list / elements=string	success	The associated pool IDs, if any. Sample: [{'id': '27b78d92-cee1-4646-b831-e3b90a7fa714'}, {'id': 'befc1fb5-1992-4697-bdb9-eee330989344'}]
	provisioning_status string	success	The provisioning status of the load balancer. Sample: ACTIVE
	public_vip_address string	success	The load balancer public VIP address. Sample: 10.17.8.254
	vip_address string	success	The load balancer virutal IP address. Sample: 192.168.2.88
	vip_network_id string	success	Network ID the load balancer virutal IP port belongs to. Sample: f171db43-56fd-41cf-82d7-4e91d741762e
	vip_port_id string	success	The load balancer virutal IP port ID. Sample: 2061395c-1c01-47ab-b925-c91b93df9c1d
	vip_subnet_id string	success	Subnet ID the load balancer virutal IP port belongs to. Sample: c53e3c70-9d62-409a-9f71-db148e7aa853

Authors

• Artem Goncharov (@gtema)