LocalLB::PoolMember

Introduced : BIG-IP_v9.0
*IMPORTANT* This entire interface has been deprecated. The functionality has been moved into the Pool interface. The PoolMember interface enables you to work with the pool members and their settings, and statistics.

Methods

Method Description Introduced
get_all_statistics Gets the statistics for all pool members of the specified pools. BIG-IP_v9.0
get_connection_limit Gets the connection limits for all members in the specified pools. BIG-IP_v9.0
get_dynamic_ratio Gets the dynamic ratios for all members of the specified pools. BIG-IP_v9.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.0
get_monitor_instance Gets the monitor instance information for the pool members in the specified pools. BIG-IP_v9.2.0
get_monitor_status Gets the monitor/availability status for all members of the specified pools. BIG-IP_v9.0
get_object_status Gets the object statuses for all members of the specified pools. BIG-IP_v9.0
get_priority Gets the priorities for all members in the specified pools. BIG-IP_v9.0
get_ratio Gets the ratios for all members in the specified pools. BIG-IP_v9.0
get_session_enabled_state Note: This function has been deprecated. Please use get_session_status. Gets the session states for all members of the specified pools. BIG-IP_v9.0
get_session_status Gets the session status for all members of the specified pools. BIG-IP_v9.0
get_statistics Gets the statistics for the specified set of pool members. BIG-IP_v9.0
get_version Gets the version information for this interface. BIG-IP_v9.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.0
reset_statistics Resets the statistics for the specified set of pool members. BIG-IP_v9.0
set_connection_limit Sets the connection limits for the specified pool members. BIG-IP_v9.0
set_dynamic_ratio Sets the dynamic ratios for the specified pool members. BIG-IP_v9.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.0
set_monitor_state Sets the monitor/availability states for the specified pool members. BIG-IP_v9.0
set_priority Sets the priorities for the specified pool members. BIG-IP_v9.0
set_ratio Sets the ratios for the specified pool members. BIG-IP_v9.0
set_session_enabled_state Sets the session states for the specified pool members. If session state is enabled or true, this means that new sessions will be allowed to be established with the pool members. BIG-IP_v9.0

Structures

Structure

Description

MemberConnectionLimit

A struct that describes a member connection limit.

MemberDynamicRatio

A struct that describes a member dynamic ratio.

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.

MemberMonitorInstanceState

A struct that describes a member&aposs monitor instances.

MemberMonitorState

A struct that describes a member monitor state.

MemberMonitorStatus

A struct that describes a member&aposs current monitor status.

MemberObjectStatus

A struct that describes a member&aposs current object status.

MemberPriority

A struct that describes a member priority.

MemberRatio

A struct that describes a member ratio.

MemberSessionState

A struct that describes a member session state, which allows new sessions to be esablished.

MemberSessionStatus

A struct that describes a member&aposs current session status.

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
MemberConnectionLimitSequence MemberConnectionLimit [] A sequence of member connection limits.
MemberConnectionLimitSequenceSequence MemberConnectionLimit [] [] An alias for a sequence of member connection limits.
MemberDynamicRatioSequence MemberDynamicRatio [] A sequence of member dynamic ratios.
MemberDynamicRatioSequenceSequence MemberDynamicRatio [] [] An alias for a sequence of member dynamic ratios.
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.
MemberMonitorInstanceStateSequence MemberMonitorInstanceState [] A sequence of member monitor instances.
MemberMonitorInstanceStateSequenceSequence MemberMonitorInstanceState [] [] An alias for a sequence of member monitor instances.
MemberMonitorStateSequence MemberMonitorState [] A sequence of member monitor states.
MemberMonitorStateSequenceSequence MemberMonitorState [] [] An alias for a sequence of member monitor states.
MemberMonitorStatusSequence MemberMonitorStatus [] A sequence of member monitor statuses.
MemberMonitorStatusSequenceSequence MemberMonitorStatus [] [] An alias for a sequence of member monitor statuses.
MemberObjectStatusSequence MemberObjectStatus [] A sequence of member object statuses.
MemberObjectStatusSequenceSequence MemberObjectStatus [] [] An alias for a sequence of member object statuses.
MemberPrioritySequence MemberPriority [] A sequence of member priorities.
MemberPrioritySequenceSequence MemberPriority [] [] An alias for a sequence of member priorities.
MemberRatioSequence MemberRatio [] A sequence of member ratios.
MemberRatioSequenceSequence MemberRatio [] [] An alias for a sequence of member ratios.
MemberSessionStateSequence MemberSessionState [] A sequence of member session states.
MemberSessionStateSequenceSequence MemberSessionState [] [] An alias for a sequence of member session states.
MemberSessionStatusSequence MemberSessionStatus [] A sequence of member monitor statuses.
MemberSessionStatusSequenceSequence MemberSessionStatus [] [] An alias for a sequence of member monitor statuses.
MemberStatisticEntrySequence MemberStatisticEntry [] A sequence of pool member statistics.
MemberStatisticsSequence MemberStatistics [] An alias for a sequence of pool member statistics.

See Also

iControl ::
iControl :: LocalLB :: PoolMember

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


Copyright © 1996-2012, F5 Networks, Inc. All rights reserved.

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.