Provides the definition of the Threshold Control Alarms.
This object has no members.
Action to be taken when TCA is fired - Alert or PolicyGroupChange
Allowed values: Alert, Alert_Add_Network_Macro, Alert_Add_Policy_Group, Alert_PolicyGroupChange
SDK attribute: action
Count of the attempts by maintenanace thread to create/update watcher
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
SDK attribute: disable
Explanation of the TCA status
Format: free
SDK attribute: displayStatus
Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.
SDK attribute: embeddedMetadata
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.
Allowed values: ACL_DENY_EVENT_COUNT, ANTI_SPOOF_EVENT_COUNT, BYTES_IN, BYTES_OUT, FIP_PRE_RATE_LIMIT_BYTES, FIP_PRE_RATE_LIMIT_PACKETS, FIP_RATE_LIMIT_DROPPED_BYTES, FIP_RATE_LIMIT_DROPPED_PACKETS, 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, PORT_SCAN_PORT_COUNT, PORT_SWEEP_IP_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
SDK attribute: metric
The name of the TCA
Format: free
Min length: 1
Max length: 255
SDK attribute: name
The averaging period
Default value: 90
Min value: 1
Max value: 2592000
SDK attribute: period
This flag is used to indicate the status of TCA
SDK attribute: status
ID of the target VSD entity used by the TCA action
Format: free
Max length: 255
SDK attribute: targetEntityID
Target policygroup used by the TCA action
Format: free
SDK attribute: targetPolicyGroupID
The threshold that must be exceeded before an alarm is issued
Min value: 1
Max value: 4294967295
SDK attribute: threshold
Throttle time in seconds
Default value: 10
Min value: 10
Max value: 4294967295
SDK attribute: throttleTime
The trigger interval of the ES watch corresponding to this TCA, in seconds
Default value: 30
Min value: 10
Max value: 86400
SDK attribute: triggerInterval
The aggregation type for the metric over the selected period - Sum, Average or Unique Count
Allowed values: BREACH, ROLLING_AVERAGE, UNIQUE_COUNT
SDK attribute: type
URL endpoint to post Alarm data to when TCA is triggered
Format: free
SDK attribute: URLEndPoint