gtm pool object definition¶

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

The physical and logical object relationships that describe the

gtm pool

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

Property

Value

Host

device <dco_device_object.html> __

Parent

gtm pool virtual server

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.

Fallbacks (avg/sec)
Preferred (avg/sec)
Dropped (avg/sec)

Create and Delete

CreateGTM Pool, DeleteGTM Pool

Events

Availability Change

Related objects

device <dco_device_object.html> __, gtm pool virtual server

Properties¶

This table lists properties available for the

gtm pool

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

get_all_statistics	Gets the statistics for all the pools.
get_enabled_state	Gets the enabled state of the specified pools.
get_limit	Gets all metrics limits for a sequence of pools.
get_list	Gets a list of pools.
get_member	This method was deprecated because of changing pool member keys. Please use get_member_v2 instead. Gets a list of pool members.
get_member_enabled_state	Gets the enabled states for the specified members of the specified pools.
get_member_limit	Gets the metric limits for the specified members of the specified pools.
get_member_object_status	Gets the statuses for the specified members of the specified pools.
get_member_order	Gets the orders for the specified members of the specified pools.
get_member_ratio	Gets the ratios for the specified members of the specified pools.
get_member_statistics	Gets the statistics for the specified members of the specified pools.
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_enabled_state	Sets the enabled state of the specified pools.
set_limit	Sets the limits for pool metrics.
set_member_enabled_state	Sets the enabled states for the specified members of the specified pools.
set_member_limit	Sets the metric limits for the specified members of the specified pools.
set_member_ratio	Sets the ratios for the specified members of the specified pools.

Methods¶

This table lists methods available for the

gtm pool

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

Method	Description
add_member	This method was deprecated due to changing pool member keys. Please use add_member_v2 instead. Adds members to the specified pools. Note: as of version 10.1.0, the members are reordered starting with 0, with no gaps, so the system maintains the relative order but not the absolute numbers originally specified for ordering.
create	This method was deprecated due to changing the pool member keys. Please use create_v2 instead. Creates the specified pools. Note: as of version 10.1.0, the members are reordered starting with 0, with no gaps, so the system maintains the relative order but not the absolute numbers originally specified for ordering.
delete_all_pools	Deletes all pools.
delete_pool	Deletes the specified pools.
remove_all_member_dependencies	Removes all virtual servers on which the specified members of the specified pools depend.
remove_all_members	Removes all members from the specified pools.
remove_member	This method was deprecated due to changing pool member keys. Please use remove_member_v2 instead. 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_statistics	Resets the statistics for the specified pools.