Resources | addressContext | linkDetectionGroup
 linkDetectionGroupThe Link Detection Group object allows you to group link interfaces (LIFs) and associated Link Monitors together and track link verification failures within the group. A Link Detection Group will be configured with a unique name and a failover threshold. The Link Detection Group tracks the number of link verification failures that have occurred among the Link Monitors configured. |
Configuration
| Parameter | Presence | Type | Default | Description | |
|---|---|---|---|---|---|
  | name | M | string | The name of this link detection group. | |
| ceName | M | reference | The name of the compute element that hosts this link detection group. | |
| type | O | enumeration | ip | Interface type supported by this link detection group. |
| threshold | O | int32 | 2 | The number of link monitor failures that will trigger this link detection group to declare a failure and attempt a switchover to the standby server. |
| verifyTimer | O | int32 | 1000 | The time interval (in milliseconds) between link verification attempts. |
| responseTimer | O | int32 | 500 | The time to wait (in milliseconds) for a link verification attempt. |
| reattemptTimer | O | int32 | 1000 | The time to wait (in milliseconds) for a link verification reattempt. |
| retries | O | int32 | 3 | The number of retries before link verification is considered failed. |
| state | O | enumeration | disabled | Administrative state of the link detection group. |
| activeLinkMonitoringProtocol | O | enumeration | icmp | The probe protocol used by Link Monitor/s in active role within this Link Detection Group |
| linkMonitor | O | Specifies a link monitor that monitors a link to a destination for a specific interface. |
Operational Data
| Parameter | Description | |
|---|---|---|
| linkMonitorStatus | Status of link verification for a link monitor |
| linkMonitorStatistics | Statistics for link failure detected per IP interface. |
| REST API: GET Example |
|---|
curl -kisu 'admin:secret' -X GET https://{SBX-SERVER}/api/config/addressContext/{name}/linkDetectionGroup/{name} |
| REST API: POST Example |
|---|
curl -kisu 'admin:secret' -X POST -H 'Content-Type: application/vnd.yang.data+xml' https://{SBX-SERVER}/api/config/addressContext/{name} --data ' |
| REST API: DELETE Example |
|---|
curl -kisu 'admin:secret' -X DELETE https://{SBX-SERVER}/api/config/addressContext/{name}/linkDetectionGroup/{name} |
Overview
Content Tools