APIRef_tm_sys_clusterΒΆ
mgmt/tm/sys/cluster
Cluster configuration
REST Endpoints
- Collection URI
/mgmt/tm/sys/cluster
- Collection Methods
OPTIONS, GET
- Resource URI
/mgmt/tm/sys/cluster/~resource id
- Resource Methods
OPTIONS, GET, PUT, PATCH
- Resource Natural Key
name
Properties
Name | Type | Default Value | Required | Access | Description |
---|---|---|---|---|---|
address |
string | optional | read/write | Specifies the IP address of the cluster. | |
minUpMembers |
integer | 0 | optional | read/write | Specifies the minimum number of cluster members that must be up for the cluster to remain Active. The default value is 0 (zero). |
minUpMembersEnabled |
string | no | optional | read/write | When enabled, specifies that when the number of active cluster members is below the value of the min up members option, the cluster fails over to its peer. Enable this parameter when you configure a redundant pair. The default value is disabled. |
Array Structures
Name | Type | Default Value | Required | Access | Description |
---|---|---|---|---|---|
/members |
array_structure | optional | read/write | Cluster member configuration | |
/members/address |
string | optional | read/write | Specifies the IP address of the cluster member. | |
/members/disabled |
boolean | true | optional | read/write | Disables the specified cluster members. |
/members/enabled |
boolean | true | optional | read/write | Enables the specified cluster members. |
/members/priming |
string | disabled | optional | read/write | Prevents the cluster members from proceeding to the RUNNING cluster quorum state, which is useful when a blade is in a reboot loop. |
Copyright (c) 2016, 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.