Developer Documentation

LBPoolMember

Pool member.


Properties

Required Property Name Type Description
optional admin_state string

Member admin state.

optional backup_member boolean

Backup servers are typically configured with a sorry page indicating to the user that the application is currently unavailable. While the pool is active (a specified minimum number of pool members are active) BACKUP members are skipped during server selection. When the pool is inactive, incoming connections are sent to only the BACKUP member(s).

optional display_name string

Pool member name.

required ip_address string

Pool member IP address.

optional max_concurrent_connections integer

To ensure members are not overloaded, connections to a member can be capped by the load balancer. When a member reaches this limit, it is skipped during server selection. If it is not specified, it means that connections are unlimited.

optional port string

If port is specified, all connections will be sent to this port. Only single port is supported. If unset, the same port the client connected to will be used, it could be overrode by default_pool_member_port setting in virtual server. The port should not specified for port range case.

optional weight integer

Pool member weight is used for WEIGHTED_ROUND_ROBIN balancing algorithm. The weight value would be ignored in other algorithms.

Property of


LBPool
Feedback

Was this page helpful?