TCA

Provides the definition of the Threshold Control Alarms.

Overview

action enum (Alert | Alert_Add_Network_Macro | Alert_Add_Policy_Group | Alert_PolicyGroupChange) required   filterable   orderable  
count integer
description string filterable  
disable boolean
displayStatus string
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
metric enum (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) required  
name string required   filterable   orderable  
period integer required   filterable   orderable  
status boolean
targetEntityID string filterable  
targetPolicyGroupID string filterable  
threshold integer required   filterable   orderable  
throttleTime integer
triggerInterval integer
type enum (BREACH | ROLLING_AVERAGE | UNIQUE_COUNT) required   filterable   orderable  
URLEndPoint string filterable  

API Resource

/tcas/id
delete get put

Parents

get
/zones/id/tcas
get post
/tcas
get
/vports/id/tcas
get post
/subnets/id/tcas
get post
/vminterfaces/id/tcas
get
/bridgeinterfaces/id/tcas
get
/domains/id/tcas
get post
/l2domains/id/tcas
get post
/hostinterfaces/id/tcas
get
get post

Children

/tcas/id/permissions
delete get post put
/tcas/id/metadatas
get post
/tcas/id/alarms
get post
/tcas/id/globalmetadatas
get post put
/tcas/id/eventlogs
get

Members

This object has no members.

Attributes documentation

action enum required   filterable   orderable  
Discussion

Action to be taken when TCA is fired - Alert or PolicyGroupChange


Charateristics

Allowed values: Alert, Alert_Add_Network_Macro, Alert_Add_Policy_Group, Alert_PolicyGroupChange
SDK attribute: action

count integer
Discussion

Count of the attempts by maintenanace thread to create/update watcher


Charateristics

SDK attribute: count

description string filterable  
Discussion

Description of the TCA


Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: description

disable boolean
Discussion

This flag is used to indicate whether the watch(TCA) is enabled/disabled


Charateristics

SDK attribute: disable

displayStatus string
Discussion

Explanation of the TCA status


Charateristics

Format: free
SDK attribute: displayStatus

embeddedMetadata list read only   autogenerated  
Discussion

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.


Charateristics

SDK attribute: embeddedMetadata

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level


Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems


Charateristics

Format: free
SDK attribute: externalID

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.


Charateristics

Format: free
SDK attribute: lastUpdatedBy

metric enum required  
Discussion

The metric associated with the TCA.


Charateristics

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

name string required   filterable   orderable  
Discussion

The name of the TCA


Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: name

period integer required   filterable   orderable  
Discussion

The averaging period


Charateristics

Default value: 90
Min value: 1
Max value: 2592000
SDK attribute: period

status boolean
Discussion

This flag is used to indicate the status of TCA


Charateristics

SDK attribute: status

targetEntityID string filterable  
Discussion

ID of the target VSD entity used by the TCA action


Charateristics

Format: free
Max length: 255
SDK attribute: targetEntityID

targetPolicyGroupID string filterable  
Discussion

Target policygroup used by the TCA action


Charateristics

Format: free
SDK attribute: targetPolicyGroupID

threshold integer required   filterable   orderable  
Discussion

The threshold that must be exceeded before an alarm is issued


Charateristics

Min value: 1
Max value: 4294967295
SDK attribute: threshold

throttleTime integer
Discussion

Throttle time in seconds


Charateristics

Default value: 10
Min value: 10
Max value: 4294967295
SDK attribute: throttleTime

triggerInterval integer
Discussion

The trigger interval of the ES watch corresponding to this TCA, in seconds


Charateristics

Default value: 30
Min value: 10
Max value: 86400
SDK attribute: triggerInterval

type enum required   filterable   orderable  
Discussion

The aggregation type for the metric over the selected period - Sum, Average or Unique Count


Charateristics

Allowed values: BREACH, ROLLING_AVERAGE, UNIQUE_COUNT
SDK attribute: type

URLEndPoint string filterable  
Discussion

URL endpoint to post Alarm data to when TCA is triggered


Charateristics

Format: free
SDK attribute: URLEndPoint