GlobalLB::Pool¶
Methods¶
Method | Description | Introduced |
add_member | This method was deprecated due to changing pool member keys. Please use add_member_v2 in its stead. Adds members to the specified pools. Note: as of v10.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. | BIG-IP_v9.2.0 |
add_member_dependency | Adds virtual servers that the specified members of the specified pools depend on. | BIG-IP_v11.0.0 |
add_member_v2 | Adds members to the specified pools. 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. | 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 |
create | This method was deprecated due to changing the pool member keys. Please use create_v2 in its stead. Creates the specified pools. Note: as of v10.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. | BIG-IP_v9.2.0 |
create_v2 | Creates the specified pools. 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. | BIG-IP_v11.0.0 |
delete_all_pools | Deletes all pools. | BIG-IP_v9.2.0 |
delete_pool | Deletes the specified pools. | BIG-IP_v9.2.0 |
get_all_statistics | Gets the statistics for all the pools. | BIG-IP_v9.2.0 |
get_alternate_lb_method | Gets the alternate load balancing methods for the specified pools. | BIG-IP_v9.2.0 |
get_answers_to_return | Gets the number of answers to return for the specified pools. | BIG-IP_v9.2.0 |
get_cname | Gets the CNAMEs for the specified pools. | BIG-IP_v9.2.0 |
get_description | Gets the descriptions for a set of pools. | BIG-IP_v11.0.0 |
get_dynamic_ratio_state | Gets the states to indicate whether to use dynamic ratio to modify the behavior of QOS. | BIG-IP_v9.2.0 |
get_enabled_state | Gets the enabled state of the specified pools. | BIG-IP_v9.2.0 |
get_fallback_ip | Gets the fallback/emergency failure IP for the specified pools. This method is deprecated; new designs should use get_fallback_ip{v4,v6}. | BIG-IP_v9.2.0 |
get_fallback_ipv4 | Gets the fallback/emergency failure IPv4 address for the specified pools. | BIG-IP_v11.0.0 |
get_fallback_ipv6 | Gets the fallback/emergency failure IPv6 address for the specified pools. | BIG-IP_v11.0.0 |
get_fallback_lb_method | Gets the fallback load balancing methods for the specified pools. | BIG-IP_v9.2.0 |
get_limit | Gets all metrics limits for a sequence of pools. | BIG-IP_v9.2.0 |
get_list | Gets a list of pools. | BIG-IP_v9.2.0 |
get_manual_resume_state | Gets the states indicating whether to disable pool members when pool member status goes from Green to Red. | BIG-IP_v9.2.0 |
get_member | This method was deprecated due to changing pool member keys. Please use get_member_v2 in its stead. Gets a list of pool members. | BIG-IP_v9.2.0 |
get_member_dependency | Gets the virtual servers that the specified members of the specified pools depend on. | BIG-IP_v11.0.0 |
get_member_description | Gets the description of a set of pool members in a set of pools. | BIG-IP_v11.0.0 |
get_member_enabled_state | Gets the enabled states for the specified members of the specified pools. | BIG-IP_v11.0.0 |
get_member_limit | Gets the metric limits for the specified members of the specified pools. | BIG-IP_v11.0.0 |
get_member_monitor_rule | Gets the monitor rules for the specified members of the specified pools. | BIG-IP_v11.0.0 |
get_member_object_status | Gets the statuses for the specified members of the specified pools. | BIG-IP_v11.0.0 |
get_member_order | Gets the orders for the specified members of the specified pools. | BIG-IP_v11.0.0 |
get_member_ratio | Gets the ratios for the specified members of the specified pools. | BIG-IP_v11.0.0 |
get_member_statistics | Gets the statistics for the specified members of the specified pools. | BIG-IP_v11.0.0 |
get_member_v2 | Gets the members of a set of pools. | 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_monitor_association | Gets the monitor associations for the specified pools, i.e. the monitor rules used by the pools. | BIG-IP_v9.2.0 |
get_object_status | Gets the statuses of the specified pools. | BIG-IP_v9.2.0 |
get_preferred_lb_method | Gets the preferred load balancing methods for the specified pools. | BIG-IP_v9.2.0 |
get_qos_coefficient_bps | Gets the relative weight for bits per second when the load balancing mode is set to LB_METHOD_QOS. | BIG-IP_v9.2.0 |
get_qos_coefficient_connection_rate | Gets the relative weight for connection rate when the load balancing mode is set to LB_METHOD_QOS. This function is deprecated and new applications should use vs_score. | BIG-IP_v9.2.0 |
get_qos_coefficient_hit_ratio | Gets the relative weight for ping packet completion rate when the load balancing mode is set to LB_METHOD_QOS. | BIG-IP_v9.2.0 |
get_qos_coefficient_hops | Gets the relative weight for hops when the load balancing mode is set to LB_METHOD_QOS. | BIG-IP_v9.2.0 |
get_qos_coefficient_lcs | Gets the relative weight for link capacity when the load balancing mode is set to LB_METHOD_QOS. | BIG-IP_v9.2.0 |
get_qos_coefficient_packet_rate | Gets the relative weight for packet rate when the load balancing mode is set to LB_METHOD_QOS. | BIG-IP_v9.2.0 |
get_qos_coefficient_rtt | Gets the relative weight for round-trip time when the load balancing mode is set to LB_METHOD_QOS. | BIG-IP_v9.2.0 |
get_qos_coefficient_topology | Gets the relative weight for topology when the load balancing mode is set to LB_METHOD_QOS. | BIG-IP_v9.2.0 |
get_qos_coefficient_vs_capacity | Gets the relative weight for virtual server capacity when the load balancing mode is set to LB_METHOD_QOS. | BIG-IP_v9.2.0 |
get_qos_coefficient_vs_score | Gets the relative weight for virtual server (VS) score when the load balancing mode is set to LB_METHOD_QOS. | BIG-IP_v9.4.0 |
get_statistics | Gets the statistics for the specified pools. | BIG-IP_v9.2.0 |
get_ttl | Gets the TTL values for the specified pools. | BIG-IP_v9.2.0 |
get_verify_member_availability_state | Gets the states to indicate whether to check the availability of pool member availability before using them. | BIG-IP_v9.2.0 |
get_version | Gets the version information for this interface. | BIG-IP_v9.2.0 |
remove_all_member_dependencies | Removes all virtual servers that the specified members of the specified pools depend on. | BIG-IP_v11.0.0 |
remove_all_members | Removes all members from the specified pools. | BIG-IP_v11.0.0 |
remove_all_metadata | Removes all the metadata instances for the specified pools. | BIG-IP_v11.2.0 |
remove_member | This method was deprecated due to changing pool member keys. Please use remove_member_v2 in its stead. Removes members from the specified pools. | BIG-IP_v9.2.0 |
remove_member_dependency | Removes virtual servers that the specified members of the specified pools depend on. | 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.2.0 |
reset_member_statistics | Resets the statistics for the specified of members of the specified pools. | BIG-IP_v11.0.0 |
reset_statistics | Resets the statistics for the specified pools. | BIG-IP_v9.2.0 |
set_alternate_lb_method | Sets the alternate load balancing methods for the specified pools. | BIG-IP_v9.2.0 |
set_answers_to_return | Sets the number of answers to return for the specified pools. | BIG-IP_v9.2.0 |
set_cname | Sets the CNAMEs for the specified pools. | BIG-IP_v9.2.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_dynamic_ratio_state | Sets the states to indicate whether to use dynamic ratio to modify the behavior of QOS. | BIG-IP_v9.2.0 |
set_enabled_state | Sets the enabled state of the specified pools. | BIG-IP_v9.2.0 |
set_fallback_ip | Sets the fallback/emergency failure IP for the specified pools. This method is deprecated; new designs should use set_fallback_ip{v4,v6}. | BIG-IP_v9.2.0 |
set_fallback_ipv4 | Sets the fallback/emergency failure IPv4 address for the specified pools. | BIG-IP_v11.0.0 |
set_fallback_ipv6 | Sets the fallback/emergency failure IPv6 address for the specified pools. | BIG-IP_v11.0.0 |
set_fallback_lb_method | Sets the fallback load balancing methods for the specified pools. | BIG-IP_v9.2.0 |
set_limit | Sets the limits for pool metrics. | BIG-IP_v9.2.0 |
set_manual_resume_state | Sets the states indicating whether to disable pool members when pool member status goes from Green to Red. | BIG-IP_v9.2.0 |
set_member_description | Sets the description of a set of pool members in a set of pools. | BIG-IP_v11.0.0 |
set_member_enabled_state | Sets the enabled states for the specified members of the specified pools. | BIG-IP_v11.0.0 |
set_member_limit | Sets the metric limits for the specified members of the specified pools. | BIG-IP_v11.0.0 |
set_member_monitor_rule | Sets the monitor rules for the specified members of the specified pools. | BIG-IP_v11.0.0 |
set_member_order | Sets the orders for the specified members of the specified pools. 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. | BIG-IP_v11.0.0 |
set_member_ratio | Sets the ratios for the specified members of the specified pools. | 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_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.2.0 |
set_preferred_lb_method | Sets the preferred load balancing methods for the specified pools. | BIG-IP_v9.2.0 |
set_qos_coefficient_bps | Sets the relative weight for bits per second when the load balancing mode is set to LB_METHOD_QOS. | BIG-IP_v9.2.0 |
set_qos_coefficient_connection_rate | Sets the relative weight for connection rate when the load balancing mode is set to LB_METHOD_QOS. This function is deprecated and new applications should use vs_score. | BIG-IP_v9.2.0 |
set_qos_coefficient_hit_ratio | Sets the relative weight for ping packet completion rate when the load balancing mode is set to LB_METHOD_QOS. | BIG-IP_v9.2.0 |
set_qos_coefficient_hops | Sets the relative weight for hops when the load balancing mode is set to LB_METHOD_QOS. | BIG-IP_v9.2.0 |
set_qos_coefficient_lcs | Sets the relative weight for link capacity when the load balancing mode is set to LB_METHOD_QOS. | BIG-IP_v9.2.0 |
set_qos_coefficient_packet_rate | Sets the relative weight for packet rate when the load balancing mode is set to LB_METHOD_QOS. | BIG-IP_v9.2.0 |
set_qos_coefficient_rtt | Sets the relative weight for round-trip time when the load balancing mode is set to LB_METHOD_QOS. | BIG-IP_v9.2.0 |
set_qos_coefficient_topology | Sets the relative weight for topology when the load balancing mode is set to LB_METHOD_QOS. | BIG-IP_v9.2.0 |
set_qos_coefficient_vs_capacity | Sets the relative weight for virtual server capacity when the load balancing mode is set to LB_METHOD_QOS. | BIG-IP_v9.2.0 |
set_qos_coefficient_vs_score | Sets the relative weight for virtual server (VS) score when the load balancing mode is set to LB_METHOD_QOS. | BIG-IP_v9.4.0 |
set_ttl | Sets the TTL values for the specified pools. | BIG-IP_v9.2.0 |
set_verify_member_availability_state | Sets the states to indicate whether to check the availability of pool member availability before using them. | BIG-IP_v9.2.0 |
Structures¶
Structure
Description
Member statistics
A struct that describes a pool&aposs monitor association.
A struct that contains a definition for a pool member.
A struct that contains metric limits for a pool.
A struct that describes statistics for a particular pool.
A struct that describes pool statistics and timestamp.
Aliases¶
Alias | Type | Description |
MonitorAssociationSequence | MonitorAssociation [] | A sequence of monitor associations. |
PoolMemberDefinitionSequence | PoolMemberDefinition [] | A sequence of PoolMemberDefinition&aposs. |
PoolMemberDefinitionSequenceSequence | PoolMemberDefinition [] [] | An alias for a sequence of PoolMemberDefinition&aposs. |
PoolMetricLimitSequence | PoolMetricLimit [] | A sequence of PoolMetricLimit&aposs. |
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.