TCA

Provides the definition of the Threshold Control Alarms.

Overview

action enum (ALERT | ALERT_POLICYGROUPCHANGE) required   filterable   orderable  
count integer
description string filterable  
disable boolean
displayStatus string
entityScope enum (ENTERPRISE | GLOBAL) autogenerated   filterable   orderable  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
metric enum (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 | INGRESS_BYTE_COUNT | INGRESS_PACKET_COUNT | PACKETS_DROPPED_BY_RATE_LIMIT | PACKETS_IN | PACKETS_IN_DROPPED | PACKETS_IN_ERROR | PACKETS_OUT | PACKETS_OUT_DROPPED | PACKETS_OUT_ERROR | TCP_FLAG_ACK | TCP_FLAG_NULL | TCP_FLAG_RST | TCP_FLAG_SYN | TCP_SYN_EVENT_COUNT) required  
name string required   filterable   orderable  
period integer required   filterable   orderable  
status boolean
targetPolicyGroupID string filterable  
threshold integer required   filterable   orderable  
throttleTime integer
type enum (BREACH | ROLLING_AVERAGE) required   filterable   orderable  
URLEndPoint string filterable  

API Resource

/tcas/id
delete get put

Parents

/containerinterfaces/id/tcas
get
/zones/id/tcas
get post
/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
/tcas
get

Children

/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_POLICYGROUPCHANGE
SDK attribute: action

count integer
Discussion

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

Charateristics

Default value: 0
SDK attribute: count

description string filterable  
Discussion

Desription 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

Default value: false
SDK attribute: disable

displayStatus string
Discussion

Explanation of the TCA status

Charateristics

Format: free
SDK attribute: displayStatus

entityScope enum autogenerated   filterable   orderable  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
Format: free
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, 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, INGRESS_BYTE_COUNT, INGRESS_PACKET_COUNT, PACKETS_DROPPED_BY_RATE_LIMIT, PACKETS_IN, PACKETS_IN_DROPPED, PACKETS_IN_ERROR, PACKETS_OUT, PACKETS_OUT_DROPPED, PACKETS_OUT_ERROR, TCP_FLAG_ACK, TCP_FLAG_NULL, TCP_FLAG_RST, TCP_FLAG_SYN, TCP_SYN_EVENT_COUNT
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

Format: free
Min value: 1
SDK attribute: period

status boolean
Discussion

This flag is used to indicate the status of TCA

Charateristics

Default value: false
SDK attribute: status

targetPolicyGroupID string filterable  
Discussion

Target policygroup when TCA is triggered

Charateristics

Format: free
SDK attribute: targetPolicyGroupID

threshold integer required   filterable   orderable  
Discussion

The threshold that must be exceeded before an alarm is issued

Charateristics

Format: free
Min value: 1
SDK attribute: threshold

throttleTime integer
Discussion

Throttle time in secs

Charateristics

Default value: 0
SDK attribute: throttleTime

type enum required   filterable   orderable  
Discussion

Rolling average or sequence of samples over the averaging period.

Charateristics

Allowed values: BREACH, ROLLING_AVERAGE
SDK attribute: type

URLEndPoint string filterable  
Discussion

URL endpoint to post Alarm data to when TCA is triggered

Charateristics

Format: free
SDK attribute: URLEndPoint