Get Event Names By Component - Cisco Catalyst SD-WAN Manager API, Release 20.18 - Cisco DevNet

{"type":"api","title":"Get Event Names By Component","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/d2f02ba2-fd0d-3a26-bcc5-feafc8f24d17","info":{"title":"Monitoring and Troubleshooting","description":"Includes API operations for the following:\n- Real-time monitoring\n- Accessing statistics APIs and statistics bulk APIs\n- Retrieving device state\n- Managing alarms and events\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Monitoring - Events"],"description":"Get event names by component.","operationId":"getEventNamesByComponent","parameters":[{"name":"query","in":"query","description":"Event component name","required":true,"schema":{"type":"string"},"examples":{"Policy":{"description":"Policy","value":"Policy"},"Nat":{"description":"Nat","value":"Nat"},"BFD":{"description":"BFD","value":"BFD"},"Nwpi":{"description":"Nwpi","value":"Nwpi"},"Security":{"description":"Security","value":"Security"},"Statistics":{"description":"Statistics","value":"Statistics"},"System":{"description":"System","value":"System"},"Control":{"description":"Control","value":"Control"},"OMP":{"description":"OMP","value":"OMP"},"VPN":{"description":"VPN","value":"VPN"},"PIM":{"description":"PIM","value":"PIM"},"App Route":{"description":"App Route","value":"App-Route"},"Software":{"description":"Software","value":"Software"},"Hardware":{"description":"Hardware","value":"Hardware"},"CloudExpress":{"description":"CloudExpress","value":"CloudExpress"},"cloudDock":{"description":"cloudDock","value":"cloudDock"},"Firmware":{"description":"Firmware","value":"Firmware"},"Bridge":{"description":"Bridge","value":"Bridge"},"OSPF":{"description":"OSPF","value":"OSPF"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"component":{"type":"string","example":"Software"},"event":{"type":"string","example":"system-software-install-change"}},"$$ref":"#/components/schemas/ComponentEventMapping"},"examples":{"Events":{"description":"Events","value":{"data":[{"component":"Software","event":"system-software-install-change"},{"component":"Software","event":"system-software-install-status"},{"component":"Firmware","event":"system-firmware-install-status"},{"component":"Software","event":"im-event"},{"component":"Software","event":"utd-notification"},{"component":"Software","event":"utd-update"},{"component":"Software","event":"utd-ips-alert"},{"component":"Software","event":"utd-engine-status"},{"component":"Software","event":"utd-sessions-max"},{"component":"Software","event":"utd-version-mismatch"},{"component":"Software","event":"utd-file-reputation-retrospective-alert"},{"component":"Software","event":"utd-file-analysis-upload-state"},{"component":"Software","event":"utd-file-reputation-alert"},{"component":"Software","event":"utd-file-analysis-status-event"},{"component":"Software","event":"utd-file-reputation-status-event"},{"component":"Software","event":"utd-con"},{"component":"Software","event":"appqoe-event"},{"component":"Software","event":"data-policy-association-status"},{"component":"Software","event":"access-list-association-status"},{"component":"Software","event":"device-policy-association-status"},{"component":"Software","event":"umbrella-anycast-server-switch"},{"component":"Software","event":"system-software-patch-change"},{"component":"Software","event":"system-software-install-complete-change"},{"component":"BFD","event":"bfd-state-change"},{"component":"Hardware","event":"flash-fault"},{"component":"Hardware","event":"emmc-fault"},{"component":"Hardware","event":"sdcard-fault"},{"component":"Hardware","event":"tempsensor-fault"},{"component":"Hardware","event":"tempsensor-state"},{"component":"Hardware","event":"fan-fault"},{"component":"Hardware","event":"fantray-fault"},{"component":"Hardware","event":"pem-fault"},{"component":"Hardware","event":"pem-state-change"},{"component":"Hardware","event":"pim-fault"},{"component":"Hardware","event":"pim-state-change"},{"component":"Hardware","event":"sfp-state-change"},{"component":"Hardware","event":"usb-state-change"},{"component":"Hardware","event":"sfp-support-state"},{"component":"OMP","event":"omp-number-of-vsmarts-change"},{"component":"OMP","event":"omp-ro-gen-failure"},{"component":"OMP","event":"omp-state-change"},{"component":"OMP","event":"omp-peer-state-change"},{"component":"OMP","event":"omp-tloc-state-change"},{"component":"OMP","event":"omp-data-policy"},{"component":"OMP","event":"omp-policy"},{"component":"Control","event":"control-connection-state-change"},{"component":"Control","event":"control-connection-auth-fail"},{"component":"Control","event":"control-vbond-state-change"},{"component":"Control","event":"control-connection-tloc-ip-change"},{"component":"Control","event":"control-no-active-vsmart"},{"component":"Control","event":"control-no-active-vbond"},{"component":"Control","event":"control-vedge-list-request"},{"component":"Control","event":"tunnel-ipsec-rekey"},{"component":"Control","event":"tunnel-ipsec-manual-rekey"},{"component":"Security","event":"security-root-cert-chain-installed"},{"component":"Security","event":"pki-certificate-event"},{"component":"Security","event":"pki-certificate-expiry"},{"component":"Security","event":"security-certificate-installed"},{"component":"Security","event":"service-gre-state-update"},{"component":"Security","event":"security-new-csr-generated"},{"component":"Security","event":"security-root-cert-chain-uninstalled"},{"component":"Security","event":"security-clear-installed-certificate"},{"component":"Security","event":"security-vedge-serial-file-uploaded"},{"component":"Security","event":"security-vsmart-serial-file-uploaded"},{"component":"Security","event":"security-vedge-entry-added"},{"component":"Security","event":"security-vedge-entry-removed"},{"component":"Security","event":"security-unclaimed-vedge-entry-added"},{"component":"Security","event":"security-vsmart-entry-added"},{"component":"Security","event":"security-vsmart-entry-removed"},{"component":"Security","event":"ssl-certificate-warning"},{"component":"Security","event":"security-certificate-expired"},{"component":"Security","event":"vbond-reject-vedge-connection"},{"component":"Security","event":"device-template-missing"},{"component":"Security","event":"device-template-attached-during-ztp"},{"component":"System","event":"process-restart"},{"component":"System","event":"process-down"},{"component":"System","event":"reboot-aborted"},{"component":"System","event":"disk-usage"},{"component":"System","event":"memory-usage"},{"component":"System","event":"aaa-admin-pwd-change"},{"component":"System","event":"site-id-change"},{"component":"System","event":"domain-id-change"},{"component":"System","event":"system-ip-change"},{"component":"System","event":"org-name-change"},{"component":"System","event":"system-login-change"},{"component":"System","event":"system-logout-change"},{"component":"System","event":"system-aaa-login-fail"},{"component":"System","event":"cpu-usage"},{"component":"System","event":"system-commit"},{"component":"System","event":"pseudo-commit-status"},{"component":"VPN","event":"bgp-peer-state-change"},{"component":"VPN","event":"interface-state-change"},{"component":"VPN","event":"interface-bw"},{"component":"VPN","event":"interface-auto-bw"},{"component":"VPN","event":"route-install-fail"},{"component":"VPN","event":"tunnel-install-fail"},{"component":"VPN","event":"vrrp-group-state-change"},{"component":"OSPF","event":"ospf-neighbor-state-change"},{"component":"OSPF","event":"ospf-interface-state-change"},{"component":"PIM","event":"pim-neighbor-state-change"},{"component":"PIM","event":"pim-interface-state-change"},{"component":"PIM","event":"pim-tunnel-state-change"},{"component":"PIM","event":"pim-tunnel-change"},{"component":"System","event":"system-reboot-issued"},{"component":"System","event":"system-reboot-complete"},{"component":"VPN","event":"dhcp-address-assigned"},{"component":"VPN","event":"dhcp-address-renewed"},{"component":"VPN","event":"dhcp-address-released"},{"component":"VPN","event":"dhcp-request-rejected"},{"component":"VPN","event":"dhcp-address-rejected"},{"component":"VPN","event":"dhcp-server-state-change"},{"component":"App-Route","event":"sla-change"},{"component":"App-Route","event":"sla-violation"},{"component":"App-Route","event":"sla-violation-pkt-drop"},{"component":"VPN","event":"fib-update"},{"component":"VPN","event":"fib-updates"},{"component":"Bridge","event":"bridge-creation"},{"component":"Bridge","event":"bridge-deletion"},{"component":"Bridge","event":"bridge-interface-state-change"},{"component":"Bridge","event":"bridge-max-mac-reached"},{"component":"System","event":"app-dpi-flows-out-of-memory"},{"component":"System","event":"app-dpi-flows-write-failed-vedge"},{"component":"Statistics","event":"data-block-create"},{"component":"Statistics","event":"data-block-delete"},{"component":"security","event":"vmanage-connection-preference-changed"},{"component":"CloudExpress","event":"cloudexpress-application-change"},{"component":"CloudExpress","event":"cloudexpress-score-change"},{"component":"CloudExpress","event":"cloudexpress-max-local-exit-exceeded"},{"component":"Hardware","event":"sim-state-change"},{"component":"VPN","event":"interface-admin-state-change"},{"component":"VPN","event":"endpoint_tracker_state_change"},{"component":"Hardware","event":"domain-state-change"},{"component":"Hardware","event":"reg-state-change"},{"component":"Hardware","event":"bearer-change"},{"component":"Policy","event":"zbfw-flow-creation"},{"component":"Policy","event":"zbfw-flow-deletion"},{"component":"Policy","event":"zbfw-clear-flow-table-full"},{"component":"Policy","event":"zbfw-pkt-log"},{"component":"Policy","event":"zbfw-sessions-maximum"},{"component":"Policy","event":"zbfw-sess-rate-alert-on"},{"component":"Policy","event":"zbfw-sess-rate-alert-off"},{"component":"Policy","event":"data-policy-association-status"},{"component":"Policy","event":"access-list-association-status"},{"component":"Policy","event":"zbfw-flow-table-full"},{"component":"Policy","event":"zbfw-half-open-limit-hit"},{"component":"App-Route","event":"sla-config"},{"component":"cloudDock","event":"NETWORK_CREATE"},{"component":"cloudDock","event":"NETWORK_DELETE"},{"component":"cloudDock","event":"BRIDGE_CREATE"},{"component":"cloudDock","event":"BRIDGE_UPDATE"},{"component":"cloudDock","event":"BRIDGE_DELETE"},{"component":"cloudDock","event":"WAN_DHCP_RENEW"},{"component":"cloudDock","event":"MGMT_DHCP_RENEW"},{"component":"cloudDock","event":"INTF_STATUS_CHANGE"},{"component":"cloudDock","event":"UPGRADE_REGISTER"},{"component":"cloudDock","event":"UPGRADE_APPLY"},{"component":"cloudDock","event":"RBAC_USER_CREATE"},{"component":"cloudDock","event":"RBAC_USER_PASSWORD_UPDATE"},{"component":"cloudDock","event":"RBAC_USER_ROLE_UPDATE"},{"component":"cloudDock","event":"RBAC_USER_DELETE"},{"component":"cloudDock","event":"RBAC_USERS_INACTIVATED"},{"component":"cloudDock","event":"RBAC_USER_ACTIVATED"},{"component":"cloudDock","event":"RBAC_PWD_EXPIRED"},{"component":"cloudDock","event":"SECURITY_SERVER_CREATE"},{"component":"cloudDock","event":"SECURITY_SERVER_UPDATE"},{"component":"cloudDock","event":"SECURITY_SERVER_DELETE"},{"component":"cloudDock","event":"AAA_TYPE_CREATE"},{"component":"cloudDock","event":"AAA_TYPE_UPDATE"},{"component":"cloudDock","event":"CERT_SWITCH_CERT"},{"component":"cloudDock","event":"CERT_CSR_CREATE"},{"component":"cloudDock","event":"CERT_CA_CERT_INSTALL"},{"component":"cloudDock","event":"REBOOT"},{"component":"cloudDock","event":"SHUTDOWN"},{"component":"cloudDock","event":"LOGGING_FAILURE"},{"component":"cloudDock","event":"DISK_SPACE_ALMOST_FULL"},{"component":"cloudDock","event":"ROTATED_LOGS_DELETE"},{"component":"cloudDock","event":"TIME_UPDATE"},{"component":"cloudDock","event":"TIMEZONE_UPDATE"},{"component":"cloudDock","event":"FILE_COPY_STATUS"},{"component":"cloudDock","event":"FILE_DOWNLOAD_STATUS"},{"component":"cloudDock","event":"FILE_DOWNLOAD_START"},{"component":"cloudDock","event":"FILE_DOWNLOAD_VERIFIED"},{"component":"cloudDock","event":"FILE_DOWNLOAD_DONE"},{"component":"cloudDock","event":"FILE_DOWNLOAD_FAILED"},{"component":"cloudDock","event":"CREATE_IMAGE"},{"component":"cloudDock","event":"DELETE_IMAGE"},{"component":"cloudDock","event":"CREATE_FLAVOR"},{"component":"cloudDock","event":"VM_DEPLOYED"},{"component":"cloudDock","event":"VM_ALIVE"},{"component":"cloudDock","event":"SERVICE_ALIVE"},{"component":"cloudDock","event":"VM_UNDEPLOYED"},{"component":"cloudDock","event":"SERVICE_UNDEPLOYED"},{"component":"cloudDock","event":"SERVICE_UPDATED"},{"component":"cloudDock","event":"VM_STOPPED"},{"component":"cloudDock","event":"VM_STARTED"},{"component":"cloudDock","event":"VM_UPDATED"},{"component":"cloudDock","event":"VM_REBOOTED"},{"component":"cloudDock","event":"VM_RECOVERY_INIT"},{"component":"cloudDock","event":"VM_RECOVERY_REBOOT"},{"component":"cloudDock","event":"VM_RECOVERY_COMPLETE"},{"component":"cloudDock","event":"VM_MONITOR_UNSET"},{"component":"cloudDock","event":"VM_MONITOR_SET"},{"component":"cloudDock","event":"CIMC_PASSWORD_UPDATE"},{"component":"cloudDock","event":"FACTORY_RESET"},{"component":"cloudDock","event":"CPU_USAGE_HIGH"},{"component":"cloudDock","event":"viptela"},{"component":"cloudDock","event":"ccmEvent"},{"component":"Software","event":"umbrella-registration-success"},{"component":"Software","event":"umbrella-registration-failure"},{"component":"Software","event":"site-id-mismatch"},{"component":"Software","event":"service-node-state"},{"component":"Software","event":"appqoe-alarm"},{"component":"Security","event":"fw-alert"},{"component":"Security","event":"ftm-zia-tunnel-setup"},{"component":"Security","event":"ftm-tunnel-setup"},{"component":"Security","event":"ftm-zia-location-setup"},{"component":"Security","event":"ftm-tunnel-tracker"},{"component":"System","event":"dca-change-event"},{"component":"System","event":"geo-fence-alert-status"},{"component":"Software","event":"app-list-app-aliases-notify"},{"component":"Software","event":"app-list-unsupported-app-notify"},{"component":"VPN","event":"tracker-state-change"},{"component":"System","event":"disk-read-speed"},{"component":"System","event":"disk-write-speed"},{"component":"Software","event":"idmgr-pxgrid-connection"},{"component":"Nwpi","event":"qos-congestion"},{"component":"Nat","event":"nat-update"},{"component":"System","event":"aaa-password-expiry-warning"},{"component":"System","event":"aaa-password-expired"},{"component":"Policy","event":"data-policy-commit-failure"},{"component":"System","event":"non-yang-cli-file-generated"},{"component":"Hardware","event":"cellular-network-status-change"}]},"$$ref":"#/components/examples/ComViptelaVmanageServerEventResponseGeteventsbycomponent"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default","method":"get","path":"/event/getEventsByComponent"}}