ltm pool object definition¶

iControl Wiki Home :: DCO Home Page :: DCO Health Model :: ltm object :: ltm pool object definition

The physical and logical object relationships that describe the

ltm pool

object’s role in the DCO health model are defined here.

Property

Value

Host

virtual server

Parent

ltm virtual server

Child

ltm pool member

Health

State Indicator: **Mo

nitor Status** ` <https://devcentral.f5.com/wiki /iControl..ashx>`__ Up a nd available ` <https://devcentral.f5.com/wiki /iControl..ashx>`__ No m onitor associated with the object ; or the object is unknown (objec t would be blue or yellow in the BIG-IP Configuration utility) ` <https://devcentral.f5.com/wiki /iControl..ashx>`__ Obje ct is disabled or marked down by a monitor (object would appear bl ack or red in the BIG-IP Configur ation utility) ================================= ============================ ==== ================================= ================================= ================================= =============================

Statistics

The statistics available for this object are listed here.

Bytes In (avg/sec)
Bytes Out (avg/sec)
Packets In (avg/sec)
Packets Out (avg/sec)
Maximum Connections (avg/sec)
Total Connections (avg/sec)
Current Connections

Create and Delete

CreatePool, DeletePool

Related objects

ltm virtual server, ltm pool member

Properties¶

This table lists properties available for the

ltm pool

object. For API reference information, click the property name.

get_all_statistics	Gets the statistics for all the pools.
get_list	Gets a list of all pools.
get_member	This method has been deprecated, due to the change in pool member key definitions. Please use get_member_v2. Gets a list of pool members.
get_member_connection_limit	Gets the connection limits for a set of pool members.
get_member_dynamic_ratio	Gets the dynamic ratios for a set of pool members.
get_member_monitor_status	Gets the monitor/availability status for the specified pool members.
get_member_object_status	Gets the object statuses for a set of pool members.
get_member_priority	Gets the priorities for a set of pool members.
get_member_ratio	Gets the ratios for a set of pool members.
get_member_session_status	Gets the session status for a set of pool members.
get_member_statistics	Gets the statistics for the specified set of pool members.
get_monitor_association	Gets the monitor associations for the specified pools, that is, the monitor rules used by the pools.
get_object_status	Gets the statuses of the specified pools.
get_statistics	Gets the statistics for the specified pools.
set_member_priority	Sets the priorities for a set of pool members.
set_member_ratio	Sets the ratios for a set of pool members.
set_member_session_enabled_state	Sets the session states for a set of pool members. If session state is enabled or true, then new sessions are allowed to be established with the pool members.
set_monitor_association	Sets/creates the monitor associations for the specified pools. This creates the monitor associations between a pool and a monitor rule.

Methods¶

This table lists methods available for the

ltm pool

object. For API reference information, click the method name.

Method	Description
add_member	This method has been deprecated, because of the change in pool member key definitions. Please use add_member_v2. Adds members to the specified pools.
create	This method has been deprecated, because of the change in pool member key definitions. Please use create_v2. Creates a new pool.
delete_all_pools	Deletes all pools.
delete_pool	Deletes the specified pools.
remove_member	This method has been deprecated, because of the change in pool member key definitions. Please use remove_member_v2. Removes members from the specified pools.
remove_monitor_association	Removes the monitor associations for the specified pools. This deletes the monitor associations between a pool and a monitor rule, that is, the specified pools are no longer monitored.
reset_member_statistics	Resets the statistics for a set of pool members.
reset_statistics	Resets the statistics for the specified pools.