LocalLB::Pool¶
Introduced : BIG-IP_v9.0
The Pool interface enables you to work with attributes, and statistics
for pools. You can also use this interface to create pools, add
members to a pool, delete members from a pool, find out the load
balancing mode for a pool, and set the load balancing mode for a pool.
Methods¶
| Method | Description | Introduced |
| add_member | This method has been deprecated, due to the change in pool member key definitions. Please use add_member_v2. Adds members to the specified pools. | BIG-IP_v9.0 |
| add_member_metadata | Adds the metadata for the specified pool members. For definition of the metadata, refer to the get_member_metadata method description. | BIG-IP_v11.2.0 |
| add_member_profile | Adds profiles to the specified pool members. Note: As of version 11.0.0, the system supports adding profiles to pool members only if the pool member does not inherit from the pool (so one must use set_member_inherit_profile_state to set a pool member not to inherit before using add_member_profile. In the future this constraint may be removed. Note: As of version 11.0.0, the system allows just one profile per pool member. In the future this constraint may be removed. | BIG-IP_v11.0.0 |
| add_member_v2 | Adds members to the specified pools. | BIG-IP_v11.0.0 |
| add_metadata | Adds the metadata for the specified pools. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| add_profile | Adds profiles to the specified pools. | BIG-IP_v11.0.0 |
| create | This method has been deprecated, due to the change in pool member key definitions. Please use create_v2. Creates a new pool. | BIG-IP_v9.0 |
| create_v2 | Creates a new pool. | BIG-IP_v11.0.0 |
| delete_all_pools | Deletes all pools. | BIG-IP_v9.0 |
| delete_persistence_record | Deletes the persistence records based on the specified persistent modes for the specified pools. | BIG-IP_v9.0 |
| delete_pool | Deletes the specified pools. | BIG-IP_v9.0 |
| get_action_on_service_down | Gets the action to take when the node goes down for the specified pools. | BIG-IP_v9.0 |
| get_active_member_count | Gets the current active member counts for the specified pools. | BIG-IP_v9.0 |
| get_aggregate_dynamic_ratio | Gets the aggregate dynamic ratio values from all the members of the pools. | BIG-IP_v9.0 |
| get_all_member_statistics | Gets the statistics for all pool members of the specified pools. | BIG-IP_v11.0.0 |
| get_all_statistics | Gets the statistics for all the pools. | BIG-IP_v9.0 |
| get_allow_nat_state | Gets the states indicating whether NATs are allowed for the specified pools. | BIG-IP_v9.0 |
| get_allow_snat_state | Gets the states indicating whether SNATs are allowed for the specified pools. | BIG-IP_v9.0 |
| get_client_ip_tos | Gets the IP ToS values for client traffic for the specified pools. | BIG-IP_v9.0 |
| get_client_link_qos | Gets the link QoS values for client traffic for the specified pools. | BIG-IP_v9.0 |
| get_description | Gets the descriptions for a set of pools. | BIG-IP_v11.0.0 |
| get_gateway_failsafe_device | Gets the gateway failsafe devices for the specified pools. | BIG-IP_v11.0.0 |
| get_gateway_failsafe_unit_id | This method has been deprecated (immediately), due to introduction of device names instead of unit IDs. Please use get_gateway_failsafe_device. Gets the gateway failsafe unit IDs for the specified pools. | BIG-IP_v9.0 |
| get_ignore_persisted_weight_state | Gets the states ignoring the weight of persistence entries being used in load balancing decisions for the specified pools. | BIG-IP_v11.0.0 |
| get_lb_method | Gets the load balancing methods for the specified pools. | BIG-IP_v9.0 |
| get_list | Gets a list of all pools. | BIG-IP_v9.0 |
| 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. | BIG-IP_v9.0 |
| get_member_address | Gets the addresses for a set of pool members. | BIG-IP_v11.2.0 |
| get_member_connection_limit | Gets the connection limits for a set of pool members. | BIG-IP_v11.0.0 |
| get_member_description | Gets the descriptions for a set of pool members. | BIG-IP_v11.0.0 |
| get_member_dynamic_ratio | Gets the dynamic ratios for a set of pool members. | BIG-IP_v11.0.0 |
| get_member_inherit_profile_state | Gets the state indicating that a pool member inherits profiles from the parent pool, for the specified set of pool members. | BIG-IP_v11.0.0 |
| get_member_metadata | Gets the user metadata for the specified pool members. User metadata, also metadata for short, is mainly a name/value pair that is associated with a metadata capable config (MCC) object. Some exmaples of MCC objects are ltm pool and virtual server. The combination of the MCC object name and the metadata name uniguely identify an instance of the metadata. One MCC object may have multiple instances of metadata associated with it. In addition to name/value pair, metadata also has a persistence attribute. See Common::MetadataPersistence for its definition. | BIG-IP_v11.2.0 |
| get_member_metadata_description | Gets the metadata descriptions for the specified metadata. For definition of the metadata, refer to the get_member_metadata method description. | BIG-IP_v11.2.0 |
| get_member_metadata_persistence | Gets the persistence for the specified metadata. For definition of the metadata, refer to the get_member_metadata method description. | BIG-IP_v11.2.0 |
| get_member_metadata_value | Gets the metadata values for the specified metadata. For definition of the metadata, refer to the get_member_metadata method description. | BIG-IP_v11.2.0 |
| get_member_monitor_instance | Gets the monitor instance information for the pool members in the specified pools. | BIG-IP_v11.0.0 |
| get_member_monitor_logging_state | Returns the pool members&apos monitor logging state. | BIG-IP_v11.5.0 |
| get_member_monitor_rule | Gets the monitor rules used by the specified pool members. | BIG-IP_v11.0.0 |
| get_member_monitor_status | Gets the monitor/availability status for the specified pool members. | BIG-IP_v11.0.0 |
| get_member_object_status | Gets the object statuses for a set of pool members. | BIG-IP_v11.0.0 |
| get_member_priority | Gets the priorities for a set of pool members. | BIG-IP_v11.0.0 |
| get_member_profile | Gets the lists of profiles for the specified pool members. | BIG-IP_v11.0.0 |
| get_member_rate_limit | Gets the rate limit for a set of pool members. | BIG-IP_v11.2.1 |
| get_member_ratio | Gets the ratios for a set of pool members. | BIG-IP_v11.0.0 |
| get_member_session_status | Gets the session status for a set of pool members. | BIG-IP_v11.0.0 |
| get_member_statistics | Gets the statistics for the specified set of pool members. | BIG-IP_v11.0.0 |
| get_member_traffic_acceleration_status | Gets the traffic acceleration status of the specified pool members, which specifies whether the pool member is in use by traffic acceleration. | BIG-IP_v13.0.0 |
| get_member_v2 | Gets a list of pool members. | BIG-IP_v11.0.0 |
| get_metadata | Gets the user metadata for the specified pools. User metadata, also metadata for short, is mainly a name/value pair that is associated with a metadata capable config (MCC) object. Some exmaples of MCC objects are ltm pool and virtual server. The combination of the MCC object name and the metadata name uniguely identify an instance of the metadata. One MCC object may have multiple instances of metadata associated with it. In addition to name/value pair, metadata also has a persistence attribute. See Common::MetadataPersistence for its definition. | BIG-IP_v11.2.0 |
| get_metadata_description | Gets the metadata descriptions for the specified metadata. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| get_metadata_persistence | Gets the persistence for the specified metadata. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| get_metadata_value | Gets the metadata values for the specified metadata. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| get_minimum_active_member | Gets the minimum active member counts for the specified pools. | BIG-IP_v9.0 |
| get_minimum_up_member | Gets the minimum member counts that are required to be UP for the specified pools. | BIG-IP_v9.0 |
| get_minimum_up_member_action | Gets the actions to be taken if the minimum number of members required to be UP for the specified pools is not met. | BIG-IP_v9.0 |
| get_minimum_up_member_enabled_state | Gets the states indicating that the feature that requires a minimum number of members to be UP is enabled/disabled for the specified pools. | BIG-IP_v9.0 |
| get_monitor_association | Gets the monitor associations for the specified pools, i.e. the monitor rules used by the pools. | BIG-IP_v9.0 |
| get_monitor_instance | Gets the monitor instance information for the specified pools, i.e. the monitor instance information for the pool members of the specified pools. | BIG-IP_v9.0 |
| get_object_status | Gets the statuses of the specified pools. | BIG-IP_v9.0 |
| get_persistence_record | Gets the persistence records based on the specified persistent modes for the specified pools. | BIG-IP_v9.0 |
| get_profile | Gets the lists of profiles for the specified pools. | BIG-IP_v11.0.0 |
| get_queue_depth_limit | Gets the maximum number of connections that may be simultaneously queued to go to any member of the specified pools. | BIG-IP_v11.0.0 |
| get_queue_on_connection_limit_state | Gets the states enabling connection queuing when pool member or node connection limits are reached, for the specified pools. | BIG-IP_v11.0.0 |
| get_queue_time_limit | Gets the maximum time a connection remains queued, for the specified pools. | BIG-IP_v11.0.0 |
| get_reselect_tries | Gets the number of times the system tries to contact a pool member after a passive failure, for the specified pools. | BIG-IP_v11.0.0 |
| get_server_ip_tos | Gets the IP ToS values for server traffic for the specified pools. | BIG-IP_v9.0 |
| get_server_link_qos | Gets the link QoS values for server traffic for the specified pools. | BIG-IP_v9.0 |
| get_simple_timeout | Gets the simple timeouts for the specified pools. | BIG-IP_v9.0 |
| get_slow_ramp_time | Gets the ramp-up time (in seconds) to gradually ramp up the load on newly added or freshly detected UP pool members. | BIG-IP_v9.0.2 |
| get_statistics | Gets the statistics for the specified pools. | BIG-IP_v9.0 |
| get_traffic_acceleration_status | Gets the traffic acceleration status of the specified pools, which specifies whether the pool is in use by traffic acceleration. | BIG-IP_v13.0.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v9.0 |
| remove_all_member_metadata | Removes all the metadata instances for the specified pool members. | BIG-IP_v11.2.0 |
| remove_all_member_profiles | Removes all profiles from the specified pool members. | BIG-IP_v11.0.0 |
| remove_all_metadata | Removes all the metadata instances for the specified pools. | BIG-IP_v11.2.0 |
| remove_all_profiles | Removes all profiles from the specified pools. | BIG-IP_v11.0.0 |
| remove_member | This method has been deprecated, due to the change in pool member key definitions. Please use remove_member_v2. Removes members from the specified pools. | BIG-IP_v9.0 |
| remove_member_metadata | Removes the metadata for the specified pool members and names. For definition of the metadata, refer to the get_member_metadata method description. | BIG-IP_v11.2.0 |
| remove_member_profile | Removes profiles from the specified pool members. | BIG-IP_v11.0.0 |
| remove_member_v2 | Removes members from the specified pools. | BIG-IP_v11.0.0 |
| remove_metadata | Removes the metadata for the specified pools and names. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| remove_monitor_association | Removes the monitor associations for the specified pools. This basically deletes the monitor associations between a pool and a monitor rule, i.e. the specified pools will no longer be monitored. | BIG-IP_v9.0 |
| remove_profile | Removes profiles from the specified pools. | BIG-IP_v11.0.0 |
| reset_member_statistics | Resets the statistics for a set of pool members. | BIG-IP_v11.0.0 |
| reset_statistics | Resets the statistics for the specified pools. | BIG-IP_v9.0 |
| set_action_on_service_down | Sets the action to take when the node goes down for the specified pools. | BIG-IP_v9.0 |
| set_allow_nat_state | Sets the states indicating whether NATs are allowed for the specified pools. | BIG-IP_v9.0 |
| set_allow_snat_state | Sets the states indicating whether SNATs are allowed for the specified pools. | BIG-IP_v9.0 |
| set_client_ip_tos | Sets the IP ToS values for client traffic for the specified pools. | BIG-IP_v9.0 |
| set_client_link_qos | Sets the link QoS values for client traffic for the specified pools. | BIG-IP_v9.0 |
| set_description | Sets the description for a set of pools. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.0.0 |
| set_gateway_failsafe_device | Sets the gateway failsafe devices for the specified pools. | BIG-IP_v11.0.0 |
| set_gateway_failsafe_unit_id | This method has been deprecated (immediately), due to introduction of device names instead of unit IDs. Please use set_gateway_failsafe_device. Sets the gateway failsafe unit IDs for the specified pools. | BIG-IP_v9.0 |
| set_ignore_persisted_weight_state | Do not count the weight of persisted connections when performing load balancing decisions for ratio-based algorithms. | BIG-IP_v11.0.0 |
| set_lb_method | Sets the load balancing methods for the specified pools. | BIG-IP_v9.0 |
| set_member_connection_limit | Sets the connection limits for a set of pool members. | BIG-IP_v11.0.0 |
| set_member_description | Sets the description for a set of pool members. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.0.0 |
| set_member_dynamic_ratio | Sets the dynamic ratios for a set of pool members. | BIG-IP_v11.0.0 |
| set_member_inherit_profile_state | Sets the state indicating that a pool member inherits profiles from the parent pool, for the specified set of pool members. Note: As of version 11.0.0, the system supports adding profiles to pool members only if the pool member does not inherit from the pool (so one must use set_member_inherit_profile_state to set a pool member not to inherit before using add_member_profile). In the future this constraint may be removed. | BIG-IP_v11.0.0 |
| set_member_metadata_description | Sets the descriptions for the specified metadata. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| set_member_metadata_persistence | Sets the persistence for the specified metadata. For definition of the metadata, refer to the get_member_metadata method description. | BIG-IP_v11.2.0 |
| set_member_metadata_value | Sets the values for the specified metadata. For definition of the metadata, refer to the get_member_metadata method description. | BIG-IP_v11.2.0 |
| set_member_monitor_logging_state | Sets the pool members&apos monitor logging state. All the monitors applied to the pool will log its actions to a unique file located in /var/log/monitors/*.log. Logs are rotated and compressed periodically. | BIG-IP_v11.5.0 |
| set_member_monitor_rule | Sets the monitor rule used to monitor the health of a set of pool members. Monitoring can be turned off on a pool member by setting the monitor rule type to MONITOR_RULE_TYPE_NONE. | BIG-IP_v11.0.0 |
| set_member_monitor_state | Sets the monitor/availability states for the specified pool members. Setting the monitor/availability state to STATE_DISABLED forces the immediate ending of all connections to the specified pool members. If the desired behavior is to allow current connections to drain normally, see set_member_session_enabled_state. | BIG-IP_v11.0.0 |
| set_member_priority | Sets the priorities for a set of pool members. | BIG-IP_v11.0.0 |
| set_member_rate_limit | Sets the rate limits for a set of pool members. | BIG-IP_v11.2.1 |
| set_member_ratio | Sets the ratios for a set of pool members. | BIG-IP_v11.0.0 |
| set_member_session_enabled_state | Sets the session states for a set of pool members. If session state is enabled or true, this means that new sessions will be allowed to be established with the pool members. Setting the session state to STATE_DISABLED will maintain current connections to the specified pool members. If the desired behavior is to kill all connections to the specified pool member immediately, see set_member_monitor_state. | BIG-IP_v11.0.0 |
| set_metadata_description | Sets the descriptions for the specified metadata. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| set_metadata_persistence | Sets the persistence for the specified metadata. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| set_metadata_value | Sets the values for the specified metadata. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| set_minimum_active_member | Sets the minimum active member counts for the specified pools. | BIG-IP_v9.0 |
| set_minimum_up_member | Sets the minimum member counts that are required to be UP for the specified pools. | BIG-IP_v9.0 |
| set_minimum_up_member_action | Sets the actions to be taken if the minimum number of members required to be UP for the specified pools is not met. | BIG-IP_v9.0 |
| set_minimum_up_member_enabled_state | Sets the states indicating that the feature that requires a minimum number of members to be UP is enabled/disabled for the specified pools. | BIG-IP_v9.0 |
| set_monitor_association | Sets/creates the monitor associations for the specified pools. This basically creates the monitor associations between a pool and a monitor rule. | BIG-IP_v9.0 |
| set_queue_depth_limit | Sets the maximum number of connections that may be simultaneously queued to go to any member of the specified pools. | BIG-IP_v11.0.0 |
| set_queue_on_connection_limit_state | Sets the states enabling connection queuing when pool member or node connection limits are reached, for the specified pools. When queuing is not enabled, new connections are reset when connection limits are met. | BIG-IP_v11.0.0 |
| set_queue_time_limit | Sets the maximum time a connection remains queued, for the specified pools. | BIG-IP_v11.0.0 |
| set_reselect_tries | Sets the number of times the system tries to contact a pool member after a passive failure, for the specified pools. A passive failure consists of a server-connect failure or a failure to receive a data response within a user-specified interval. | BIG-IP_v11.0.0 |
| set_server_ip_tos | Sets the IP ToS values for server traffic for the specified pools. | BIG-IP_v9.0 |
| set_server_link_qos | Sets the link QoS values for server traffic for the specified pools. | BIG-IP_v9.0 |
| set_simple_timeout | Sets the simple timeouts for the specified pools. | BIG-IP_v9.0 |
| set_slow_ramp_time | Sets the ramp-up time (in seconds) to gradually ramp up the load on newly added or freshly detected UP pool members. | BIG-IP_v9.0.2 |
Structures¶
Structure
Description
A struct that describes statistics for a particular pool member.
A struct that describes pool member statistics and timestamp.
A struct that describes a pool&aposs monitor association.
A struct that describes statistics for a particular pool.
A struct that describes pool statistics and timestamp.
Aliases¶
| Alias | Type | Description |
| MemberStatisticEntrySequence | MemberStatisticEntry [] | A sequence of pool member statistics. |
| MemberStatisticsSequence | MemberStatistics [] | An alias for a sequence of pool member statistics. |
| MonitorAssociationSequence | MonitorAssociation [] | A sequence of monitor associations. |
| PoolStatisticEntrySequence | PoolStatisticEntry [] | A sequence of Pool statistics. |
See Also¶
Warning
The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.
Sample Code¶
The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.