GlobalLB::PoolMember

Introduced : BIG-IP_v9.2.0
Due to changing virtual server keys, this full interface is deprecated. Its functionality has been moved to the GlobalLB::Pool interface. The PoolMember interface enables you to work with the pool members and their settings, and statistics.

Methods

Method Description Introduced
add_dependency Adds the virtual servers to the dependency list that the specified pool members depend on. BIG-IP_v9.2.0
get_all_statistics Gets the statistics for all pool members of the specified pools. BIG-IP_v9.2.0
get_dependency Gets the list of virtual servers that the specified pool members depend on. BIG-IP_v9.2.0
get_enabled_state Gets the enabled states for the specified members in the specified pools. BIG-IP_v9.2.0
get_limit Gets the metric limits for the specified members of the specified pools. BIG-IP_v9.2.0
get_monitor_association Gets the monitor associations used by the specified pool members, i.e. the monitor rules used by the pool members. BIG-IP_v9.2.0
get_object_status Gets the statuses for the specified members in the specified pools. BIG-IP_v9.2.0
get_order Gets the orders for the specified members in the specified pools. BIG-IP_v9.2.0
get_ratio Gets the ratios for the specified members in the specified pools. BIG-IP_v9.2.0
get_statistics Gets the statistics for the specified set of pool members. BIG-IP_v9.2.0
get_version Gets the version information for this interface. BIG-IP_v9.2.0
remove_all_dependencies Removes any and all dependencies of the specified pool members. BIG-IP_v9.2.0
remove_dependency Removes the virtual servers from the dependency list that the specified pool members depend on. BIG-IP_v9.2.0
remove_monitor_association Removes the monitor associations for the specified pool members. Depending on the monitor association removal rule specified, this basically deletes any explicit monitor associations between a pool member and a monitor rule and thus causing the pool member to use the default monitor association of its parent pool, or this will delete any monitor association for the pool members altogether, i.e. the specified pool members will no longer be monitored. BIG-IP_v9.2.0
reset_statistics Resets the statistics for the specified set of pool members. BIG-IP_v9.2.0
set_enabled_state Sets the enabled states for the specified pool members in the specified pools. BIG-IP_v9.2.0
set_limit Sets the metric limits for the specified members of the specified pools. BIG-IP_v9.2.0
set_monitor_association Sets/creates the monitor associations for the specified pool members. This basically creates the monitor associations between a pool member and a monitor rule. BIG-IP_v9.2.0
set_order Sets the orders for the specified pool members. 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
set_ratio Sets the ratios for the specified pool members. BIG-IP_v9.2.0

Structures

Structure

Description

MemberDependency

A struct that describes a pool member&aposs dependencies on other virtual servers.

MemberEnabledState

A struct that describes a pool member state.

MemberMetricLimit

A struct that contains metric limits for a pool member.

MemberMonitorAssociation

A struct that describes a pool member&aposs monitor association.

MemberMonitorAssociationRemoval

A struct that describes a pool member&aposs monitor association to be removed.

MemberObjectStatus

A struct that describes a pool member status.

MemberOrder

A struct that describes a pool member order.

MemberRatio

A struct that describes a pool member ratio.

MemberStatisticEntry

A struct that describes statistics for a particular pool member.

MemberStatistics

A struct that describes pool member statistics and timestamp.


Enumerations

Enumeration Description

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description
MemberDependencySequence MemberDependency [] A sequence of pool member dependency definitions.
MemberDependencySequenceSequence MemberDependency [] [] An alias for a sequence of pool member dependency definitions.
MemberEnabledStateSequence MemberEnabledState [] A sequence of pool member states.
MemberEnabledStateSequenceSequence MemberEnabledState [] [] An alias for a sequence of member states.
MemberMetricLimitSequence MemberMetricLimit [] A sequence of MemberMetricLimit&aposs.
MemberMetricLimitSequenceSequence MemberMetricLimit [] [] An alias for a sequence of MemberMetricLimit&aposs.
MemberMonitorAssociationRemovalSequence MemberMonitorAssociationRemoval [] A sequence of MemberMonitorAssociationRemoval&aposs.
MemberMonitorAssociationRemovalSequenceSequence MemberMonitorAssociationRemoval [] [] An alias for a sequence of member MemberMonitorAssociationRemoval&aposs.
MemberMonitorAssociationSequence MemberMonitorAssociation [] A sequence of monitor associations.
MemberMonitorAssociationSequenceSequence MemberMonitorAssociation [] [] An alias for a sequence of member monitor associations.
MemberObjectStatusSequence MemberObjectStatus [] A sequence of pool member states.
MemberObjectStatusSequenceSequence MemberObjectStatus [] [] An alias for a sequence of member statuses.
MemberOrderSequence MemberOrder [] A sequence of pool member orders.
MemberOrderSequenceSequence MemberOrder [] [] An alias for a sequence of member orders.
MemberRatioSequence MemberRatio [] A sequence of pool member ratios.
MemberRatioSequenceSequence MemberRatio [] [] An alias for a sequence of member ratios.
MemberStatisticEntrySequence MemberStatisticEntry [] A sequence of pool member statistics.
MemberStatisticsSequence MemberStatistics [] An alias for a sequence of pool member 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.