GlobalLB::ProberPool

Introduced : BIG-IP_v11.0.0
The ProberPool interface enables you to create and maintain a prober pool, which contains a set of members which will be used to monitor the Server&aposs resources (typically its virtual servers). The members named in the prober pool should be BIG-IP systems, set up as Servers of type bigip-standalone or bigip-redundant. If a Server doesn&apost name a prober pool, the Server will use the prober pool attached to the server&aposs data center, if that has been assigned. The probing members named in the prober pool will be chosen according to the load balancing method selected for the prober pool (e.g., round robin or global availability).

Methods

Method Description Introduced
add_member Adds members to the specified prober pools. BIG-IP_v11.0.0
create Creates prober pools. BIG-IP_v11.0.0
delete_all_prober_pools Deletes all prober pools. BIG-IP_v11.0.0
delete_prober_pool Deletes prober pools. BIG-IP_v11.0.0
get_all_member_statistics Gets the statistics for all prober pool members (of the specified prober pools). BIG-IP_v11.0.0
get_all_statistics Gets the statistics for all prober pools. BIG-IP_v11.0.0
get_description Gets the descriptions for a set of prober pools. BIG-IP_v11.0.0
get_enabled_state Gets the enabled state of the specified prober pools. BIG-IP_v11.0.0
get_lb_method Gets the load balancing method for the specified prober pools. BIG-IP_v11.0.0
get_list Gets a list of all prober pools. BIG-IP_v11.0.0
get_member Gets a list of members belonging to the specified prober pools. BIG-IP_v11.0.0
get_member_enabled_state Gets the enabled state of the specified prober pool members. BIG-IP_v11.0.0
get_member_object_status Gets the statuses of the specified prober pool members. BIG-IP_v11.0.0
get_member_order Sets the order of the specified prober pool members. BIG-IP_v11.0.0
get_member_statistics Gets the statistics for specified prober pool members. BIG-IP_v11.0.0
get_object_status Gets the statuses of the specified prober pools. BIG-IP_v11.0.0
get_statistics Gets the statistics for a list of prober pools. BIG-IP_v11.0.0
get_version Get the version information for this interface. BIG-IP_v11.0.0
remove_all_members Removes all members from the specified prober pools. BIG-IP_v11.0.0
remove_member Removes members from the specified prober pools. BIG-IP_v11.0.0
reset_member_statistics Resets the statistics for a list of prober pool members. BIG-IP_v11.0.0
reset_statistics Resets the statistics for a list of prober pools. BIG-IP_v11.0.0
set_description Sets the description for a set of prober pools. This is an arbitrary field which can be used for any purpose. BIG-IP_v11.0.0
set_enabled_state Sets the enabled state of the specified prober pools. BIG-IP_v11.0.0
set_lb_method Sets the load balancing method for the specified prober pools. As of version 11.0.0, there is support for GTM_LB_GA and GTM_LB_ROUND_ROBIN types (the default is Global Availability). BIG-IP_v11.0.0
set_member_enabled_state Sets the enabled state of the specified prober pool members. BIG-IP_v11.0.0
set_member_order Sets the order of the specified prober pool members. BIG-IP_v11.0.0

Structures

Structure

Description

ProberPoolMemberStatisticEntry

A struct that describes statistics for a specified prober pool member.

ProberPoolMemberStatistics

A struct that describes prober pool statistics and timestamp.

ProberPoolStatisticEntry

A struct that describes statistics for a specified prober pool.

ProberPoolStatistics

A struct that describes prober pool statistics and timestamp.


Enumerations

Enumeration Description

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description
ProberPoolMemberStatisticEntrySequence ProberPoolMemberStatisticEntry [] A sequence of prober pool member statistics.
ProberPoolMemberStatisticsSequence ProberPoolMemberStatistics [] An alias for a sequence of pool member statistics.
ProberPoolStatisticEntrySequence ProberPoolStatisticEntry [] A sequence of prober 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.