Provides the definition of the Threshold Control Alarms.
| action |
| count |
| description |
| disable |
| displayStatus |
| entityScope |
| externalID |
| lastUpdatedBy |
| metric |
| name |
| period |
| status |
| targetPolicyGroupID |
| threshold |
| throttleTime |
| type |
| URLEndPoint |
This object has no members.
Action to be taken when TCA is fired - Alert or PolicyGroupChange
Allowed values: Alert, Alert_PolicyGroupChange
SDK attribute: action
Count of the attempts by maintenanace thread to create/update watcher
Default value: 0
SDK attribute: count
Description of the TCA
Format: free
Min length: 1
Max length: 255
SDK attribute: description
This flag is used to indicate whether the watch(TCA) is enabled/disabled
Default value: false
SDK attribute: disable
Explanation of the TCA status
Format: free
SDK attribute: displayStatus
Specify if scope of entity is Data center or Enterprise level
Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope
External object ID. Used for integration with third party systems
Format: free
SDK attribute: externalID
ID of the user who last updated the object.
Format: free
SDK attribute: lastUpdatedBy
The metric associated with the TCA. The following enum values have been deprecated and will be removed in the next major release 6.0: ADDRESS_MAP_EGRESS_BYTE_CNT, ADDRESS_MAP_EGRESS_PKT_CNT, ADDRESS_MAP_INGRESS_BYTE_CNT, ADDRESS_MAP_INGRESS_PKT_CNT, CONNECTION_TYPE, EGRESS_BYTE_COUNT, EGRESS_PACKET_COUNT, INGRESS_BYTE_COUNT, INGRESS_PACKET_COUNT, Q0_BYTES, Q0_DROPPED, Q0_PKT_COUNT, Q10_BYTES, Q10_DROPPED, Q10_PKT_COUNT, Q1_BYTES, Q1_DROPPED, Q1_PKT_COUNT, Q2_BYTES, Q2_DROPPED, Q2_PKT_COUNT, Q3_BYTES, Q3_DROPPED, Q3_PKT_COUNT, Q4_BYTES, Q4_DROPPED, Q4_PKT_COUNT, RX_BYTES, RX_DROPPED, RX_ERRORS, RX_PKT_COUNT, TCP_SYN_EVENT_COUNT, TX_BYTES, TX_DROPPED, TX_ERRORS, TX_PKT_COUNT
Allowed values: ACL_DENY_EVENT_COUNT, ADDRESS_MAP_EGRESS_BYTE_CNT, ADDRESS_MAP_EGRESS_PKT_CNT, ADDRESS_MAP_INGRESS_BYTE_CNT, ADDRESS_MAP_INGRESS_PKT_CNT, ANTI_SPOOF_EVENT_COUNT, BYTES_IN, BYTES_OUT, CONNECTION_TYPE, EGRESS_BYTE_COUNT, EGRESS_PACKET_COUNT, FIP_PRE_RATE_LIMIT_BYTES, FIP_PRE_RATE_LIMIT_PACKETS, FIP_RATE_LIMIT_DROPPED_BYTES, FIP_RATE_LIMIT_DROPPED_PACKETS, INGRESS_BYTE_COUNT, INGRESS_PACKET_COUNT, L7_BYTES_IN, L7_BYTES_OUT, L7_PACKETS_IN, L7_PACKETS_OUT, PACKETS_DROPPED_BY_RATE_LIMIT, PACKETS_IN, PACKETS_IN_DROPPED, PACKETS_IN_ERROR, PACKETS_OUT, PACKETS_OUT_DROPPED, PACKETS_OUT_ERROR, Q0_BYTES, Q0_DROPPED, Q0_PKT_COUNT, Q10_BYTES, Q10_DROPPED, Q10_PKT_COUNT, Q1_BYTES, Q1_DROPPED, Q1_PKT_COUNT, Q2_BYTES, Q2_DROPPED, Q2_PKT_COUNT, Q3_BYTES, Q3_DROPPED, Q3_PKT_COUNT, Q4_BYTES, Q4_DROPPED, Q4_PKT_COUNT, RX_BYTES, RX_DROPPED, RX_ERRORS, RX_PKT_COUNT, TCP_FLAG_ACK_IN, TCP_FLAG_ACK_OUT, TCP_FLAG_NULL_IN, TCP_FLAG_NULL_OUT, TCP_FLAG_RST_IN, TCP_FLAG_RST_OUT, TCP_FLAG_SYN_IN, TCP_FLAG_SYN_OUT, TCP_SYN_EVENT_COUNT, TX_BYTES, TX_DROPPED, TX_ERRORS, TX_PKT_COUNT
SDK attribute: metric
The name of the TCA
Format: free
Min length: 1
Max length: 255
SDK attribute: name
The averaging period
Min value: 1
SDK attribute: period
This flag is used to indicate the status of TCA
Default value: false
SDK attribute: status
Target policygroup when TCA is triggered
Format: free
SDK attribute: targetPolicyGroupID
The threshold that must be exceeded before an alarm is issued
Min value: 1
SDK attribute: threshold
Throttle time in secs
Default value: 0
SDK attribute: throttleTime
Rolling average or sequence of samples over the averaging period.
Allowed values: BREACH, ROLLING_AVERAGE
SDK attribute: type
URL endpoint to post Alarm data to when TCA is triggered
Format: free
SDK attribute: URLEndPoint