IBM::ElasticLoadBalancing::Pool

This resource type represents the load balancing pool.

The blueprint uses the core properties and extended properties, if any, from this resource type. Review and configure the applicable heat resources that apply to your configuration information.

In the blueprint designer, you can configure the properties that the following table includes. Properties are listed as either core or extended. Each type of property is located in separate sections of the heat resource that you can view in the blueprint designer. You set the core properties in the properties section and set the extended properties in the metadata section of the blueprint.

Table 1. Properties
Name Type Required Core or extended Description
admin_state_up Boolean False Core The administrative state of this pool. The default value is true.
description String False Core The description of the load balancing pool.
lb_method String True Core The algorithm that is used to distribute load between the members of the pool. The following values are allowed:
  • round_robin
  • least_connections
  • source_ip
monitors List False Core The list of health monitors that are associated with the pool.
name String False Core The name of the load balancing pool.
protocol String True Core The protocol for load balancing. The following values are allowed:
  • TCP
  • HTTP
  • HTTPS
subnet String False Core The subnet for the port on which the members of the pool are connected.
subnet_id String False Core The subnet for the port on which the members of the pool are connected.
vip Map True Core The IP addresses and port numbers of the pool.
The vip parameter requires a list of addresses and ports for the pool. The following table shows the properties in each list item.
Table 2. vip list properties
Property Type Required Description
address String False The vip IP address.
admin_state_up Boolean False The vip administrative state. The default value is true.
connection_limit Integer False The maximum number of connections per second that the vip allows.
description String False The vip description.
name String False The vip name.
protocol_port Integer True The TCP port on which to listen for client traffic that is associated with the vip address.
session_persistence Map False The configuration of session persistence.
subnet String False The vip subnet.
The session_persistence parameter for the vip parameter requires a list of types. The following table shows the properties in each list item.
Table 3. session_persistence list properties
Property Type Required Description
cookie_name String False The name of the cookie, which is required if the type is app_cookie.
type String True The method of implementation of the session persistence feature. The following values are allowed:
  • source_ip
  • http_cookie
  • app_cookie
This resource type has no attributes.