openapi: 3.2.0 info: title: Monitoring and Troubleshooting Monitoring - Alarms Details API 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" contact: email: vmanage@cisco.com license: name: Commercial License url: https://www.cisco.com/c/en/us/solutions/enterprise-networks/sd-wan/index.html version: 26.1.0+2026-01-06 x-provenance: method: harvested authored_by: Cisco Catalyst SD-WAN harvested_by: API Evangelist harvested_on: '2026-08-19' first_party: true provider_published: true source_host: pubhub.devnetcloud.com note: 4,138 operations across 2,841 paths, published by Cisco as self-contained per-operation OpenAPI 3.1.0 fragments on the DevNet CDN and consolidated here into 13 documents. Ownership verified from info.contact vmanage@cisco.com and the Cisco license URL rather than from the fetch host. x-evidence: - type: source url: https://pubhub.devnetcloud.com/media/cisco-catalyst-sd-wan-26-1-api-guide/docs/ - type: source url: https://developer.cisco.com/docs/sdwan/ servers: - url: /dataservice tags: - name: Monitoring - Alarms Details paths: /alarms: post: tags: - Monitoring - Alarms Details description: Get alarms for given query. operationId: postRawAlarmData parameters: - name: page in: query description: Specify page number. Value should be a positive integer schema: minimum: 1 type: integer format: int64 - name: pageSize in: query description: Specify page size. Value should be a positive integer schema: minimum: 1 type: integer format: int64 - name: sortBy in: query description: Specify a field by which alarms need to be sorted schema: pattern: ^[a-zA-Z-_]+$ type: string - name: sortOrder in: query description: Select sorting order. Use ASC for ascending and DESC for descending schema: type: string - name: site-id in: query description: Specify the site-id to filter the alarms schema: pattern: ^[0-9]+$ type: string - name: includeTenants in: query description: Specify whether the tenant alarms need to be visible or not from provider view. schema: type: boolean requestBody: description: Alarm query string content: application/json: schema: type: object examples: Get active alarms: description: Get active alarms value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: active type: boolean value: - 'true' operator: equal $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByActive' Get alarms filter by hours: description: Get alarms filter by hours value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByHours' Get alarms filter between dates: description: Get alarms filter between dates value: query: condition: AND rules: - field: entry_time type: date value: - 2024-04-30T19:30:00 UTC - 2024-05-30T17:30:00 UTC operator: between size: 10000 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBetweenDates' Get alarms filter by type: description: Get alarms filter by type value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: rule_name_display operator: in type: string value: - Memory_Usage size: 10000 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByType' Get alarms filter by system ip: description: Get alarms filter by system ip value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: system_ip operator: in type: string value: - 1.1.1.1 size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySystemIp' Get alarms filter by severity: description: Get alarms filter by severity value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: severity operator: in type: string value: - Critical size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySeverity' Get alarms filter by site-id: description: Get alarms filter by site-id value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: site_id operator: in type: string value: - '400' - '500' size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySites' required: true responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: type: object properties: acknowledged: type: boolean active: type: boolean cleared_by: type: string format: uuid example: 0a0dca23-11d5-4014-bfbb-976d3c6de492 cleared_events: type: array items: type: string format: uuid cleared_time: type: integer format: int64 example: 1652894923722 component: type: string example: Schedule Telemetry collection consumed_events: type: array items: type: object $$ref: '#/components/schemas/OneOfAlarmConsumedEventsItems' devices: type: array items: type: object properties: system-ip: type: string example: 19.19.19.1 $$ref: '#/components/schemas/AlarmDevices' entry_time: type: integer format: int64 example: 1652906591837 eventname: type: string example: telemetry-data-collection-failure id: type: string example: HHbp2IABUbH5BDy9BhJe message: type: string example: Scheduled telemetry data collection failed on 19.19.19.1 possible_causes: type: array items: type: string receive_time: type: integer format: int64 rule_name_display: type: string example: Telemetry data save failed rulename: type: string example: cpu-usage severity: type: string enum: - Minor - Major - Critical - Medium severity_number: type: integer format: int64 example: 4 site_id: type: integer format: int64 example: 100 statcycletime: type: integer format: int64 suppressed: type: boolean example: false suppressed_by: type: object example: system-ip: type: string example: 172.16.255.11 component: type: string example: BFD system_ip: type: string example: 172.16.255.26 tenant: type: string example: default type: type: string example: Telemetry data save failed uuid: type: string format: uuid example: f6f83721-3a69-42d1-841f-94e015957fb7 values: type: array items: type: object properties: empty: type: boolean additionalProperties: type: string $$ref: '#/components/schemas/GeneralSchema' values_short_display: type: array items: type: object properties: empty: type: boolean additionalProperties: type: string $$ref: '#/components/schemas/GeneralSchema' description: Represents any kind of alarm $$ref: '#/components/schemas/Alarm' pageInfo: type: object properties: count: type: integer description: number of alarms to be fetched format: int64 endTime: type: integer description: end time of alarms to be fetched format: int64 startTime: type: integer description: start time of alarms to be fetched format: int64 $$ref: '#/components/schemas/PageInfo' description: AlarmResponse is used for GET/POST /alarms call. $$ref: '#/components/schemas/AlarmResponse' examples: 200 Response: description: 200 Response value: header: generatedOn: 1717671384603 viewKeys: uniqueKey: [] preferenceKey: grid-Alarms columns: - title: Impacted Entities property: values_short_display minWidth: 250 dataType: jsonArray - title: Severity property: severity display: iconAndText iconProperty: severity hideable: false icon: - key: Minor value: images/event_minor.png - key: Major value: images/event_major.png - key: Critical value: images/event_critical.png - key: Medium value: images/event_other.png minWidth: 70 dataType: string - title: Alarm Name property: rule_name_display minWidth: 160 dataType: string - title: Message property: message minWidth: 250 dataType: string - title: Date & Time property: entry_time displayFormat: DD MMM YYYY h:mm:ss A z inputFormat: unix-time minWidth: 200 dataType: date - title: Cleared Date & Time property: cleared_time displayFormat: DD MMM YYYY h:mm:ss A z inputFormat: unix-time minWidth: 200 dataType: date fields: - property: values_short_display dataType: jsonArray - property: severity dataType: string display: iconAndText - property: rule_name_display dataType: string - property: message dataType: string - property: possible_causes dataType: string - property: entry_time dataType: date - property: cleared_time dataType: date chart: {} pageInfo: startTime: '1717671338582' endTime: '1717669597190' count: 60 data: - entry_time: 1717671338582 uuid: 59a93996-719d-4550-bbd5-1ba8c60b3d31 message: failed to sync root cert to device (ca9ec973-ba93-48ea-ad40-dea43b32d9f5, vm10, 172.16.255.20) on 06 Jun 2024 10:55:38 UTC type: rootca-sync-failure component: System severity: Critical severity_number: 1 devices: - system-ip: 172.16.255.20 active: 'true' values: - system-ip: 172.16.255.20 host-name: vm10 acknowledged: 'false' cleared_by: '' suppressed: 'false' suppressed_by: '' rulename: rootca-sync-failure rule_name_display: ROOTCA_SYNC_FAILURE values_short_display: - host-name: vm10 system-ip: 172.16.255.20 cleared_time: 0 statcycletime: 1717671338582 tenant: default eventname: rootca-sync-failure receive_time: 1717671338582 system_ip: 172.16.255.20 host_name: vm10 site_id: '' update_time: 1717671338595 - entry_time: 1717671338582 uuid: 3bdf551c-5dbd-4add-9884-285d1f475d18 message: failed to sync root cert to device (353e002d-1d66-403e-b94b-86a890761803, vm9, 172.16.255.19) on 06 Jun 2024 10:55:38 UTC type: rootca-sync-failure component: System severity: Critical severity_number: 1 devices: - system-ip: 172.16.255.19 active: 'true' values: - system-ip: 172.16.255.19 host-name: vm9 acknowledged: 'false' cleared_by: '' suppressed: 'false' suppressed_by: '' rulename: rootca-sync-failure rule_name_display: ROOTCA_SYNC_FAILURE values_short_display: - host-name: vm9 system-ip: 172.16.255.19 cleared_time: 0 statcycletime: 1717671338582 tenant: default eventname: rootca-sync-failure receive_time: 1717671338582 system_ip: 172.16.255.19 host_name: vm9 site_id: '' update_time: 1717671338618 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineResponseAlarm' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Alarms-read get: tags: - Monitoring - Alarms Details description: Get alarms for given query. If query is empty then last 30 mins data will be returned. operationId: getRawAlarmData parameters: - name: query in: query description: Query allowEmptyValue: true schema: type: string examples: Empty: description: Empty Get active alarms: description: Get active alarms value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: active type: boolean value: - 'true' operator: equal $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByActive' Get alarms filter by hours: description: Get alarms filter by hours value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByHours' Get alarms filter between dates: description: Get alarms filter between dates value: query: condition: AND rules: - field: entry_time type: date value: - 2024-04-30T19:30:00 UTC - 2024-05-30T17:30:00 UTC operator: between size: 10000 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBetweenDates' Get alarms filter by type: description: Get alarms filter by type value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: rule_name_display operator: in type: string value: - Memory_Usage size: 10000 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByType' Get alarms filter by system ip: description: Get alarms filter by system ip value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: system_ip operator: in type: string value: - 1.1.1.1 size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySystemIp' Get alarms filter by severity: description: Get alarms filter by severity value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: severity operator: in type: string value: - Critical size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySeverity' Get alarms filter by site-id: description: Get alarms filter by site-id value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: site_id operator: in type: string value: - '400' - '500' size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySites' - name: site-id in: query description: Specify the site-id to filter the alarms schema: pattern: ^[0-9]+$ type: string - name: includeTenants in: query description: Specify whether the tenant alarms need to be visible or not from provider view. schema: type: boolean responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: type: object properties: acknowledged: type: boolean active: type: boolean cleared_by: type: string format: uuid example: 0a0dca23-11d5-4014-bfbb-976d3c6de492 cleared_events: type: array items: type: string format: uuid cleared_time: type: integer format: int64 example: 1652894923722 component: type: string example: Schedule Telemetry collection consumed_events: type: array items: type: object $$ref: '#/components/schemas/OneOfAlarmConsumedEventsItems' devices: type: array items: type: object properties: system-ip: type: string example: 19.19.19.1 $$ref: '#/components/schemas/AlarmDevices' entry_time: type: integer format: int64 example: 1652906591837 eventname: type: string example: telemetry-data-collection-failure id: type: string example: HHbp2IABUbH5BDy9BhJe message: type: string example: Scheduled telemetry data collection failed on 19.19.19.1 possible_causes: type: array items: type: string receive_time: type: integer format: int64 rule_name_display: type: string example: Telemetry data save failed rulename: type: string example: cpu-usage severity: type: string enum: - Minor - Major - Critical - Medium severity_number: type: integer format: int64 example: 4 site_id: type: integer format: int64 example: 100 statcycletime: type: integer format: int64 suppressed: type: boolean example: false suppressed_by: type: object example: system-ip: type: string example: 172.16.255.11 component: type: string example: BFD system_ip: type: string example: 172.16.255.26 tenant: type: string example: default type: type: string example: Telemetry data save failed uuid: type: string format: uuid example: f6f83721-3a69-42d1-841f-94e015957fb7 values: type: array items: type: object properties: empty: type: boolean additionalProperties: type: string $$ref: '#/components/schemas/GeneralSchema' values_short_display: type: array items: type: object properties: empty: type: boolean additionalProperties: type: string $$ref: '#/components/schemas/GeneralSchema' description: Represents any kind of alarm $$ref: '#/components/schemas/Alarm' pageInfo: type: object properties: count: type: integer description: number of alarms to be fetched format: int64 endTime: type: integer description: end time of alarms to be fetched format: int64 startTime: type: integer description: start time of alarms to be fetched format: int64 $$ref: '#/components/schemas/PageInfo' description: AlarmResponse is used for GET/POST /alarms call. $$ref: '#/components/schemas/AlarmResponse' examples: Alarms: description: Alarms value: header: generatedOn: 1717671384603 viewKeys: uniqueKey: [] preferenceKey: grid-Alarms columns: - title: Impacted Entities property: values_short_display minWidth: 250 dataType: jsonArray - title: Severity property: severity display: iconAndText iconProperty: severity hideable: false icon: - key: Minor value: images/event_minor.png - key: Major value: images/event_major.png - key: Critical value: images/event_critical.png - key: Medium value: images/event_other.png minWidth: 70 dataType: string - title: Alarm Name property: rule_name_display minWidth: 160 dataType: string - title: Message property: message minWidth: 250 dataType: string - title: Date & Time property: entry_time displayFormat: DD MMM YYYY h:mm:ss A z inputFormat: unix-time minWidth: 200 dataType: date - title: Cleared Date & Time property: cleared_time displayFormat: DD MMM YYYY h:mm:ss A z inputFormat: unix-time minWidth: 200 dataType: date fields: - property: values_short_display dataType: jsonArray - property: severity dataType: string display: iconAndText - property: rule_name_display dataType: string - property: message dataType: string - property: possible_causes dataType: string - property: entry_time dataType: date - property: cleared_time dataType: date chart: {} pageInfo: startTime: '1717671338582' endTime: '1717669597190' count: 60 data: - entry_time: 1717671338582 uuid: 59a93996-719d-4550-bbd5-1ba8c60b3d31 message: failed to sync root cert to device (ca9ec973-ba93-48ea-ad40-dea43b32d9f5, vm10, 172.16.255.20) on 06 Jun 2024 10:55:38 UTC type: rootca-sync-failure component: System severity: Critical severity_number: 1 devices: - system-ip: 172.16.255.20 active: 'true' values: - system-ip: 172.16.255.20 host-name: vm10 acknowledged: 'false' cleared_by: '' suppressed: 'false' suppressed_by: '' rulename: rootca-sync-failure rule_name_display: ROOTCA_SYNC_FAILURE values_short_display: - host-name: vm10 system-ip: 172.16.255.20 cleared_time: 0 statcycletime: 1717671338582 tenant: default eventname: rootca-sync-failure receive_time: 1717671338582 system_ip: 172.16.255.20 host_name: vm10 site_id: '' update_time: 1717671338595 - entry_time: 1717671338582 uuid: 3bdf551c-5dbd-4add-9884-285d1f475d18 message: failed to sync root cert to device (353e002d-1d66-403e-b94b-86a890761803, vm9, 172.16.255.19) on 06 Jun 2024 10:55:38 UTC type: rootca-sync-failure component: System severity: Critical severity_number: 1 devices: - system-ip: 172.16.255.19 active: 'true' values: - system-ip: 172.16.255.19 host-name: vm9 acknowledged: 'false' cleared_by: '' suppressed: 'false' suppressed_by: '' rulename: rootca-sync-failure rule_name_display: ROOTCA_SYNC_FAILURE values_short_display: - host-name: vm9 system-ip: 172.16.255.19 cleared_time: 0 statcycletime: 1717671338582 tenant: default eventname: rootca-sync-failure receive_time: 1717671338582 system_ip: 172.16.255.19 host_name: vm9 site_id: '' update_time: 1717671338618 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineResponseAlarm' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Alarms-read /alarms/aggregation: get: tags: - Monitoring - Alarms Details description: Get aggregated count of alarms based on given query. operationId: getAggregationData_MonitoringAlarmsDetails_1903 parameters: - name: query in: query description: Query required: true schema: type: string examples: Aggregation by severity: description: Aggregation by severity value: query: condition: AND rules: - field: entry_time type: date value: - '24' operator: last_n_hours aggregation: field: - property: severity order: asc sequence: 1 histogram: property: entry_time type: minute interval: 30 order: asc $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestAggregationBySeverity' - name: site-id in: query description: Specify the site-id to filter the alarms schema: pattern: ^[0-9]+$ type: string - name: includeTenants in: query description: Specify whether the tenant alarms need to be visible or not from provider view. schema: type: boolean responses: '200': description: Success content: application/json: schema: type: object properties: data: type: object properties: count: type: integer format: int64 example: 6 entry_time: type: integer format: int64 example: 1653575400000 severity: type: string enum: - MINOR - MAJOR - MEDIUM - CRITICAL $$ref: '#/components/schemas/AlarmAggregation' entryTimeList: type: array items: type: integer format: int64 $$ref: '#/components/schemas/AlarmAggregationResponse' examples: Aggregation by severity: description: Aggregation by severity value: header: generatedOn: 1717656395296 columns: - property: severity title: Severity dataType: string isDisplay: true - property: entry_time title: Entry_time dataType: date isDisplay: true fields: - property: severity dataType: string - property: entry_time dataType: date entryTimeList: - 1717569000000 - 1717570800000 - 1717572600000 - 1717574400000 - 1717576200000 - 1717578000000 - 1717579800000 - 1717581600000 - 1717583400000 - 1717585200000 - 1717587000000 - 1717588800000 - 1717590600000 - 1717592400000 - 1717594200000 - 1717596000000 - 1717597800000 - 1717599600000 - 1717601400000 - 1717603200000 - 1717605000000 - 1717606800000 - 1717608600000 - 1717610400000 - 1717612200000 - 1717614000000 - 1717615800000 - 1717617600000 - 1717619400000 - 1717621200000 - 1717623000000 - 1717624800000 - 1717626600000 - 1717628400000 - 1717630200000 - 1717632000000 - 1717633800000 - 1717635600000 - 1717637400000 - 1717639200000 - 1717641000000 - 1717642800000 - 1717644600000 - 1717646400000 - 1717648200000 - 1717650000000 - 1717651800000 - 1717653600000 - 1717655400000 data: - entry_time: 1717569000000 severity: Minor count: 6 - entry_time: 1717569000000 severity: Medium count: 7 - entry_time: 1717570800000 severity: Minor count: 36 - entry_time: 1717570800000 severity: Medium count: 35 - entry_time: 1717572600000 severity: Minor count: 59 - entry_time: 1717572600000 severity: Medium count: 60 - entry_time: 1717574400000 severity: Minor count: 62 - entry_time: 1717574400000 severity: Medium count: 62 - entry_time: 1717576200000 severity: Medium count: 71 - entry_time: 1717576200000 severity: Minor count: 72 - entry_time: 1717578000000 severity: Minor count: 66 - entry_time: 1717578000000 severity: Medium count: 66 - entry_time: 1717579800000 severity: Critical count: 6 - entry_time: 1717579800000 severity: Minor count: 60 - entry_time: 1717579800000 severity: Major count: 1 - entry_time: 1717579800000 severity: Medium count: 62 - entry_time: 1717581600000 severity: Critical count: 60 - entry_time: 1717583400000 severity: Critical count: 60 - entry_time: 1717585200000 severity: Critical count: 60 - entry_time: 1717587000000 severity: Critical count: 60 - entry_time: 1717588800000 severity: Critical count: 60 - entry_time: 1717590600000 severity: Critical count: 60 - entry_time: 1717592400000 severity: Critical count: 60 - entry_time: 1717594200000 severity: Critical count: 60 - entry_time: 1717596000000 severity: Critical count: 60 - entry_time: 1717597800000 severity: Critical count: 60 - entry_time: 1717599600000 severity: Critical count: 60 - entry_time: 1717601400000 severity: Critical count: 60 - entry_time: 1717603200000 severity: Critical count: 60 - entry_time: 1717605000000 severity: Critical count: 60 - entry_time: 1717606800000 severity: Critical count: 60 - entry_time: 1717608600000 severity: Critical count: 60 - entry_time: 1717610400000 severity: Critical count: 60 - entry_time: 1717612200000 severity: Critical count: 60 - entry_time: 1717614000000 severity: Critical count: 60 - entry_time: 1717615800000 severity: Critical count: 60 - entry_time: 1717617600000 severity: Critical count: 60 - entry_time: 1717619400000 severity: Critical count: 60 - entry_time: 1717621200000 severity: Critical count: 58 - entry_time: 1717623000000 severity: Critical count: 60 - entry_time: 1717624800000 severity: Critical count: 60 - entry_time: 1717626600000 severity: Critical count: 60 - entry_time: 1717628400000 severity: Critical count: 60 - entry_time: 1717630200000 severity: Critical count: 60 - entry_time: 1717632000000 severity: Critical count: 60 - entry_time: 1717633800000 severity: Critical count: 60 - entry_time: 1717635600000 severity: Critical count: 60 - entry_time: 1717637400000 severity: Critical count: 60 - entry_time: 1717639200000 severity: Critical count: 60 - entry_time: 1717641000000 severity: Critical count: 60 - entry_time: 1717642800000 severity: Critical count: 60 - entry_time: 1717644600000 severity: Critical count: 60 - entry_time: 1717646400000 severity: Critical count: 60 - entry_time: 1717648200000 severity: Critical count: 60 - entry_time: 1717650000000 severity: Critical count: 60 - entry_time: 1717651800000 severity: Critical count: 60 - entry_time: 1717653600000 severity: Critical count: 60 - entry_time: 1717655400000 severity: Critical count: 34 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineResponseAggregationBySeverity' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Alarms-read post: tags: - Monitoring - Alarms Details description: Get aggregated count of alarms based on given query. operationId: postAggregationData_MonitoringAlarmsDetails_1904 parameters: - name: site-id in: query description: Specify the site-id to filter the alarms schema: pattern: ^[0-9]+$ type: string - name: includeTenants in: query description: Specify whether the tenant alarms need to be visible or not from provider view. schema: type: boolean requestBody: description: Query content: application/json: schema: type: object examples: Aggregation by severity: description: Aggregation by severity value: query: condition: AND rules: - field: entry_time type: date value: - '24' operator: last_n_hours aggregation: field: - property: severity order: asc sequence: 1 histogram: property: entry_time type: minute interval: 30 order: asc $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestAggregationBySeverity' required: true responses: '200': description: Success content: application/json: schema: type: object properties: data: type: object properties: count: type: integer format: int64 example: 6 entry_time: type: integer format: int64 example: 1653575400000 severity: type: string enum: - MINOR - MAJOR - MEDIUM - CRITICAL $$ref: '#/components/schemas/AlarmAggregation' entryTimeList: type: array items: type: integer format: int64 $$ref: '#/components/schemas/AlarmAggregationResponse' examples: Aggregation by severity: description: Aggregation by severity value: header: generatedOn: 1717656395296 columns: - property: severity title: Severity dataType: string isDisplay: true - property: entry_time title: Entry_time dataType: date isDisplay: true fields: - property: severity dataType: string - property: entry_time dataType: date entryTimeList: - 1717569000000 - 1717570800000 - 1717572600000 - 1717574400000 - 1717576200000 - 1717578000000 - 1717579800000 - 1717581600000 - 1717583400000 - 1717585200000 - 1717587000000 - 1717588800000 - 1717590600000 - 1717592400000 - 1717594200000 - 1717596000000 - 1717597800000 - 1717599600000 - 1717601400000 - 1717603200000 - 1717605000000 - 1717606800000 - 1717608600000 - 1717610400000 - 1717612200000 - 1717614000000 - 1717615800000 - 1717617600000 - 1717619400000 - 1717621200000 - 1717623000000 - 1717624800000 - 1717626600000 - 1717628400000 - 1717630200000 - 1717632000000 - 1717633800000 - 1717635600000 - 1717637400000 - 1717639200000 - 1717641000000 - 1717642800000 - 1717644600000 - 1717646400000 - 1717648200000 - 1717650000000 - 1717651800000 - 1717653600000 - 1717655400000 data: - entry_time: 1717569000000 severity: Minor count: 6 - entry_time: 1717569000000 severity: Medium count: 7 - entry_time: 1717570800000 severity: Minor count: 36 - entry_time: 1717570800000 severity: Medium count: 35 - entry_time: 1717572600000 severity: Minor count: 59 - entry_time: 1717572600000 severity: Medium count: 60 - entry_time: 1717574400000 severity: Minor count: 62 - entry_time: 1717574400000 severity: Medium count: 62 - entry_time: 1717576200000 severity: Medium count: 71 - entry_time: 1717576200000 severity: Minor count: 72 - entry_time: 1717578000000 severity: Minor count: 66 - entry_time: 1717578000000 severity: Medium count: 66 - entry_time: 1717579800000 severity: Critical count: 6 - entry_time: 1717579800000 severity: Minor count: 60 - entry_time: 1717579800000 severity: Major count: 1 - entry_time: 1717579800000 severity: Medium count: 62 - entry_time: 1717581600000 severity: Critical count: 60 - entry_time: 1717583400000 severity: Critical count: 60 - entry_time: 1717585200000 severity: Critical count: 60 - entry_time: 1717587000000 severity: Critical count: 60 - entry_time: 1717588800000 severity: Critical count: 60 - entry_time: 1717590600000 severity: Critical count: 60 - entry_time: 1717592400000 severity: Critical count: 60 - entry_time: 1717594200000 severity: Critical count: 60 - entry_time: 1717596000000 severity: Critical count: 60 - entry_time: 1717597800000 severity: Critical count: 60 - entry_time: 1717599600000 severity: Critical count: 60 - entry_time: 1717601400000 severity: Critical count: 60 - entry_time: 1717603200000 severity: Critical count: 60 - entry_time: 1717605000000 severity: Critical count: 60 - entry_time: 1717606800000 severity: Critical count: 60 - entry_time: 1717608600000 severity: Critical count: 60 - entry_time: 1717610400000 severity: Critical count: 60 - entry_time: 1717612200000 severity: Critical count: 60 - entry_time: 1717614000000 severity: Critical count: 60 - entry_time: 1717615800000 severity: Critical count: 60 - entry_time: 1717617600000 severity: Critical count: 60 - entry_time: 1717619400000 severity: Critical count: 60 - entry_time: 1717621200000 severity: Critical count: 58 - entry_time: 1717623000000 severity: Critical count: 60 - entry_time: 1717624800000 severity: Critical count: 60 - entry_time: 1717626600000 severity: Critical count: 60 - entry_time: 1717628400000 severity: Critical count: 60 - entry_time: 1717630200000 severity: Critical count: 60 - entry_time: 1717632000000 severity: Critical count: 60 - entry_time: 1717633800000 severity: Critical count: 60 - entry_time: 1717635600000 severity: Critical count: 60 - entry_time: 1717637400000 severity: Critical count: 60 - entry_time: 1717639200000 severity: Critical count: 60 - entry_time: 1717641000000 severity: Critical count: 60 - entry_time: 1717642800000 severity: Critical count: 60 - entry_time: 1717644600000 severity: Critical count: 60 - entry_time: 1717646400000 severity: Critical count: 60 - entry_time: 1717648200000 severity: Critical count: 60 - entry_time: 1717650000000 severity: Critical count: 60 - entry_time: 1717651800000 severity: Critical count: 60 - entry_time: 1717653600000 severity: Critical count: 60 - entry_time: 1717655400000 severity: Critical count: 34 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineResponseAggregationBySeverity' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Alarms-read /alarms/clear: post: tags: - Monitoring - Alarms Details description: Clear the alarm for a specific UUID. operationId: clearStaleAlarm requestBody: description: Clear Alarm content: application/json: schema: type: object examples: Clear alarm by UUID: description: Clear alarm by UUID value: alarm_uuid: 25103468-8860-48c2-8ff9-763d1dd93b81 required: true responses: '200': description: Success content: application/json: schema: type: object examples: Clear alarm by UUID: description: Clear alarm by UUID value: alarm_uuid: 25103468-8860-48c2-8ff9-763d1dd93b81 cleared: 'true' $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineResponseClear' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Alarms-write /alarms/count: post: tags: - Monitoring - Alarms Details description: Get the count of alarms as per the query passed. operationId: postCount parameters: - name: site-id in: query description: Specify the site-id to filter the alarms schema: pattern: ^[0-9]+$ type: string - name: includeTenants in: query description: Specify whether the tenant alarms need to be visible or not from provider view. schema: type: boolean requestBody: description: Query content: application/json: schema: type: object examples: Get active alarms count: description: Get active alarms count value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: active type: boolean value: - 'true' operator: equal $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByActive' Get alarms count filter by hours: description: Get alarms count filter by hours value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByHours' Get alarms count filter between dates: description: Get alarms count filter between dates value: query: condition: AND rules: - field: entry_time type: date value: - 2024-04-30T19:30:00 UTC - 2024-05-30T17:30:00 UTC operator: between size: 10000 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBetweenDates' Get alarms count filter by type: description: Get alarms count filter by type value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: rule_name_display operator: in type: string value: - Memory_Usage size: 10000 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByType' Get alarms count filter by system ip: description: Get alarms count filter by system ip value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: system_ip operator: in type: string value: - 1.1.1.1 size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySystemIp' Get alarms count filter by severity: description: Get alarms count filter by severity value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: severity operator: in type: string value: - Critical size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySeverity' Get alarms count filter by site-id: description: Get alarms count filter by site-id value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: site_id operator: in type: string value: - '400' - '500' size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySites' required: true responses: '200': description: Success content: application/json: schema: type: array properties: empty: type: boolean items: type: object properties: count: type: number example: 12 $$ref: '#/components/schemas/AlarmCountPost' $$ref: '#/components/schemas/AlarmCountPostResponse' examples: Alarm count response: description: Alarm count response value: header: generatedOn: 1717655909125 data: - count: 12 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineResponsePostCount' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Alarms-read get: tags: - Monitoring - Alarms Details description: Get the count of alarms which are active and not acknowledged by user. operationId: getNonViewedActiveAlarmsCount parameters: - name: includeTenants in: query description: include tenants schema: type: boolean responses: '200': description: Success content: application/json: schema: type: object examples: Alarm count: description: Alarm count value: header: generatedOn: 1717494253166 data: - count: 83 cleared_count: 278 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineResponseGetCount' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Alarms-read /alarms/disabled: post: tags: - Monitoring - Alarms Details description: Enable/Disable alarms by event name operationId: disableEnableAlarm parameters: - name: eventName in: query description: Event name required: true schema: pattern: ^([a-zA-Z]+(?:\-[a-zA-Z]+)*)$ type: string examples: Memory usage: description: Memory usage value: memory-usage Control connection: description: Control connection value: control-connection-state-change BFD: description: BFD value: bfd-state-change System Login: description: System Login value: system-login-change - name: disable in: query description: disable alarm schema: type: boolean - name: time in: query description: Specify the duration for which the alarm is disabled. Duration between 0-72 hours schema: maximum: 72 minimum: 0 type: integer format: int32 responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Alarms-read get: tags: - Monitoring - Alarms Details description: List all disabled alarms operationId: listDisabledAlarm responses: '200': description: Success content: application/json: schema: type: array items: type: object properties: endTime: type: string example: 2022-06-06 10:50:05 UTC eventName: type: string example: bfd-state-change startTime: type: string example: 2022-06-06 09:50:05 UTC $$ref: '#/components/schemas/DisabledAlarmDetails' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Alarms-read /alarms/doccount: get: tags: - Monitoring - Alarms Details description: Get the count of alarms as per the query passed. operationId: getDocCount_MonitoringAlarmsDetails_1603 parameters: - name: query in: query description: Query required: true schema: type: string examples: Get active alarms count: description: Get active alarms count value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: active type: boolean value: - 'true' operator: equal $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByActive' Get alarms count filter by hours: description: Get alarms count filter by hours value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByHours' Get alarms count filter between dates: description: Get alarms count filter between dates value: query: condition: AND rules: - field: entry_time type: date value: - 2024-04-30T19:30:00 UTC - 2024-05-30T17:30:00 UTC operator: between size: 10000 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBetweenDates' Get alarms count filter by type: description: Get alarms count filter by type value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: rule_name_display operator: in type: string value: - Memory_Usage size: 10000 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByType' Get alarms count filter by system ip: description: Get alarms count filter by system ip value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: system_ip operator: in type: string value: - 1.1.1.1 size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySystemIp' Get alarms count filter by severity: description: Get alarms count filter by severity value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: severity operator: in type: string value: - Critical size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySeverity' Get alarms count filter by site-id: description: Get alarms count filter by site-id value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: site_id operator: in type: string value: - '400' - '500' size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySites' - name: site-id in: query description: Specify the site-id to filter the alarms schema: pattern: ^[0-9]+$ type: string responses: '200': description: Success content: application/json: schema: type: object examples: Count: description: Count value: count: 17193 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineResponseDoccount' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error post: tags: - Monitoring - Alarms Details description: Get the count of alarms as per the query passed. operationId: postDocCount_MonitoringAlarmsDetails_1604 parameters: - name: site-id in: query description: Specify the site-id to filter the alarms schema: pattern: ^[0-9]+$ type: string requestBody: description: Query content: application/json: schema: type: object examples: Get active alarms count: description: Get active alarms count value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: active type: boolean value: - 'true' operator: equal $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByActive' Get alarms count filter by hours: description: Get alarms count filter by hours value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByHours' Get alarms count filter between dates: description: Get alarms count filter between dates value: query: condition: AND rules: - field: entry_time type: date value: - 2024-04-30T19:30:00 UTC - 2024-05-30T17:30:00 UTC operator: between size: 10000 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBetweenDates' Get alarms count filter by type: description: Get alarms count filter by type value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: rule_name_display operator: in type: string value: - Memory_Usage size: 10000 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByType' Get alarms count filter by system ip: description: Get alarms count filter by system ip value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: system_ip operator: in type: string value: - 1.1.1.1 size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySystemIp' Get alarms count filter by severity: description: Get alarms count filter by severity value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: severity operator: in type: string value: - Critical size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySeverity' Get alarms count filter by site-id: description: Get alarms count filter by site-id value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: site_id operator: in type: string value: - '400' - '500' size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySites' required: true responses: '200': description: Success content: application/json: schema: type: object examples: Count: description: Count value: count: 17193 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineResponseDoccount' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /alarms/dump: post: tags: - Monitoring - Alarms Details description: Dump correlation engine server cache in log file operationId: dumpCorrelationEngineData responses: '200': description: Success content: application/json: schema: type: object properties: Message: type: string example: Successfully dump data in log file $$ref: '#/components/schemas/SimpleMessageResponse' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Alarms-read /alarms/fields: get: tags: - Monitoring - Alarms Details description: Get fields and types operationId: getAlarmDataFields responses: '200': description: Success content: application/json: schema: type: object examples: Response: description: Response value: - property: values_short_display dataType: jsonArray - property: values dataType: jsonArray - property: severity dataType: string display: iconAndText - property: rule_name_display dataType: string - property: message dataType: string - property: possible_causes dataType: string - property: entry_time dataType: date - property: cleared_time dataType: date - property: uuid dataType: string - property: type dataType: string - property: component dataType: string - property: severity_number dataType: number - property: devices dataType: object - property: active dataType: boolean - property: consumed_events dataType: 'false' - property: values dataType: object - property: acknowledged dataType: boolean - property: cleared_events dataType: string - property: cleared_by dataType: string $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineResponseFields' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /alarms/link-state-alarm: get: tags: - Monitoring - Alarms Details description: Get configuration for link-state alarm operationId: getLinkStateAlarmConfig responses: '200': description: Success content: application/json: schema: type: string examples: Response: description: Response value: bgp-peer-state-change: enabled '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Alarms-read post: tags: - Monitoring - Alarms Details description: Enable/Disable a specific link-state alarm operationId: enableDisableLinkStateAlarm parameters: - name: linkName in: query description: Link Name required: true schema: pattern: ^(ospf|bgp)((?:\-[a-zA-Z]+)*)$ type: string examples: BGP: description: BGP value: bgp-peer-state-change OSPF: description: OSPF value: ospf-neighbor-state-change - name: enable in: query description: enable link state alarm required: true schema: type: boolean responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Alarms-read /alarms/markallasviewed: post: tags: - Monitoring - Alarms Details description: Mark all alarms as acknowledged by the user operationId: markAllAlarmsAsViewed parameters: - name: type in: query description: 'Specify type. Allowed values: ["active", "cleared"]' schema: pattern: ^active|cleared$ type: string examples: Active: description: Active value: active Cleared: description: Cleared value: cleared requestBody: description: Query content: application/json: schema: type: object examples: Empty: description: Empty Get active alarms: description: Get active alarms value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: active type: boolean value: - 'true' operator: equal $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByActive' Get alarms filter by hours: description: Get alarms filter by hours value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByHours' Get alarms filter between dates: description: Get alarms filter between dates value: query: condition: AND rules: - field: entry_time type: date value: - 2024-04-30T19:30:00 UTC - 2024-05-30T17:30:00 UTC operator: between size: 10000 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBetweenDates' Get alarms filter by type: description: Get alarms filter by type value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: rule_name_display operator: in type: string value: - Memory_Usage size: 10000 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByType' Get alarms filter by system ip: description: Get alarms filter by system ip value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: system_ip operator: in type: string value: - 1.1.1.1 size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySystemIp' Get alarms filter by severity: description: Get alarms filter by severity value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: severity operator: in type: string value: - Critical size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySeverity' Get alarms filter by site-id: description: Get alarms filter by site-id value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: site_id operator: in type: string value: - '400' - '500' size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySites' required: true responses: '200': description: Success content: application/json: schema: type: object examples: Response: description: Response value: status: success $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineResponseMarkallasviewed' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Alarms-read /alarms/markviewed: post: tags: - Monitoring - Alarms Details description: Mark alarms as acknowledged based on list of UUIDs. operationId: markAlarmsAsViewed requestBody: description: Mark alarms as viewed content: application/json: schema: type: object examples: List of UUIDs: description: List of UUIDs value: uuid: - 29f9bf31-0fbe-4114-b8f0-e6234699485c required: true responses: '200': description: Success content: application/json: schema: type: array properties: empty: type: boolean items: type: object properties: cleared_count: type: number example: 718 count: type: number example: 13 $$ref: '#/components/schemas/AlarmCount' $$ref: '#/components/schemas/AlarmCountResponse' examples: Mark viewed: description: Mark viewed value: header: generatedOn: 1717665227943 data: - count: 2816 cleared_count: 1948 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineResponseMarkviewed' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Alarms-read /alarms/master: get: tags: - Monitoring - Alarms Details description: Get topic details. operationId: getLeaderManagerState responses: '200': description: Success content: application/json: schema: type: string examples: Topics: description: Topics value: master-ip: localhost AlarmEvent0: localhost $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineResponsePrimary' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Alarms-read /alarms/notviewed: get: tags: - Monitoring - Alarms Details description: Get alarms which are not acknowledged by the user. operationId: getNonViewedAlarms parameters: - name: state in: query description: 'Specify the not viewed alarm state to be fetched. Allowed values : ["active", "cleared"] ' schema: pattern: ^active|cleared$ type: string responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: type: object properties: acknowledged: type: boolean active: type: boolean cleared_by: type: string format: uuid example: 0a0dca23-11d5-4014-bfbb-976d3c6de492 cleared_events: type: array items: type: string format: uuid cleared_time: type: integer format: int64 example: 1652894923722 component: type: string example: Schedule Telemetry collection consumed_events: type: array items: type: object $$ref: '#/components/schemas/OneOfAlarmConsumedEventsItems' devices: type: array items: type: object properties: system-ip: type: string example: 19.19.19.1 $$ref: '#/components/schemas/AlarmDevices' entry_time: type: integer format: int64 example: 1652906591837 eventname: type: string example: telemetry-data-collection-failure id: type: string example: HHbp2IABUbH5BDy9BhJe message: type: string example: Scheduled telemetry data collection failed on 19.19.19.1 possible_causes: type: array items: type: string receive_time: type: integer format: int64 rule_name_display: type: string example: Telemetry data save failed rulename: type: string example: cpu-usage severity: type: string enum: - Minor - Major - Critical - Medium severity_number: type: integer format: int64 example: 4 site_id: type: integer format: int64 example: 100 statcycletime: type: integer format: int64 suppressed: type: boolean example: false suppressed_by: type: object example: system-ip: type: string example: 172.16.255.11 component: type: string example: BFD system_ip: type: string example: 172.16.255.26 tenant: type: string example: default type: type: string example: Telemetry data save failed uuid: type: string format: uuid example: f6f83721-3a69-42d1-841f-94e015957fb7 values: type: array items: type: object properties: empty: type: boolean additionalProperties: type: string $$ref: '#/components/schemas/GeneralSchema' values_short_display: type: array items: type: object properties: empty: type: boolean additionalProperties: type: string $$ref: '#/components/schemas/GeneralSchema' description: Represents any kind of alarm $$ref: '#/components/schemas/Alarm' pageInfo: type: object properties: count: type: integer description: number of alarms to be fetched format: int64 endTime: type: integer description: end time of alarms to be fetched format: int64 startTime: type: integer description: start time of alarms to be fetched format: int64 $$ref: '#/components/schemas/PageInfo' description: AlarmResponse is used for GET/POST /alarms call. $$ref: '#/components/schemas/AlarmResponse' examples: Not viewed alarms: description: Not viewed alarms value: header: generatedOn: 1717671984421 viewKeys: uniqueKey: [] preferenceKey: grid-Alarms columns: - title: Impacted Entities property: values_short_display minWidth: 250 dataType: jsonArray - title: Severity property: severity display: iconAndText iconProperty: severity hideable: false icon: - key: Minor value: images/event_minor.png - key: Major value: images/event_major.png - key: Critical value: images/event_critical.png - key: Medium value: images/event_other.png minWidth: 70 dataType: string - title: Alarm Name property: rule_name_display minWidth: 160 dataType: string - title: Message property: message minWidth: 250 dataType: string - title: Date & Time property: entry_time displayFormat: DD MMM YYYY h:mm:ss A z inputFormat: unix-time minWidth: 200 dataType: date - title: Cleared Date & Time property: cleared_time displayFormat: DD MMM YYYY h:mm:ss A z inputFormat: unix-time minWidth: 200 dataType: date fields: - property: values_short_display dataType: jsonArray - property: severity dataType: string display: iconAndText - property: rule_name_display dataType: string - property: message dataType: string - property: possible_causes dataType: string - property: entry_time dataType: date - property: cleared_time dataType: date data: - severity_number: 1 entry_time: 1717671939079 uuid: 5f573c27-4264-4b9b-8b46-4a415fc583a1 message: failed to sync root cert to device (353e002d-1d66-403e-b94b-86a890761803, vm9, 172.16.255.19) on 06 Jun 2024 11:05:39 UTC type: rootca-sync-failure component: System severity: Critical devices: - system-ip: 172.16.255.19 active: 'true' values: - system-ip: 172.16.255.19 host-name: vm9 acknowledged: 'false' cleared_by: '' suppressed: 'false' suppressed_by: '' rulename: rootca-sync-failure rule_name_display: ROOTCA_SYNC_FAILURE values_short_display: - host-name: vm9 system-ip: 172.16.255.19 cleared_time: 0 statcycletime: 1717671939079 tenant: default eventname: rootca-sync-failure receive_time: 1717671939079 system_ip: 172.16.255.19 host_name: vm9 site_id: '' - severity_number: 1 entry_time: 1717671939079 uuid: 3ad7e9e2-df6e-43f7-bf1b-a947b3274e7e message: failed to sync root cert to device (ca9ec973-ba93-48ea-ad40-dea43b32d9f5, vm10, 172.16.255.20) on 06 Jun 2024 11:05:39 UTC type: rootca-sync-failure component: System severity: Critical devices: - system-ip: 172.16.255.20 active: 'true' values: - system-ip: 172.16.255.20 host-name: vm10 acknowledged: 'false' cleared_by: '' suppressed: 'false' suppressed_by: '' rulename: rootca-sync-failure rule_name_display: ROOTCA_SYNC_FAILURE values_short_display: - host-name: vm10 system-ip: 172.16.255.20 cleared_time: 0 statcycletime: 1717671939079 tenant: default eventname: rootca-sync-failure receive_time: 1717671939079 system_ip: 172.16.255.20 host_name: vm10 site_id: '' $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineResponseNotviewed' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Alarms-read /alarms/page: get: tags: - Monitoring - Alarms Details description: Get paginated alarms operationId: getPage_MonitoringAlarmsDetails_1203 parameters: - name: query in: query description: Query schema: type: string examples: Get active alarms: description: Get active alarms value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: active type: boolean value: - 'true' operator: equal $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByActive' Get alarms filter by hours: description: Get alarms filter by hours value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByHours' Get alarms filter between dates: description: Get alarms filter between dates value: query: condition: AND rules: - field: entry_time type: date value: - 2024-04-30T19:30:00 UTC - 2024-05-30T17:30:00 UTC operator: between size: 10000 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBetweenDates' Get alarms filter by type: description: Get alarms filter by type value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: rule_name_display operator: in type: string value: - Memory_Usage size: 10000 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByType' Get alarms filter by system ip: description: Get alarms filter by system ip value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: system_ip operator: in type: string value: - 1.1.1.1 size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySystemIp' Get alarms filter by severity: description: Get alarms filter by severity value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: severity operator: in type: string value: - Critical size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySeverity' Get alarms filter by site-id: description: Get alarms filter by site-id value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: site_id operator: in type: string value: - '400' - '500' size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySites' - name: scrollId in: query description: Scroll ID schema: type: string - name: count in: query description: Number of alarms per page schema: type: integer format: int32 - name: site-id in: query description: Specify the site-id to filter the alarms schema: pattern: ^[0-9]+$ type: string responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: type: object properties: acknowledged: type: boolean active: type: boolean cleared_by: type: string format: uuid example: 0a0dca23-11d5-4014-bfbb-976d3c6de492 cleared_events: type: array items: type: string format: uuid cleared_time: type: integer format: int64 example: 1652894923722 component: type: string example: Schedule Telemetry collection consumed_events: type: array items: type: object $$ref: '#/components/schemas/OneOfAlarmConsumedEventsItems' devices: type: array items: type: object properties: system-ip: type: string example: 19.19.19.1 $$ref: '#/components/schemas/AlarmDevices' entry_time: type: integer format: int64 example: 1652906591837 eventname: type: string example: telemetry-data-collection-failure id: type: string example: HHbp2IABUbH5BDy9BhJe message: type: string example: Scheduled telemetry data collection failed on 19.19.19.1 possible_causes: type: array items: type: string receive_time: type: integer format: int64 rule_name_display: type: string example: Telemetry data save failed rulename: type: string example: cpu-usage severity: type: string enum: - Minor - Major - Critical - Medium severity_number: type: integer format: int64 example: 4 site_id: type: integer format: int64 example: 100 statcycletime: type: integer format: int64 suppressed: type: boolean example: false suppressed_by: type: object example: system-ip: type: string example: 172.16.255.11 component: type: string example: BFD system_ip: type: string example: 172.16.255.26 tenant: type: string example: default type: type: string example: Telemetry data save failed uuid: type: string format: uuid example: f6f83721-3a69-42d1-841f-94e015957fb7 values: type: array items: type: object properties: empty: type: boolean additionalProperties: type: string $$ref: '#/components/schemas/GeneralSchema' values_short_display: type: array items: type: object properties: empty: type: boolean additionalProperties: type: string $$ref: '#/components/schemas/GeneralSchema' description: Represents any kind of alarm $$ref: '#/components/schemas/Alarm' pageInfo: type: object properties: count: type: integer description: number of alarms to be fetched format: int64 endTime: type: integer description: end time of alarms to be fetched format: int64 startTime: type: integer description: start time of alarms to be fetched format: int64 $$ref: '#/components/schemas/PageInfo' description: AlarmResponse is used for GET/POST /alarms call. $$ref: '#/components/schemas/AlarmResponse' examples: Response: description: Response value: header: generatedOn: 1717672304804 viewKeys: uniqueKey: [] preferenceKey: grid-raw_alarm columns: - title: Impacted Entities property: values_short_display minWidth: 250 dataType: jsonArray - title: Impacted Entities Details property: values hideable: true visible: false minWidth: 250 dataType: jsonArray - title: Severity property: severity display: iconAndText iconProperty: severity hideable: false icon: - key: Minor value: images/event_minor.png - key: Major value: images/event_major.png - key: Critical value: images/event_critical.png - key: Medium value: images/event_other.png minWidth: 70 dataType: string - title: Alarm Name property: rule_name_display hideable: false minWidth: 160 dataType: string - title: Message property: message minWidth: 250 dataType: string - title: Date & Time property: entry_time displayFormat: DD MMM YYYY h:mm:ss A z inputFormat: unix-time hideable: false minWidth: 200 dataType: date - title: Cleared Date & Time property: cleared_time displayFormat: DD MMM YYYY h:mm:ss A z inputFormat: unix-time minWidth: 200 dataType: date fields: - property: values_short_display dataType: jsonArray - property: values dataType: jsonArray - property: severity dataType: string display: iconAndText - property: rule_name_display dataType: string - property: message dataType: string - property: possible_causes dataType: string - property: entry_time dataType: date - property: cleared_time dataType: date - property: uuid dataType: string - property: type dataType: string - property: component dataType: string - property: severity_number dataType: number - property: devices dataType: object - property: active dataType: boolean - property: consumed_events dataType: 'false' - property: values dataType: object - property: acknowledged dataType: boolean - property: cleared_events dataType: string - property: cleared_by dataType: string chart: {} data: - entry_time: 1717505999936 uuid: edc2ed16-88c1-4a06-8bc7-19cfb489131c message: The interface admin-state changed to down type: interface-admin-state-change component: VPN severity: Critical severity_number: 1 devices: '[{"system-ip":"172.16.255.26"}]' active: 'true' consumed_events: '' values: '[{"host-name":"vm16","system-ip":"172.16.255.26","if-name":"ge0/0","new-admin-state":"down","vpn-id":"0"}]' acknowledged: 'true' possible_causes: '' cleared_events: '' cleared_by: '' suppressed: 'false' suppressed_by: '' rulename: interface-admin-state-change rule_name_display: Interface_Admin_State_Change values_short_display: '[{"host-name":"vm16","system-ip":"172.16.255.26","if-name":"ge0/0","new-admin-state":"down"}]' cleared_time: 0 statcycletime: 1717505999936 tenant: default eventname: interface-admin-state-change receive_time: 1717506427663 system_ip: 172.16.255.26 host_name: vm16 site_id: '' update_time: 1717670310269 pageInfo: startTime: '1717505999936' endTime: '1717505999936' scrollId: o1ZSObpt5WS4AbmFImwHaC6D1fGWs3j5sGX9O0bNlQErayGcAWysadCDWPV9qUmygzrXpVREKLV2oz8DKCxUrmscYXIEaUkxAJ0RXn3rnhPWmsRLAjs7mIOj hasMoreData: true count: 1 totalCount: 3074 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineResponsePage' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Alarms-read post: tags: - Monitoring - Alarms Details description: Get paginated alarm raw data operationId: postPage_MonitoringAlarmsDetails_1204 parameters: - name: scrollId in: query description: Scroll ID schema: type: string - name: count in: query description: Number of alarms per page schema: type: integer format: int32 - name: site-id in: query description: Specify the site-id to filter the alarms schema: pattern: ^[0-9]+$ type: string requestBody: description: Alarm query string content: application/json: schema: type: object examples: Get active alarms: description: Get active alarms value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: active type: boolean value: - 'true' operator: equal $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByActive' Get alarms filter by hours: description: Get alarms filter by hours value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByHours' Get alarms filter between dates: description: Get alarms filter between dates value: query: condition: AND rules: - field: entry_time type: date value: - 2024-04-30T19:30:00 UTC - 2024-05-30T17:30:00 UTC operator: between size: 10000 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBetweenDates' Get alarms filter by type: description: Get alarms filter by type value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: rule_name_display operator: in type: string value: - Memory_Usage size: 10000 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByType' Get alarms filter by system ip: description: Get alarms filter by system ip value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: system_ip operator: in type: string value: - 1.1.1.1 size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySystemIp' Get alarms filter by severity: description: Get alarms filter by severity value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: severity operator: in type: string value: - Critical size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySeverity' Get alarms filter by site-id: description: Get alarms filter by site-id value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: site_id operator: in type: string value: - '400' - '500' size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySites' required: true responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: type: object properties: acknowledged: type: boolean active: type: boolean cleared_by: type: string format: uuid example: 0a0dca23-11d5-4014-bfbb-976d3c6de492 cleared_events: type: array items: type: string format: uuid cleared_time: type: integer format: int64 example: 1652894923722 component: type: string example: Schedule Telemetry collection consumed_events: type: array items: type: object $$ref: '#/components/schemas/OneOfAlarmConsumedEventsItems' devices: type: array items: type: object properties: system-ip: type: string example: 19.19.19.1 $$ref: '#/components/schemas/AlarmDevices' entry_time: type: integer format: int64 example: 1652906591837 eventname: type: string example: telemetry-data-collection-failure id: type: string example: HHbp2IABUbH5BDy9BhJe message: type: string example: Scheduled telemetry data collection failed on 19.19.19.1 possible_causes: type: array items: type: string receive_time: type: integer format: int64 rule_name_display: type: string example: Telemetry data save failed rulename: type: string example: cpu-usage severity: type: string enum: - Minor - Major - Critical - Medium severity_number: type: integer format: int64 example: 4 site_id: type: integer format: int64 example: 100 statcycletime: type: integer format: int64 suppressed: type: boolean example: false suppressed_by: type: object example: system-ip: type: string example: 172.16.255.11 component: type: string example: BFD system_ip: type: string example: 172.16.255.26 tenant: type: string example: default type: type: string example: Telemetry data save failed uuid: type: string format: uuid example: f6f83721-3a69-42d1-841f-94e015957fb7 values: type: array items: type: object properties: empty: type: boolean additionalProperties: type: string $$ref: '#/components/schemas/GeneralSchema' values_short_display: type: array items: type: object properties: empty: type: boolean additionalProperties: type: string $$ref: '#/components/schemas/GeneralSchema' description: Represents any kind of alarm $$ref: '#/components/schemas/Alarm' pageInfo: type: object properties: count: type: integer description: number of alarms to be fetched format: int64 endTime: type: integer description: end time of alarms to be fetched format: int64 startTime: type: integer description: start time of alarms to be fetched format: int64 $$ref: '#/components/schemas/PageInfo' description: AlarmResponse is used for GET/POST /alarms call. $$ref: '#/components/schemas/AlarmResponse' examples: Response: description: Response value: header: generatedOn: 1717672304804 viewKeys: uniqueKey: [] preferenceKey: grid-raw_alarm columns: - title: Impacted Entities property: values_short_display minWidth: 250 dataType: jsonArray - title: Impacted Entities Details property: values hideable: true visible: false minWidth: 250 dataType: jsonArray - title: Severity property: severity display: iconAndText iconProperty: severity hideable: false icon: - key: Minor value: images/event_minor.png - key: Major value: images/event_major.png - key: Critical value: images/event_critical.png - key: Medium value: images/event_other.png minWidth: 70 dataType: string - title: Alarm Name property: rule_name_display hideable: false minWidth: 160 dataType: string - title: Message property: message minWidth: 250 dataType: string - title: Date & Time property: entry_time displayFormat: DD MMM YYYY h:mm:ss A z inputFormat: unix-time hideable: false minWidth: 200 dataType: date - title: Cleared Date & Time property: cleared_time displayFormat: DD MMM YYYY h:mm:ss A z inputFormat: unix-time minWidth: 200 dataType: date fields: - property: values_short_display dataType: jsonArray - property: values dataType: jsonArray - property: severity dataType: string display: iconAndText - property: rule_name_display dataType: string - property: message dataType: string - property: possible_causes dataType: string - property: entry_time dataType: date - property: cleared_time dataType: date - property: uuid dataType: string - property: type dataType: string - property: component dataType: string - property: severity_number dataType: number - property: devices dataType: object - property: active dataType: boolean - property: consumed_events dataType: 'false' - property: values dataType: object - property: acknowledged dataType: boolean - property: cleared_events dataType: string - property: cleared_by dataType: string chart: {} data: - entry_time: 1717505999936 uuid: edc2ed16-88c1-4a06-8bc7-19cfb489131c message: The interface admin-state changed to down type: interface-admin-state-change component: VPN severity: Critical severity_number: 1 devices: '[{"system-ip":"172.16.255.26"}]' active: 'true' consumed_events: '' values: '[{"host-name":"vm16","system-ip":"172.16.255.26","if-name":"ge0/0","new-admin-state":"down","vpn-id":"0"}]' acknowledged: 'true' possible_causes: '' cleared_events: '' cleared_by: '' suppressed: 'false' suppressed_by: '' rulename: interface-admin-state-change rule_name_display: Interface_Admin_State_Change values_short_display: '[{"host-name":"vm16","system-ip":"172.16.255.26","if-name":"ge0/0","new-admin-state":"down"}]' cleared_time: 0 statcycletime: 1717505999936 tenant: default eventname: interface-admin-state-change receive_time: 1717506427663 system_ip: 172.16.255.26 host_name: vm16 site_id: '' update_time: 1717670310269 pageInfo: startTime: '1717505999936' endTime: '1717505999936' scrollId: o1ZSObpt5WS4AbmFImwHaC6D1fGWs3j5sGX9O0bNlQErayGcAWysadCDWPV9qUmygzrXpVREKLV2oz8DKCxUrmscYXIEaUkxAJ0RXn3rnhPWmsRLAjs7mIOj hasMoreData: true count: 1 totalCount: 3074 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineResponsePage' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Alarms-read /alarms/purgefrequency: get: tags: - Monitoring - Alarms Details description: Set alarm purge timer operationId: setPeriodicPurgeTimer parameters: - name: interval in: query description: Purge interval schema: pattern: ^[1-9]+[0-9]{0,4}([hHmM])?$ type: string - name: activeTime in: query description: Active time schema: pattern: ^[1-9]+[0-9]{0,4}([hHmM])?$ type: string responses: '200': description: Success content: application/json: schema: type: object properties: activeTime: type: string example: '60000' interval: type: string example: '60000' $$ref: '#/components/schemas/PurgeFrequency' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Alarms-read /alarms/query/fields: get: tags: - Monitoring - Alarms Details description: Get query fields operationId: getAlarmQueryFields responses: '200': description: Success content: application/json: schema: type: object examples: Query fields: description: Query fields value: data: - property: entry_time name: Event Time isRequired: true dataType: date fieldData: type: dateList options: - key: last_1_hour value: Last 1 hour number: '1' enableDateFields: false - key: last_3_hours value: Last 3 hours number: '3' enableDateFields: false - key: last_6_hours value: Last 6 hours number: '6' enableDateFields: false - key: last_12_hours value: Last 12 hours number: '12' enableDateFields: false - key: last_24_hours value: Last 24 hours number: '24' enableDateFields: false isSelected: true - key: last_168_hours value: Last 7 days number: '168' enableDateFields: false - key: custom value: Custom enableDateFields: true - property: vdevice_name name: Device name isRequired: true multiSelect: false dataType: string $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineResponseQueryFields' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /alarms/query/input: get: tags: - Monitoring - Alarms Details description: Get alarm field details operationId: getFieldDetails responses: '200': description: Success content: application/json: schema: type: object properties: component: type: array items: type: object properties: key: type: string example: system value: type: string example: System $$ref: '#/components/schemas/SimpleKeyValueMapping' severityOptions: type: array items: type: object properties: key: type: string example: system value: type: string example: System $$ref: '#/components/schemas/SimpleKeyValueMapping' timeOptions: type: array items: type: object properties: enableDateFields: type: boolean example: false key: type: string example: last_24_hours value: type: string example: Last 24 hours $$ref: '#/components/schemas/TimeOptions' $$ref: '#/components/schemas/AlarmQueryInputResponse' examples: Field details: description: Field details value: timeOptions: - key: last_24_hours value: Last 24 hours enableDateFields: false - key: last_12_hours value: Last 12 hours enableDateFields: false - key: last_6_hours value: Last 6 hours enableDateFields: false - key: last_1_hour value: Last 1 hour enableDateFields: false - key: custom value: Custom enableDateFields: true severityOptions: - key: critical value: Critical - key: major value: Major - key: medium value: Medium - key: minor value: Minor component: - key: system value: System - key: hardware value: Hardware - key: bfd value: BFD - key: control value: Control - key: interface value: Interface - key: omp value: OMP - key: tunnel value: Tunnel - key: routing value: Routing - key: policy value: vSmart Policy - key: security value: Security - key: software value: Software $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineResponseQueryInput' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Alarms-read /alarms/reset: get: tags: - Monitoring - Alarms Details description: Reset correlation engine. operationId: reset responses: '200': description: Success content: application/json: schema: type: object properties: Message: type: string example: Successfully dump data in log file $$ref: '#/components/schemas/SimpleMessageResponse' examples: Response: description: Response value: Message: Successfully reset correlation engine data $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineResponseReset' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: admin /alarms/restart: get: tags: - Monitoring - Alarms Details description: Restart correlation engine. operationId: restartCorrelationEngine responses: '200': description: Success content: application/json: schema: type: object properties: Message: type: string example: Successfully dump data in log file $$ref: '#/components/schemas/SimpleMessageResponse' examples: Response: description: Response value: Message: Successfully restarted correlation engine $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineResponseRestart' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: admin /alarms/rulenamedisplay/keyvalue: get: tags: - Monitoring - Alarms Details description: Get alarm types. operationId: getAlarmTypesAsKeyValue responses: '200': description: Success content: application/json: schema: type: object properties: key: type: string example: system value: type: string example: System $$ref: '#/components/schemas/SimpleKeyValueMapping' examples: Response: description: Response value: header: generatedOn: 1717666137603 data: - key: BFD_Node_Up value: BFD Node Up - key: BFD_TLOC_Up value: BFD TLOC Up - key: BFD_TLOC_Down value: BFD TLOC Down - key: BFD_Site_Down value: BFD Site Down - key: BFD_Site_Up value: BFD Site Up - key: BFD_Node_Down value: BFD Node Down - key: Control_Vsmart_Down value: Control Vsmart Down - key: Control_Vsmart_Up value: Control Vsmart Up - key: Control_Site_Down value: Control Site Down - key: Control_TLOC_Down value: Control TLOC Down - key: Control_Vmanage_Up value: Control Vmanage Up - key: Control_Site_Up value: Control Site Up - key: Control_Vmanage_Down value: Control Vmanage Down - key: Control_Vsmarts_Up value: Control Vsmarts Up - key: Control_Node_Up value: Control Node Up - key: Control_TLOC_Up value: Control TLOC Up - key: Control_Node_Down value: Control Node Down - key: Control_All_Vsmarts_Down value: Control All Vsmarts Down - key: OMP_Site_Down value: OMP Site Down - key: OMP_Node_Down value: OMP Node Down - key: OMP_Vsmarts_Up value: OMP Vsmarts Up - key: OMP_All_Vsmarts_Down value: OMP All Vsmarts Down - key: OMP_Vsmart_Down value: OMP Vsmart Down - key: OMP_Site_Up value: OMP Site Up - key: OMP_Node_Up value: OMP Node Up - key: OMP_Vsmart_Up value: OMP Vsmart Up - key: BGP_Router_Down value: BGP Router Down - key: BGP_Router_Up value: BGP Router Up - key: OSPF_Router_Down value: OSPF Router Down - key: OSPF_Router_Up value: OSPF Router Up - key: Device Activation Failed value: Device Activation Failed - key: Container activate failed value: Container activate failed - key: Nat_Update value: Nat Update - key: Tracker_State_Change value: Tracker State Change - key: SD-AVC Cloud Connector Credentials Error value: SD-AVC Cloud Connector Credentials Error - key: BGP_Peer_State_Change value: BGP Peer State Change - key: UTD_File_Reputation_Alert value: UTD File Reputation Alert - key: Container App installation failed value: Container App installation failed - key: ZTP Upgrade Failed value: ZTP Upgrade Failed - key: vManage_Self_Signed_Cert_Out_Of_Sync value: vManage Self Signed Cert Out Of Sync - key: Certificate_Expiration_Status value: Certificate Expiration Status - key: devices-have-no-license-associated value: devices-have-no-license-associated - key: UTD_File_Analysis_Upload_Status value: UTD File Analysis Upload Status - key: ZBFW_Session_Rate_Alert_On value: ZBFW Session Rate Alert On - key: PxGrid_Connection_Notification value: PxGrid Connection Notification - key: OMP_State_Change value: OMP State Change - key: Pseudo_Commit_Status value: Pseudo Commit Status - key: '' value: '' - key: ZBFW_Session_Rate_Alert_Off value: ZBFW Session Rate Alert Off - key: UTD_Notification value: UTD Notification - key: SLA_Violation_Packet_Drop value: SLA Violation Packet Drop - key: Multicloud value: Multicloud - key: '' value: '' - key: SLA_Violation value: SLA Violation - key: '' value: '' - key: Security_Certificate_Expired value: Security Certificate Expired - key: System_License_Mismatch value: System License Mismatch - key: DHCP_Server_State_Change value: DHCP Server State Change - key: Certificate_CRL_Has_Been_Disabled value: Certificate CRL Has Been Disabled - key: Clear_Installed_Certificate value: Clear Installed Certificate - key: Domain-ID_Change value: Domain-ID Change - key: Cisco Secure Access value: Cisco Secure Access - key: New_CSR_Generated value: New CSR Generated - key: UTD_File_Reputation_Retrospective_Alert value: UTD File Reputation Retrospective Alert - key: MultiCloud_License_State_Change value: MultiCloud License State Change - key: Interface_State_Change value: Interface State Change - key: Root_Cert_Chain_Uninstalled value: Root Cert Chain Uninstalled - key: Device Upgrade Failed value: Device Upgrade Failed - key: Umbrella CA has been updated value: Umbrella CA has been updated - key: Template_Rollback value: Template Rollback - key: aaa_Admin_Password_Change value: aaa Admin Password Change - key: UTD signature package installation failed value: UTD signature package installation failed - key: Container reload failed value: Container reload failed - key: CRL_UNREACHABLE_OR_INVALID value: CRL UNREACHABLE OR INVALID - key: APPQOE_ALARM value: APPQOE ALARM - key: Cloud On Ramp value: Cloud On Ramp - key: Disk_Write_Speed value: Disk Write Speed - key: System-IP_Change value: System-IP Change - key: Disaster_Recovery value: Disaster Recovery - key: ZBFW_Session_Maximum value: ZBFW Session Maximum - key: '' value: '' - key: Certificate_Has_Been_Revoked value: Certificate Has Been Revoked - key: Memory_Usage value: Memory Usage - key: UTD_File_Analysis_Status_Event value: UTD File Analysis Status Event - key: vSmart/vManage_Serial_File_Uploaded value: vSmart/vManage Serial File Uploaded - key: Edge_Device_Has_Been_Quarantined value: Edge Device Has Been Quarantined - key: Process_Restart value: Process Restart - key: Zscaler SSE Sublocation value: Zscaler SSE Sublocation - key: UTD_Version_Mismatch value: UTD Version Mismatch - key: OSPF_Neighbor_State_Change value: OSPF Neighbor State Change - key: Acknowledgement file not uploaded value: Acknowledgement file not uploaded - key: UTD_File_Reputation_Status_Event value: UTD File Reputation Status Event - key: AppQoe site id mismatch value: AppQoe site id mismatch - key: failed to update umbrella CA value: failed to update umbrella CA - key: Interface_Admin_State_Change value: Interface Admin State Change - key: CPU_Usage value: CPU Usage - key: UTD_Con value: UTD Con - key: Interface_State_Change value: Interface State Change - key: Control_No_Active_vBond value: Control No Active vBond - key: Geo_Fence_Alert_Status value: Geo Fence Alert Status - key: OMP_Ribout_Gen_Failure value: OMP Ribout Gen Failure - key: UTD_IPS_Alert value: UTD IPS Alert - key: Container reset failed value: Container reset failed - key: System_IP_Reuse value: System IP Reuse - key: API_VOLUME_MONITOR value: API VOLUME MONITOR - key: Vmanage_Service_State value: Vmanage Service State - key: WebServer_Certificate_Warning value: WebServer Certificate Warning - key: Default App List Update value: Default App List Update - key: edge device doesn't support umbrella CA update value: edge device doesn't support umbrella CA update - key: AAA_Password_Expiry_Warning value: AAA Password Expiry Warning - key: Root_Cert_Chain_Installed value: Root Cert Chain Installed - key: Site-ID_Change value: Site-ID Change - key: Disk_Read_Speed value: Disk Read Speed - key: Pim_Interface_State_Change value: Pim Interface State Change - key: License report generation failure value: License report generation failure - key: vEdge_Serial_File_Uploaded value: vEdge Serial File Uploaded - key: ROOTCA_SYNC_FAILURE value: ROOTCA SYNC FAILURE - key: Data_Policy_Commit_Failure value: Data Policy Commit Failure - key: Security_Certificate_Expiring value: Security Certificate Expiring - key: '' value: '' - key: AAA_Password_Expired value: AAA Password Expired - key: Vmanage_Critical_Space_Usage value: Vmanage Critical Space Usage - key: ZBFW_Half_Open_Limit_Hit value: ZBFW Half Open Limit Hit - key: HTTP_PROXY_UNREACHABLE value: HTTP PROXY UNREACHABLE - key: CRL_Has_Been_Disabled value: CRL Has Been Disabled - key: System_Reboot_Issued value: System Reboot Issued - key: Container upgrade failed value: Container upgrade failed - key: Analytics-license-compliance value: Analytics-license-compliance - key: '' value: '' - key: Disk_Usage value: Disk Usage - key: Control_vBond_State_Change value: Control vBond State Change - key: UTD_Update value: UTD Update - key: vManage_Queue_State value: vManage Queue State - key: Cloned_Vedge_Detected value: Cloned Vedge Detected - key: AppQoe service node state value: AppQoe service node state - key: Org_Name_Change value: Org Name Change - key: Vmanage_Node_Reachability_State value: Vmanage Node Reachability State - key: CRL_Has_Been_Enabled value: CRL Has Been Enabled - key: Unsupported_SFP_Detected value: Unsupported SFP Detected - key: SSL_Certificate_Warning value: SSL Certificate Warning $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineResponseRulenamedisplayKeyvalue' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Alarms-read /alarms/severity: get: tags: - Monitoring - Alarms Details description: Get alarms by severity operationId: getBySeverity parameters: - name: severity-level in: query description: Severity level required: true schema: type: array items: type: string examples: Critical: description: Critical value: Critical Major: description: Major value: Major Medium: description: Medium value: Medium Minor: description: Minor value: Minor - name: deviceId in: query description: Device System IP schema: type: array items: type: string - name: query in: query description: Query allowEmptyValue: true schema: type: string examples: Empty: description: Empty Get active alarms: description: Get active alarms value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: active type: boolean value: - 'true' operator: equal $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByActive' Get alarms filter by hours: description: Get alarms filter by hours value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByHours' Get alarms filter between dates: description: Get alarms filter between dates value: query: condition: AND rules: - field: entry_time type: date value: - 2024-04-30T19:30:00 UTC - 2024-05-30T17:30:00 UTC operator: between size: 10000 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBetweenDates' Get alarms filter by type: description: Get alarms filter by type value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: rule_name_display operator: in type: string value: - Memory_Usage size: 10000 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByType' Get alarms filter by system ip: description: Get alarms filter by system ip value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: system_ip operator: in type: string value: - 1.1.1.1 size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySystemIp' Get alarms filter by severity: description: Get alarms filter by severity value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: severity operator: in type: string value: - Critical size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySeverity' Get alarms filter by site-id: description: Get alarms filter by site-id value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: site_id operator: in type: string value: - '400' - '500' size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySites' - name: site-id in: query description: Specify the site-id to filter the alarms schema: pattern: ^[0-9]+$ type: string responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: type: object properties: acknowledged: type: boolean active: type: boolean cleared_by: type: string format: uuid example: 0a0dca23-11d5-4014-bfbb-976d3c6de492 cleared_events: type: array items: type: string format: uuid cleared_time: type: integer format: int64 example: 1652894923722 component: type: string example: Schedule Telemetry collection consumed_events: type: array items: type: object $$ref: '#/components/schemas/OneOfAlarmConsumedEventsItems' devices: type: array items: type: object properties: system-ip: type: string example: 19.19.19.1 $$ref: '#/components/schemas/AlarmDevices' entry_time: type: integer format: int64 example: 1652906591837 eventname: type: string example: telemetry-data-collection-failure id: type: string example: HHbp2IABUbH5BDy9BhJe message: type: string example: Scheduled telemetry data collection failed on 19.19.19.1 possible_causes: type: array items: type: string receive_time: type: integer format: int64 rule_name_display: type: string example: Telemetry data save failed rulename: type: string example: cpu-usage severity: type: string enum: - Minor - Major - Critical - Medium severity_number: type: integer format: int64 example: 4 site_id: type: integer format: int64 example: 100 statcycletime: type: integer format: int64 suppressed: type: boolean example: false suppressed_by: type: object example: system-ip: type: string example: 172.16.255.11 component: type: string example: BFD system_ip: type: string example: 172.16.255.26 tenant: type: string example: default type: type: string example: Telemetry data save failed uuid: type: string format: uuid example: f6f83721-3a69-42d1-841f-94e015957fb7 values: type: array items: type: object properties: empty: type: boolean additionalProperties: type: string $$ref: '#/components/schemas/GeneralSchema' values_short_display: type: array items: type: object properties: empty: type: boolean additionalProperties: type: string $$ref: '#/components/schemas/GeneralSchema' description: Represents any kind of alarm $$ref: '#/components/schemas/Alarm' pageInfo: type: object properties: count: type: integer description: number of alarms to be fetched format: int64 endTime: type: integer description: end time of alarms to be fetched format: int64 startTime: type: integer description: start time of alarms to be fetched format: int64 $$ref: '#/components/schemas/PageInfo' description: AlarmResponse is used for GET/POST /alarms call. $$ref: '#/components/schemas/AlarmResponse' examples: Response: description: Response value: header: generatedOn: 1717672304804 viewKeys: uniqueKey: [] preferenceKey: grid-raw_alarm columns: - title: Impacted Entities property: values_short_display minWidth: 250 dataType: jsonArray - title: Impacted Entities Details property: values hideable: true visible: false minWidth: 250 dataType: jsonArray - title: Severity property: severity display: iconAndText iconProperty: severity hideable: false icon: - key: Minor value: images/event_minor.png - key: Major value: images/event_major.png - key: Critical value: images/event_critical.png - key: Medium value: images/event_other.png minWidth: 70 dataType: string - title: Alarm Name property: rule_name_display hideable: false minWidth: 160 dataType: string - title: Message property: message minWidth: 250 dataType: string - title: Date & Time property: entry_time displayFormat: DD MMM YYYY h:mm:ss A z inputFormat: unix-time hideable: false minWidth: 200 dataType: date - title: Cleared Date & Time property: cleared_time displayFormat: DD MMM YYYY h:mm:ss A z inputFormat: unix-time minWidth: 200 dataType: date fields: - property: values_short_display dataType: jsonArray - property: values dataType: jsonArray - property: severity dataType: string display: iconAndText - property: rule_name_display dataType: string - property: message dataType: string - property: possible_causes dataType: string - property: entry_time dataType: date - property: cleared_time dataType: date - property: uuid dataType: string - property: type dataType: string - property: component dataType: string - property: severity_number dataType: number - property: devices dataType: object - property: active dataType: boolean - property: consumed_events dataType: 'false' - property: values dataType: object - property: acknowledged dataType: boolean - property: cleared_events dataType: string - property: cleared_by dataType: string chart: {} data: - entry_time: 1717505999936 uuid: edc2ed16-88c1-4a06-8bc7-19cfb489131c message: The interface admin-state changed to down type: interface-admin-state-change component: VPN severity: Critical severity_number: 1 devices: '[{"system-ip":"172.16.255.26"}]' active: 'true' consumed_events: '' values: '[{"host-name":"vm16","system-ip":"172.16.255.26","if-name":"ge0/0","new-admin-state":"down","vpn-id":"0"}]' acknowledged: 'true' possible_causes: '' cleared_events: '' cleared_by: '' suppressed: 'false' suppressed_by: '' rulename: interface-admin-state-change rule_name_display: Interface_Admin_State_Change values_short_display: '[{"host-name":"vm16","system-ip":"172.16.255.26","if-name":"ge0/0","new-admin-state":"down"}]' cleared_time: 0 statcycletime: 1717505999936 tenant: default eventname: interface-admin-state-change receive_time: 1717506427663 system_ip: 172.16.255.26 host_name: vm16 site_id: '' update_time: 1717670310269 pageInfo: startTime: '1717505999936' endTime: '1717505999936' scrollId: o1ZSObpt5WS4AbmFImwHaC6D1fGWs3j5sGX9O0bNlQErayGcAWysadCDWPV9qUmygzrXpVREKLV2oz8DKCxUrmscYXIEaUkxAJ0RXn3rnhPWmsRLAjs7mIOj hasMoreData: true count: 1 totalCount: 3074 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineResponsePage' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Alarms-read /alarms/severity/summary: get: tags: - Monitoring - Alarms Details description: Get alarm severity histogram operationId: getAlarmSeverityCustomHistogram parameters: - name: query in: query description: Query required: true schema: type: string examples: Get active alarms: description: Get active alarms value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: active type: boolean value: - 'true' operator: equal $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByActive' Get alarms filter by hours: description: Get alarms filter by hours value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByHours' Get alarms filter between dates: description: Get alarms filter between dates value: query: condition: AND rules: - field: entry_time type: date value: - 2024-04-30T19:30:00 UTC - 2024-05-30T17:30:00 UTC operator: between size: 10000 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBetweenDates' Get alarms filter by type: description: Get alarms filter by type value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: rule_name_display operator: in type: string value: - Memory_Usage size: 10000 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByType' Get alarms filter by system ip: description: Get alarms filter by system ip value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: system_ip operator: in type: string value: - 1.1.1.1 size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySystemIp' Get alarms filter by severity: description: Get alarms filter by severity value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: severity operator: in type: string value: - Critical size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySeverity' Get alarms filter by site-id: description: Get alarms filter by site-id value: query: condition: AND rules: - field: entry_time operator: last_n_hours type: date value: - '10' - field: site_id operator: in type: string value: - '400' - '500' size: 100 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySites' - name: site-id in: query description: Specify the site-id to filter the alarms schema: pattern: ^[0-9]+$ type: string responses: '200': description: Success content: application/json: schema: type: object $$ref: '#/components/schemas/SeveritySummary' examples: Severity: description: Severity value: header: generatedOn: 1718005537956 viewKeys: uniqueKey: [] preferenceKey: grid-Alarm_histogram columns: - title: Event Time property: entry_time displayFormat: DD MMM YYYY h:mm:ss A z inputFormat: unix-time width: 200 dataType: date - title: Count property: count width: 150 dataType: number - title: Component property: component width: 150 dataType: string fields: - property: entry_time dataType: date - property: count dataType: number - property: component dataType: string chart: xAxis: - entry_time yAxis: - count series: - component title: view.chart.clientViewAlarmHistogram.alarm xAxisLabel: view.chart.clientViewAlarmHistogram.time yAxisLabel: view.chart.clientViewAlarmHistogram.count data: - entry_time: 1717966800000 component: '' count: 0 - entry_time: 1717970400000 component: '' count: 0 - entry_time: 1717974000000 component: '' count: 0 - entry_time: 1717977600000 component: '' count: 0 - entry_time: 1717981200000 component: '' count: 0 - entry_time: 1717984800000 component: '' count: 0 - entry_time: 1717988400000 component: Critical count: 19 - entry_time: 1717988400000 component: Major count: 2 - entry_time: 1717988400000 component: Minor count: 40 - entry_time: 1717988400000 component: Medium count: 17 - entry_time: 1717992000000 component: Minor count: 141 - entry_time: 1717992000000 component: Medium count: 130 - entry_time: 1717992000000 component: Major count: 1 - entry_time: 1717995600000 component: Major count: 1 - entry_time: 1717995600000 component: Minor count: 148 - entry_time: 1717995600000 component: Medium count: 149 - entry_time: 1717999200000 component: Minor count: 76 - entry_time: 1717999200000 component: Medium count: 76 - entry_time: 1718002800000 component: Major count: 1 - entry_time: 1718002800000 component: Medium count: 109 - entry_time: 1718002800000 component: Minor count: 108 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineResponseSeverity' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Alarms-read /alarms/severitymappings: get: tags: - Monitoring - Alarms Details description: Gets alarm severity mappings operationId: getAlarmSeverityMappings responses: '200': description: Success content: application/json: schema: type: array properties: empty: type: boolean items: type: object properties: associatedAlarms: type: array items: type: object properties: key: type: string example: system value: type: string example: System $$ref: '#/components/schemas/SimpleKeyValueMapping' key: type: string example: Critical value: type: string example: Critical $$ref: '#/components/schemas/AlarmSeverityMapping' $$ref: '#/components/schemas/AlarmSeverityMappingResponse' examples: Response: description: Response value: header: generatedOn: 1717665973795 data: - key: Critical value: Critical associatedAlarms: - key: System_IP_Reuse value: System IP Reuse - key: OMP_All_Vsmarts_Down value: OMP All Vsmarts Down - key: Interface_Admin_State_Change value: Interface Admin State Change - key: System-IP_Change value: System-IP Change - key: Control_Node_Down value: Control Node Down - key: Disk_Usage value: Disk Usage - key: Control_All_Vsmarts_Down value: Control All Vsmarts Down - key: Control_Vmanage_Down value: Control Vmanage Down - key: Vmanage_Critical_Space_Usage value: Vmanage Critical Space Usage - key: vEdge_Serial_File_Uploaded value: vEdge Serial File Uploaded - key: UTD_File_Reputation_Retrospective_Alert value: UTD File Reputation Retrospective Alert - key: UTD_Con value: UTD Con - key: Device Upgrade Failed value: Device Upgrade Failed - key: Root_Cert_Chain_Uninstalled value: Root Cert Chain Uninstalled - key: UTD_Version_Mismatch value: UTD Version Mismatch - key: OSPF_Router_Down value: OSPF Router Down - key: Interface_State_Change value: Interface State Change - key: aaa_Admin_Password_Change value: aaa Admin Password Change - key: Device Activation Failed value: Device Activation Failed - key: Org_Name_Change value: Org Name Change - key: Control_Site_Down value: Control Site Down - key: CPU_Usage value: CPU Usage - key: UTD_File_Reputation_Alert value: UTD File Reputation Alert - key: UTD_Notification value: UTD Notification - key: Template_Rollback value: Template Rollback - key: UTD_IPS_Alert value: UTD IPS Alert - key: BFD_Node_Down value: BFD Node Down - key: Root_Cert_Chain_Installed value: Root Cert Chain Installed - key: Disk_Read_Speed value: Disk Read Speed - key: OMP_Node_Down value: OMP Node Down - key: System_License_Mismatch value: System License Mismatch - key: Disaster_Recovery value: Disaster Recovery - key: OMP_State_Change value: OMP State Change - key: Site-ID_Change value: Site-ID Change - key: Domain-ID_Change value: Domain-ID Change - key: BGP_Router_Down value: BGP Router Down - key: Control_Vsmart_Down value: Control Vsmart Down - key: Memory_Usage value: Memory Usage - key: Vmanage_Service_State value: Vmanage Service State - key: Cloned_Vedge_Detected value: Cloned Vedge Detected - key: vSmart/vManage_Serial_File_Uploaded value: vSmart/vManage Serial File Uploaded - key: New_CSR_Generated value: New CSR Generated - key: Vmanage_Node_Reachability_State value: Vmanage Node Reachability State - key: OMP_Site_Down value: OMP Site Down - key: Unsupported_SFP_Detected value: Unsupported SFP Detected - key: Disk_Write_Speed value: Disk Write Speed - key: System_Reboot_Issued value: System Reboot Issued - key: Clear_Installed_Certificate value: Clear Installed Certificate - key: GEO_Fence_Alert_Status value: GEO Fence Alert Status - key: ZTP Upgrade Failed value: ZTP Upgrade Failed - key: APPQOE_ALARM value: APPQOE ALARM - key: PxGrid_Connection_Notification value: PxGrid Connection Notification - key: BFD_Site_Down value: BFD Site Down - key: Control_vBond_State_Change value: Control vBond State Change - key: Process_Restart value: Process Restart - key: Major value: Major associatedAlarms: - key: System_IP_Reuse value: System IP Reuse - key: OMP_All_Vsmarts_Down value: OMP All Vsmarts Down - key: Interface_Admin_State_Change value: Interface Admin State Change - key: System-IP_Change value: System-IP Change - key: DHCP_Server_State_Change value: DHCP Server State Change - key: Control_Node_Down value: Control Node Down - key: Disk_Usage value: Disk Usage - key: Control_All_Vsmarts_Down value: Control All Vsmarts Down - key: Control_Vmanage_Down value: Control Vmanage Down - key: Vmanage_Critical_Space_Usage value: Vmanage Critical Space Usage - key: ZBFW_Session_Rate_Alert_Off value: ZBFW Session Rate Alert Off - key: vEdge_Serial_File_Uploaded value: vEdge Serial File Uploaded - key: UTD_File_Reputation_Retrospective_Alert value: UTD File Reputation Retrospective Alert - key: UTD_Con value: UTD Con - key: Device Upgrade Failed value: Device Upgrade Failed - key: Cisco Secure Access value: Cisco Secure Access - key: UTD_Update value: UTD Update - key: Root_Cert_Chain_Uninstalled value: Root Cert Chain Uninstalled - key: UTD_Version_Mismatch value: UTD Version Mismatch - key: OSPF_Router_Down value: OSPF Router Down - key: Interface_State_Change value: Interface State Change - key: aaa_Admin_Password_Change value: aaa Admin Password Change - key: OSPF_Neighbor_State_Change value: OSPF Neighbor State Change - key: Device Activation Failed value: Device Activation Failed - key: Cloud On Ramp value: Cloud On Ramp - key: Org_Name_Change value: Org Name Change - key: SD-AVC Cloud Connector Error value: SD-AVC Cloud Connector Error - key: Data_Policy_Commit_Failure value: Data Policy Commit Failure - key: Control_Site_Down value: Control Site Down - key: CPU_Usage value: CPU Usage - key: UTD_File_Reputation_Alert value: UTD File Reputation Alert - key: BFD_TLOC_Down value: BFD TLOC Down - key: UTD_Notification value: UTD Notification - key: Template_Rollback value: Template Rollback - key: UTD_IPS_Alert value: UTD IPS Alert - key: BFD_Node_Down value: BFD Node Down - key: BGP_Peer_State_Change value: BGP Peer State Change - key: Root_Cert_Chain_Installed value: Root Cert Chain Installed - key: ZBFW_Session_Rate_Alert_On value: ZBFW Session Rate Alert On - key: UTD_File_Reputation_Status_Event value: UTD File Reputation Status Event - key: Disk_Read_Speed value: Disk Read Speed - key: OMP_Node_Down value: OMP Node Down - key: Pim_Interface_State_Change value: Pim Interface State Change - key: ZBFW_Half_Open_Limit_Hit value: ZBFW Half Open Limit Hit - key: System_License_Mismatch value: System License Mismatch - key: Disaster_Recovery value: Disaster Recovery - key: OMP_State_Change value: OMP State Change - key: Site-ID_Change value: Site-ID Change - key: UTD_File_Analysis_Status_Event value: UTD File Analysis Status Event - key: Tracker_State_Change value: Tracker State Change - key: Domain-ID_Change value: Domain-ID Change - key: BGP_Router_Down value: BGP Router Down - key: Control_Vsmart_Down value: Control Vsmart Down - key: Memory_Usage value: Memory Usage - key: SLA_change value: SLA change - key: Vmanage_Service_State value: Vmanage Service State - key: Cloned_Vedge_Detected value: Cloned Vedge Detected - key: vSmart/vManage_Serial_File_Uploaded value: vSmart/vManage Serial File Uploaded - key: vManage_Queue_State value: vManage Queue State - key: New_CSR_Generated value: New CSR Generated - key: Vmanage_Node_Reachability_State value: Vmanage Node Reachability State - key: Default App List Update value: Default App List Update - key: OMP_Site_Down value: OMP Site Down - key: Unsupported_SFP_Detected value: Unsupported SFP Detected - key: Disk_Write_Speed value: Disk Write Speed - key: System_Reboot_Issued value: System Reboot Issued - key: Clear_Installed_Certificate value: Clear Installed Certificate - key: UTD_File_Analysis_Upload_Status value: UTD File Analysis Upload Status - key: GEO_Fence_Alert_Status value: GEO Fence Alert Status - key: ZTP Upgrade Failed value: ZTP Upgrade Failed - key: Control_TLOC_Down value: Control TLOC Down - key: APPQOE_ALARM value: APPQOE ALARM - key: PxGrid_Connection_Notification value: PxGrid Connection Notification - key: BFD_Site_Down value: BFD Site Down - key: Control_vBond_State_Change value: Control vBond State Change - key: Process_Restart value: Process Restart - key: ZBFW_Session_Maximum value: ZBFW Session Maximum - key: Medium value: Medium associatedAlarms: - key: Control_Vsmart_Up value: Control Vsmart Up - key: System_IP_Reuse value: System IP Reuse - key: OMP_Vsmarts_Up value: OMP Vsmarts Up - key: OMP_All_Vsmarts_Down value: OMP All Vsmarts Down - key: Interface_Admin_State_Change value: Interface Admin State Change - key: Control_Vsmarts_Up value: Control Vsmarts Up - key: OMP_Site_Up value: OMP Site Up - key: System-IP_Change value: System-IP Change - key: DHCP_Server_State_Change value: DHCP Server State Change - key: Control_Node_Down value: Control Node Down - key: Disk_Usage value: Disk Usage - key: Control_All_Vsmarts_Down value: Control All Vsmarts Down - key: Control_Vmanage_Down value: Control Vmanage Down - key: Vmanage_Critical_Space_Usage value: Vmanage Critical Space Usage - key: ZBFW_Session_Rate_Alert_Off value: ZBFW Session Rate Alert Off - key: vEdge_Serial_File_Uploaded value: vEdge Serial File Uploaded - key: UTD_File_Reputation_Retrospective_Alert value: UTD File Reputation Retrospective Alert - key: UTD_Con value: UTD Con - key: OSPF_Router_Up value: OSPF Router Up - key: Device Upgrade Failed value: Device Upgrade Failed - key: Cisco Secure Access value: Cisco Secure Access - key: UTD_Update value: UTD Update - key: Root_Cert_Chain_Uninstalled value: Root Cert Chain Uninstalled - key: UTD_Version_Mismatch value: UTD Version Mismatch - key: OSPF_Router_Down value: OSPF Router Down - key: Interface_State_Change value: Interface State Change - key: aaa_Admin_Password_Change value: aaa Admin Password Change - key: OSPF_Neighbor_State_Change value: OSPF Neighbor State Change - key: Device Activation Failed value: Device Activation Failed - key: Cloud On Ramp value: Cloud On Ramp - key: Org_Name_Change value: Org Name Change - key: SD-AVC Cloud Connector Error value: SD-AVC Cloud Connector Error - key: Data_Policy_Commit_Failure value: Data Policy Commit Failure - key: BFD_Node_Up value: BFD Node Up - key: Control_Site_Down value: Control Site Down - key: CPU_Usage value: CPU Usage - key: BFD_TLOC_Up value: BFD TLOC Up - key: UTD_File_Reputation_Alert value: UTD File Reputation Alert - key: BFD_TLOC_Down value: BFD TLOC Down - key: OMP_Node_Up value: OMP Node Up - key: Control_Node_Up value: Control Node Up - key: UTD_Notification value: UTD Notification - key: Control_TLOC_Up value: Control TLOC Up - key: Template_Rollback value: Template Rollback - key: UTD_IPS_Alert value: UTD IPS Alert - key: BFD_Node_Down value: BFD Node Down - key: BGP_Peer_State_Change value: BGP Peer State Change - key: Root_Cert_Chain_Installed value: Root Cert Chain Installed - key: ZBFW_Session_Rate_Alert_On value: ZBFW Session Rate Alert On - key: UTD_File_Reputation_Status_Event value: UTD File Reputation Status Event - key: Disk_Read_Speed value: Disk Read Speed - key: Control_Vmanage_Up value: Control Vmanage Up - key: OMP_Node_Down value: OMP Node Down - key: Pim_Interface_State_Change value: Pim Interface State Change - key: ZBFW_Half_Open_Limit_Hit value: ZBFW Half Open Limit Hit - key: System_License_Mismatch value: System License Mismatch - key: Disaster_Recovery value: Disaster Recovery - key: OMP_State_Change value: OMP State Change - key: Site-ID_Change value: Site-ID Change - key: UTD_File_Analysis_Status_Event value: UTD File Analysis Status Event - key: Tracker_State_Change value: Tracker State Change - key: Domain-ID_Change value: Domain-ID Change - key: BGP_Router_Down value: BGP Router Down - key: Control_Vsmart_Down value: Control Vsmart Down - key: Memory_Usage value: Memory Usage - key: SLA_change value: SLA change - key: Vmanage_Service_State value: Vmanage Service State - key: Cloned_Vedge_Detected value: Cloned Vedge Detected - key: vSmart/vManage_Serial_File_Uploaded value: vSmart/vManage Serial File Uploaded - key: vManage_Queue_State value: vManage Queue State - key: New_CSR_Generated value: New CSR Generated - key: Vmanage_Node_Reachability_State value: Vmanage Node Reachability State - key: Default App List Update value: Default App List Update - key: OMP_Site_Down value: OMP Site Down - key: Unsupported_SFP_Detected value: Unsupported SFP Detected - key: Disk_Write_Speed value: Disk Write Speed - key: System_Reboot_Issued value: System Reboot Issued - key: Clear_Installed_Certificate value: Clear Installed Certificate - key: UTD_File_Analysis_Upload_Status value: UTD File Analysis Upload Status - key: GEO_Fence_Alert_Status value: GEO Fence Alert Status - key: ZTP Upgrade Failed value: ZTP Upgrade Failed - key: Control_TLOC_Down value: Control TLOC Down - key: APPQOE_ALARM value: APPQOE ALARM - key: PxGrid_Connection_Notification value: PxGrid Connection Notification - key: Control_Site_Up value: Control Site Up - key: BFD_Site_Down value: BFD Site Down - key: BFD_Site_Up value: BFD Site Up - key: Control_vBond_State_Change value: Control vBond State Change - key: BGP_Router_Up value: BGP Router Up - key: Process_Restart value: Process Restart - key: ZBFW_Session_Maximum value: ZBFW Session Maximum - key: Minor value: Minor associatedAlarms: - key: Control_Vsmart_Up value: Control Vsmart Up - key: SLA_Violation value: SLA Violation - key: System_IP_Reuse value: System IP Reuse - key: OMP_Vsmarts_Up value: OMP Vsmarts Up - key: OMP_All_Vsmarts_Down value: OMP All Vsmarts Down - key: Interface_Admin_State_Change value: Interface Admin State Change - key: Control_Vsmarts_Up value: Control Vsmarts Up - key: OMP_Site_Up value: OMP Site Up - key: System-IP_Change value: System-IP Change - key: DHCP_Server_State_Change value: DHCP Server State Change - key: Control_Node_Down value: Control Node Down - key: Disk_Usage value: Disk Usage - key: Control_All_Vsmarts_Down value: Control All Vsmarts Down - key: Control_Vmanage_Down value: Control Vmanage Down - key: Vmanage_Critical_Space_Usage value: Vmanage Critical Space Usage - key: ZBFW_Session_Rate_Alert_Off value: ZBFW Session Rate Alert Off - key: vEdge_Serial_File_Uploaded value: vEdge Serial File Uploaded - key: UTD_File_Reputation_Retrospective_Alert value: UTD File Reputation Retrospective Alert - key: UTD_Con value: UTD Con - key: OSPF_Router_Up value: OSPF Router Up - key: Device Upgrade Failed value: Device Upgrade Failed - key: Cisco Secure Access value: Cisco Secure Access - key: UTD_Update value: UTD Update - key: Root_Cert_Chain_Uninstalled value: Root Cert Chain Uninstalled - key: UTD_Version_Mismatch value: UTD Version Mismatch - key: OSPF_Router_Down value: OSPF Router Down - key: Interface_State_Change value: Interface State Change - key: aaa_Admin_Password_Change value: aaa Admin Password Change - key: OSPF_Neighbor_State_Change value: OSPF Neighbor State Change - key: Device Activation Failed value: Device Activation Failed - key: Cloud On Ramp value: Cloud On Ramp - key: Org_Name_Change value: Org Name Change - key: SD-AVC Cloud Connector Error value: SD-AVC Cloud Connector Error - key: Data_Policy_Commit_Failure value: Data Policy Commit Failure - key: BFD_Node_Up value: BFD Node Up - key: Control_Site_Down value: Control Site Down - key: CPU_Usage value: CPU Usage - key: BFD_TLOC_Up value: BFD TLOC Up - key: UTD_File_Reputation_Alert value: UTD File Reputation Alert - key: BFD_TLOC_Down value: BFD TLOC Down - key: Pseudo_Commit_Status value: Pseudo Commit Status - key: OMP_Node_Up value: OMP Node Up - key: Control_Node_Up value: Control Node Up - key: UTD_Notification value: UTD Notification - key: Control_TLOC_Up value: Control TLOC Up - key: Template_Rollback value: Template Rollback - key: UTD_IPS_Alert value: UTD IPS Alert - key: BFD_Node_Down value: BFD Node Down - key: BGP_Peer_State_Change value: BGP Peer State Change - key: Root_Cert_Chain_Installed value: Root Cert Chain Installed - key: ZBFW_Session_Rate_Alert_On value: ZBFW Session Rate Alert On - key: UTD_File_Reputation_Status_Event value: UTD File Reputation Status Event - key: Disk_Read_Speed value: Disk Read Speed - key: Control_Vmanage_Up value: Control Vmanage Up - key: OMP_Node_Down value: OMP Node Down - key: Pim_Interface_State_Change value: Pim Interface State Change - key: ZBFW_Half_Open_Limit_Hit value: ZBFW Half Open Limit Hit - key: System_License_Mismatch value: System License Mismatch - key: Disaster_Recovery value: Disaster Recovery - key: OMP_State_Change value: OMP State Change - key: Site-ID_Change value: Site-ID Change - key: UTD_File_Analysis_Status_Event value: UTD File Analysis Status Event - key: Tracker_State_Change value: Tracker State Change - key: Domain-ID_Change value: Domain-ID Change - key: BGP_Router_Down value: BGP Router Down - key: Control_Vsmart_Down value: Control Vsmart Down - key: Memory_Usage value: Memory Usage - key: SLA_change value: SLA change - key: Vmanage_Service_State value: Vmanage Service State - key: Cloned_Vedge_Detected value: Cloned Vedge Detected - key: vSmart/vManage_Serial_File_Uploaded value: vSmart/vManage Serial File Uploaded - key: vManage_Queue_State value: vManage Queue State - key: New_CSR_Generated value: New CSR Generated - key: Vmanage_Node_Reachability_State value: Vmanage Node Reachability State - key: Default App List Update value: Default App List Update - key: OMP_Site_Down value: OMP Site Down - key: Unsupported_SFP_Detected value: Unsupported SFP Detected - key: Disk_Write_Speed value: Disk Write Speed - key: System_Reboot_Issued value: System Reboot Issued - key: Clear_Installed_Certificate value: Clear Installed Certificate - key: UTD_File_Analysis_Upload_Status value: UTD File Analysis Upload Status - key: GEO_Fence_Alert_Status value: GEO Fence Alert Status - key: ZTP Upgrade Failed value: ZTP Upgrade Failed - key: Control_TLOC_Down value: Control TLOC Down - key: APPQOE_ALARM value: APPQOE ALARM - key: PxGrid_Connection_Notification value: PxGrid Connection Notification - key: Control_Site_Up value: Control Site Up - key: SLA_Violation_Packet_Drop value: SLA Violation Packet Drop - key: BFD_Site_Down value: BFD Site Down - key: BFD_Site_Up value: BFD Site Up - key: Control_vBond_State_Change value: Control vBond State Change - key: BGP_Router_Up value: BGP Router Up - key: Process_Restart value: Process Restart - key: ZBFW_Session_Maximum value: ZBFW Session Maximum - key: Info value: Info associatedAlarms: - key: Control_Vsmart_Up value: Control Vsmart Up - key: SLA_Violation value: SLA Violation - key: System_IP_Reuse value: System IP Reuse - key: OMP_Vsmarts_Up value: OMP Vsmarts Up - key: OMP_All_Vsmarts_Down value: OMP All Vsmarts Down - key: Interface_Admin_State_Change value: Interface Admin State Change - key: Control_Vsmarts_Up value: Control Vsmarts Up - key: OMP_Site_Up value: OMP Site Up - key: System-IP_Change value: System-IP Change - key: DHCP_Server_State_Change value: DHCP Server State Change - key: Control_Node_Down value: Control Node Down - key: Disk_Usage value: Disk Usage - key: Control_All_Vsmarts_Down value: Control All Vsmarts Down - key: Control_Vmanage_Down value: Control Vmanage Down - key: Vmanage_Critical_Space_Usage value: Vmanage Critical Space Usage - key: ZBFW_Session_Rate_Alert_Off value: ZBFW Session Rate Alert Off - key: vEdge_Serial_File_Uploaded value: vEdge Serial File Uploaded - key: UTD_File_Reputation_Retrospective_Alert value: UTD File Reputation Retrospective Alert - key: UTD_Con value: UTD Con - key: OSPF_Router_Up value: OSPF Router Up - key: Device Upgrade Failed value: Device Upgrade Failed - key: Cisco Secure Access value: Cisco Secure Access - key: UTD_Update value: UTD Update - key: Root_Cert_Chain_Uninstalled value: Root Cert Chain Uninstalled - key: UTD_Version_Mismatch value: UTD Version Mismatch - key: OSPF_Router_Down value: OSPF Router Down - key: Interface_State_Change value: Interface State Change - key: aaa_Admin_Password_Change value: aaa Admin Password Change - key: OSPF_Neighbor_State_Change value: OSPF Neighbor State Change - key: Device Activation Failed value: Device Activation Failed - key: Cloud On Ramp value: Cloud On Ramp - key: Org_Name_Change value: Org Name Change - key: SD-AVC Cloud Connector Error value: SD-AVC Cloud Connector Error - key: Data_Policy_Commit_Failure value: Data Policy Commit Failure - key: BFD_Node_Up value: BFD Node Up - key: Control_Site_Down value: Control Site Down - key: CPU_Usage value: CPU Usage - key: BFD_TLOC_Up value: BFD TLOC Up - key: UTD_File_Reputation_Alert value: UTD File Reputation Alert - key: BFD_TLOC_Down value: BFD TLOC Down - key: Pseudo_Commit_Status value: Pseudo Commit Status - key: OMP_Node_Up value: OMP Node Up - key: Control_Node_Up value: Control Node Up - key: UTD_Notification value: UTD Notification - key: Control_TLOC_Up value: Control TLOC Up - key: Template_Rollback value: Template Rollback - key: UTD_IPS_Alert value: UTD IPS Alert - key: BFD_Node_Down value: BFD Node Down - key: BGP_Peer_State_Change value: BGP Peer State Change - key: Root_Cert_Chain_Installed value: Root Cert Chain Installed - key: ZBFW_Session_Rate_Alert_On value: ZBFW Session Rate Alert On - key: UTD_File_Reputation_Status_Event value: UTD File Reputation Status Event - key: Disk_Read_Speed value: Disk Read Speed - key: Control_Vmanage_Up value: Control Vmanage Up - key: OMP_Node_Down value: OMP Node Down - key: Pim_Interface_State_Change value: Pim Interface State Change - key: ZBFW_Half_Open_Limit_Hit value: ZBFW Half Open Limit Hit - key: System_License_Mismatch value: System License Mismatch - key: Disaster_Recovery value: Disaster Recovery - key: OMP_State_Change value: OMP State Change - key: Site-ID_Change value: Site-ID Change - key: UTD_File_Analysis_Status_Event value: UTD File Analysis Status Event - key: Tracker_State_Change value: Tracker State Change - key: Domain-ID_Change value: Domain-ID Change - key: BGP_Router_Down value: BGP Router Down - key: Control_Vsmart_Down value: Control Vsmart Down - key: Memory_Usage value: Memory Usage - key: SLA_change value: SLA change - key: Vmanage_Service_State value: Vmanage Service State - key: Cloned_Vedge_Detected value: Cloned Vedge Detected - key: vSmart/vManage_Serial_File_Uploaded value: vSmart/vManage Serial File Uploaded - key: vManage_Queue_State value: vManage Queue State - key: New_CSR_Generated value: New CSR Generated - key: Vmanage_Node_Reachability_State value: Vmanage Node Reachability State - key: Default App List Update value: Default App List Update - key: OMP_Site_Down value: OMP Site Down - key: Unsupported_SFP_Detected value: Unsupported SFP Detected - key: Disk_Write_Speed value: Disk Write Speed - key: System_Reboot_Issued value: System Reboot Issued - key: Clear_Installed_Certificate value: Clear Installed Certificate - key: UTD_File_Analysis_Upload_Status value: UTD File Analysis Upload Status - key: GEO_Fence_Alert_Status value: GEO Fence Alert Status - key: ZTP Upgrade Failed value: ZTP Upgrade Failed - key: Control_TLOC_Down value: Control TLOC Down - key: APPQOE_ALARM value: APPQOE ALARM - key: PxGrid_Connection_Notification value: PxGrid Connection Notification - key: Control_Site_Up value: Control Site Up - key: SLA_Violation_Packet_Drop value: SLA Violation Packet Drop - key: BFD_Site_Down value: BFD Site Down - key: BFD_Site_Up value: BFD Site Up - key: Control_vBond_State_Change value: Control vBond State Change - key: BGP_Router_Up value: BGP Router Up - key: Process_Restart value: Process Restart - key: ZBFW_Session_Maximum value: ZBFW Session Maximum $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineResponseSeveritymappings' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Alarms-read /alarms/starttracking/{testName}: post: tags: - Monitoring - Alarms Details description: Start tracking events operationId: startTracking parameters: - name: testName in: path description: Test Name required: true schema: pattern: ^[a-zA-Z0-9\-_]*$ type: string responses: '200': description: Success content: application/json: schema: type: object properties: Message: type: string example: Successfully dump data in log file $$ref: '#/components/schemas/SimpleMessageResponse' examples: Response: description: Response value: Message: Done $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineResponseStarttracking' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Alarms-read /alarms/stats: get: tags: - Monitoring - Alarms Details description: Get alarm statistics operationId: getStats responses: '200': description: Success content: application/json: schema: type: object properties: Correlation DB Manipulator: type: object additionalProperties: type: object properties: Discarded Events: type: integer format: int32 example: 0 Processed Events: type: integer format: int32 example: 0 Total: type: integer format: int32 example: 0 $$ref: '#/components/schemas/EventStats' Correlation Engine: type: object properties: Added Events: type: integer format: int32 example: 89 $$ref: '#/components/schemas/AlarmStatsResponseCorrelationEngine' Link Update Correlator: type: object additionalProperties: type: string $$ref: '#/components/schemas/AlarmStatsResponse' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Alarms-read /alarms/stoptracking/{testName}: post: tags: - Monitoring - Alarms Details description: Stop tracking events operationId: stopTracking parameters: - name: testName in: path description: Test Name required: true schema: pattern: ^[a-zA-Z0-9\-_]*$ type: string responses: '200': description: Success content: application/json: schema: type: object properties: Message: type: string example: Successfully dump data in log file $$ref: '#/components/schemas/SimpleMessageResponse' examples: Response: description: Response value: Message: Done $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineResponseStarttracking' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Alarms-read /alarms/topic: get: tags: - Monitoring - Alarms Details description: Get topic on which alarms for given device are publishing. operationId: getDeviceTopic parameters: - name: ip in: query description: Device system IP required: true schema: type: string responses: '200': description: Success content: application/json: schema: type: object properties: device-ip: type: string example: 172.16.255.11 server-ip: type: string example: 10.0.105.39 topic: type: string example: AlarmEvent3 $$ref: '#/components/schemas/AlarmTopic' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Alarms-read /alarms/topn: post: tags: - Monitoring - Alarms Details description: Returns top-n alarm count based on given query operationId: getTopN parameters: - name: site-id in: query description: Specify the site-id to filter the alarms schema: pattern: ^[0-9]+$ type: string - name: includeTenants in: query description: Specify whether the tenant alarms need to be visible or not from provider view. schema: type: boolean requestBody: description: Input query content: application/json: schema: type: object examples: Topn by system IP: description: Topn by system IP value: query: field: system_ip condition: AND rules: - value: - '24' field: entry_time type: date operator: last_n_hours - field: active operator: in type: boolean value: - 'true' - field: acknowledged operator: in type: boolean value: - 'false' size: 2 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestTopnBySystemip' Topn by host name: description: Topn by host name value: query: field: host-name condition: AND rules: - value: - '24' field: entry_time type: date operator: last_n_hours - field: active operator: in type: boolean value: - 'true' - field: acknowledged operator: in type: boolean value: - 'false' size: 2 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestTopnByHostname' Topn by type: description: Topn by type value: query: field: type condition: AND rules: - value: - '24' field: entry_time type: date operator: last_n_hours - field: active operator: in type: boolean value: - 'true' - field: acknowledged operator: in type: boolean value: - 'false' size: 2 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestTopnByType' Topn by severity: description: Topn by severity value: query: field: severity condition: AND rules: - value: - '24' field: entry_time type: date operator: last_n_hours - field: active operator: in type: boolean value: - 'true' - field: acknowledged operator: in type: boolean value: - 'false' size: 2 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestTopnBySeverity' Topn by rule name display: description: Topn by rule name display value: query: field: rule_name_display condition: AND rules: - value: - '24' field: entry_time type: date operator: last_n_hours - field: active operator: in type: boolean value: - 'true' - field: acknowledged operator: in type: boolean value: - 'false' size: 3 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestTopnByRulenamedisplay' required: true responses: '200': description: Success content: application/json: schema: type: object examples: Topn by system IP: description: Topn by system IP value: data: - system_ip: 172.16.255.16 count: 38 devices: - system_ip: 172.16.255.16 host_name: vm6 count: 38 - system_ip: 172.16.255.22 count: 30 devices: - system_ip: 172.16.255.22 host_name: vm12 count: 30 - system_ip: 172.16.255.26 count: 28 devices: - system_ip: 172.16.255.26 host_name: vm16 count: 28 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineResponseTopnBySystemip' Topn by host name: description: Topn by host name value: data: - host-name: vm6 count: 38 devices: - system_ip: 172.16.255.16 host_name: vm6 count: 38 - host-name: vm12 count: 30 devices: - system_ip: 172.16.255.22 host_name: vm12 count: 30 - host-name: vm16 count: 28 devices: - system_ip: 172.16.255.26 host_name: vm16 count: 28 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineResponseTopnByHostname' Topn by type: description: Topn by type value: data: - count: 281 devices: - host_name: vm16 system_ip: 172.16.255.26 count: 181 - host_name: vm12 system_ip: 172.16.255.22 count: 100 type: cpu-usage - count: 3 devices: - host_name: vm5 system_ip: 172.16.255.15 count: 3 type: node_down $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineResponseTopnByType' Topn by severity: description: Topn by severity value: data: - count: 127 devices: - host_name: vm16 system_ip: 172.16.255.26 count: 60 - host_name: vm12 system_ip: 172.16.255.22 count: 40 - host_name: vm5 system_ip: 172.16.255.15 count: 27 severity: Medium - count: 106 devices: - host_name: vm16 system_ip: 172.16.255.26 count: 56 - host_name: vm12 system_ip: 172.16.255.22 count: 50 severity: Minor $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineResponseTopnBySeverity' Topn by rule name display: description: Topn by rule name display value: data: - count: 12 devices: - count: 7 host_name: vm12 system_ip: 172.16.255.22 - count: 5 host_name: vm6 system_ip: 172.16.255.16 rule_name_display: Memory_Usage - count: 12 devices: - count: 4 host_name: vm10 system_ip: 172.16.255.20 - count: 4 host_name: vm12 system_ip: 172.16.255.22 - count: 4 host_name: vm9 system_ip: 172.16.255.19 rule_name_display: Root_Cert_Chain_Installed - count: 2 devices: - count: 2 host_name: vm12 system_ip: 172.16.255.22 rule_name_display: CRL_Has_Been_Disabled $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineResponseTopnByRulenamedisplay' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /alarms/uuid/{alarm_uuid}: get: tags: - Monitoring - Alarms Details description: Get alarm details for given UUID operationId: getAlarmDetails parameters: - name: alarm_uuid in: path description: Alarm UUID required: true schema: pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string - name: includeTenants in: query description: Specify whether the tenant alarms need to be visible or not from provider view. schema: type: boolean responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: type: object properties: acknowledged: type: boolean active: type: boolean cleared_by: type: string format: uuid example: 0a0dca23-11d5-4014-bfbb-976d3c6de492 cleared_events: type: array items: type: string format: uuid cleared_time: type: integer format: int64 example: 1652894923722 component: type: string example: Schedule Telemetry collection consumed_events: type: array items: type: object $$ref: '#/components/schemas/OneOfAlarmConsumedEventsItems' devices: type: array items: type: object properties: system-ip: type: string example: 19.19.19.1 $$ref: '#/components/schemas/AlarmDevices' entry_time: type: integer format: int64 example: 1652906591837 eventname: type: string example: telemetry-data-collection-failure id: type: string example: HHbp2IABUbH5BDy9BhJe message: type: string example: Scheduled telemetry data collection failed on 19.19.19.1 possible_causes: type: array items: type: string receive_time: type: integer format: int64 rule_name_display: type: string example: Telemetry data save failed rulename: type: string example: cpu-usage severity: type: string enum: - Minor - Major - Critical - Medium severity_number: type: integer format: int64 example: 4 site_id: type: integer format: int64 example: 100 statcycletime: type: integer format: int64 suppressed: type: boolean example: false suppressed_by: type: object example: system-ip: type: string example: 172.16.255.11 component: type: string example: BFD system_ip: type: string example: 172.16.255.26 tenant: type: string example: default type: type: string example: Telemetry data save failed uuid: type: string format: uuid example: f6f83721-3a69-42d1-841f-94e015957fb7 values: type: array items: type: object properties: empty: type: boolean additionalProperties: type: string $$ref: '#/components/schemas/GeneralSchema' values_short_display: type: array items: type: object properties: empty: type: boolean additionalProperties: type: string $$ref: '#/components/schemas/GeneralSchema' description: Represents any kind of alarm $$ref: '#/components/schemas/Alarm' pageInfo: type: object properties: count: type: integer description: number of alarms to be fetched format: int64 endTime: type: integer description: end time of alarms to be fetched format: int64 startTime: type: integer description: start time of alarms to be fetched format: int64 $$ref: '#/components/schemas/PageInfo' description: AlarmResponse is used for GET/POST /alarms call. $$ref: '#/components/schemas/AlarmResponse' examples: Response: description: Response value: header: generatedOn: 1717671791755 data: - entry_time: 1717671338582 uuid: 59a93996-719d-4550-bbd5-1ba8c60b3d31 message: failed to sync root cert to device (ca9ec973-ba93-48ea-ad40-dea43b32d9f5, vm10, 172.16.255.20) on 06 Jun 2024 10:55:38 UTC type: rootca-sync-failure component: System severity: Critical severity_number: 1 devices: - system-ip: 172.16.255.20 active: 'true' values: - system-ip: 172.16.255.20 host-name: vm10 acknowledged: 'false' cleared_by: '' suppressed: 'false' suppressed_by: '' rulename: rootca-sync-failure rule_name_display: ROOTCA_SYNC_FAILURE values_short_display: - host-name: vm10 system-ip: 172.16.255.20 cleared_time: 0 statcycletime: 1717671338582 tenant: default eventname: rootca-sync-failure receive_time: 1717671338582 system_ip: 172.16.255.20 host_name: vm10 site_id: '' update_time: 1717671338595 $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineResponseUuid' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Alarms-read