System::Cluster

Introduced : BIG-IP_v9.0
The Cluster interface enables you to work with the definitions and attributes in a clustered device.

Methods

Method Description Introduced
get_cluster_enabled_state Gets the cluster enabled states. BIG-IP_v9.6.0
get_cluster_ha_state Gets the cluster high-availability states. BIG-IP_v9.6.0
get_current_primary_slot Gets the primary slot numbers. BIG-IP_v9.6.0
get_list Gets a list of the cluster names. BIG-IP_v9.6.0
get_member_enabled_state Gets the cluster member enabled states. BIG-IP_v9.6.0
get_member_ha_state Gets the cluster member high-availability states. BIG-IP_v9.6.0
get_member_licensed_state Gets the cluster member licensed states. BIG-IP_v9.6.0
get_member_priming_state Gets the cluster member priming states. BIG-IP_v9.6.0
get_min_up_members Gets the minimum up members values. BIG-IP_v9.6.0
get_min_up_members_action Gets the cluster minimum up members actions. BIG-IP_v9.6.0
get_min_up_members_state Gets the cluster minimum up members enabled states. BIG-IP_v9.6.0
get_slot_id Get a list of list of slot ids (the size of each list is the number of slots). BIG-IP_v9.6.0
get_version Gets the version information for this interface. BIG-IP_v9.6.0
is_clustered_environment Checks to see whether the system is a clustered environment. BIG-IP_v10.0.1
set_cluster_enabled_state Sets the cluster enabled states. BIG-IP_v9.6.0
set_current_primary_slot Currently this is not implemented. BIG-IP_v9.6.0
set_member_enabled_state Sets the cluster member enabled states. BIG-IP_v9.6.0
set_member_priming_state Sets the cluster member priming states. BIG-IP_v9.6.0
set_min_up_members Sets the minimum up members values. BIG-IP_v9.6.0
set_min_up_members_action Sets the cluster minimum up members actions. BIG-IP_v9.6.0
set_min_up_members_state Sets the cluster minimum up members enabled states. BIG-IP_v9.6.0

Structures

Structure Description

Enumerations

Enumeration Description

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description

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.