Update Event Correlation Policy Rule Configuration (v2.0)
Update the event correlation policy rule configuration.
Path Parameters
- policy_set_id string required
ID of the event policy set.
- policy_rule_id string required
ID of the event policy rule.
- application/json
Request Body
Details of the event correlation policyrule to be updated
- description
Description of the event correlation policy rules.
- enabled boolean
The enabled event correlation policy rules.
- end_time int64
The end date in MM/DD/YYYY HH: mm format of the applied event policy rule.
escalation_rules EscalationRule
The alarms which have their priority escalated based on standing rule and flap rule.
flap_rule FlapRule
Resource flaps more than the rate specified during the defined interval, then a new flap rate exceeded alarm is generated.
flap_duration integerFlap duration cannot be less than 5 minutes and more than 10080 minutes (a week).
flap_rate integerFlap count cannot be lower than 2 nor higher than 512.
standing_rule StandingRule
Alarms standing for more than the specified period.
priority string requiredPossible values: [
p1
,p2
,p3
,p4
,p5
,none
]Priority specified for the standing rule. Range from Priority 1 (P1), through Priority 5 (P5).
standing_for integerStanding for duration cannot be less than 5 minutes and more than 10080 minutes(a week).
- event_codes string[]
Possible values: [
DEVICEHW_POWER_LOST
,DEVICEHW_INTERFACE_DOWN
,DEVICEHW_INTERFACE_HALFDUPLEX
,DEVICEHW_INTERFACE_ERRORS
,DEVICEHW_DISKUTIL_PARTITIONSPACE
,DEVICEHW_DISKENC_SYSTEM
,DEVICEHW_MEMUTIL_SWAPSPACE
,DEVICESW_GENERAL_PROCESSRESTART
,DEVICESW_GENERAL_PROCESSSTOP
,DEVICESW_CRITICAL_PROCESSRESTART
,DEVICESW_CRITICAL_PROCESSSTOP
,DEVICESW_LICENSE_VERIFICATION_FAILED
,DEVICESW_MONITOR_DISABLED
,DEVICESW_SYSTEM_BOOT
,DEVICESW_TOKEN_VERIFICATION_FAILED
,DEVICESW_IMAGE_UNSUPPORTED
,DEVICESW_DHCPSERVER_RESTART
,DEVICESW_DHCPRELAY_RESTART
,DEVICESW_DHCPSERVER_ERRORS
,DEVICESW_SNMP_AGENT_RESTART
,DEVICESW_SNMP_AGENT_FAILED_TO_START
,DEVICESW_SYSLOGSERVERS_DOWN
,DEVICESW_NTP_NO_SYNC
,DEVICEIF_ADDRESS_DUPLICATE
,DEVICEIF_IPV6_ADDRESS_DUPLICATE
,NETWORK_VPNLINK_DOWN
,NETWORK_VPNPEER_UNAVAILABLE
,NETWORK_VPNPEER_UNREACHABLE
,NETWORK_VPNSS_MISMATCH
,NETWORK_VPNSS_UNAVAILABLE
,NETWORK_VPNBFD_DOWN
,NETWORK_VPNLINKCIPHERS_INCOMPATIBLE
,NETWORK_DIRECTPRIVATE_DOWN
,NETWORK_DIRECTINTERNET_DOWN
,NETWORK_PRIVATEWAN_UNREACHABLE
,NETWORK_PRIVATEWAN_DEGRADED
,PEERING_EDGE_DOWN
,PEERING_CORE_DOWN
,PEERING_BGP_DOWN
,APPLICATION_APP_UNREACHABLE
,APPLICATION_IP_COLLISION
,APPLICATION_UNKNOWNS_HIGH
,APPLICATION_FLOWCTRL_APPUNREACHABLE
,APPLICATION_FLOWCTRL_APPREACHABLE
,APPLICATION_FLOWCTRL_APPWITHINSLA
,APPLICATION_FLOWCTRL_APPOUTSIDESLA
,OPERATOR_SIGNUP_TOKEN_DISABLED
,DEVICESW_FPS_LIMIT_EXCEEDED
,DEVICESW_CONCURRENT_FLOWLIMIT_EXCEEDED
,SITE_CIRCUIT_ABSENT_FOR_POLICY
,NETWORK_POLICY_RULE_CONFLICT
,PRIORITY_POLICY_RULE_CONFLICT
,APPLICATION_CUSTOM_RULE_CONFLICT
,NETWORK_POLICY_RULE_DROPPED
,PRIORITY_POLICY_RULE_DROPPED
,DEVICESW_DISCONNECTED_FROM_CONTROLLER
,SPOKEHA_STATE_UPDATE
,SPOKEHA_MULTIPLE_ACTIVE_DEVICES
,SPOKEHA_CLUSTER_DEGRADED
,SPOKEHA_CLUSTER_DOWN
,NAT_POLICY_LEGACY_ALG_CONFIG_OVERRIDE
,NAT_POLICY_STATIC_NATPOOL_OVERRUN
,DEVICESW_CONNTRACK_FLOWLIMIT_EXCEEDED
,DEVICESW_INITIATED_CONNECTION_ON_EXCLUDED_PATH
,NETWORK_ANYNETLINK_DEGRADED
,NETWORK_ANYNETLINK_DOWN
,CLAIMCERT_RENEWAL_RETRY_LIMIT_EXCEEDED
,CLAIMCERT_RENEWAL_FAILED
,CLAIMCERT_AUTO_RENEWAL_DISABLED
,CLAIMCERT_RENEWALS_TOO_FREQUENT
,FLAP_RATE_EXCEEDED
,DEVICESW_ANALYTICS_DISCONNECTED_FROM_CONTROLLER
,DEVICESW_FLOWS_DISCONNECTED_FROM_CONTROLLER
,APPLICATION_PROBE_DISABLED
,SITE_CONNECTIVITY_DOWN
,NETWORK_STANDARD_VPN_ENDPOINT_DOWN
,SECURITY_POLICY_RULE_INCOMPLETE
,SITE_NETWORK_SERVICE_ABSENT_FOR_POLICY
,DEVICESW_IPFIX_COLLECTORS_DOWN
,SITE_CONNECTIVITY_DEGRADED
,CLAIMCERT_EXPIRY_WARNING
,DEVICE_CELLULAR_ROAMING
,DEVICE_CELLULAR_SIM_REMOVAL
,DEVICE_CELLULAR_SIM_SWITCHOVER
,DEVICE_CELLULAR_SIGNAL_STRENGTH_THRESH
,DEVICE_CELLULAR_INTERNAL_MODEM_ERROR
,DEVICE_CELLULAR_TECH_CHANGE
,DEVICE_CELLULAR_SIM_PIN_ERROR
,DEVICE_CELLULAR_SIM_PUK_NEEDED
,DEVICE_CELLULAR_MODEM_TEMP_HIGH
,DEVICE_CELLULAR_MTU_MISMATCH
,DEVICE_CELLULAR_MODEM_DETECTION_ERROR
,DEVICE_CELLULAR_SIM_SECURITY_ERROR
,DEVICE_CELLULAR_FIRMWARE_NOT_AVAILABLE
,DEVICEHW_ION9000X722FW_OUTOFDATE
,DEVICESW_APPDEF_SIGFILE_MISMATCH
,SECURITY_POLICY_LIMITS_EXCEEDED
,SASE_SERVICEENDPOINT_BANDWIDTH_LIMIT_EXCEEDED
,SASE_SERVICEENDPOINT_BANDWIDTH_SOFT_LIMIT_EXCEEDED
,VION_BANDWIDTH_LIMIT_EXCEEDED
,VION_BANDWIDTH_SOFT_LIMIT_EXCEEDED
,SPN_BANDWIDTH_LIMIT_EXCEEDED
,SPN_BANDWIDTH_SOFT_LIMIT_EXCEEDED
,DEVICE_POE_PORT_POWER_STATUS
,DEVICE_POE_PORT_POWER_OVER_THRESHOLD
,DEVICE_POE_MAIN_POWER_OVER_THRESHOLD
,DEVICE_POE_MAIN_POWER_FAULT
,DOT1X_RADIUS_SERVER_UNREACHABLE
,DOT1X_DYNAMIC_VLAN_NOT_CONFIGURED
,DOT1X_CLIENT_AUTH_FAIL
,HUB_CLUSTER_SITE_COUNT_THRESHOLD_EXCEEDED
]List all the event codes.
- id string
ID of the event policy set.
- name string required
Name of the event policy set. Max 25 characters.
- priority string required
Possible values: [
p1
,p2
,p3
,p4
,p5
,none
]Priority level set for the event policy rule.
- resource_ids string[]
The resource IDs configured for a rule. Max 128 resources can be configured in a rule.
- resource_type string
Possible values: [
site
,element
,anynetlink
,bgppeer
,interface
,waninterface
,networkpolicyset
,prioritypolicyset
,natpolicyset
,securitypolicyset
,appdef
,serviceendpoint
,cellular_module
]The resource on which the event policy rule is applied.
- start_time int64
The start date in MM/DD/YYYY HH: mm format of the event policy rule applied.
- sub_resource_type string
Possible values: [
spoke
,hub
,public
,private
]The sub-resource type to narrow down the match criteria to more specific elements.
- suppress string required
Possible values: [
yes
,no
,none
]The sub-resource type to narrow down the match criteria to more specific elements.The event policy rule which suppresses or unsuppress the alarms on the resources identified by the resource type, sub-resource type, or matched event codes during the specified schedule.
- tags string[]
A information field that can be added to identify the event correlation policy rule. Maximum 10 unique tags of length 1024 each are allowed.
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
- description
Description of the event correlation policy rules.
- enabled boolean
The enabled event correlation policy rules.
- end_time int64
The end date in MM/DD/YYYY HH: mm format of the applied event policy rule.
escalation_rules EscalationRule
The alarms which have their priority escalated based on standing rule and flap rule.
flap_rule FlapRule
Resource flaps more than the rate specified during the defined interval, then a new flap rate exceeded alarm is generated.
flap_duration integerFlap duration cannot be less than 5 minutes and more than 10080 minutes (a week).
flap_rate integerFlap count cannot be lower than 2 nor higher than 512.
standing_rule StandingRule
Alarms standing for more than the specified period.
priority string requiredPossible values: [
p1
,p2
,p3
,p4
,p5
,none
]Priority specified for the standing rule. Range from Priority 1 (P1), through Priority 5 (P5).
standing_for integerStanding for duration cannot be less than 5 minutes and more than 10080 minutes(a week).
- event_codes string[]
Possible values: [
DEVICEHW_POWER_LOST
,DEVICEHW_INTERFACE_DOWN
,DEVICEHW_INTERFACE_HALFDUPLEX
,DEVICEHW_INTERFACE_ERRORS
,DEVICEHW_DISKUTIL_PARTITIONSPACE
,DEVICEHW_DISKENC_SYSTEM
,DEVICEHW_MEMUTIL_SWAPSPACE
,DEVICESW_GENERAL_PROCESSRESTART
,DEVICESW_GENERAL_PROCESSSTOP
,DEVICESW_CRITICAL_PROCESSRESTART
,DEVICESW_CRITICAL_PROCESSSTOP
,DEVICESW_LICENSE_VERIFICATION_FAILED
,DEVICESW_MONITOR_DISABLED
,DEVICESW_SYSTEM_BOOT
,DEVICESW_TOKEN_VERIFICATION_FAILED
,DEVICESW_IMAGE_UNSUPPORTED
,DEVICESW_DHCPSERVER_RESTART
,DEVICESW_DHCPRELAY_RESTART
,DEVICESW_DHCPSERVER_ERRORS
,DEVICESW_SNMP_AGENT_RESTART
,DEVICESW_SNMP_AGENT_FAILED_TO_START
,DEVICESW_SYSLOGSERVERS_DOWN
,DEVICESW_NTP_NO_SYNC
,DEVICEIF_ADDRESS_DUPLICATE
,DEVICEIF_IPV6_ADDRESS_DUPLICATE
,NETWORK_VPNLINK_DOWN
,NETWORK_VPNPEER_UNAVAILABLE
,NETWORK_VPNPEER_UNREACHABLE
,NETWORK_VPNSS_MISMATCH
,NETWORK_VPNSS_UNAVAILABLE
,NETWORK_VPNBFD_DOWN
,NETWORK_VPNLINKCIPHERS_INCOMPATIBLE
,NETWORK_DIRECTPRIVATE_DOWN
,NETWORK_DIRECTINTERNET_DOWN
,NETWORK_PRIVATEWAN_UNREACHABLE
,NETWORK_PRIVATEWAN_DEGRADED
,PEERING_EDGE_DOWN
,PEERING_CORE_DOWN
,PEERING_BGP_DOWN
,APPLICATION_APP_UNREACHABLE
,APPLICATION_IP_COLLISION
,APPLICATION_UNKNOWNS_HIGH
,APPLICATION_FLOWCTRL_APPUNREACHABLE
,APPLICATION_FLOWCTRL_APPREACHABLE
,APPLICATION_FLOWCTRL_APPWITHINSLA
,APPLICATION_FLOWCTRL_APPOUTSIDESLA
,OPERATOR_SIGNUP_TOKEN_DISABLED
,DEVICESW_FPS_LIMIT_EXCEEDED
,DEVICESW_CONCURRENT_FLOWLIMIT_EXCEEDED
,SITE_CIRCUIT_ABSENT_FOR_POLICY
,NETWORK_POLICY_RULE_CONFLICT
,PRIORITY_POLICY_RULE_CONFLICT
,APPLICATION_CUSTOM_RULE_CONFLICT
,NETWORK_POLICY_RULE_DROPPED
,PRIORITY_POLICY_RULE_DROPPED
,DEVICESW_DISCONNECTED_FROM_CONTROLLER
,SPOKEHA_STATE_UPDATE
,SPOKEHA_MULTIPLE_ACTIVE_DEVICES
,SPOKEHA_CLUSTER_DEGRADED
,SPOKEHA_CLUSTER_DOWN
,NAT_POLICY_LEGACY_ALG_CONFIG_OVERRIDE
,NAT_POLICY_STATIC_NATPOOL_OVERRUN
,DEVICESW_CONNTRACK_FLOWLIMIT_EXCEEDED
,DEVICESW_INITIATED_CONNECTION_ON_EXCLUDED_PATH
,NETWORK_ANYNETLINK_DEGRADED
,NETWORK_ANYNETLINK_DOWN
,CLAIMCERT_RENEWAL_RETRY_LIMIT_EXCEEDED
,CLAIMCERT_RENEWAL_FAILED
,CLAIMCERT_AUTO_RENEWAL_DISABLED
,CLAIMCERT_RENEWALS_TOO_FREQUENT
,FLAP_RATE_EXCEEDED
,DEVICESW_ANALYTICS_DISCONNECTED_FROM_CONTROLLER
,DEVICESW_FLOWS_DISCONNECTED_FROM_CONTROLLER
,APPLICATION_PROBE_DISABLED
,SITE_CONNECTIVITY_DOWN
,NETWORK_STANDARD_VPN_ENDPOINT_DOWN
,SECURITY_POLICY_RULE_INCOMPLETE
,SITE_NETWORK_SERVICE_ABSENT_FOR_POLICY
,DEVICESW_IPFIX_COLLECTORS_DOWN
,SITE_CONNECTIVITY_DEGRADED
,CLAIMCERT_EXPIRY_WARNING
,DEVICE_CELLULAR_ROAMING
,DEVICE_CELLULAR_SIM_REMOVAL
,DEVICE_CELLULAR_SIM_SWITCHOVER
,DEVICE_CELLULAR_SIGNAL_STRENGTH_THRESH
,DEVICE_CELLULAR_INTERNAL_MODEM_ERROR
,DEVICE_CELLULAR_TECH_CHANGE
,DEVICE_CELLULAR_SIM_PIN_ERROR
,DEVICE_CELLULAR_SIM_PUK_NEEDED
,DEVICE_CELLULAR_MODEM_TEMP_HIGH
,DEVICE_CELLULAR_MTU_MISMATCH
,DEVICE_CELLULAR_MODEM_DETECTION_ERROR
,DEVICE_CELLULAR_SIM_SECURITY_ERROR
,DEVICE_CELLULAR_FIRMWARE_NOT_AVAILABLE
,DEVICEHW_ION9000X722FW_OUTOFDATE
,DEVICESW_APPDEF_SIGFILE_MISMATCH
,SECURITY_POLICY_LIMITS_EXCEEDED
,SASE_SERVICEENDPOINT_BANDWIDTH_LIMIT_EXCEEDED
,SASE_SERVICEENDPOINT_BANDWIDTH_SOFT_LIMIT_EXCEEDED
,VION_BANDWIDTH_LIMIT_EXCEEDED
,VION_BANDWIDTH_SOFT_LIMIT_EXCEEDED
,SPN_BANDWIDTH_LIMIT_EXCEEDED
,SPN_BANDWIDTH_SOFT_LIMIT_EXCEEDED
,DEVICE_POE_PORT_POWER_STATUS
,DEVICE_POE_PORT_POWER_OVER_THRESHOLD
,DEVICE_POE_MAIN_POWER_OVER_THRESHOLD
,DEVICE_POE_MAIN_POWER_FAULT
,DOT1X_RADIUS_SERVER_UNREACHABLE
,DOT1X_DYNAMIC_VLAN_NOT_CONFIGURED
,DOT1X_CLIENT_AUTH_FAIL
,HUB_CLUSTER_SITE_COUNT_THRESHOLD_EXCEEDED
]List all the event codes.
- id string
ID of the event policy set.
- name string required
Name of the event policy set. Max 25 characters.
- priority string required
Possible values: [
p1
,p2
,p3
,p4
,p5
,none
]Priority level set for the event policy rule.
- resource_ids string[]
The resource IDs configured for a rule. Max 128 resources can be configured in a rule.
- resource_type string
Possible values: [
site
,element
,anynetlink
,bgppeer
,interface
,waninterface
,networkpolicyset
,prioritypolicyset
,natpolicyset
,securitypolicyset
,appdef
,serviceendpoint
,cellular_module
]The resource on which the event policy rule is applied.
- start_time int64
The start date in MM/DD/YYYY HH: mm format of the event policy rule applied.
- sub_resource_type string
Possible values: [
spoke
,hub
,public
,private
]The sub-resource type to narrow down the match criteria to more specific elements.
- suppress string required
Possible values: [
yes
,no
,none
]The sub-resource type to narrow down the match criteria to more specific elements.The event policy rule which suppresses or unsuppress the alarms on the resources identified by the resource type, sub-resource type, or matched event codes during the specified schedule.
- tags string[]
A information field that can be added to identify the event correlation policy rule. Maximum 10 unique tags of length 1024 each are allowed.
{
"enabled": true,
"end_time": 0,
"escalation_rules": {
"flap_rule": {
"flap_duration": 0,
"flap_rate": 0
},
"standing_rule": {
"priority": "p1",
"standing_for": 0
}
},
"event_codes": [
"DEVICEHW_POWER_LOST"
],
"id": "string",
"name": "string",
"priority": "p1",
"resource_ids": [
"string"
],
"resource_type": "site",
"start_time": 0,
"sub_resource_type": "spoke",
"suppress": "yes",
"tags": [
"string"
]
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
_error ErrorResponse[]
Array [code stringmessage string]
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "INVALID_JSON_EXTRA_ATTRIBUTE"
},
{
"code": "EVENT_POLICY_INVALID_RESOURCES"
},
{
"code": "EVENT_POLICY_INVALID_PRIORITY"
},
{
"code": "EVENT_POLICY_INVALID_SUPPRESS"
},
{
"code": "EVENT_POLICY_INVALID_RESOURCE_SUB_TYPE"
},
{
"code": "EVENT_POLICY_RULE_MAX_RESOURCE_IDS"
},
{
"code": "EVENT_POLICY_INVALID_RESOURCE_TYPE"
}
]
}
}