{ "openapi": "3.1.0", "info": { "title": "Monitoring and Troubleshooting", "description": "Includes API operations for the following:\n Real-time monitoring\n Accessing statistics APIs and statistics bulk APIs\n Retrieving device state\n Managing alarms and events", "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 - ART" }, { "name": "Monitoring - Alarms Details" }, { "name": "Monitoring - Alarms Notification" }, { "name": "Monitoring - App Hosting" }, { "name": "Monitoring - Application Aware Routing" }, { "name": "Monitoring - BFD" }, { "name": "Monitoring - BootUp Time" }, { "name": "Monitoring - Bridge" }, { "name": "Monitoring - Cedge Cflowd" }, { "name": "Monitoring - Cellular-EIOLTE" }, { "name": "Monitoring - Cflowd" }, { "name": "Monitoring - CloudExpress" }, { "name": "Monitoring - Crypto VPN" }, { "name": "Monitoring - DPI" }, { "name": "Monitoring - DPI - On-demand troubleshooting" }, { "name": "Monitoring - Device Configuration Security Advisories" }, { "name": "Monitoring - Device Details" }, { "name": "Monitoring - Device Health" }, { "name": "Monitoring - Device Statistics" }, { "name": "Monitoring - Device Statistics Details" }, { "name": "Monitoring - Device Statistics Details V2" }, { "name": "Monitoring - Endpoint Tracker Status" }, { "name": "Monitoring - Events" }, { "name": "Monitoring - Flowlog" }, { "name": "Monitoring - Health" }, { "name": "Monitoring - IPsAlert" }, { "name": "Monitoring - Interface Statistics" }, { "name": "Monitoring - Network Availability" }, { "name": "Monitoring - PPL" }, { "name": "Monitoring - Performance Monitor" }, { "name": "Monitoring - Power Consumption Statistics" }, { "name": "Monitoring - Qfp" }, { "name": "Monitoring - Qfp Drop Statistics" }, { "name": "Monitoring - QoS" }, { "name": "Monitoring - SDRA" }, { "name": "Monitoring - Search" }, { "name": "Monitoring - SecureX Integration" }, { "name": "Monitoring - Security Policy" }, { "name": "Monitoring - Security Unified Logging Connection Events" }, { "name": "Monitoring - Server Info" }, { "name": "Monitoring - SiteHealth Monitor" }, { "name": "Monitoring - Stats Download" }, { "name": "Monitoring - Stats Processing" }, { "name": "Monitoring - Status" }, { "name": "Monitoring - System Status Stats" }, { "name": "Monitoring - Temperature Statistics" }, { "name": "Monitoring - Tunnel Health" }, { "name": "Monitoring - URL Filtering" }, { "name": "Monitoring - Umbrella" }, { "name": "Monitoring - Umbrella Patterns" }, { "name": "Monitoring - Underlay Alarms" }, { "name": "Monitoring - VNF Interface Statistics" }, { "name": "Monitoring - Wlan Client Info" }, { "name": "Real-Time Monitoring - AAA" }, { "name": "Real-Time Monitoring - ARP" }, { "name": "Real-Time Monitoring - App Hosting" }, { "name": "Real-Time Monitoring - App Logs" }, { "name": "Real-Time Monitoring - Application-Aware Route" }, { "name": "Real-Time Monitoring - Appqoe" }, { "name": "Real-Time Monitoring - BFD" }, { "name": "Real-Time Monitoring - BGP" }, { "name": "Real-Time Monitoring - Bridge" }, { "name": "Real-Time Monitoring - CFM" }, { "name": "Real-Time Monitoring - Cellular" }, { "name": "Real-Time Monitoring - Cellular AON Ipsec Interface " }, { "name": "Real-Time Monitoring - Cellular EIOLTE Connection Service" }, { "name": "Real-Time Monitoring - Cellular EIOLTE Hardware Service " }, { "name": "Real-Time Monitoring - Cellular EIOLTE Network Service" }, { "name": "Real-Time Monitoring - Cellular EIOLTE Sim Service" }, { "name": "Real-Time Monitoring - CloudExpress" }, { "name": "Real-Time Monitoring - Commit List" }, { "name": "Real-Time Monitoring - Container Lifecycle" }, { "name": "Real-Time Monitoring - Crash Log" }, { "name": "Real-Time Monitoring - DHCP" }, { "name": "Real-Time Monitoring - DOT1x" }, { "name": "Real-Time Monitoring - DPI" }, { "name": "Real-Time Monitoring - DRE" }, { "name": "Real-Time Monitoring - Device" }, { "name": "Real-Time Monitoring - Device Control" }, { "name": "Real-Time Monitoring - Device Feature List" }, { "name": "Real-Time Monitoring - Device System Stats" }, { "name": "Real-Time Monitoring - Dns Defense" }, { "name": "Real-Time Monitoring - Dual Static Route Tracker Service" }, { "name": "Real-Time Monitoring - EIGRP" }, { "name": "Real-Time Monitoring - Endpoint Tracker Group Service" }, { "name": "Real-Time Monitoring - Endpoint Tracker Service" }, { "name": "Real-Time Monitoring - Geo-fencing" }, { "name": "Real-Time Monitoring - Hardware" }, { "name": "Real-Time Monitoring - IGMP" }, { "name": "Real-Time Monitoring - IP" }, { "name": "Real-Time Monitoring - IPsec" }, { "name": "Real-Time Monitoring - IPv4 FIB" }, { "name": "Real-Time Monitoring - IPv6 FIB" }, { "name": "Real-Time Monitoring - IPv6 Neighbours" }, { "name": "Real-Time Monitoring - Ignition Status" }, { "name": "Real-Time Monitoring - Insecure Device Configuration" }, { "name": "Real-Time Monitoring - Interface" }, { "name": "Real-Time Monitoring - Lacp" }, { "name": "Real-Time Monitoring - License Info" }, { "name": "Real-Time Monitoring - Multicast" }, { "name": "Real-Time Monitoring - NMS" }, { "name": "Real-Time Monitoring - NTP" }, { "name": "Real-Time Monitoring - NetworkHub Resources" }, { "name": "Real-Time Monitoring - OMP" }, { "name": "Real-Time Monitoring - OSPF" }, { "name": "Real-Time Monitoring - Orchestrator" }, { "name": "Real-Time Monitoring - PIM" }, { "name": "Real-Time Monitoring - PPPoE" }, { "name": "Real-Time Monitoring - Pki Trustpoint" }, { "name": "Real-Time Monitoring - Policer" }, { "name": "Real-Time Monitoring - Policy" }, { "name": "Real-Time Monitoring - Power Consumption" }, { "name": "Real-Time Monitoring - QFP" }, { "name": "Real-Time Monitoring - QoS" }, { "name": "Real-Time Monitoring - RBAC" }, { "name": "Real-Time Monitoring - Reboot History" }, { "name": "Real-Time Monitoring - SDWAN Statistics" }, { "name": "Real-Time Monitoring - SFP" }, { "name": "Real-Time Monitoring - SIG" }, { "name": "Real-Time Monitoring - SSE" }, { "name": "Real-Time Monitoring - Security" }, { "name": "Real-Time Monitoring - Show On Demand Local" }, { "name": "Real-Time Monitoring - Show On Demand Remote" }, { "name": "Real-Time Monitoring - Software" }, { "name": "Real-Time Monitoring - Sslproxy" }, { "name": "Real-Time Monitoring - Static Route Tracker Service" }, { "name": "Real-Time Monitoring - System" }, { "name": "Real-Time Monitoring - TCP Optimization" }, { "name": "Real-Time Monitoring - Tcpproxy" }, { "name": "Real-Time Monitoring - Tools" }, { "name": "Real-Time Monitoring - Transport" }, { "name": "Real-Time Monitoring - Trustsec" }, { "name": "Real-Time Monitoring - Tunnel" }, { "name": "Real-Time Monitoring - UTD" }, { "name": "Real-Time Monitoring - Ucse" }, { "name": "Real-Time Monitoring - Umbrella" }, { "name": "Real-Time Monitoring - VDSL Service" }, { "name": "Real-Time Monitoring - VM" }, { "name": "Real-Time Monitoring - VPN" }, { "name": "Real-Time Monitoring - VRRP" }, { "name": "Real-Time Monitoring - Voice" }, { "name": "Real-Time Monitoring - WLAN" }, { "name": "Real-Time Monitoring - Wireless" }, { "name": "Troubleshooting MRE - Workflow" }, { "name": "Troubleshooting Tools - Device Connectivity" }, { "name": "Troubleshooting Tools - Device Group" }, { "name": "Troubleshooting Tools - Diagnostics" }, { "name": "Troubleshooting Tools - Network Wide Path Insight" }, { "name": "Troubleshooting Tools - UMTS" } ], "paths": { "/accesstoken/{regionBaseUri}/{clientId}": { "get": { "tags": [ "Monitoring - SecureX Integration" ], "description": "Get Access Token for SecureX Ribbon", "operationId": "getSecureXAccessToken", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "regionBaseUri", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/advisories/insecure-config/devices": { "get": { "tags": [ "Monitoring - Device Configuration Security Advisories" ], "summary": "Get device advisories", "operationId": "getDeviceAdvisories", "responses": { "200": { "description": "Successful response with device advisories", "content": { "application/json": { "schema": { "required": [ "devices", "totalDevices" ], "type": "object", "properties": { "devices": { "type": "array", "description": "List of devices with insecure config", "items": { "required": [ "chassisNumber", "deviceModel", "deviceType", "hostName", "insecureConfigCount", "lastupdated", "localSystemIp", "managedBy", "reachability", "siteId", "siteName", "systemIp", "tags", "uuid", "version" ], "type": "object", "properties": { "chassisNumber": { "type": "string", "description": "Chassis number of the device", "example": "C8K-74b60256-ae6e-4718-b080-29660c203463" }, "deviceModel": { "type": "string", "description": "Device model", "example": "vedge-C8000V" }, "deviceType": { "type": "string", "description": "Device type", "example": "vedge" }, "hostName": { "type": "string", "description": "Hostname of the device", "example": "vm33" }, "insecureConfigCount": { "type": "integer", "description": "Insecure config count of the device", "format": "int32", "example": 2 }, "lastupdated": { "type": "integer", "description": "Last updated time of the device in epoch milliseconds", "format": "int64", "example": 1754276455939 }, "localSystemIp": { "type": "string", "description": "Local system ip of the device", "example": "172.16.255.15" }, "managedBy": { "type": "string", "description": "Managed by config group, template or policy etc", "example": "Config group cg1" }, "reachability": { "type": "string", "description": "Reachability of the device", "example": "reachable" }, "siteId": { "type": "string", "description": "Site id of the device", "example": "600" }, "siteName": { "type": "string", "description": "Site name of the device", "example": "SITE_600" }, "systemIp": { "type": "string", "description": "System ip of the device", "example": "172.16.255.15" }, "tags": { "type": "array", "description": "Tags associated with the device", "example": [ "east-china" ], "items": { "type": "string", "description": "associated tag", "example": "east-china" } }, "uuid": { "type": "string", "description": "Unique identifier of the device", "example": "74b60256-ae6e-4718-b080-29660c203465" }, "version": { "type": "string", "description": "Version of the device", "example": "17.18.02.0.2039" } }, "description": "List of devices with insecure config", "$$ref": "#/components/schemas/InsecureConfigDevice" } }, "totalDevices": { "type": "integer", "description": "Total devices with insecure config", "format": "int32", "example": 1 } }, "$$ref": "#/components/schemas/InsecureDeviceAdvisoroesResponse" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/advisories/insecure-config/devices/{deviceIP}": { "get": { "tags": [ "Monitoring - Device Configuration Security Advisories" ], "summary": "Get insecure configuration for a device", "operationId": "getDeviceInsecureConfig", "parameters": [ { "name": "deviceIP", "in": "path", "description": "Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "10.1.1.15" } } ], "responses": { "200": { "description": "Successful response with insecure configurations", "content": { "application/json": { "schema": { "required": [ "insecureCliConfigurations", "insecureConfigCount" ], "type": "object", "properties": { "insecureCliConfigurations": { "type": "array", "description": "Insecure cli configurations", "items": { "required": [ "description", "insecureCli", "reason", "remediation" ], "type": "object", "properties": { "description": { "type": "string", "description": "Description for insecure CLI", "example": "authentication protocol for the user" }, "insecureCli": { "type": "string", "description": "Insecure device CLI", "example": "snmp user {user} auth-protocol {auth-protocol}" }, "reason": { "type": "string", "description": "Reason for configuration CLI being marked insecure", "example": "SHA-256 provides a more secure hashing algorithm compared to MD5 or SHA-1" }, "remediation": { "type": "string", "description": "Remediation action for insecure configuration CLI", "example": "Use SHA-256 for stronger authentication" } }, "description": "Insecure cli configurations", "$$ref": "#/components/schemas/InsecureConfig" } }, "insecureConfigCount": { "type": "integer", "description": "The count of insecure configurations", "format": "int32", "example": 1 } }, "$$ref": "#/components/schemas/InsecureConfigResp" } } } }, "404": { "description": "Device not found" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/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" } }, "/data/device/state/{state_data_type}": { "get": { "tags": [ "Monitoring - Device Details" ], "description": "Get device state data", "operationId": "generateDeviceStateData", "parameters": [ { "name": "state_data_type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "startId", "in": "query", "schema": { "type": "string" } }, { "name": "count", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1000 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "@rid": { "type": "integer", "format": "int32", "example": 3413 }, "auto-downstream-bandwidth": { "type": "string", "example": "0" }, "auto-upstream-bandwidth": { "type": "string", "example": "0" }, "bia-address": { "type": "string", "example": "00:50:56:00:01:0e" }, "createTimeStamp": { "type": "string", "example": "1681732399130" }, "description": { "type": "string", "example": "Service Management VPN Interface Ethernet" }, "hwaddr": { "type": "string", "example": "00:50:56:00:01:0e" }, "if-admin-status": { "type": "string", "example": "if-state-up" }, "if-oper-status": { "type": "string", "example": "if-oper-state-ready" }, "ifindex": { "type": "string", "example": "1" }, "ifname": { "type": "string", "example": "GigabitEthernet1" }, "interface-type": { "type": "string", "example": "iana-iftype-ethernet-csmacd" }, "ip-address": { "type": "string", "example": "10.0.1.14" }, "ipv4-subnet-mask": { "type": "string", "example": "255.255.255.0" }, "ipv4-tcp-adjust-mss": { "type": "string", "example": "0" }, "ipv6-tcp-adjust-mss": { "type": "string", "example": "0" }, "lastupdated": { "type": "integer", "format": "int32", "example": 168232232 }, "mtu": { "type": "string", "example": "1500" }, "recordId": { "type": "string", "example": "0:CEdgeInterfaceNode:1681732387143:3340" }, "rx-drops": { "type": "integer", "format": "int32", "example": 0 }, "rx-errors": { "type": "integer", "format": "int32", "example": 1 }, "rx-octets": { "type": "integer", "format": "int32", "example": 22625972 }, "rx-packets": { "type": "string", "example": "367109" }, "speed-mbps": { "type": "string", "example": "1000" }, "tx-drops": { "type": "integer", "format": "int32", "example": 0 }, "tx-errors": { "type": "integer", "format": "int32", "example": 0 }, "tx-octets": { "type": "integer", "format": "int32", "example": 12993252 }, "tx-packets": { "type": "integer", "format": "int32", "example": 38282 }, "vdevice-dataKey": { "type": "string", "example": "172.16.255.14-512-GigabitEthernet1-10.0.1.14-00:50:56:00:01:0e" }, "vdevice-host-name": { "type": "string", "example": "vm4" }, "vdevice-name": { "type": "string", "example": "172.16.255.14" }, "vmanage-system-ip": { "type": "string", "example": "172.16.255.14" }, "vpn-id": { "type": "string", "example": "512" } }, "$$ref": "#/components/schemas/GenerateDeviceStateDataData" } } }, "$$ref": "#/components/schemas/GenerateDeviceStateData" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/data/device/state/{state_data_type}/fields": { "get": { "tags": [ "Monitoring - Device Details" ], "description": "Get device state data fileds", "operationId": "generateDeviceStateDataFields", "parameters": [ { "name": "state_data_type", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "object", "properties": { "dataType": { "type": "string" }, "display": { "type": "string" }, "property": { "type": "string" } }, "$$ref": "#/components/schemas/GenerateDeviceStateDataFieldsInner" }, "$$ref": "#/components/schemas/GenerateDeviceStateDataFields" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/data/device/state/{state_data_type}/query": { "get": { "tags": [ "Monitoring - Device Details" ], "description": "Get device state data fileds", "operationId": "generateDeviceStateDataWithQueryString", "parameters": [ { "name": "state_data_type", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "@rid": { "type": "integer", "format": "int32", "example": 3413 }, "auto-downstream-bandwidth": { "type": "string", "example": "0" }, "auto-upstream-bandwidth": { "type": "string", "example": "0" }, "bia-address": { "type": "string", "example": "00:50:56:00:01:0e" }, "createTimeStamp": { "type": "string", "example": "1681732399130" }, "description": { "type": "string", "example": "Service Management VPN Interface Ethernet" }, "hwaddr": { "type": "string", "example": "00:50:56:00:01:0e" }, "if-admin-status": { "type": "string", "example": "if-state-up" }, "if-oper-status": { "type": "string", "example": "if-oper-state-ready" }, "ifindex": { "type": "string", "example": "1" }, "ifname": { "type": "string", "example": "GigabitEthernet1" }, "interface-type": { "type": "string", "example": "iana-iftype-ethernet-csmacd" }, "ip-address": { "type": "string", "example": "10.0.1.14" }, "ipv4-subnet-mask": { "type": "string", "example": "255.255.255.0" }, "ipv4-tcp-adjust-mss": { "type": "string", "example": "0" }, "ipv6-tcp-adjust-mss": { "type": "string", "example": "0" }, "lastupdated": { "type": "integer", "format": "int32", "example": 168232232 }, "mtu": { "type": "string", "example": "1500" }, "recordId": { "type": "string", "example": "0:CEdgeInterfaceNode:1681732387143:3340" }, "rx-drops": { "type": "integer", "format": "int32", "example": 0 }, "rx-errors": { "type": "integer", "format": "int32", "example": 1 }, "rx-octets": { "type": "integer", "format": "int32", "example": 22625972 }, "rx-packets": { "type": "string", "example": "367109" }, "speed-mbps": { "type": "string", "example": "1000" }, "tx-drops": { "type": "integer", "format": "int32", "example": 0 }, "tx-errors": { "type": "integer", "format": "int32", "example": 0 }, "tx-octets": { "type": "integer", "format": "int32", "example": 12993252 }, "tx-packets": { "type": "integer", "format": "int32", "example": 38282 }, "vdevice-dataKey": { "type": "string", "example": "172.16.255.14-512-GigabitEthernet1-10.0.1.14-00:50:56:00:01:0e" }, "vdevice-host-name": { "type": "string", "example": "vm4" }, "vdevice-name": { "type": "string", "example": "172.16.255.14" }, "vmanage-system-ip": { "type": "string", "example": "172.16.255.14" }, "vpn-id": { "type": "string", "example": "512" } }, "$$ref": "#/components/schemas/GenerateDeviceStateDataData" } } }, "$$ref": "#/components/schemas/GenerateDeviceStateDataWithQueryString" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/data/device/statistics": { "get": { "tags": [ "Monitoring - Device Statistics Details" ], "description": "Get statistics types", "operationId": "getStatisticsType", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Status": { "description": "Status", "value": [ "interfacestatistics", "eioltestatistics", "sulstatistics", "qosstatistics", "devicesystemstatusstatistics", "bridgemacstatistics", "dpistatistics", "approutestatsstatistics", "wlanclientinfostatistics", "flowlogstatistics", "urlf", "fwall", "vnfstatistics", "umbrella", "apphostingstatistics", "utddaqioxstatistics", "ipsalert", "aggregatedappsdpistatistics", "bridgeinterfacestatistics", "artstatistics", "trackerstatistics", "cloudxstatistics", "deviceevents", "sleofflinereport", "alarm", "auditlog", "deviceconfiguration", "nwpi", "nwpiflowraw", "speedtest" ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/data/device/statistics/alarm/active": { "get": { "tags": [ "Monitoring - Device Statistics Details" ], "description": "Get active alarms", "operationId": "getActiveAlarms", "parameters": [ { "name": "scrollId", "in": "query", "description": "SrollId", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "description": "Start date (example:2023-10-31T14:30:00)", "schema": { "pattern": "^\\d{4}-(0?[1-9]|1[0-2])-(0?[1-9]|[12][0-9]|3[01])T\\d{2}:\\d{2}:\\d{2}$", "type": "string" } }, { "name": "endDate", "in": "query", "description": "End date (example:2023-10-31T14:30:00)", "schema": { "pattern": "^\\d{4}-(0?[1-9]|1[0-2])-(0?[1-9]|[12][0-9]|3[01])T\\d{2}:\\d{2}:\\d{2}$", "type": "string" } }, { "name": "count", "in": "query", "description": "count", "schema": { "type": "integer", "format": "int64" } }, { "name": "timeZone", "in": "query", "description": "Time zone", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Active alarms": { "description": "Active alarms", "value": [] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Alarms-read" } }, "/data/device/statistics/{state_data_type}": { "get": { "tags": [ "Monitoring - Device Statistics Details" ], "description": "Get device statistics data", "operationId": "generateDeviceStatisticsData", "parameters": [ { "name": "state_data_type", "in": "path", "description": "State data type", "required": true, "schema": { "type": "string" } }, { "name": "scrollId", "in": "query", "description": "Scroll Id", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "description": "Start date", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "description": "End date", "schema": { "type": "string" } }, { "name": "count", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "timeZone", "in": "query", "description": "Time zone", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Statistics data": { "description": "Statistics data", "value": [] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write,dca" } }, "/data/device/statistics/{state_data_type}/doccount": { "get": { "tags": [ "Monitoring - Device Statistics Details" ], "description": "Get response count of a query", "operationId": "getCountWithStateDataType", "parameters": [ { "name": "state_data_type", "in": "path", "description": "State data type(example:object)", "required": true, "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "startDate", "in": "query", "description": "Start date (example:2023-10-31T14:30:00)", "required": true, "schema": { "pattern": "^\\d{4}-(0?[1-9]|1[0-2])-(0?[1-9]|[12][0-9]|3[01])T\\d{2}:\\d{2}:\\d{2}$", "type": "string" } }, { "name": "endDate", "in": "query", "description": "End date (example:2023-10-31T14:30:00)", "required": true, "schema": { "pattern": "^\\d{4}-(0?[1-9]|1[0-2])-(0?[1-9]|[12][0-9]|3[01])T\\d{2}:\\d{2}:\\d{2}$", "type": "string" } }, { "name": "timeZone", "in": "query", "description": "Time zone (example:UTC)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Response count": { "description": "Response count", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/data/device/statistics/{state_data_type}/fields": { "get": { "tags": [ "Monitoring - Device Statistics Details" ], "description": "Get statistics fields and types", "operationId": "getStatDataFieldsByStateDataType", "parameters": [ { "name": "state_data_type", "in": "path", "description": "State data type", "required": true, "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Statistics field and type": { "description": "Statistics field and type", "value": [] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device": { "get": { "tags": [ "Monitoring - Device Details" ], "description": "List all devices", "operationId": "listAllDevices", "parameters": [ { "name": "site-id", "in": "query", "schema": { "pattern": "^[0-9]+$", "type": "string" } }, { "name": "includeTenantvSmart", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "board-serial": { "type": "string", "example": "12345704" }, "certificate-validity": { "type": "string", "example": "Valid" }, "connectedVManages": { "type": "array", "items": { "type": "string" } }, "controlConnections": { "type": "string", "example": "9" }, "device-groups": { "type": "array", "items": { "type": "string" } }, "device-model": { "type": "string", "example": "vmanage" }, "device-os": { "type": "string", "example": "device-os" }, "device-type": { "type": "string", "example": "vmanage" }, "deviceId": { "type": "string", "example": "169.254.10.1" }, "domain-id": { "type": "string", "example": "0" }, "host-name": { "type": "string", "example": "169.254.10.1" }, "isDeviceGeoData": { "type": "boolean", "example": false }, "lastupdated": { "type": "string", "example": "1634627015139" }, "latitude": { "type": "string", "example": "37.666684" }, "layoutLevel": { "type": "integer", "format": "int32", "example": 1 }, "local-system-ip": { "type": "string", "example": "172.16.255.200" }, "longitude": { "type": "string", "example": "-122.777023" }, "max-controllers": { "type": "string", "example": "0" }, "model_sku": { "type": "string", "example": "None" }, "personality": { "type": "string", "example": "vmanage" }, "platform": { "type": "string", "example": "x86_64" }, "reachability": { "type": "string", "example": "reachable" }, "site-id": { "type": "string", "example": "200" }, "state": { "type": "string", "example": "green" }, "state_description": { "type": "string", "example": "All daemons up" }, "status": { "type": "string", "example": "normal" }, "statusOrder": { "type": "string", "example": "4" }, "system-ip": { "type": "string", "example": "169.254.10.1" }, "testbed_mode": { "type": "boolean", "example": true }, "timezone": { "type": "string", "example": "UTC" }, "total_cpu_count": { "type": "string", "example": "8" }, "uptime-date": { "type": "string", "example": "1634626320000" }, "uuid": { "type": "string", "example": "96af574a-eadd-4b6a-97bf-d5c1e98f40f2" }, "validity": { "type": "string", "example": "valid" }, "version": { "type": "string", "example": "9" } }, "$$ref": "#/components/schemas/DeviceData" }, "examples": { "Devices List": { "description": "Devices List", "value": [ { "deviceId": "169.254.10.1", "system-ip": "169.254.10.1", "host-name": "vm200", "reachability": "reachable", "status": "normal", "personality": "vmanage", "device-type": "vmanage", "timezone": "UTC", "device-groups": [ "No groups" ], "lastupdated": 1634627015139, "domain-id": "0", "board-serial": "12345704", "certificate-validity": "Valid", "max-controllers": "0", "uuid": "96af574a-eadd-4b6a-97bf-d5c1e98f40f2", "controlConnections": "9", "device-model": "vmanage", "version": "20.8.999-1397", "connectedVManages": [ "169.254.10.1" ], "site-id": "200", "latitude": "37.666684", "longitude": -122.777023, "isDeviceGeoData": false, "platform": "x86_64", "uptime-date": 1634626320000, "statusOrder": 4, "device-os": "next", "validity": "valid", "state": "green", "state_description": "All daemons up", "model_sku": "None", "local-system-ip": "172.16.255.200", "total_cpu_count": "8", "testbed_mode": true, "layoutLevel": 1 } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/aaa/servers": { "get": { "tags": [ "Real-Time Monitoring - AAA" ], "description": "Get AAA servers from device (Real Time)", "operationId": "getAAAservers", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "AAA servers": { "description": "AAA servers", "value": { "data": [ { "authen-retried-access-requests": "0", "vdevice-name": "169.254.10.13", "author-errors-received": "0", "author-retried-access-requests": "0", "connection-failures": "0", "acct-messages-sent": "0", "acct-errors-received": "0", "author-timeout-access-requests": "0", "author-messages-sent": "0", "auth-port": "1812", "acct-port": "1813", "authen-access-accepts": "0", "author-access-accepts": "0", "connection-timeouts": "0", "author-access-rejects": "0", "authen-timeout-access-requests": "0", "authen-messages-received": "0", "stats-time": "2022-06-06T06:55:52+00:00", "authen-errors-received": "0", "author-messages-received": "0", "vdevice-host-name": "vm6", "vdevice-dataKey": "169.254.10.13-vm6-radius-0-10.10.10.10-1812-1813", "group-name": "radius-0", "authen-access-rejects": "0", "lastupdated": 1654498624166, "connection-aborts": "0", "radius-server-ip": "10.10.10.10", "authen-messages-sent": "0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write,System-read,System-write" } }, "/device/aaa/users": { "get": { "tags": [ "Real-Time Monitoring - AAA" ], "description": "Get AAA users from device (Real Time)", "operationId": "getAAAUsers", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "AAA users": { "description": "AAA users", "value": { "data": [ { "protocol": "aaa-sess-proto-type-none", "ip-addr": "0.0.0.0", "vdevice-dataKey": "169.254.10.13-admin-4157", "vdevice-name": "169.254.10.13", "login-time": "2022-06-06T08:54:01+00:00", "lastupdated": 1654505707413, "aaa-uid": "4157", "vdevice-host-name": "vm6", "username": "admin", "session-id": "4145" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write,System-read,System-write" } }, "/device/acl/matchcounter": { "get": { "tags": [ "Real-Time Monitoring - AAA" ], "description": "Get ACL match counters from device (Real Time)", "operationId": "getACLMatchCounterUsers", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "ACL match counters": { "description": "ACL match counters", "value": { "data": [ { "vdevice-dataKey": "10.0.0.121-CISCO-CWA-URL-REDIRECT-ACL-100", "vdevice-name": "10.0.0.121", "rule-name": "100", "access-control-list-name": "CISCO-CWA-URL-REDIRECT-ACL", "lastupdated": 1652169932765, "vdevice-host-name": "Router", "match-counter": "0" }, { "vdevice-dataKey": "10.0.0.121-CISCO-CWA-URL-REDIRECT-ACL-101", "vdevice-name": "10.0.0.121", "rule-name": "101", "access-control-list-name": "CISCO-CWA-URL-REDIRECT-ACL", "lastupdated": 1652169932765, "vdevice-host-name": "Router", "match-counter": "0" }, { "vdevice-dataKey": "10.0.0.121-CISCO-CWA-URL-REDIRECT-ACL-102", "vdevice-name": "10.0.0.121", "rule-name": "102", "access-control-list-name": "CISCO-CWA-URL-REDIRECT-ACL", "lastupdated": 1652169932765, "vdevice-host-name": "Router", "match-counter": "0" }, { "vdevice-dataKey": "10.0.0.121-CISCO-CWA-URL-REDIRECT-ACL-103", "vdevice-name": "10.0.0.121", "rule-name": "103", "access-control-list-name": "CISCO-CWA-URL-REDIRECT-ACL", "lastupdated": 1652169932765, "vdevice-host-name": "Router", "match-counter": "0" }, { "vdevice-dataKey": "10.0.0.121-CISCO-CWA-URL-REDIRECT-ACL-104", "vdevice-name": "10.0.0.121", "rule-name": "104", "access-control-list-name": "CISCO-CWA-URL-REDIRECT-ACL", "lastupdated": 1652169932765, "vdevice-host-name": "Router", "match-counter": "0" }, { "vdevice-dataKey": "10.0.0.121-CISCO-CWA-URL-REDIRECT-ACL-105", "vdevice-name": "10.0.0.121", "rule-name": "105", "access-control-list-name": "CISCO-CWA-URL-REDIRECT-ACL", "lastupdated": 1652169932765, "vdevice-host-name": "Router", "match-counter": "0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write,System-read,System-write" } }, "/device/app-hosting/attached-devices": { "get": { "tags": [ "Real-Time Monitoring - App Hosting" ], "description": "Get App hosting attached device from device", "operationId": "getAppHostingAttachedDevices", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "App hosting attached device": { "description": "App hosting attached device", "value": { "data": [ { "vdevice-dataKey": "172.16.255.15-utd-null", "attached-device-type": "Serial/Trace", "vdevice-name": "172.16.255.15", "lastupdated": 1659432314427, "vdevice-host-name": "vm5", "attached-device-alias": "serial3", "app-name": "utd" }, { "attached-device-name": "dp_1_0", "vdevice-dataKey": "172.16.255.15-utd-dp_1_0", "attached-device-type": "NIC", "vdevice-name": "172.16.255.15", "lastupdated": 1659432314427, "vdevice-host-name": "vm5", "attached-device-alias": "net2", "app-name": "utd" }, { "attached-device-name": "dp_1_1", "vdevice-dataKey": "172.16.255.15-utd-dp_1_1", "attached-device-type": "NIC", "vdevice-name": "172.16.255.15", "lastupdated": 1659432314427, "vdevice-host-name": "vm5", "attached-device-alias": "net3", "app-name": "utd" }, { "attached-device-name": "_rootfs", "vdevice-dataKey": "172.16.255.15-utd-_rootfs", "attached-device-type": "Disk", "vdevice-name": "172.16.255.15", "lastupdated": 1659432314427, "vdevice-host-name": "vm5", "app-name": "utd" }, { "attached-device-name": "ieobc_1", "vdevice-dataKey": "172.16.255.15-utd-ieobc_1", "attached-device-type": "NIC", "vdevice-name": "172.16.255.15", "lastupdated": 1659432314427, "vdevice-host-name": "vm5", "attached-device-alias": "ieobc", "app-name": "utd" }, { "attached-device-name": "/opt/var", "vdevice-dataKey": "172.16.255.15-utd-/opt/var", "attached-device-type": "Disk", "vdevice-name": "172.16.255.15", "lastupdated": 1659432314427, "vdevice-host-name": "vm5", "app-name": "utd" }, { "attached-device-name": "/tmp/HTX-IOX", "vdevice-dataKey": "172.16.255.15-utd-/tmp/HTX-IOX", "attached-device-type": "Disk", "vdevice-name": "172.16.255.15", "lastupdated": 1659432314427, "vdevice-host-name": "vm5", "app-name": "utd" }, { "attached-device-name": "/opt/var/core", "vdevice-dataKey": "172.16.255.15-utd-/opt/var/core", "attached-device-type": "Disk", "vdevice-name": "172.16.255.15", "lastupdated": 1659432314428, "vdevice-host-name": "vm5", "app-name": "utd" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/app-hosting/details": { "get": { "tags": [ "Real-Time Monitoring - App Hosting" ], "description": "Get App hosting details from device", "operationId": "getAppHostingDetails", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "App hosting details": { "description": "App hosting details", "value": { "data": [ { "application-name": "utd", "activated-profile-name": "cloud-low", "application-installed-version": "1.0.6_SV2.9.18.1_XE17.9", "vdevice-name": "172.16.255.15", "package-info-name": "UTD-Snort-Feature", "application-owner": "ioxm", "vdevice-host-name": "vm5", "resource-admission-cpu": "0", "resource-reservation-disk": "861", "package-info-path": "/bootflash/111.tar", "vdevice-dataKey": "172.16.255.15-utd", "resource-reservation-cpu": "0", "resource-reservation-memory": "2048", "name": "utd", "application-description": "Unified Threat Defense", "lastupdated": 1659432542156, "state": "RUNNING", "application-type": "LXC" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/app-hosting/guest-routes": { "get": { "tags": [ "Real-Time Monitoring - App Hosting" ], "description": "Get App hosting guest routes from device", "operationId": "getAppHostingGuestRoutes", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "App hosting guest routes": { "description": "App hosting guest routes", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "app-name": "utd", "vdevice-dataKey": "172.16.255.15-utd", "guest-route-route": "192.168.0.1", "lastupdated": "1660244459596" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/app-hosting/network-interfaces": { "get": { "tags": [ "Real-Time Monitoring - App Hosting" ], "description": "Get App hosting network interface from device", "operationId": "getAppHostingNetworkDevices", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "App hosting network interface": { "description": "App hosting network interface", "value": { "data": [ { "network-interface-ipv4-address": "0.0.0.0", "vdevice-dataKey": "172.16.255.15-utd-54:0e:00:0b:0c:02", "vdevice-name": "172.16.255.15", "network-interface-mac-address": "54:0e:00:0b:0c:02", "lastupdated": 1659432268936, "network-interface-attached-interface": "eth0", "vdevice-host-name": "vm5", "app-name": "utd" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/app-hosting/network-utilization": { "get": { "tags": [ "Real-Time Monitoring - App Hosting" ], "description": "Get App hosting network utilization from device", "operationId": "getAppHostingNetworkUtils", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "App hosting network utilization": { "description": "App hosting network utilization", "value": { "data": [ { "network-util-alias": "net2", "network-util-rx-bytes": "0", "vdevice-name": "172.16.255.15", "network-util-name": "dp_1_0", "network-util-tx-errors": "0", "vdevice-host-name": "vm5", "app-name": "utd", "network-util-rx-packets": "0", "vdevice-dataKey": "172.16.255.15-utd-dp_1_0", "network-util-tx-packets": "0", "lastupdated": 1659432057682, "network-util-tx-bytes": "0", "network-util-rx-errors": "0" }, { "network-util-alias": "net3", "network-util-rx-bytes": "0", "vdevice-name": "172.16.255.15", "network-util-name": "dp_1_1", "network-util-tx-errors": "0", "vdevice-host-name": "vm5", "app-name": "utd", "network-util-rx-packets": "0", "vdevice-dataKey": "172.16.255.15-utd-dp_1_1", "network-util-tx-packets": "0", "lastupdated": 1659432057683, "network-util-tx-bytes": "0", "network-util-rx-errors": "0" }, { "network-util-alias": "ieobc", "network-util-rx-bytes": "11138", "vdevice-name": "172.16.255.15", "network-util-name": "ieobc_1", "network-util-tx-errors": "0", "vdevice-host-name": "vm5", "app-name": "utd", "network-util-rx-packets": "189", "vdevice-dataKey": "172.16.255.15-utd-ieobc_1", "network-util-tx-packets": "189", "lastupdated": 1659432057683, "network-util-tx-bytes": "12243", "network-util-rx-errors": "0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/app-hosting/processes": { "get": { "tags": [ "Real-Time Monitoring - App Hosting" ], "description": "Get App hosting processes from device", "operationId": "getAppHostingProcesses", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "App hosting processes utilization": { "description": "App hosting processes utilization", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "app-name": "utd", "process-name": "process01", "process-status": "Running", "process-pid": "10", "process-uptime": "3600", "process-memory": "2048", "lastupdated": 1660244459596, "vdevice-dataKey": "172.16.255.15-utd" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/app-hosting/storage-utilization": { "get": { "tags": [ "Real-Time Monitoring - App Hosting" ], "description": "Get App hosting storage utilization from device", "operationId": "getAppHostingStorageUtils", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "App hosting storage utilization": { "description": "App hosting storage utilization", "value": { "data": [ { "storage-util-name": "disk", "storage-util-rd-bytes": "0", "storage-util-wr-requests": "0", "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "app-name": "utd", "storage-util-capacity": "881664", "storage-util-errors": "0", "vdevice-dataKey": "172.16.255.15-utd-disk", "storage-util-available": "35990", "lastupdated": 1659432204521, "storage-util-wr-bytes": "0", "storage-util-rd-requests": "0", "storage-util-used": "845674" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/app-hosting/utilization": { "get": { "tags": [ "Real-Time Monitoring - App Hosting" ], "description": "Get App hosting utilization from device", "operationId": "getAppHostingUtilization", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "App hosting utilization": { "description": "App hosting utilization", "value": { "data": [ { "utilization-name": "utd", "memory-allocation": "0", "vdevice-dataKey": "172.16.255.15-utd", "actual-application-util": "0", "vdevice-name": "172.16.255.15", "requested-application-util": "0", "name": "utd", "lastupdated": 1659353382195, "vdevice-host-name": "vm5" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/app-route/sla-class": { "get": { "tags": [ "Real-Time Monitoring - Application-Aware Route" ], "description": "Get SLA class list from device (Real Time)", "operationId": "createAppRouteSlaClassList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "SLA class": { "description": "SLA class", "value": { "data": [ { "app-probe-class": "None", "loss": 0, "fallback-best-tunnel": "None", "jitter": 0, "vdevice-dataKey": "169.254.10.10-0", "vdevice-name": "169.254.10.10", "latency": 0, "name": "__all_tunnels__", "index": 0, "lastupdated": 1642576726463, "vdevice-host-name": "vm3" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write" } }, "/device/app-route/statistics": { "get": { "tags": [ "Real-Time Monitoring - Application-Aware Route" ], "description": "Get application-aware routing statistics from device (Real Time)", "operationId": "createAppRouteStatisticsList", "parameters": [ { "name": "remote-system-ip", "in": "query", "description": "Remote system IP", "schema": { "type": "string" } }, { "name": "local-color", "in": "query", "description": "Local color", "schema": { "type": "string", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] } }, { "name": "remote-color", "in": "query", "description": "Remote color", "schema": { "type": "string", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Application-aware routing statistics": { "description": "Application-aware routing statistics", "value": { "data": [ { "src-ip": "10.101.3.3", "dst-ip": "10.101.2.2", "tx-data-pkts": "0", "vdevice-name": "169.254.10.10", "src-port": 12346, "dst-port": "12426", "remote-color": "default", "remote-system-ip": "172.16.254.1", "fallback-sla-class-index": "None", "mean-latency": 0, "total-packets": "600", "loss": "0", "mean-jitter": 0, "average-latency": "0", "index": "3", "sla-class-index": "0", "vdevice-host-name": "vm3", "local-color": "default", "app-probe-class": "None", "mean-loss": 0, "vdevice-dataKey": "169.254.10.10-3", "proto": "ipsec", "lastupdated": 1642577794383, "average-jitter": "0", "rx-data-pkts": "0" }, { "src-ip": "10.101.3.3", "dst-ip": "10.101.2.2", "tx-data-pkts": "0", "vdevice-name": "169.254.10.10", "src-port": 12346, "dst-port": "12426", "remote-color": "default", "remote-system-ip": "172.16.254.1", "fallback-sla-class-index": "None", "mean-latency": 0, "total-packets": "600", "loss": "0", "mean-jitter": 0, "average-latency": "0", "index": "4", "sla-class-index": "0", "vdevice-host-name": "vm3", "local-color": "default", "app-probe-class": "None", "mean-loss": 0, "vdevice-dataKey": "169.254.10.10-4", "proto": "ipsec", "lastupdated": 1642577794385, "average-jitter": "0", "rx-data-pkts": "0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write" } }, "/device/app/log/flow-count": { "get": { "tags": [ "Real-Time Monitoring - App Logs" ], "description": "Get App log flows count from device (Real Time)", "operationId": "getAppLogFlowCount", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "App log flows count": { "description": "App log flows count", "value": { "data": [ { "vdevice-name": "172.16.254.1", "vdevice-host-name": "vm2", "vpn-id": "1", "count": "20", "vdevice-dataKey": "172.16.254.1", "lastupdated": 1654066320000 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/app/log/flows": { "get": { "tags": [ "Real-Time Monitoring - App Logs" ], "description": "Get App log flows from device (Real Time)", "operationId": "getAppLogFlows", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "App log flows": { "description": "App log flows", "value": { "data": [ { "vdevice-name": "172.16.254.2", "vdevice-host-name": "vm2", "vpn-id": "0", "src-ip": "10.0.5.19", "dest-ip": "10.1.15.15", "src-port": "23556", "dest-port": "34576", "dscp": "0", "ip-proto": "6", "tcp-cntrl-bits": "16", "icmp-opcode": "0", "nhop-ip": "10.1.15.15", "total-pkts": "8531", "total-bytes": "1200071", "start-time": "Fri July 15 10:32:52 2022", "time-to-expire": "59", "egress-intf-name": "cpu", "ingress-intf-name": "ge0/0", "policy-name": "123NenokaKantri", "policy-action": "accept", "policy-direction": "inbound-acl", "lastupdated": 1657853484627, "vdevice-dataKey": "172.16.254.2" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/appqoe/active-flow-id": { "get": { "tags": [ "Real-Time Monitoring - Appqoe" ], "description": "Get Appqoe Active flow Id details from device", "operationId": "createAppqoeActiveFlowIdDetails", "parameters": [ { "name": "flow-id", "in": "query", "description": "Flow Id", "required": true, "schema": { "type": "string" } }, { "name": "deviceId", "in": "query", "description": "Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Appqoe Flow Active FlowId details": { "description": "Appqoe Flow Active FlowId details", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write" } }, "/device/appqoe/appqoe-hput-stats": { "get": { "tags": [ "Real-Time Monitoring - Appqoe" ], "description": "Get Appqoe Hput Statistics from device", "operationId": "getAppqoeHputStats", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device Id", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Appqoe Hput Statistics": { "description": "Appqoe Hput Statistics", "value": { "data": [ { "hs-sch-delay20us": "2569563", "hs-time-node-dealloc": "10730115", "uhs-callout-drain": "0", "uhs-stop-cancel": "0", "hs-exp-list-process": "237791", "hs-curr-node-null": "0", "hs-sch-delay200us": "4110", "hs-sch-delay10000us": "6741", "uhs-callout-unlock": "0", "uhs-add": "1624643", "uhs-rst-sbt-drain": "0", "hs-timer-deleted": "0", "hs-sch-delay300us": "1809", "uhs-stop-del-cancel": "0", "hs-sch-delay400us": "1541", "uhs-add-fail": "0", "hs-sch-delay1000000us": "0", "hs-sch-delay1000us": "1069", "uhs-stop-no-pending": "4", "hs-timer-del-failed": "0", "hs-expired-send-sig": "224059", "uhs-stop-nodrain": "0", "hs-sch-delay500us": "1444", "hs-sch-delay30us": "198079", "hs-timer-alloc": "10730124", "hs-time-node-added": "10713486", "uhs-stop": "4", "uhs-callout-lock": "0", "uhs-raw-add": "9105481", "hs-ktimer-start": "17812503", "hs-sch-delay600us": "1463", "hs-ktimer-cb": "10475629", "uhs-rst-sbt-del": "0", "hs-expired-list-alloc": "237791", "hs-sch-delay700us": "1417", "hs-timer-cb": "10730115", "uhs-callout": "1624635", "uhs-raw-cb": "9105480", "hs-timer-add-req": "10730124", "vdevice-name": "169.254.10.12", "uhs-rst-sbt-req": "1624643", "hs-sch-delay40us": "27818", "hs-timer-dealloc": "10730115", "uhs-callout-done": "1624635", "hs-time-node-deleted": "10713477", "hs-sch-delay100000us": "2", "uhs-callout-not-pending": "0", "uhs-raw-add-failed": "0", "hs-timer-del-req": "0", "hs-pending-list-process": "224059", "uhs-rst-sbt-add": "1624643", "uhs-callout-cancel": "0", "hs-sch-delay800us": "1334", "hs-sch-delay10us": "7627736", "hs-expired-list-dealloc": "237791", "hs-min-sch-delay": "4330", "uhs-callout-call": "1624635", "uhs-callout-del": "0", "uhs-rst-sbt-cancel": "0", "vdevice-host-name": "vm5", "hs-sch-delay900us": "1186", "hs-time-node-alloc": "10730124", "hs-time-node-exist": "0", "hs-sch-delay50us": "13812", "uhs-stop-drain": "0", "uhs-stop-del": "0", "hs-time-node-expired": "1642", "vdevice-dataKey": "169.254.10.12", "hs-curr-node-ts-not-valid": "0", "hs-timer-added": "10493918", "hs-sch-delay100us": "16505", "uihs-nr-hpts-cpu": "0", "hs-timer-add-expired": "236206", "hs-max-sch-delay": "36715506", "lastupdated": 1644996827424, "hs-ktimer-stop": "17812503" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/appqoe/appqoe-nat-stats": { "get": { "tags": [ "Real-Time Monitoring - Appqoe" ], "description": "Get Appqoe Nat Statistics from device", "operationId": "getAppqoeNatStats", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device Id", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Appqoe Nat Statistics": { "description": "Appqoe Nat Statistics", "value": { "data": [ { "port-alloc-fail": "0", "port-free-succ": "0", "port-free-fail": "0", "vdevice-dataKey": "169.254.10.12", "vdevice-name": "169.254.10.12", "alloc-fail": "0", "lastupdated": 1644997117219, "dup-entries": "0", "vdevice-host-name": "vm5", "port-alloc-succ": "0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/appqoe/appqoe-rm-resource": { "get": { "tags": [ "Real-Time Monitoring - Appqoe" ], "description": "Get Appqoe Resource Manager resources from device", "operationId": "getAppqoeRmResources", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device Id", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Appqoe Resource Manager resources": { "description": "Appqoe Resource Manager resources", "value": { "data": [ { "ssl-max-sess": "40000", "avail-sys-mem": "2411556", "dre-mem-per-sess": "0", "ssl-used-sess": "0", "vdevice-name": "169.254.10.12", "rm-global-health-flag": "status-green", "rm-tcp-sess-flag": "status-green", "dre-used-sess": "0", "tcp-max-sess": "40000", "http-mem-per-sess": "0", "vdevice-host-name": "vm5", "rm-svc-mem-flag": "status-green", "vdevice-dataKey": "169.254.10.12", "per-used-serv-mem": "0", "used-serv-mem": "0", "http-max-sess": "0", "tcp-used-sess": "0", "ssl-mem-per-sess": "50", "tcp-mem-per-sess": "64", "lastupdated": 1644997246553, "http-used-sess": "0", "max-serv-mem": "1205778", "dre-max-sess": "0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/appqoe/appqoe-rm-stats": { "get": { "tags": [ "Real-Time Monitoring - Appqoe" ], "description": "Get Appqoe RM Statistics from device", "operationId": "getAppqoeRMStats", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device Id", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Appqoe RM Statistics": { "description": "Appqoe RM Statistics", "value": { "data": [ { "port-alloc-fail": "0", "port-free-succ": "0", "port-free-fail": "0", "vdevice-dataKey": "169.254.10.12", "vdevice-name": "169.254.10.12", "alloc-fail": "0", "lastupdated": 1644997491529, "dup-entries": "0", "vdevice-host-name": "vm5", "port-alloc-succ": "0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/appqoe/appqoe-services-status": { "get": { "tags": [ "Real-Time Monitoring - Appqoe" ], "description": "Get Appqoe Services Status from device", "operationId": "getAppqoeServicesStatus", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device Id", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Appqoe Services Status": { "description": "Appqoe Services Status", "value": { "data": [ { "vdevice-dataKey": "169.254.10.12", "load-status": "appqoe-service-status-green", "vdevice-name": "169.254.10.12", "service": "appqoe-service-tcpopt", "load-percentage": "0", "lastupdated": 1644998907908, "vdevice-host-name": "vm5" }, { "vdevice-dataKey": "169.254.10.12", "load-status": "appqoe-service-status-green", "vdevice-name": "169.254.10.12", "service": "appqoe-service-ssl", "load-percentage": "0", "lastupdated": 1644998907908, "vdevice-host-name": "vm5" }, { "vdevice-dataKey": "169.254.10.12", "load-status": "appqoe-service-status-red", "vdevice-name": "169.254.10.12", "service": "appqoe-service-dreopt", "lastupdated": 1644998907908, "vdevice-host-name": "vm5" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/appqoe/appqoe-sppi-pipe-resource": { "get": { "tags": [ "Real-Time Monitoring - Appqoe" ], "description": "Get Appqoe Sppi Pipe Stats from device", "operationId": "getAppqoeSppiPipeStats", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device Id", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Appqoe Sppi Pipe Statistics": { "description": "Appqoe Sppi Pipe Statistics", "value": { "data": [ { "p-invalid-mtu": "0", "p-disconnect": "0", "p-in-use": "0", "p-invalid-queue-id": "0", "vdevice-dataKey": "169.254.10.12", "vdevice-name": "169.254.10.12", "channel-num": "0", "lastupdated": 1644997573992, "p-ifindex-error": "0", "vdevice-host-name": "vm5", "p-sock-error": "0" }, { "p-invalid-mtu": "0", "p-disconnect": "0", "p-in-use": "0", "p-invalid-queue-id": "0", "vdevice-dataKey": "169.254.10.12", "vdevice-name": "169.254.10.12", "channel-num": "1", "lastupdated": 1644997573993, "p-ifindex-error": "0", "vdevice-host-name": "vm5", "p-sock-error": "0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/appqoe/appqoe-sppi-queue-resource": { "get": { "tags": [ "Real-Time Monitoring - Appqoe" ], "description": "Get Appqoe Sppi Queue Stats from device", "operationId": "getAppqoeSppiQueueStats", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device Id", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Appqoe Sppi Queue Statistics": { "description": "Appqoe Sppi Queue Statistics", "value": { "data": [ { "pkt-send-failed": "0", "vdevice-name": "169.254.10.12", "poll-error": "0", "tpkt-version-error": "0", "mmap-error": "0", "truncated": "0", "no-pkt-buf": "0", "pkt-available": "0", "invalid-ring": "0", "vdevice-host-name": "vm5", "in-use": "0", "no-dev": "0", "pkt-read-failed": "0", "invalid-mode": "0", "vdevice-dataKey": "169.254.10.12", "nomem": "0", "no-iov-buf": "0", "not-init": "0", "sock-error": "0", "pkt": "8", "channel-num": "0", "lastupdated": 1644998764198, "invalid-size": "0", "pkt-losing": "0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/appqoe/cluster-summary": { "get": { "tags": [ "Real-Time Monitoring - Appqoe" ], "description": "Get Appqoe Cluster Summary from device", "operationId": "getAppqoeClusterSummary", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device Id", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Appqoe Cluster Summary": { "description": "Appqoe Cluster Summary", "value": { "data": [ { "load-status": "appqoe-service-status-green", "vdevice-name": "169.254.10.12", "load-percentage": "0", "system-ip": "172.16.254.4", "sng-name": "SNG-APPQOE", "site-id": "5", "vdevice-host-name": "vm5", "lan-ip": "192.168.2.2", "vdevice-dataKey": "169.254.10.12-192.168.2.2", "error-message": "-", "service": "appqoe-service-tcpopt", "lastupdated": 1644995623537, "device-mode": "device-mode-integrated-service-node", "status": "sn-status-green" }, { "load-status": "appqoe-service-status-green", "vdevice-name": "169.254.10.12", "load-percentage": "0", "system-ip": "172.16.254.4", "sng-name": "SNG-APPQOE", "site-id": "5", "vdevice-host-name": "vm5", "lan-ip": "192.168.2.2", "vdevice-dataKey": "169.254.10.12-192.168.2.2", "error-message": "-", "service": "appqoe-service-ssl", "lastupdated": 1644995623537, "device-mode": "device-mode-integrated-service-node", "status": "sn-status-green" }, { "load-status": "appqoe-service-status-red", "vdevice-name": "169.254.10.12", "system-ip": "172.16.254.4", "sng-name": "SNG-APPQOE", "site-id": "5", "vdevice-host-name": "vm5", "lan-ip": "192.168.2.2", "vdevice-dataKey": "169.254.10.12-192.168.2.2", "error-message": "-", "service": "appqoe-service-dreopt", "lastupdated": 1644995623537, "device-mode": "device-mode-integrated-service-node", "status": "sn-status-green" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/appqoe/error-recent": { "get": { "tags": [ "Real-Time Monitoring - Appqoe" ], "description": "Get Appqoe error recent from device", "operationId": "getAppqoeErrorRecent", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device Id", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Appqoe Error Recent": { "description": "Appqoe Error Recent", "value": { "data": [ { "vdevice-dataKey": "169.254.10.12", "vdevice-name": "169.254.10.12", "stat-current": "0", "stat-60s": "0", "lastupdated": 1644995930359, "stat-30s": "0", "label": "appqoe-stat-rm-res-tcp-used-sess", "vdevice-host-name": "vm5" }, { "vdevice-dataKey": "169.254.10.12", "vdevice-name": "169.254.10.12", "stat-current": "0", "stat-60s": "0", "lastupdated": 1644995930359, "stat-30s": "0", "label": "appqoe-stat-rm-res-ssl-used-sess", "vdevice-host-name": "vm5" }, { "vdevice-dataKey": "169.254.10.12", "vdevice-name": "169.254.10.12", "stat-current": "0", "stat-60s": "0", "lastupdated": 1644995930359, "stat-30s": "0", "label": "appqoe-stat-rm-health-yellow", "vdevice-host-name": "vm5" }, { "vdevice-dataKey": "169.254.10.12", "vdevice-name": "169.254.10.12", "stat-current": "0", "stat-60s": "0", "lastupdated": 1644995930359, "stat-30s": "0", "label": "appqoe-stat-rm-health-green", "vdevice-host-name": "vm5" }, { "vdevice-dataKey": "169.254.10.12", "vdevice-name": "169.254.10.12", "stat-current": "0", "stat-60s": "0", "lastupdated": 1644995930359, "stat-30s": "0", "label": "appqoe-stat-rm-tcp-sess-alloc", "vdevice-host-name": "vm5" }, { "vdevice-dataKey": "169.254.10.12", "vdevice-name": "169.254.10.12", "stat-current": "0", "stat-60s": "0", "lastupdated": 1644995930359, "stat-30s": "0", "label": "appqoe-stat-rm-tcp-sess-free", "vdevice-host-name": "vm5" }, { "vdevice-dataKey": "169.254.10.12", "vdevice-name": "169.254.10.12", "stat-current": "0", "stat-60s": "0", "lastupdated": 1644995930359, "stat-30s": "0", "label": "appqoe-stat-rm-ssl-sess-alloc", "vdevice-host-name": "vm5" }, { "vdevice-dataKey": "169.254.10.12", "vdevice-name": "169.254.10.12", "stat-current": "0", "stat-60s": "0", "lastupdated": 1644995930359, "stat-30s": "0", "label": "appqoe-stat-rm-ssl-sess-free", "vdevice-host-name": "vm5" }, { "vdevice-dataKey": "169.254.10.12", "vdevice-name": "169.254.10.12", "stat-current": "0", "stat-60s": "0", "lastupdated": 1644995930359, "stat-30s": "0", "label": "appqoe-stat-tcp-tot-conn", "vdevice-host-name": "vm5" }, { "vdevice-dataKey": "169.254.10.12", "vdevice-name": "169.254.10.12", "stat-current": "0", "stat-60s": "0", "lastupdated": 1644995930359, "stat-30s": "0", "label": "appqoe-stat-tcp-tot-flow-create", "vdevice-host-name": "vm5" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/appqoe/expired-flow-id": { "get": { "tags": [ "Real-Time Monitoring - Appqoe" ], "description": "Get Appqoe Expired flow Id details from device", "operationId": "createAppqoeFlowIdExpiredDetails", "parameters": [ { "name": "flow-id", "in": "query", "description": "Flow Id", "required": true, "schema": { "type": "string" } }, { "name": "deviceId", "in": "query", "description": "Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Appqoe Expired flow Id details": { "description": "Appqoe Expired flow Id details", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write" } }, "/device/appqoe/flow-closed-error": { "get": { "tags": [ "Real-Time Monitoring - Appqoe" ], "description": "Get Appqoe flow closed error from device", "operationId": "getAppqoeFlowClosedError", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device Id", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Appqoe Flow Closed Error": { "description": "Appqoe Flow Closed Error", "value": { "data": [ { "vdevice-name": "172.16.255.11", "vdevice-host-name": "vm1", "flow-id": "0", "vpn-id": "1", "client-ip": "1.1.1.1", "client-port": "80", "remote-server-ip": "2.2.2.2", "remote-server-port": "8080", "service": "appqoe-service-ssl", "tcpproxy-err-tag": "tag1", "sslproxy-err-tag": "tag2", "lastupdated": 1655736428995 }, { "vdevice-name": "172.16.255.11", "vdevice-host-name": "vm1", "flow-id": "0", "vpn-id": "1", "client-ip": "1.1.1.1", "client-port": "80", "remote-server-ip": "2.2.2.3", "remote-server-port": "8080", "service": "appqoe-service-ssl", "tcpproxy-err-tag": "tag1", "sslproxy-err-tag": "tag2", "lastupdated": 1655736428995 }, { "vdevice-name": "172.16.255.11", "vdevice-host-name": "vm1", "flow-id": "0", "vpn-id": "1", "client-ip": "1.1.1.1", "client-port": "80", "remote-server-ip": "2.2.2.4", "remote-server-port": "8080", "service": "appqoe-service-ssl", "tcpproxy-err-tag": "tag1", "sslproxy-err-tag": "tag2", "lastupdated": 1655736428995 }, { "vdevice-name": "172.16.255.11", "vdevice-host-name": "vm1", "flow-id": "0", "vpn-id": "1", "client-ip": "1.1.1.1", "client-port": "80", "remote-server-ip": "2.2.2.5", "remote-server-port": "8080", "service": "appqoe-service-ssl", "tcpproxy-err-tag": "tag1", "sslproxy-err-tag": "tag2", "lastupdated": 1655736428995 }, { "vdevice-name": "172.16.255.11", "vdevice-host-name": "vm1", "flow-id": "0", "vpn-id": "1", "client-ip": "1.1.1.1", "client-port": "80", "remote-server-ip": "2.2.2.6", "remote-server-port": "8080", "service": "appqoe-service-ssl", "tcpproxy-err-tag": "tag1", "sslproxy-err-tag": "tag2", "lastupdated": 1655736428995 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/appqoe/flow-expired": { "get": { "tags": [ "Real-Time Monitoring - Appqoe" ], "description": "Get Appqoe expired from device", "operationId": "getAppqoeExpired", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Appqoe Flow Expired List": { "description": "Appqoe Flow Expired List", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write" } }, "/device/appqoe/service-controllers": { "get": { "tags": [ "Real-Time Monitoring - Appqoe" ], "description": "Get Appqoe service controllers from device", "operationId": "getAppqoeServiceControllers", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device Id", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Appqoe Service Controllers": { "description": "Appqoe Service Controllers", "value": { "data": [ { "sn-lan-ip": "192.168.2.2", "vdevice-dataKey": "169.254.10.12-192.168.2.1", "vdevice-name": "169.254.10.12", "sc-lan-ip": "192.168.2.1", "system-ip": "172.16.254.4", "lastupdated": 1644996521181, "site-id": "5", "vdevice-host-name": "vm5" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/appqoe/status": { "get": { "tags": [ "Real-Time Monitoring - Appqoe" ], "description": "Get Appqoe status from device", "operationId": "getAppqoeStatus", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device Id", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Appqoe Status": { "description": "Appqoe Status", "value": { "data": [ { "vdevice-dataKey": "169.254.10.12", "vdevice-name": "169.254.10.12", "module": "appqoe-module-sslproxy", "err-tag": "appqoe-err-ca-tp-cfg", "appqoe-status": "appqoe-status-yellow", "lastupdated": 1644996370984, "vdevice-host-name": "vm5", "status": "appqoe-status-yellow" }, { "vdevice-dataKey": "169.254.10.12", "vdevice-name": "169.254.10.12", "module": "appqoe-module-tcpproxy", "err-tag": "appqoe-err-undef", "appqoe-status": "appqoe-status-yellow", "lastupdated": 1644996370984, "vdevice-host-name": "vm5", "status": "appqoe-status-green" }, { "vdevice-dataKey": "169.254.10.12", "vdevice-name": "169.254.10.12", "module": "appqoe-module-sc", "err-tag": "appqoe-err-undef", "appqoe-status": "appqoe-status-yellow", "lastupdated": 1644996370984, "vdevice-host-name": "vm5", "status": "appqoe-status-green" }, { "vdevice-dataKey": "169.254.10.12", "vdevice-name": "169.254.10.12", "module": "appqoe-module-rm", "err-tag": "appqoe-err-undef", "appqoe-status": "appqoe-status-yellow", "lastupdated": 1644996370984, "vdevice-host-name": "vm5", "status": "appqoe-status-green" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/appqoe/vpn-id": { "get": { "tags": [ "Real-Time Monitoring - Appqoe" ], "description": "Get Appqoe Active vpn Id details from device", "operationId": "createAppqoeVpnIdList", "parameters": [ { "name": "vpn-id", "in": "query", "description": "VPN Id", "required": true, "schema": { "type": "string" } }, { "name": "client-ip", "in": "query", "description": "Client Ip", "schema": { "type": "string" } }, { "name": "server-ip", "in": "query", "description": "Server Ip", "schema": { "type": "string" } }, { "name": "server-port", "in": "query", "description": "Server-Port", "schema": { "type": "string" } }, { "name": "deviceId", "in": "query", "description": "Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Appqoe Flow Active VpnId List": { "description": "Appqoe Flow Active VpnId List", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write" } }, "/device/arp": { "get": { "tags": [ "Real-Time Monitoring - ARP" ], "description": "Get ARP interfaces from device (Real Time)", "operationId": "getARPInterface", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "ARP interface": { "description": "ARP interface", "value": { "data": [ { "if-name": "ge0/1", "idle-timer": "0:00:10:36", "vdevice-dataKey": "169.254.10.10-0-ge0/1", "vdevice-name": "169.254.10.10", "ip": "10.101.254.254", "lastupdated": 1642578468257, "state": "dynamic", "vpn-id": "0", "uptime-date": 1642160280000, "vdevice-host-name": "vm3", "mac": "52:54:00:7a:da:f8", "uptime": "4:20:09:23" }, { "if-name": "eth0", "vdevice-dataKey": "169.254.10.10-512-eth0", "vdevice-name": "169.254.10.10", "ip": "10.0.1.3", "lastupdated": 1642578468257, "state": "static", "vpn-id": "512", "uptime-date": 1642154760000, "vdevice-host-name": "vm3", "mac": "00:50:56:00:01:03", "uptime": "4:21:41:16" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Interface-read,Interface-write" } }, "/device/bfd/history": { "get": { "tags": [ "Real-Time Monitoring - BFD" ], "description": "Get BFD session history from device (Real Time)", "operationId": "createBFDHistoryList", "parameters": [ { "name": "system-ip", "in": "query", "description": "System IP", "schema": { "type": "string" } }, { "name": "color", "in": "query", "description": "Remote color", "schema": { "type": "string", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "BFD session history": { "description": "BFD session history", "value": { "data": [ { "dst-ip": "10.101.2.2", "src-ip": "10.101.3.3", "color": "default", "tx-pkts": 3856, "vdevice-name": "169.254.10.10", "src-port": 12366, "time-date": 1642187218000, "system-ip": "172.16.254.1", "index": 8, "dst-port": 12386, "del": 0, "site-id": 2, "vdevice-host-name": "vm3", "vdevice-dataKey": "169.254.10.10-8-2022-01-14T19:06:58+0000", "proto": "ipsec", "lastupdated": 1642581869106, "time": "2022-01-14T19:06:58+0000", "state": "down", "rx-pkts": 3855 }, { "dst-ip": "10.101.2.2", "src-ip": "10.101.3.3", "color": "default", "tx-pkts": 6, "vdevice-name": "169.254.10.10", "src-port": 12366, "time-date": 1642187218000, "system-ip": "172.16.254.1", "index": 9, "dst-port": 12386, "del": 1, "site-id": 2, "vdevice-host-name": "vm3", "vdevice-dataKey": "169.254.10.10-9-2022-01-14T19:06:58+0000", "proto": "ipsec", "lastupdated": 1642581869106, "time": "2022-01-14T19:06:58+0000", "state": "down", "rx-pkts": 6 }, { "dst-ip": "10.101.2.2", "src-ip": "10.101.3.3", "color": "biz-internet", "tx-pkts": 0, "vdevice-name": "169.254.10.10", "src-port": 12366, "time-date": 1642187219000, "system-ip": "172.16.254.1", "index": 6, "dst-port": 12406, "del": 0, "site-id": 2, "vdevice-host-name": "vm3", "vdevice-dataKey": "169.254.10.10-6-2022-01-14T19:06:59+0000", "proto": "ipsec", "lastupdated": 1642581869106, "time": "2022-01-14T19:06:59+0000", "state": "down", "rx-pkts": 0 }, { "dst-ip": "10.101.2.2", "src-ip": "10.101.3.3", "color": "biz-internet", "tx-pkts": 6, "vdevice-name": "169.254.10.10", "src-port": 12366, "time-date": 1642187219000, "system-ip": "172.16.254.1", "index": 7, "dst-port": 12406, "del": 0, "site-id": 2, "vdevice-host-name": "vm3", "vdevice-dataKey": "169.254.10.10-7-2022-01-14T19:06:59+0000", "proto": "ipsec", "lastupdated": 1642581869106, "time": "2022-01-14T19:06:59+0000", "state": "up", "rx-pkts": 6 }, { "dst-ip": "10.102.5.5", "src-ip": "10.101.3.3", "color": "default", "tx-pkts": 95431, "vdevice-name": "169.254.10.10", "src-port": 12346, "time-date": 1642577832000, "system-ip": "172.16.254.4", "index": 8, "dst-port": 12386, "del": 0, "site-id": 5, "vdevice-host-name": "vm3", "vdevice-dataKey": "169.254.10.10-8-2022-01-19T07:37:12+0000", "proto": "ipsec", "lastupdated": 1642581869106, "time": "2022-01-19T07:37:12+0000", "state": "down", "rx-pkts": 95426 }, { "dst-ip": "10.102.16.16", "src-ip": "10.102.3.3", "color": "lte", "tx-pkts": 0, "vdevice-name": "169.254.10.10", "src-port": 12366, "time-date": 1642163442000, "system-ip": "172.16.254.16", "index": 6, "dst-port": 12366, "del": 0, "site-id": 16, "vdevice-host-name": "vm3", "vdevice-dataKey": "169.254.10.10-6-2022-01-14T12:30:42+0000", "proto": "ipsec", "lastupdated": 1642581869106, "time": "2022-01-14T12:30:42+0000", "state": "down", "rx-pkts": 0 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write,System-read,System-write" } }, "/device/bfd/links": { "get": { "tags": [ "Real-Time Monitoring - BFD" ], "description": "Get list of BFD connections", "operationId": "createBFDLinkList", "parameters": [ { "name": "state", "in": "query", "description": "Device state", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "BFD connections": { "description": "BFD connections", "value": { "data": [ { "linkKey": "172.16.255.14:lte - 172.16.255.16:lte", "linkKeyDisplay": "172.16.255.14 (lte) - 172.16.255.16 (lte)", "asystem-ip": "172.16.255.16", "bhost-name": "vm4", "lastupdated": "1642494861369", "bsite-id": "400", "color1": "lte", "bpersonality": "vedge", "state": "up", "color2": "lte", "apersonality": "vedge", "bdeviceId": "172.16.255.14", "ahost-name": "vm6", "adeviceId": "172.16.255.16", "asite-id": "600", "bsystem-ip": "172.16.255.14" }, { "linkKey": "172.16.255.11:lte - 172.16.255.16:lte", "linkKeyDisplay": "172.16.255.11 (lte) - 172.16.255.16 (lte)", "asystem-ip": "172.16.255.16", "bhost-name": "vm1", "lastupdated": "1642663041881", "bsite-id": "100", "color1": "lte", "bpersonality": "vedge", "state": "up", "color2": "lte", "apersonality": "vedge", "bdeviceId": "172.16.255.11", "ahost-name": "vm6", "adeviceId": "172.16.255.16", "asite-id": "600", "bsystem-ip": "172.16.255.11" }, { "linkKey": "172.16.255.16:lte - 172.16.255.21:lte", "linkKeyDisplay": "172.16.255.16 (lte) - 172.16.255.21 (lte)", "asystem-ip": "172.16.255.16", "bhost-name": "vm11", "lastupdated": "1642494861369", "bsite-id": "100", "color1": "lte", "bpersonality": "vedge", "state": "up", "color2": "lte", "apersonality": "vedge", "bdeviceId": "172.16.255.21", "ahost-name": "vm6", "adeviceId": "172.16.255.16", "asite-id": "600", "bsystem-ip": "172.16.255.21" }, { "linkKey": "172.16.255.15:lte - 172.16.255.16:lte", "linkKeyDisplay": "172.16.255.15 (lte) - 172.16.255.16 (lte)", "asystem-ip": "172.16.255.15", "bhost-name": "vm6", "lastupdated": "1642975004139", "bsite-id": "600", "color1": "lte", "bpersonality": "vedge", "state": "up", "color2": "lte", "apersonality": "vedge", "bdeviceId": "172.16.255.16", "ahost-name": "vm5", "adeviceId": "172.16.255.15", "asite-id": "500", "bsystem-ip": "172.16.255.16" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/bfd/sessions": { "get": { "tags": [ "Real-Time Monitoring - BFD" ], "description": "Get list of BFD sessions from vManage (Real Time)", "operationId": "createBFDSessions", "parameters": [ { "name": "system-ip", "in": "query", "description": "System IP", "schema": { "type": "string" } }, { "name": "color", "in": "query", "description": "Remote color", "schema": { "type": "string", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] } }, { "name": "local-color", "in": "query", "description": "Source color", "schema": { "type": "string", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] } }, { "name": "region-type", "in": "query", "description": "Region type", "schema": { "type": "string", "enum": [ "core", "access" ] } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "BFD sessions": { "description": "BFD sessions", "value": { "data": [ { "src-ip": "10.101.3.3", "dst-ip": "10.101.2.2", "color": "default", "vdevice-name": "169.254.10.10", "src-port": 12346, "system-ip": "172.16.254.1", "dst-port": 12426, "site-id": 2, "transitions": 1, "vdevice-host-name": "vm3", "local-color": "default", "uptime": "0:14:04:10", "detect-multiplier": "7", "vdevice-dataKey": "169.254.10.10-default-172.16.254.1-default-ipsec", "proto": "ipsec", "lastupdated": 1642583341666, "state": "up", "tx-interval": 1000, "uptime-date": 1642532640000 }, { "src-ip": "10.101.3.3", "dst-ip": "10.101.4.4", "color": "default", "vdevice-name": "169.254.10.10", "src-port": 12346, "system-ip": "172.16.254.3", "dst-port": 12386, "site-id": 4, "transitions": 1, "vdevice-host-name": "vm3", "local-color": "default", "uptime": "0:14:04:10", "detect-multiplier": "7", "vdevice-dataKey": "169.254.10.10-default-172.16.254.3-default-ipsec", "proto": "ipsec", "lastupdated": 1642583341666, "state": "up", "tx-interval": 1000, "uptime-date": 1642532640000 }, { "src-ip": "10.101.3.3", "dst-ip": "10.102.5.5", "color": "default", "vdevice-name": "169.254.10.10", "src-port": 12346, "system-ip": "172.16.254.4", "dst-port": 12386, "site-id": 5, "transitions": 3, "vdevice-host-name": "vm3", "local-color": "default", "uptime": "0:01:31:46", "detect-multiplier": "7", "vdevice-dataKey": "169.254.10.10-default-172.16.254.4-default-ipsec", "proto": "ipsec", "lastupdated": 1642583341666, "state": "up", "tx-interval": 1000, "uptime-date": 1642577820000 }, { "src-ip": "10.101.3.3", "dst-ip": "10.102.6.6", "color": "default", "vdevice-name": "169.254.10.10", "src-port": 12346, "system-ip": "172.16.254.5", "dst-port": 12386, "site-id": 6, "transitions": 2, "vdevice-host-name": "vm3", "local-color": "default", "uptime": "0:01:36:07", "detect-multiplier": "7", "vdevice-dataKey": "169.254.10.10-default-172.16.254.5-default-ipsec", "proto": "ipsec", "lastupdated": 1642583341666, "state": "up", "tx-interval": 1000, "uptime-date": 1642577520000 }, { "src-ip": "10.101.3.3", "dst-ip": "10.102.16.16", "color": "default", "vdevice-name": "169.254.10.10", "src-port": 12346, "system-ip": "172.16.254.16", "dst-port": 12386, "site-id": 16, "transitions": 1, "vdevice-host-name": "vm3", "local-color": "default", "uptime": "0:14:04:10", "detect-multiplier": "7", "vdevice-dataKey": "169.254.10.10-default-172.16.254.16-default-ipsec", "proto": "ipsec", "lastupdated": 1642583341666, "state": "up", "tx-interval": 1000, "uptime-date": 1642532640000 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write,System-read,System-write" } }, "/device/bfd/sites/detail": { "get": { "tags": [ "Real-Time Monitoring - BFD" ], "description": "Get detailed BFD site details", "operationId": "getBFDSiteStateDetail", "parameters": [ { "name": "state", "in": "query", "description": "State", "schema": { "type": "string", "enum": [ "siteup", "sitedown", "sitepartial" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "BFD site detail: state=siteup": { "description": "BFD site detail: state=siteup", "value": { "data": [ { "bfdSessions": "5", "site-id": "4", "device-type": "vedge", "uuid": "4125a7b2-65cd-43c5-a393-cba53ebcdc00", "lastupdated": 1648413952287, "reachability": "reachable", "device-model": "vedge-cloud", "version": "20.3.4-542", "system-ip": "169.254.10.11", "uptime-date": 1646298000000, "controlConnections": "3", "host-name": "vm4", "ompPeers": "2", "number-vsmart-peers": 2, "local-system-ip": "172.16.254.3", "board-serial": "12345709" }, { "bfdSessions": "5", "site-id": "16", "device-type": "vedge", "uuid": "CSR-aec2123c-f20b-4876-b9ac-ae1dba561fb5", "lastupdated": 1648416356665, "reachability": "reachable", "device-model": "vedge-CSR-1000v", "version": "17.03.06.0.6691", "system-ip": "169.254.10.14", "uptime-date": 1647300780000, "controlConnections": "3", "host-name": "vm16", "ompPeers": "2", "number-vsmart-peers": 2, "local-system-ip": "172.16.254.16", "board-serial": "1234570F" }, { "bfdSessions": "5", "site-id": "5", "device-type": "vedge", "uuid": "C8K-d721a892-1cc1-4a30-9d17-98387348e2d4", "lastupdated": 1648418760239, "reachability": "reachable", "device-model": "vedge-C8000V", "version": "17.06.03.0.3496", "system-ip": "169.254.10.12", "uptime-date": 1646298240000, "controlConnections": "3", "host-name": "vm5", "ompPeers": "2", "number-vsmart-peers": 2, "local-system-ip": "172.16.254.4", "board-serial": "1234570A" }, { "bfdSessions": "5", "site-id": "2", "device-type": "vedge", "uuid": "f713e867-4376-45f1-8ecf-7c5fbe2be2f8", "lastupdated": 1648453581214, "reachability": "reachable", "device-model": "vedge-cloud", "version": "20.8.0-218", "system-ip": "169.254.10.9", "uptime-date": 1648060560000, "controlConnections": "3", "host-name": "vm2", "ompPeers": "2", "number-vsmart-peers": 2, "local-system-ip": "172.16.254.1", "board-serial": "12345707" }, { "bfdSessions": "5", "site-id": "6", "device-type": "vedge", "uuid": "C8K-47924f4e-0029-4693-a3df-986cb132437f", "lastupdated": 1648413353813, "reachability": "reachable", "device-model": "vedge-C8000V", "version": "17.08.01.0.1034", "system-ip": "169.254.10.13", "uptime-date": 1646298240000, "controlConnections": "3", "host-name": "vm6", "ompPeers": "2", "number-vsmart-peers": 2, "local-system-ip": "172.16.254.5", "board-serial": "1234570B" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "RBAC VPN-read,RBAC VPN-write" } }, "/device/bfd/sites/summary": { "get": { "tags": [ "Real-Time Monitoring - BFD" ], "description": "Get BFD site summary", "operationId": "getBFDSitesSummary", "parameters": [ { "name": "isCached", "in": "query", "description": "Flag for caching", "schema": { "type": "boolean", "default": false } }, { "name": "vpnId", "in": "query", "description": "Filter VPN", "required": true, "schema": { "type": "array", "items": { "type": "object", "properties": { "vpn": { "type": "string" } }, "description": "This is the valid list of VPN-IDs", "$$ref": "#/components/schemas/VPNID" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "BFD site summary": { "description": "BFD site summary", "value": { "data": [ { "count": 6, "detailsURL": "", "status": "error", "statusList": [ { "name": "Full WAN Connectivity", "status": "up", "message": "6 Full WAN Connectivity", "detailsURL": "/dataservice/device/bfd/sites/detail?state=siteup", "count": 6 }, { "name": "Partial WAN Connectivity", "status": "warning", "message": "0 Partial WAN Connectivity", "detailsURL": "/dataservice/device/bfd/sites/detail?state=sitepartial", "count": 0 }, { "name": "No WAN Connectivity", "status": "down", "message": "0 No WAN Connectivity", "detailsURL": "/dataservice/device/bfd/sites/detail?state=sitedown", "count": 0 } ] } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,RBAC VPN-read,System-read,System-write" } }, "/device/bfd/state/device": { "get": { "tags": [ "Real-Time Monitoring - BFD" ], "description": "Get device BFD state summary", "operationId": "getDeviceBFDStateSummary", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "BFD state summary": { "description": "BFD state summary", "value": { "data": [ { "site-id": 400, "color": "lte", "vmanage-system-ip": "172.16.255.11", "local-color": "lte", "local-if-desc": "", "vdevice-dataKey": "172.16.255.11-lte-172.16.255.14-lte-ipsec", "tx-interval": 1000, "vdevice-host-name": "vm1", "transitions": 0, "proto": "ipsec", "lastupdated": 1642663028239, "state": "up", "uptime-date": 1642663020000, "dst-port": 12366, "system-ip": "172.16.255.14", "dst-ip": "10.1.14.14", "remote-if-desc": "", "createTimeStamp": 1642494963368, "src-port": 12347, "vdevice-name": "172.16.255.11", "@rid": 936, "detect-multiplier": "7", "src-ip": "10.0.5.11", "local-remote-ifname": "ge0/2-ge0/4" }, { "site-id": 600, "color": "lte", "vmanage-system-ip": "172.16.255.11", "local-color": "lte", "local-if-desc": "", "vdevice-dataKey": "172.16.255.11-lte-172.16.255.16-lte-ipsec", "tx-interval": 1000, "vdevice-host-name": "vm1", "transitions": 0, "proto": "ipsec", "lastupdated": 1642663028239, "state": "up", "uptime-date": 1642663020000, "dst-port": 12366, "system-ip": "172.16.255.16", "dst-ip": "10.1.16.16", "remote-if-desc": "", "createTimeStamp": 1642494971424, "src-port": 12347, "vdevice-name": "172.16.255.11", "@rid": 947, "detect-multiplier": "7", "src-ip": "10.0.5.11", "local-remote-ifname": "ge0/2-GigabitEthernet1" }, { "site-id": 500, "color": "lte", "vmanage-system-ip": "172.16.255.11", "local-color": "lte", "local-if-desc": "", "vdevice-dataKey": "172.16.255.11-lte-172.16.255.15-lte-ipsec", "tx-interval": 1000, "vdevice-host-name": "vm1", "transitions": 0, "proto": "ipsec", "lastupdated": 1642663028239, "state": "up", "uptime-date": 1642663020000, "dst-port": 12346, "system-ip": "172.16.255.15", "dst-ip": "10.1.15.15", "remote-if-desc": "", "createTimeStamp": 1642657637570, "src-port": 12347, "vdevice-name": "172.16.255.11", "@rid": 1004, "detect-multiplier": "7", "src-ip": "10.0.5.11", "local-remote-ifname": "ge0/2-GigabitEthernet1" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,RBAC VPN-read,RBAC VPN-write" } }, "/device/bfd/state/device/tloc": { "get": { "tags": [ "Real-Time Monitoring - BFD" ], "description": "Get device BFD state summary with tloc color", "operationId": "getDeviceBFDStateSummaryTloc", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "BFD state summary with tloc": { "description": "BFD state summary with tloc", "value": { "data": [ { "local-color": [ "lte", "dia" ], "color": [ "lte", "dia" ] } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,RBAC VPN-read,RBAC VPN-write" } }, "/device/bfd/state/device/tlocInterfaceMap": { "get": { "tags": [ "Real-Time Monitoring - BFD" ], "description": "Get device tloc color to Intf Mapping Relationship", "operationId": "getDeviceTlocToIntfList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device tloc to intf mapping relationships": { "description": "Device tloc to intf mapping relationships", "value": { "intfList": { "private1": "GigabitEthernet1", "mpls": "GigabitEthernet2" } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,RBAC VPN-read,RBAC VPN-write" } }, "/device/bfd/status": { "get": { "tags": [ "Real-Time Monitoring - BFD" ], "description": "Get device BFD status", "operationId": "getDeviceBFDStatus", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "BFD status": { "description": "BFD status", "value": { "data": [ { "count": 0, "statusList": [ { "status": "up", "count": 0, "name": "up", "color": "b0e276", "detailsURL": "/dataservice/device/bfd/links?state=up", "detailView": "dialog", "icon": "images/connection/connection-network-up.png" }, { "status": "down", "count": 0, "name": "down", "color": "fa7c7d", "detailsURL": "/dataservice/device/bfd/links?state=down", "detailView": "dialog", "icon": "images/connection/connection-network-down.png" } ], "name": "BFD", "image": "images/bfd.png", "detailsURL": "/dataservice/device/bfd/links", "type": "bfd", "detailView": "dialog" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/bfd/summary": { "get": { "tags": [ "Real-Time Monitoring - BFD" ], "description": "Get BFD summary from device (Real Time)", "operationId": "createBFDSummary", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "BFD summary": { "description": "BFD summary", "value": { "data": [ { "bfd-sessions-max": "22", "vdevice-dataKey": "169.254.10.10", "bfd-sessions-flap": "111", "vdevice-name": "169.254.10.10", "bfd-sessions-up": "5", "lastupdated": 1642641879344, "bfd-sessions-total": "5", "poll-interval": "600000", "vdevice-host-name": "vm3" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write,System-read,System-write" } }, "/device/bfd/summary/device": { "get": { "tags": [ "Real-Time Monitoring - BFD" ], "description": "Get device BFD status summary", "operationId": "getDeviceBFDStatusSummary", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "BFD status summary": { "description": "BFD status summary", "value": { "header": { "generatedOn": 1646894919672, "title": "DataConnections" }, "data": [ { "name": "DataConnection", "count": 3, "detailsURL": "", "status": "error", "statusList": [ { "name": "up", "message": "3up", "detailsURL": "/dataservice/device/bfd/sessions?deviceId=172.16.255.11&state=up", "count": 3 } ] } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/bfd/synced/sessions": { "get": { "tags": [ "Real-Time Monitoring - BFD" ], "description": "Get list of BFD sessions from vManage synchronously", "operationId": "createSyncedBFDSession", "parameters": [ { "name": "system-ip", "in": "query", "description": "System IP", "schema": { "type": "string" } }, { "name": "color", "in": "query", "description": "Remote color", "schema": { "type": "string", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] } }, { "name": "local-color", "in": "query", "description": "Source color", "schema": { "type": "string", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "BFD sessions": { "description": "BFD sessions", "value": { "data": [ { "src-ip": "10.0.5.11", "dst-ip": "10.1.14.14", "color": "lte", "vdevice-name": "172.16.255.11", "src-port": 12347, "createTimeStamp": 1646804370042, "system-ip": "172.16.255.14", "dst-port": 12366, "site-id": 400, "transitions": 0, "vdevice-host-name": "vm1", "local-color": "lte", "detect-multiplier": "7", "vdevice-dataKey": "172.16.255.11-lte-172.16.255.14-lte-ipsec", "@rid": 1050, "vmanage-system-ip": "172.16.255.11", "proto": "ipsec", "lastupdated": 1646893777827, "tx-interval": 1000, "state": "up", "uptime-date": 1646893680000 }, { "src-ip": "10.0.5.11", "dst-ip": "10.1.15.15", "color": "lte", "vdevice-name": "172.16.255.11", "src-port": 12347, "createTimeStamp": 1646804372038, "system-ip": "172.16.255.15", "dst-port": 12366, "site-id": 500, "transitions": 0, "vdevice-host-name": "vm1", "local-color": "lte", "detect-multiplier": "7", "vdevice-dataKey": "172.16.255.11-lte-172.16.255.15-lte-ipsec", "@rid": 1057, "vmanage-system-ip": "172.16.255.11", "proto": "ipsec", "lastupdated": 1646893777827, "tx-interval": 1000, "state": "up", "uptime-date": 1646893680000 }, { "src-ip": "10.0.5.11", "dst-ip": "10.1.16.16", "color": "lte", "vdevice-name": "172.16.255.11", "src-port": 12347, "createTimeStamp": 1646804374521, "system-ip": "172.16.255.16", "dst-port": 12366, "site-id": 600, "transitions": 0, "vdevice-host-name": "vm1", "local-color": "lte", "detect-multiplier": "7", "vdevice-dataKey": "172.16.255.11-lte-172.16.255.16-lte-ipsec", "@rid": 1060, "vmanage-system-ip": "172.16.255.11", "proto": "ipsec", "lastupdated": 1646893777827, "tx-interval": 1000, "state": "up", "uptime-date": 1646893680000 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write,System-read,System-write" } }, "/device/bfd/tloc": { "get": { "tags": [ "Real-Time Monitoring - BFD" ], "description": "Get TLOC summary from device (Real Time)", "operationId": "createTLOCSummary", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "TLOC summary": { "description": "TLOC summary", "value": { "data": [ { "sessions-flap": 90, "if-name": "ge0/1", "sessions-total": 5, "vdevice-dataKey": "169.254.10.10", "vdevice-name": "169.254.10.10", "lastupdated": 1642641739756, "encap": "ipsec", "sessions-up": 5, "vdevice-host-name": "vm3" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write,System-read,System-write" } }, "/device/bfd/tloc/detail": { "get": { "tags": [ "Real-Time Monitoring - BFD" ], "description": "Get detailed BFD tloc details", "operationId": "getBFDTlocStateDetail", "parameters": [ { "name": "state", "in": "query", "description": "State", "schema": { "type": "string", "enum": [ "up", "down" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "BFD tloc detail: state=up": { "description": "BFD tloc detail: state=up", "value": { "data": [ { "color": "lte", "site-id": "4", "system-ip": "169.254.10.11" }, { "color": "mpls", "site-id": "16", "system-ip": "169.254.10.14" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write" } }, "/device/bgp/neighbors": { "get": { "tags": [ "Real-Time Monitoring - BGP" ], "description": "Get BGP neighbors list (Real Time)", "operationId": "createBGPNeighborsList", "parameters": [ { "name": "vpn-id", "in": "query", "description": "VPN Id", "schema": { "type": "string", "enum": [ "0", "512" ] } }, { "name": "peer-addr", "in": "query", "description": "Peer address", "schema": { "type": "string" } }, { "name": "as", "in": "query", "description": "AS number", "schema": { "type": "string" } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "BGP neighbors list": { "description": "BGP neighbors list", "value": { "data": [ { "vdevice-name": "169.254.10.10", "afi": "ipv4-unicast", "vpn-id": 10, "vdevice-host-name": "vm3", "peer-addr": "20.20.20.20", "as": 200, "vdevice-dataKey": "169.254.10.10-10-20.20.20.20", "msg-rcvd": 0, "outQ": 0, "afi-id": 0, "lastupdated": 1642657118366, "msg-sent": 0, "state": "active" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/bgp/routes": { "get": { "tags": [ "Real-Time Monitoring - BGP" ], "description": "Get BGP routes list (Real Time)", "operationId": "createBGPRoutesList", "parameters": [ { "name": "vpn-id", "in": "query", "description": "VPN Id", "schema": { "type": "string", "enum": [ "0", "512" ] } }, { "name": "prefix", "in": "query", "description": "IP prefix", "schema": { "type": "string" } }, { "name": "nexthop", "in": "query", "description": "Next hop", "schema": { "type": "string" } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "BGP routes list": { "description": "BGP routes list", "value": { "data": [ { "vdevice-name": "172.16.255.15", "prefix": "10.20.24.0/24", "origin": "origin-incomplete", "as-path": "10007", "weight": "0", "vpn-id": "1", "vdevice-host-name": "vm5", "nexthop": "10.20.24.17", "afi-safi": "vpnv4-unicast", "path-id": "0", "vdevice-dataKey": "172.16.255.15-1-vpnv4-unicast-10.20.24.0/24", "metric": "0", "local-pref": "100", "lastupdated": 1646989331657, "path-status": "valid" }, { "vdevice-name": "172.16.255.15", "prefix": "10.20.24.0/24", "origin": "origin-incomplete", "weight": "32768", "vpn-id": "1", "vdevice-host-name": "vm5", "nexthop": "0.0.0.0", "afi-safi": "vpnv4-unicast", "path-id": "0", "vdevice-dataKey": "172.16.255.15-1-vpnv4-unicast-10.20.24.0/24", "metric": "0", "local-pref": "100", "lastupdated": 1646989331694, "path-status": "bestpathvalid" }, { "vdevice-name": "172.16.255.15", "prefix": "172.16.255.117/32", "origin": "origin-incomplete", "as-path": "10007", "weight": "0", "vpn-id": "1", "vdevice-host-name": "vm5", "nexthop": "10.20.24.17", "afi-safi": "vpnv4-unicast", "path-id": "0", "vdevice-dataKey": "172.16.255.15-1-vpnv4-unicast-172.16.255.117/32", "metric": "0", "local-pref": "100", "lastupdated": 1646989331735, "path-status": "bestpathvalid" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/bgp/summary": { "get": { "tags": [ "Real-Time Monitoring - BGP" ], "description": "Get BGP summary (Real Time)", "operationId": "createBGPSummary", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "BGP summary": { "description": "BGP summary", "value": { "data": [ { "local-site-of-origin": "SoO:0:3", "vdevice-dataKey": "169.254.10.10-10", "bgp-router-identifier": "172.16.254.2", "peer-memory": "4816", "vdevice-name": "169.254.10.10", "rib-memory": "0", "lastupdated": 1642657523957, "total-peers": "1", "vpn-id": 10, "vdevice-host-name": "vm3", "rib-entries": "0", "local-as": "100" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/blockSync": { "post": { "tags": [ "Monitoring - Device Details" ], "description": "Set collection manager block set flag", "operationId": "setBlockSync", "parameters": [ { "name": "blockSync", "in": "query", "description": "Block sync flag", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/bootup/time": { "get": { "tags": [ "Monitoring - BootUp Time" ], "summary": "get vManage reboot time", "operationId": "getBootUpTime", "parameters": [ { "name": "vmanage", "in": "query", "schema": { "type": "string" } }, { "name": "bootup_type", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "boot_up_time": { "type": "integer", "format": "int64" }, "bootup_type": { "type": "string" }, "host_name": { "type": "string" }, "last_update_time": { "type": "integer", "format": "int64" }, "local_system_ip": { "type": "string" }, "system_bootup": { "type": "object", "properties": { "duration": { "type": "number" }, "ready": { "type": "object", "properties": { "logtime": { "type": "string" }, "relative_time": { "type": "number" }, "timestamp": { "type": "integer", "format": "int64" } }, "$$ref": "#/components/schemas/TimeData" }, "start": { "type": "object", "properties": { "logtime": { "type": "string" }, "relative_time": { "type": "number" }, "timestamp": { "type": "integer", "format": "int64" } }, "$$ref": "#/components/schemas/TimeData" } }, "$$ref": "#/components/schemas/BootUpTimeEntry" }, "system_ip": { "type": "string" } }, "$$ref": "#/components/schemas/BootUpTimeData" } } }, "$$ref": "#/components/schemas/BootUpTime" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/bridge/interface": { "get": { "tags": [ "Real-Time Monitoring - Bridge" ], "description": "Get device bridge interface list (Real Time)", "operationId": "getBridgeInterfaceList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device bridge interface": { "description": "Device bridge interface", "value": { "data": [ { "ifindex": "13", "vdevice-name": "10.0.0.121", "oper-status": "up", "vdevice-host-name": "ISR4451-X", "mtu": "1500", "if-name": "GigabitEthernet0/3/0", "admin-status": "up", "vdevice-dataKey": "10.0.0.121-1-GigabitEthernet0/3/0", "vlan": "1", "native-vlan": "true", "lastupdated": 1650883014316, "bridge-id": "1", "encap-type": "vlan" }, { "ifindex": "14", "vdevice-name": "10.0.0.121", "oper-status": "down", "vdevice-host-name": "ISR4451-X", "mtu": "1500", "if-name": "GigabitEthernet0/3/1", "admin-status": "down", "vdevice-dataKey": "10.0.0.121-1-GigabitEthernet0/3/1", "vlan": "1", "native-vlan": "true", "lastupdated": 1650883014316, "bridge-id": "1", "encap-type": "vlan" }, { "ifindex": "15", "vdevice-name": "10.0.0.121", "oper-status": "down", "vdevice-host-name": "ISR4451-X", "mtu": "1500", "if-name": "GigabitEthernet0/3/2", "admin-status": "down", "vdevice-dataKey": "10.0.0.121-1-GigabitEthernet0/3/2", "vlan": "1", "native-vlan": "true", "lastupdated": 1650883014316, "bridge-id": "1", "encap-type": "vlan" }, { "ifindex": "16", "vdevice-name": "10.0.0.121", "oper-status": "down", "vdevice-host-name": "ISR4451-X", "mtu": "1500", "if-name": "GigabitEthernet0/3/3", "admin-status": "down", "vdevice-dataKey": "10.0.0.121-1-GigabitEthernet0/3/3", "vlan": "1", "native-vlan": "true", "lastupdated": 1650883014316, "bridge-id": "1", "encap-type": "vlan" }, { "ifindex": "17", "vdevice-name": "10.0.0.121", "oper-status": "down", "vdevice-host-name": "ISR4451-X", "mtu": "1500", "if-name": "GigabitEthernet0/3/4", "admin-status": "down", "vdevice-dataKey": "10.0.0.121-1-GigabitEthernet0/3/4", "vlan": "1", "native-vlan": "true", "lastupdated": 1650883014316, "bridge-id": "1", "encap-type": "vlan" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Interface-read,Interface-write" } }, "/device/bridge/mac": { "get": { "tags": [ "Real-Time Monitoring - Bridge" ], "description": "Get device bridge interface MAC (Real Time)", "operationId": "getBridgeInterfaceMac", "parameters": [ { "name": "bridge-id", "in": "query", "description": "Bridge ID", "schema": { "type": "string" } }, { "name": "if-name", "in": "query", "description": "Interface name", "schema": { "type": "string", "enum": [ "ge0/0", "ge0/1", "ge0/2", "ge0/3", "ge0/4", "ge0/5", "ge0/6", "ge0/7", "system", "eth0" ] } }, { "name": "mac-address", "in": "query", "description": "MAC address", "schema": { "type": "string" } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device bridge interface MAC": { "description": "Device bridge interface MAC", "value": { "data": [ { "if-name": "Ethernet-Internal2/0/0", "mac-address": "58:bc:27:6d:c3:09", "vdevice-dataKey": "10.0.0.121-1-Ethernet-Internal2/0/0-58:bc:27:6d:c3:09", "vlan": "1", "vdevice-name": "10.0.0.121", "lastupdated": 1650882797794, "bridge-id": "1", "interface": "GigabitEthernet0/3/0", "type": "bridge-mac-type-dynamic", "vdevice-host-name": "ISR4451-X" }, { "if-name": "Ethernet-Internal2/0/0", "mac-address": "a4:4c:11:9e:03:d7", "vdevice-dataKey": "10.0.0.121-1-Ethernet-Internal2/0/0-a4:4c:11:9e:03:d7", "vlan": "1", "vdevice-name": "10.0.0.121", "lastupdated": 1650882797794, "bridge-id": "1", "interface": "GigabitEthernet0/3/0", "type": "bridge-mac-type-dynamic", "vdevice-host-name": "ISR4451-X" }, { "if-name": "Ethernet-Internal2/0/0", "mac-address": "a4:4c:11:9e:1d:cc", "vdevice-dataKey": "10.0.0.121-1-Ethernet-Internal2/0/0-a4:4c:11:9e:1d:cc", "vlan": "1", "vdevice-name": "10.0.0.121", "lastupdated": 1650882797794, "bridge-id": "1", "type": "bridge-mac-type-static", "vdevice-host-name": "ISR4451-X" }, { "if-name": "Ethernet-Internal2/0/0", "vdevice-dataKey": "10.0.0.121-1002-Ethernet-Internal2/0/0-", "vlan": "1002", "vdevice-name": "10.0.0.121", "lastupdated": 1650882797794, "bridge-id": "1002", "vdevice-host-name": "ISR4451-X" }, { "if-name": "Ethernet-Internal2/0/0", "vdevice-dataKey": "10.0.0.121-1003-Ethernet-Internal2/0/0-", "vlan": "1003", "vdevice-name": "10.0.0.121", "lastupdated": 1650882797794, "bridge-id": "1003", "vdevice-host-name": "ISR4451-X" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Interface-read,Interface-write" } }, "/device/bridge/table": { "get": { "tags": [ "Real-Time Monitoring - Bridge" ], "description": "Get device bridge interface table (Real Time)", "operationId": "getBridgeInterfaceTable", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device bridge interface": { "description": "Device bridge interface", "value": { "data": [ { "flood-packets": "0", "max-macs": 1024, "move": 0, "vdevice-name": "10.0.0.121", "learn": 0, "age-time": 300, "rx-packets": "0", "rx-routed-packets": "0", "num-macs": 4, "routing-interface": "Vlan1", "vdevice-host-name": "ISR4451-X", "vdevice-dataKey": "10.0.0.121-1", "vlan": "1", "tx-octets": "0", "tx-packets": "0", "name": "default", "rx-octets": "0", "lastupdated": 1650882963285, "bridge-id": "1", "flood-octets": "0", "tx-routed-packets": "0", "age": 0 }, { "flood-packets": "0", "max-macs": 1024, "move": 0, "vdevice-name": "10.0.0.121", "learn": 0, "age-time": 300, "rx-packets": "0", "rx-routed-packets": "0", "num-macs": 0, "routing-interface": "null", "vdevice-host-name": "ISR4451-X", "vdevice-dataKey": "10.0.0.121-1002", "vlan": "1002", "tx-octets": "0", "tx-packets": "0", "name": "fddi-default", "rx-octets": "0", "lastupdated": 1650882963285, "bridge-id": "1002", "flood-octets": "0", "tx-routed-packets": "0", "age": 0 }, { "flood-packets": "0", "max-macs": 1024, "move": 0, "vdevice-name": "10.0.0.121", "learn": 0, "age-time": 300, "rx-packets": "0", "rx-routed-packets": "0", "num-macs": 0, "routing-interface": "null", "vdevice-host-name": "ISR4451-X", "vdevice-dataKey": "10.0.0.121-1003", "vlan": "1003", "tx-octets": "0", "tx-packets": "0", "name": "token-ring-default", "rx-octets": "0", "lastupdated": 1650882963285, "bridge-id": "1003", "flood-octets": "0", "tx-routed-packets": "0", "age": 0 }, { "flood-packets": "0", "max-macs": 1024, "move": 0, "vdevice-name": "10.0.0.121", "learn": 0, "age-time": 300, "rx-packets": "0", "rx-routed-packets": "0", "num-macs": 0, "routing-interface": "null", "vdevice-host-name": "ISR4451-X", "vdevice-dataKey": "10.0.0.121-1004", "vlan": "1004", "tx-octets": "0", "tx-packets": "0", "name": "fddinet-default", "rx-octets": "0", "lastupdated": 1650882963285, "bridge-id": "1004", "flood-octets": "0", "tx-routed-packets": "0", "age": 0 }, { "flood-packets": "0", "max-macs": 1024, "move": 0, "vdevice-name": "10.0.0.121", "learn": 0, "age-time": 300, "rx-packets": "0", "rx-routed-packets": "0", "num-macs": 0, "routing-interface": "null", "vdevice-host-name": "ISR4451-X", "vdevice-dataKey": "10.0.0.121-1005", "vlan": "1005", "tx-octets": "0", "tx-packets": "0", "name": "trnet-default", "rx-octets": "0", "lastupdated": 1650882963285, "bridge-id": "1005", "flood-octets": "0", "tx-routed-packets": "0", "age": 0 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Interface-read,Interface-write" } }, "/device/cedgecflowd/app-fwd-cflowd-flows": { "get": { "tags": [ "Monitoring - Cedge Cflowd" ], "description": "Get list of app fwd cflowd flows from device", "operationId": "createAppFwdCflowdFlowsList", "parameters": [ { "name": "deviceId", "in": "query", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } }, { "name": "vpn-id", "in": "query", "schema": { "maximum": 512, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "src-addr", "in": "query", "schema": { "type": "string" } }, { "name": "dst-addr", "in": "query", "schema": { "type": "string" } }, { "name": "app", "in": "query", "schema": { "type": "string" } }, { "name": "family", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/cedgecflowd/app-fwd-cflowd-v6-flows": { "get": { "tags": [ "Monitoring - Cedge Cflowd" ], "description": "Get list of app fwd cflowd v6 flows from device", "operationId": "createAppFwdCflowdV6FlowsList", "parameters": [ { "name": "deviceId", "in": "query", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } }, { "name": "vpn-id", "in": "query", "schema": { "maximum": 512, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "src-addr", "in": "query", "schema": { "type": "string" } }, { "name": "dst-addr", "in": "query", "schema": { "type": "string" } }, { "name": "app", "in": "query", "schema": { "type": "string" } }, { "name": "family", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/cellular/connection": { "get": { "tags": [ "Real-Time Monitoring - Cellular" ], "description": "Get cellular connection list from device", "operationId": "createCellularConnectionList", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Cellular connection list": { "description": "Cellular connection list", "value": [ { "lastupdated": 1649242617635, "cellular-interface": "Cellular0/1/0", "active-profile": "1", "cellular-packet-status": "packet-session-status-active", "rx-packets": "20905", "rx-bytes": "10301", "tx-packets": "20905", "tx-bytes": "10301", "ipv4-addr": "29.29.29.105", "ipv4-dns-pri": "8.0.0.8", "ipv4-dns-sec": "4.4.4.4", "ipv6-addr": "2001:a0:c::1a", "ipv6-dns-pri": "2400:da00::6666", "ipv6-dns-sec": "2400:da00::6666", "scope": "scope", "ursp-configured": "true", "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "vdevice-dataKey": "172.16.255.15" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Interface-read,Interface-write" } }, "/device/cellular/hardware": { "get": { "tags": [ "Real-Time Monitoring - Cellular" ], "description": "Get cellular hardware list from device", "operationId": "createHardwareList_RealTimeMonitoringCellular_2503", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Cellular hardware list": { "description": "Cellular hardware list", "value": [ { "lastupdated": 1649242617635, "cellular-interface": "Cellular0/1/0", "cellular-firmware-build-time": "1649242617635", "cellular-firmware-version": "1.0", "cellular-hardware-version": "1.0", "cellular-device-model": "HMOD1", "cellular-imsi": "HUID1", "cellular-imei": "imei", "cellular-iccid": "iccid", "cellular-msisdn": "msisdn", "cellular-fsn": "fsn", "cellular-modem-status": "active", "cellular-modem-temperature": "16c", "cellular-pri-skuid": "skuid", "cellular-pri-version": "2.0", "cellular-carrier": "carrier", "cellular-oem-pri-version": "2.0", "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "vdevice-dataKey": "172.16.255.15" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Interface-read,Interface-write" } }, "/device/cellular/modem": { "get": { "tags": [ "Real-Time Monitoring - Cellular" ], "description": "Get cellular modem list from device", "operationId": "createModemList", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device Id", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Cellular modem list": { "description": "Cellular modem list", "value": [ { "lastupdated": 1649242617635, "if-name": "Cellular0/1/0", "model": "model", "fw-version": "1.0", "fw-date": "2022-04-18", "fw-time": "1649242617635", "fw-pkg-ver": "1.2", "fw-pkg-carrier": "carrier", "fw-pkg-pri": "pri", "fw-pkg-subver": "subver", "hw-version": "1.5", "modem-status": "active", "temperature": "16c", "imsi": "imsi", "imei": "imei", "iccid": "iccid", "msisdn": "msisdn", "esn": "esn", "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "vdevice-dataKey": "172.16.255.15" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Interface-read,Interface-write" } }, "/device/cellular/network": { "get": { "tags": [ "Real-Time Monitoring - Cellular" ], "description": "Get cellular network list from device", "operationId": "createNetworkList_RealTimeMonitoringCellular_2403", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Cellular network list": { "description": "Cellular network list", "value": [ { "lastupdated": 1649242617635, "if-name": "Cellular0/1/0", "reg-status": "status", "roam-status": "status", "domain-status": "status", "mcc": "mcc", "mnc": "mnc", "nw-name": "name", "emm-state": "state", "emm-substate": "good", "emm-connstate": "good", "cellid": "cellid", "tac": "tac", "sid": "sid", "nid": "nid", "bid": "bid", "lac": "lac", "psc": "psc", "bsic": "bsic", "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "vdevice-dataKey": "172.16.255.15" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Interface-read,Interface-write" } }, "/device/cellular/profiles": { "get": { "tags": [ "Real-Time Monitoring - Cellular" ], "description": "Get cellular profile list from device", "operationId": "createProfileList", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Cellular profile list": { "description": "Cellular profile list", "value": [ { "lastupdated": 1649242617635, "if-name": "Cellular0/1/0", "profile-id": "123", "pdn-type": "type", "apn": "apn", "name": "name", "auth": "auth", "ip-addr": "172.16.255.15", "primary-dns": "8.8.8.8", "secondary-dns": "4.4.4.4", "user-name": "uname", "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "vdevice-dataKey": "172.16.255.15" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Interface-read,Interface-write" } }, "/device/cellular/radio": { "get": { "tags": [ "Real-Time Monitoring - Cellular" ], "description": "Get cellular radio list from device", "operationId": "createRadioList_RealTimeMonitoringCellular_2203", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Cellular radio list": { "description": "Cellular radio list", "value": [ { "lastupdated": 1649242617635, "if-name": "Cellular0/1/0", "band": 123, "bandwidth": 1000.2, "tx-channel": 1, "rx-channel": 2, "rssi": 1, "rsrp": 2, "rsrp-comment": "comment", "rsrq": 4, "rsrq-comment": "comment", "snr": 3.4, "snr-comment": "comment", "ecio": "ecio", "sinr": "sinr", "io": "io", "mode": "mode", "band-class": "band class", "channel": "unam123e", "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "vdevice-dataKey": "172.16.255.15" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Interface-read,Interface-write" } }, "/device/cellular/sessions": { "get": { "tags": [ "Real-Time Monitoring - Cellular" ], "description": "Get cellular session list from device", "operationId": "createSessionsList", "parameters": [ { "name": "if-name", "in": "query", "description": "Interface name", "schema": { "type": "string", "enum": [ "ge0/0", "ge0/1", "ge0/2", "ge0/3", "ge0/4", "ge0/5", "ge0/6", "ge0/7", "system", "eth0" ] } }, { "name": "ipv4-dns-pri", "in": "query", "description": "DNS primary IP", "schema": { "type": "string" } }, { "name": "deviceId", "in": "query", "description": "Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Cellular session list": { "description": "Cellular session list", "value": [ { "lastupdated": 1649242617635, "if-name": "Cellular0/1/0", "session-id": "123", "data-bearer": "bearer", "dormancy-state": "state", "active-profile": 1, "rx-packets": 18, "rx-drops": 15, "rx-errors": 888, "rx-overflows": 444, "rx-octets": 235, "tx-packets": 234, "tx-drops": 234, "tx-errors": 123, "tx-overflows": 123, "tx-octets": 123, "ipv4-addr": "172.16.255.15", "ipv4-mask": "255.255.255.0", "ipv4-gw": "192.168.0.1", "ipv4-dns-pri": "8.8.8.8", "ipv4-dns-sec": "4.4.4.4", "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "vdevice-dataKey": "172.16.255.15" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Interface-read,Interface-write" } }, "/device/cellular/status": { "get": { "tags": [ "Real-Time Monitoring - Cellular" ], "description": "Get cellular status list from device", "operationId": "getCellularStatusList", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Cellular status list": { "description": "Cellular status list", "value": [ { "lastupdated": 1649242617635, "if-name": "Cellular0/1/0", "modem-status": "status", "sim-status": "status", "signal-strength": "12", "network-status": "health", "last-seen-error": "last error", "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "vdevice-dataKey": "172.16.255.15" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Interface-read,Interface-write" } }, "/device/cellular/ursp/routes": { "get": { "tags": [ "Real-Time Monitoring - Cellular" ], "description": "Get cellular URSP routes from device", "operationId": "getCellularUrspRoutes", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Cellular URSP routes": { "description": "Cellular URSP routes" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Interface-read,Interface-write" } }, "/device/cellular/ursp/rules": { "get": { "tags": [ "Real-Time Monitoring - Cellular" ], "description": "Get cellular URSP rules from device", "operationId": "getCellularUrspRules", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Cellular URSP rules": { "description": "Cellular URSP rules", "value": [ { "vdevice-dataKey": "172.16.255.101-Cellular0/2/0-1", "cellular-interface": "Cellular0/2/0", "policy-source": "0", "vdevice-name": "172.16.255.101", "pdu-session-type": "0", "lastupdated": 1749206177430, "rule-precedence": "1", "vdevice-host-name": "Router", "match-all": "0" }, { "vdevice-dataKey": "172.16.255.101-Cellular0/2/0-2", "cellular-interface": "Cellular0/2/0", "policy-source": "0", "vdevice-name": "172.16.255.101", "pdu-session-type": "0", "lastupdated": 1749206177430, "rule-precedence": "2", "vdevice-host-name": "Router", "match-all": "0" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Interface-read,Interface-write" } }, "/device/cellularEiolte/connections": { "get": { "tags": [ "Real-Time Monitoring - Cellular EIOLTE Connection Service" ], "description": "Get cellular connection info from device", "operationId": "getEiolteConnectionInfo", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device Ip address, example:172.16.255.111", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "cellular connection info": { "description": "cellular connection info", "value": [ { "vdevice-name": "172.16.255.111", "rx-errors": 0, "cellular-interface-name": "Cellular 1/0", "tx-errors": 0, "sec-dns-ipv4-addr": "0.0.0.0", "pri-dns-ipv4-addr": "8.8.8.8", "tx-ofl": 0, "connectivity": "Attach and Data", "ipv4-address": "192.168.3.2", "rx-ofl": 0, "rx-pkts": 42067, "apn": "internet", "ipv6-prefix-length": "0", "tx-pkts": 36604, "ipv4-gateway-addr": "192.168.3.1", "session-status": "Connected", "pri-dns-ipv6-addr": "::", "sec-dns-ipv6-addr": "::", "vdevice-host-name": "CellularGateway", "tx-drops": 0, "rx-drops": 0, "vdevice-dataKey": "172.16.255.111-1-1-", "profile-id": 1, "modem-index": "1", "tx-bytes": 10145490, "lastupdated": 1649249750021, "ipv6-gw-prefix-length": "0", "ipv6-gw-prefix": "::", "rx-bytes": 8887213, "ipv6-prefix": "::" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,System-read" } }, "/device/cellularEiolte/hardware": { "get": { "tags": [ "Real-Time Monitoring - Cellular EIOLTE Hardware Service " ], "description": "Get cellular hardware info from device", "operationId": "getEiolteHardwareInfo", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device Ip address, example:172.16.255.111", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "cellular hardware info": { "description": "cellular hardware info", "value": [ { "ICCID": "8952530306500032705", "FSN": "4H0222009903AG", "host-manufacturer": "Cisco Systems, Inc.", "vdevice-name": "172.16.255.111", "PRI-SKU-ID": "1104567", "Modem-Status": "MODEM_STATE_DNS_ACQUIRED", "cellular-interface-name": "Cellular 1/0", "Firmware-Version": "SWIX55C_03.07.00.00 fef145 jenkins", "host-software-version": "N/A", "IMEI": "351735110100118", "Model-ID": "EM9190", "vdevice-host-name": "CellularGateway", "vdevice-dataKey": "172.16.255.111-1-", "Modem-Temperature": 33, "PRI-Version": "030.018_000", "IMSI": "001010123456063", "OEM-PRI-Version": "001.021", "modem-index": "1", "Host-Firmware-Version": "SWIX55C_03.07.00.00 fef145 jenkins", "lastupdated": 1649250029516, "Carrier": "GENERIC", "host-id": "N/A", "host-model": "N/A" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,System-read" } }, "/device/cellularEiolte/ipsec/interface/counters": { "get": { "tags": [ "Real-Time Monitoring - Cellular AON Ipsec Interface " ], "description": "Get cellular ipsec interface info from device", "operationId": "getAONIpsecInterfaceCountersInfo", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device Id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "cellular info": { "description": "cellular info", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,System-read" } }, "/device/cellularEiolte/ipsec/interface/session": { "get": { "tags": [ "Real-Time Monitoring - Cellular AON Ipsec Interface " ], "description": "Get cellular ipsec interface info from device", "operationId": "getAONIpsecInterfaceSessionnfo", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device Id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "cellular info": { "description": "cellular info", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,System-read" } }, "/device/cellularEiolte/network": { "get": { "tags": [ "Real-Time Monitoring - Cellular EIOLTE Network Service" ], "description": "Get cellular network info from device", "operationId": "getEiolteNetworkInfo", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device Ip address, example:172.16.255.111", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "cellular network info": { "description": "cellular network info", "value": [ { "Network-Selection-Mode": "Automatic", "MNC": 1, "vdevice-name": "172.16.255.111", "cellular-interface-name": "Cellular 1/0", "MCC": 1, "vdevice-host-name": "CellularGateway", "MTU": 1500, "System-Time": "Thu Mar 24 3:6:0 2022", "PS-State": "Attached", "Roaming-Status": "Home", "RRC-Connection-State": "RRC Connected", "vdevice-dataKey": "172.16.255.111-1-", "Network": "Test PLMN 1-1", "EMM-State": "Registered", "TAC": 1, "Cell-ID": 27447297, "modem-index": "1", "lastupdated": 1649250149676, "Current-Service": "Packet switched", "Current-Service-status": "Normal", "EMM-Sub-State": "Normal-Service" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,System-read" } }, "/device/cellularEiolte/radio": { "get": { "tags": [ "Real-Time Monitoring - Cellular EIOLTE Connection Service" ], "description": "Get cellular radio info from device", "operationId": "getEiolteRadioInfo", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device Ip address, example:172.16.255.111", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "cellular radio info": { "description": "cellular radio info", "value": [ { "Current-ENDC-RSRQ": "-11 dB", "Current-ENDC-RSRP": "-71 dBm", "vdevice-name": "172.16.255.111", "LTE-Bandwidth": "20 MHz", "cellular-interface-name": "Cellular 1/0", "Offline-Reason": "Unknown", "LTE-Rx-Channel-Number": 18300, "Measured-ENDC-SINR": "36.0 dB", "ENDC-active-downlink-channel": "632628", "Low-Power-Reason": "Unknown", "ENDC-active-band": "78", "SNR": "30.0 dB", "ENDC-Physical-CellId": "500", "LTE-Band": 1, "RSRP": "-60 dBm", "Radio-Status": "online", "ENDC-active-uplink-channel": "632628", "RSRQ": "-7 dB", "LTE-Tx-Channel-Number": 300, "vdevice-host-name": "CellularGateway", "RSSI": "-33 dBm", "vdevice-dataKey": "172.16.255.111-1-", "PCI": 1, "ENDC-bandwidth": "50 MHz", "modem-index": "1", "lastupdated": 1649250251234, "RAT-Selected": "LTE" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,System-read" } }, "/device/cellularEiolte/sim": { "get": { "tags": [ "Real-Time Monitoring - Cellular EIOLTE Sim Service" ], "description": "Get cellular sim info from device", "operationId": "getEiolteSimInfo", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device Ip address, example:172.16.255.111", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "cellular sim info": { "description": "cellular sim info", "value": [ { "active-sim": 0, "vdevice-dataKey": "172.16.255.111-1-", "vdevice-name": "172.16.255.111", "cellular-interface-name": "Cellular 1/0", "sim-status-slot-0": "Present", "modem-index": "1", "sim-status-slot-1": "Not Present", "lastupdated": 1649250373414, "vdevice-host-name": "CellularGateway" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,System-read" } }, "/device/cflowd/application/fields": { "get": { "tags": [ "Monitoring - Cflowd" ], "description": "Get Cflowd DPI query field JSON", "operationId": "getCflowdDPIDeviceFieldJSON", "parameters": [ { "name": "isDeviceDashBoard", "in": "query", "description": "Flag whether it is device dashboard request", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DPI query field in JSON": { "description": "DPI query field in JSON", "value": { "header": {}, "data": [ { "property": "entry_time", "name": "Event Time", "isRequired": true, "dataType": "date", "fieldData": { "type": "dateList" }, "options": [ { "key": "last_24_hours", "value": "Last 24 hours", "number": "24", "enableDateFields": false }, { "key": "last_12_hours", "value": "Last 12 hours", "number": "12", "enableDateFields": false }, { "key": "last_6_hours", "value": "Last 6 hours", "number": "6", "enableDateFields": false }, { "key": "last_3_hours", "value": "Last 3 hours", "number": "3", "enableDateFields": false }, { "key": "last_1_hour", "value": "Last 1 hour", "number": "1", "enableDateFields": false } ] }, { "property": "vpn_id", "name": "VPN", "isRequired": true, "multiSelect": false, "dataType": "int", "fieldData": { "type": "url", "url": "dataservice/device/action/vpn" } }, { "property": "vdevice_name", "name": "Device name", "isRequired": true, "multiSelect": false, "isHidden": true, "dataType": "string" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write" } }, "/device/cflowd/collector": { "get": { "tags": [ "Monitoring - Cflowd" ], "description": "Get cflowd collector list from device", "operationId": "createCflowdCollectorList", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Cflowd collector list": { "description": "Cflowd collector list", "value": [] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write" } }, "/device/cflowd/device/fields": { "get": { "tags": [ "Monitoring - Cflowd" ], "description": "Get CflowdvDPI query field JSON", "operationId": "getCflowdDPIFieldJSON", "parameters": [ { "name": "isDeviceDashBoard", "in": "query", "description": "Flag whether it is device dashboard request", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DPI query field in JSON": { "description": "DPI query field in JSON", "value": [ { "name": "Event Time", "dataType": "date", "isRequired": true, "property": "entry_time", "options": [ { "enableDateFields": false, "value": "Last 24 hours", "key": "last_24_hours", "number": "24" }, { "enableDateFields": false, "value": "Last 12 hours", "key": "last_12_hours", "number": "12" }, { "enableDateFields": false, "value": "Last 6 hours", "key": "last_6_hours", "number": "6" }, { "enableDateFields": false, "value": "Last 3 hours", "key": "last_3_hours", "number": "3" }, { "enableDateFields": false, "value": "Last 1 hour", "key": "last_1_hour", "number": "1" }, { "enableDateFields": false, "value": "Last 7 days", "key": "last_168_hours", "number": "168" } ], "fieldData": { "type": "dateList" } }, { "dataType": "string", "isRequired": true, "property": "dest_ip", "multiSelect": false, "name": "Destination Ip" }, { "dataType": "long", "isRequired": true, "property": "dest_port", "multiSelect": false, "name": "Destination port" }, { "name": "Device name", "dataType": "string", "isRequired": true, "multiSelect": false, "property": "vdevice_name", "isHidden": true } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/cflowd/flows": { "get": { "tags": [ "Monitoring - Cflowd" ], "description": "Get list of cflowd flows from device", "operationId": "createCflowCollectorList", "parameters": [ { "name": "vpn-id", "in": "query", "description": "VPN Id", "schema": { "type": "string", "enum": [ "0", "512" ] } }, { "name": "src-ip", "in": "query", "description": "Source IP", "schema": { "type": "string" } }, { "name": "dest-ip", "in": "query", "description": "Destination IP", "schema": { "type": "string" } }, { "name": "deviceId", "in": "query", "description": "Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Cflowd flows list": { "description": "Cflowd flows list", "value": [] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write" } }, "/device/cflowd/flows-count": { "get": { "tags": [ "Monitoring - Cflowd" ], "description": "Get cflowd flow count from device", "operationId": "createCflowdFlowsCountList", "parameters": [ { "name": "vpn-id", "in": "query", "description": "VPN Id", "schema": { "type": "string", "enum": [ "0", "512" ] } }, { "name": "src-ip", "in": "query", "description": "Source IP", "schema": { "type": "string" } }, { "name": "dest-ip", "in": "query", "description": "Destination IP", "schema": { "type": "string" } }, { "name": "deviceId", "in": "query", "description": "Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Cflowd flow count": { "description": "Cflowd flow count", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write" } }, "/device/cflowd/fnf/cache-stats": { "get": { "tags": [ "Monitoring - Cflowd" ], "description": "Get FnF cache stats from device", "operationId": "getFnFCacheStats", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "FnF cache stats": { "description": "FnF cache stats", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write" } }, "/device/cflowd/fnf/export-client-stats": { "get": { "tags": [ "Monitoring - Cflowd" ], "description": "Get FnF export client stats from device", "operationId": "getFnFExportClientStats", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "FnF export client stats": { "description": "FnF export client stats", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write" } }, "/device/cflowd/fnf/export-stats": { "get": { "tags": [ "Monitoring - Cflowd" ], "description": "Get FnF export stats from device", "operationId": "getFnFExportStats", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "FnF export stats": { "description": "FnF export stats", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write" } }, "/device/cflowd/fnf/flow-monitor": { "get": { "tags": [ "Monitoring - Cflowd" ], "description": "Get FnF from device", "operationId": "getFnf", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "FnF": { "description": "FnF", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write" } }, "/device/cflowd/fnf/monitor-stats": { "get": { "tags": [ "Monitoring - Cflowd" ], "description": "Get FnF monitor stats from device", "operationId": "getFnFMonitorStats", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "FnF monitor stats": { "description": "FnF monitor stats", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write" } }, "/device/cflowd/statistics": { "get": { "tags": [ "Monitoring - Cflowd" ], "description": "Get cflowd statistics from device", "operationId": "createCflowdStatistics", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Cflowd statistics": { "description": "Cflowd statistics", "value": [ { "model_sk": "None", "state_description": "All daemons up", "site-id": "200", "version": "20.7.999-1133", "local-system-ip": "172.16.255.22", "timezone": "UTC", "controlConnections": "7", "domain-id": "0", "total_cpu_count": "2", "device-groups": [ "No groups" ], "device-type": "vmanage", "uuid": "b9944bb0-b10b-427a-8fb4-5d3b51eec679", "lastupdated": 1639105319291, "platform": "x86_64", "state": "green", "host-name": "vm12", "uptime-date": 1638953400000, "latitude": "37.666684", "system-ip": "172.16.255.22", "personality": "vmanage", "status": "normal", "board-serial": "12345963", "validity": "valid", "certificate-validity": "Valid", "max-controllers": "0", "device-model": "vmanage", "deviceId": "172.16.255.22", "layoutLevel": 1, "testbed_mode": true, "device-os": "next", "isDeviceGeoData": false, "connectedVManages": [ "172.16.255.22" ], "longitude": "-122.777023", "reachability": "reachable", "statusOrder": 4 } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write" } }, "/device/cflowd/template": { "get": { "tags": [ "Monitoring - Cflowd" ], "description": "Get cflowd template from device", "operationId": "createCflowdTemplate", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Cflowd template": { "description": "Cflowd template", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write" } }, "/device/cfm/mp/database": { "get": { "tags": [ "Real-Time Monitoring - CFM" ], "description": "Get mp database from device", "operationId": "getMpDatabase", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Mp database": { "description": "Mp database", "value": { "data": [ { "defect": "defect-none", "flag": "rmep-flag-none", "vdevice-dataKey": "172.16.255.11", "vdevice-name": "172.16.255.11", "level": "7", "service": "UNINET_VERLEANDROVALLE-17_5005", "domain": "UNINET", "local-mep-id": "1562", "lastupdated": 1648692601592, "remote-mep-id": "1561", "vdevice-host-name": "vm1" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write,System-read,System-write" } }, "/device/cfm/mp/local/mep": { "get": { "tags": [ "Real-Time Monitoring - CFM" ], "description": "Get mp local mep from device", "operationId": "getMpLocalMep", "parameters": [ { "name": "domain", "in": "query", "description": "Domain Name", "schema": { "type": "string" } }, { "name": "service", "in": "query", "description": "Service Name", "schema": { "type": "string" } }, { "name": "mep-id", "in": "query", "description": "MEP ID", "schema": { "type": "number" } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Mp local mep": { "description": "Mp local mep", "value": { "data": [ { "svc-type": "cfm-svc-bd-vlan", "offload-success": "false", "vdevice-name": "172.16.255.11", "level": "7", "offload": "false", "ccm-mode": "ccm-mode-multicast", "dir": "mep-direction-down", "vdevice-host-name": "vm1", "svc-inst": "0", "mep-id": "1562", "vdevice-dataKey": "172.16.255.11-UNINET-UNINET_VERLEANDROVALLE-17_5005-1562", "vlan": "112", "port": "GigabitEthernet3", "evc-name": "UNINET_VERLEANDROVALLE-17_5005", "service": "UNINET_VERLEANDROVALLE-17_5005", "ccm-state": "ccm-enabled", "domain": "UNINET", "lastupdated": 1648692897652, "mac-addr": "52:54:00:fb:57:42" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write,System-read,System-write" } }, "/device/cfm/mp/local/mip": { "get": { "tags": [ "Real-Time Monitoring - CFM" ], "description": "Get mp local mip from device", "operationId": "getMpLocalMip", "parameters": [ { "name": "level", "in": "query", "description": "Level", "schema": { "type": "number" } }, { "name": "port", "in": "query", "description": "Port", "schema": { "type": "string" } }, { "name": "svc-inst", "in": "query", "description": "Service Instance", "schema": { "type": "number" } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Mp local mip": { "description": "Mp local mip", "value": { "data": [ { "vdevice-name": "172.16.255.11", "vdevice-host-name": "vm1", "level": "7", "port": "GigabitEthernet3", "svc-inst": "0", "mac-addr": "52:54:00:fb:57:42", "bd-id": "1562", "svc-type": "cfm-svc-bd-vlan", "source-static": "Dynamic", "manual": "*", "vdevice-dataKey": "172.16.255.11-UNINET-UNINET_VERLEANDROVALLE-17_5005-1562", "lastupdated": 1648692897652 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write,System-read,System-write" } }, "/device/cfm/mp/remotemep": { "get": { "tags": [ "Real-Time Monitoring - CFM" ], "description": "Get mp remote mep from device", "operationId": "getMpRemoteMep", "parameters": [ { "name": "domain", "in": "query", "description": "Domain Name", "schema": { "type": "string" } }, { "name": "service", "in": "query", "description": "Service Name", "schema": { "type": "string" } }, { "name": "local-mep-id", "in": "query", "description": "Local MEP ID", "schema": { "type": "number" } }, { "name": "remote-mep-id", "in": "query", "description": "Remote MEP ID", "schema": { "type": "number" } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Mp remote mep": { "description": "Mp remote mep", "value": { "data": [ { "svc-type": "cfm-svc-bd-vlan", "vdevice-name": "172.16.255.11", "level": "7", "remote-mep-id": "1561", "if-status": "if-status-up", "vdevice-host-name": "vm1", "port-status": "port-status-up", "svc-inst": "0", "vdevice-dataKey": "172.16.255.11-UNINET-UNINET_VERLEANDROVALLE-17_5005-1562-1561", "vlan": "112", "evc-name": "UNINET_VERLEANDROVALLE-17_5005", "service": "UNINET_VERLEANDROVALLE-17_5005", "rdi": "false", "domain": "UNINET", "up-time": "2022-03-31T02:24:16.459+00:00", "local-mep-id": "1562", "lastupdated": 1648693001718, "mac-addr": "52:54:00:aa:65:ba", "ingress-if": "GigabitEthernet3" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write,System-read,System-write" } }, "/device/cloudx/application/detail": { "get": { "tags": [ "Real-Time Monitoring - CloudExpress" ], "description": "Get list of cloudexpress applications from device (Real Time)", "operationId": "createApplicationsDetailList", "parameters": [ { "name": "vpn-id", "in": "query", "description": "VPN Id", "schema": { "type": "string", "enum": [ "0", "512" ] } }, { "name": "application", "in": "query", "description": "Application", "schema": { "type": "string" } }, { "name": "query", "in": "query", "description": "Query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Cloudexpress applications detail": { "description": "Cloudexpress applications detail", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "vpn-id": 1, "application": "office365", "app-name": "Exchange", "exit-type": "local", "gateway-system-ip": "10.1.15.13", "interface": "GigabitEthernet1", "latency": 1, "loss": 5, "local-color": "lte", "remote-color": "lte", "vanalytics-score": 11, "lastupdated": 1660727547133 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/cloudx/applications": { "get": { "tags": [ "Real-Time Monitoring - CloudExpress" ], "description": "Get list of cloudexpress applications from device (Real Time)", "operationId": "createApplicationsList", "parameters": [ { "name": "vpn-id", "in": "query", "description": "VPN Id", "schema": { "type": "string", "enum": [ "0", "512" ] } }, { "name": "application", "in": "query", "description": "Application", "schema": { "type": "string" } }, { "name": "query", "in": "query", "description": "Query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Cloudexpress applications": { "description": "Cloudexpress applications", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "vpn-id": 1, "application": "amazon_aws", "exit-type": "gateway", "gateway-system-ip": "10.1.15.13", "interface": "GigabitEthernet1", "latency": 1, "loss": 40, "local-color": "lte", "remote-color": "lte", "lastupdated": 660244459596 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/cloudx/gatewayexits": { "get": { "tags": [ "Real-Time Monitoring - CloudExpress" ], "description": "Get list of cloudexpress gateway exits from device (Real Time)", "operationId": "createGatewayExitsList", "parameters": [ { "name": "vpn-id", "in": "query", "description": "VPN Id", "schema": { "type": "string", "enum": [ "0", "512" ] } }, { "name": "application", "in": "query", "description": "Application", "schema": { "type": "string" } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Cloudexpress gateway exits": { "description": "Cloudexpress gateway exits", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "vpn-id": 1, "application": "amazon_aws", "gateway-ip": "10.1.15.13", "latency": 1, "loss": 0, "local-color": "lte", "remote-color": "lte", "lastupdated": 660244459596 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/cloudx/loadbalance": { "get": { "tags": [ "Real-Time Monitoring - CloudExpress" ], "description": "Get list of cloudexpress load balance applications from device (Real Time)", "operationId": "createLbApplicationsList", "parameters": [ { "name": "vpn-id", "in": "query", "description": "VPN Id", "schema": { "type": "string", "enum": [ "0", "512" ] } }, { "name": "application", "in": "query", "description": "Application", "schema": { "type": "string" } }, { "name": "query", "in": "query", "description": "Query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Cloudexpress load-balance applications-lb": { "description": "Cloudexpress load-balance applications-lb", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "vpn-id": 10, "application": "office365", "interface": "GigabitEthernet1", "exit-type": "local", "gateway-system-ip": "10.0.1.2", "latency": 1, "loss": 5, "local-color": "lte", "remote-color": "lte", "lastupdated": 1660727547133 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/cloudx/localexits": { "get": { "tags": [ "Real-Time Monitoring - CloudExpress" ], "description": "Get list of cloudexpress local exits from device (Real Time)", "operationId": "createLocalExitsList", "parameters": [ { "name": "vpn-id", "in": "query", "description": "VPN Id", "schema": { "type": "string", "enum": [ "0", "512" ] } }, { "name": "application", "in": "query", "description": "Application", "schema": { "type": "string" } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Cloudexpress local exits": { "description": "Cloudexpress local exits", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "vpn-id": 1, "application": "office365 ", "interface": "GigabitEthernet1", "latency": 1, "loss": 43, "lastupdated": 1660727547133 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/config": { "get": { "tags": [ "Monitoring - Device Details" ], "description": "Get device running configuration", "operationId": "getDeviceRunningConfig", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device Id list", "required": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "string" }, "examples": { "Device running configuration": { "description": "Device running configuration" } } }, "text/xml": { "schema": { "type": "string" }, "examples": { "Device running configuration": { "description": "Device running configuration" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/config/html": { "get": { "tags": [ "Monitoring - Device Details" ], "description": "Get device running configuration in HTML format", "operationId": "getDeviceRunningConfigHTML", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device Id list", "required": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Success", "content": { "text/html": { "schema": { "type": "string" }, "examples": { "Device running configuration": { "description": "Device running configuration" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/device/configuration/commit-list": { "get": { "tags": [ "Real-Time Monitoring - Commit List" ], "description": "Get device commit list", "operationId": "getDeviceConfigurationCommitList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device commit list": { "description": "Device commit list", "value": { "data": [ { "time-stamp": "2022-03-1006:53:10", "vdevice-dataKey": "172.16.255.11-0-10032", "vdevice-name": "172.16.255.11", "client": "system", "lastupdated": 1646900329409, "sn": "0", "id": "10032", "user": "system-vdaemon", "vdevice-host-name": "vm1" }, { "time-stamp": "2022-03-1006:48:02", "vdevice-dataKey": "172.16.255.11-1-10031", "vdevice-name": "172.16.255.11", "client": "netconf", "lastupdated": 1646900329409, "sn": "1", "id": "10031", "user": "vmanage-admin", "vdevice-host-name": "vm1" }, { "time-stamp": "2022-03-1006:47:42", "vdevice-dataKey": "172.16.255.11-2-10030", "vdevice-name": "172.16.255.11", "client": "cli", "lastupdated": 1646900329409, "sn": "2", "id": "10030", "user": "admin", "vdevice-host-name": "vm1" }, { "time-stamp": "2022-03-1006:28:31", "vdevice-dataKey": "172.16.255.11-3-10026", "vdevice-name": "172.16.255.11", "client": "system", "lastupdated": 1646900329409, "sn": "3", "id": "10026", "user": "system-vdaemon", "vdevice-host-name": "vm1" }, { "time-stamp": "2022-03-1006:23:22", "vdevice-dataKey": "172.16.255.11-4-10025", "vdevice-name": "172.16.255.11", "client": "netconf", "lastupdated": 1646900329409, "sn": "4", "id": "10025", "user": "vmanage-admin", "vdevice-host-name": "vm1" }, { "time-stamp": "2022-03-1006:02:22", "vdevice-dataKey": "172.16.255.11-5-10024", "vdevice-name": "172.16.255.11", "client": "netconf", "lastupdated": 1646900329409, "sn": "5", "id": "10024", "user": "vmanage-admin", "vdevice-host-name": "vm1" }, { "time-stamp": "2022-03-1005:56:46", "vdevice-dataKey": "172.16.255.11-6-10023", "vdevice-name": "172.16.255.11", "client": "system", "lastupdated": 1646900329409, "sn": "6", "id": "10023", "user": "system-vdaemon", "vdevice-host-name": "vm1" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/control/affinity/config": { "get": { "tags": [ "Real-Time Monitoring - Device Control" ], "description": "Get affinity config from device (Real Time)", "operationId": "getAffinityConfig", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Affinity config": { "description": "Affinity config", "value": { "data": [ { "vdevice-dataKey": "169.254.10.10--0", "vdevice-name": "169.254.10.10", "affc-ccl": "0(2)Y", "affc-equil": "Yes", "affc-ecl": "0(2)", "affc-index": "0", "lastupdated": 1642746599493, "affc-interface": "ge0/1", "affc-last-resort": "No", "vdevice-host-name": "vm3", "affc-ervc": "2" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Security-read,Security-write" } }, "/device/control/affinity/status": { "get": { "tags": [ "Real-Time Monitoring - Device Control" ], "description": "Get affinity status from device (Real Time)", "operationId": "getAffinityStatus", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Affinity status": { "description": "Affinity status", "value": { "data": [ { "affs-acc": "172.16.253.129(0),172.16.255.130(0)", "vdevice-dataKey": "169.254.10.10--0", "vdevice-name": "169.254.10.10", "affs-index": "0", "lastupdated": 1642746754330, "vdevice-host-name": "vm3", "affs-interface": "ge0/1" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Security-read,Security-write" } }, "/device/control/connections": { "get": { "tags": [ "Real-Time Monitoring - Device Control" ], "description": "Get connections list from device (Real Time)", "operationId": "createRealTimeConnectionList_RealTimeMonitoringDeviceControl_2703", "parameters": [ { "name": "peer-type", "in": "query", "description": "Peer type", "schema": { "type": "string", "enum": [ "vedge", "vsmart", "vmanage", "vbond" ] } }, { "name": "system-ip", "in": "query", "description": "Peer system IP", "schema": { "type": "string" } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Connections list": { "description": "Connections list", "value": { "data": [ { "domain-id": 1, "instance": 0, "vdevice-name": "169.254.10.10", "behind-proxy": "No", "system-ip": "172.16.253.129", "remote-color": "default", "site-id": 129, "private-port": 12346, "controller-group-id": 0, "vdevice-host-name": "vm3", "local-color": "default", "uptime": "0:05:55:35", "peer-type": "vsmart", "v-org-name": "vIPtela Inc Regression", "protocol": "dtls", "vdevice-dataKey": "169.254.10.10-0-default-172.16.253.129-default", "public-ip": "10.103.129.129", "public-port": 12346, "lastupdated": 1642727162594, "state": "up", "private-ip": "10.103.129.129", "uptime-date": 1642705800000 }, { "domain-id": 1, "instance": 0, "vdevice-name": "169.254.10.10", "behind-proxy": "No", "system-ip": "172.16.255.130", "remote-color": "default", "site-id": 130, "private-port": 12346, "controller-group-id": 0, "vdevice-host-name": "vm3", "local-color": "default", "uptime": "0:05:55:35", "peer-type": "vsmart", "v-org-name": "vIPtela Inc Regression", "protocol": "dtls", "vdevice-dataKey": "169.254.10.10-0-default-172.16.255.130-default", "public-ip": "10.103.130.130", "public-port": 12346, "lastupdated": 1642727162594, "state": "up", "private-ip": "10.103.130.130", "uptime-date": 1642705800000 }, { "domain-id": 0, "instance": 0, "vdevice-name": "169.254.10.10", "behind-proxy": "No", "system-ip": "169.254.10.3", "remote-color": "default", "site-id": 202, "private-port": 12346, "controller-group-id": 0, "vdevice-host-name": "vm3", "local-color": "default", "uptime": "0:05:55:35", "peer-type": "vmanage", "v-org-name": "vIPtela Inc Regression", "protocol": "dtls", "vdevice-dataKey": "169.254.10.10-0-default-169.254.10.3-default", "public-ip": "10.103.202.202", "public-port": 12346, "lastupdated": 1642727162594, "state": "up", "private-ip": "10.103.202.202", "uptime-date": 1642705800000 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Security-read,Security-write,Device Monitoring-read,Device Monitoring-write" } }, "/device/control/connectionshistory": { "get": { "tags": [ "Real-Time Monitoring - Device Control" ], "description": "Get connections history list from device (Real Time)", "operationId": "createConnectionHistoryListRealTime", "parameters": [ { "name": "peer-type", "in": "query", "description": "Peer type", "schema": { "type": "string", "enum": [ "vedge", "vsmart", "vmanage", "vbond" ] } }, { "name": "system-ip", "in": "query", "description": "Peer system IP", "schema": { "type": "string" } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Connections list": { "description": "Connections list", "value": { "data": [ { "instance": 0, "vdevice-name": "169.254.10.10", "remote_enum-desc": "No Error.", "system-ip": "0.0.0.0", "remote-color": "default", "site-id": 0, "uuid": "d7e88eac-250c-4189-bc66-747615452ad9", "peer-type": "vbond", "protocol": "dtls", "state": "tear_down", "private-ip": "10.103.135.135", "local_enum-desc": "Disconnect vBond after register reply.", "domain-id": 0, "rep-count": 0, "index": 0, "private-port": 12346, "vdevice-host-name": "vm3", "vh-org-name": "vIPtela Inc Regression", "local-color": "default", "downtime": "2022-01-20T19:10:43+0000", "vdevice-dataKey": "169.254.10.10-0-0-2022-01-20T19:10:43+0000", "public-ip": "10.103.135.135", "downtime-date": 1642705843000, "remote_enum": "NOERR", "public-port": 12346, "lastupdated": 1642727714927, "local_enum": "DISCVBD" }, { "instance": 0, "vdevice-name": "169.254.10.10", "remote_enum-desc": "No Error.", "system-ip": "169.254.10.3", "remote-color": "default", "site-id": 202, "uuid": "387d8bf3-5306-41fe-9090-7ee61c91d9c3", "peer-type": "vmanage", "protocol": "dtls", "state": "tear_down", "private-ip": "10.103.202.202", "local_enum-desc": "TLOC Disabled.", "domain-id": 0, "rep-count": 0, "index": 1, "private-port": 12346, "vdevice-host-name": "vm3", "vh-org-name": "vIPtela Inc Regression", "local-color": "biz-internet", "downtime": "2022-01-20T19:10:24+0000", "vdevice-dataKey": "169.254.10.10-0-1-2022-01-20T19:10:24+0000", "public-ip": "10.103.202.202", "downtime-date": 1642705824000, "remote_enum": "NOERR", "public-port": 12346, "lastupdated": 1642727714927, "local_enum": "DISTLOC" }, { "instance": 0, "vdevice-name": "169.254.10.10", "remote_enum-desc": "No Error.", "system-ip": "172.16.255.130", "remote-color": "default", "site-id": 130, "uuid": "fca7532b-9366-466a-a8f9-79922392917b", "peer-type": "vsmart", "protocol": "dtls", "state": "tear_down", "private-ip": "10.103.130.130", "local_enum-desc": "TLOC Disabled.", "domain-id": 1, "rep-count": 0, "index": 2, "private-port": 12346, "vdevice-host-name": "vm3", "vh-org-name": "vIPtela Inc Regression", "local-color": "biz-internet", "downtime": "2022-01-20T19:10:24+0000", "vdevice-dataKey": "169.254.10.10-0-2-2022-01-20T19:10:24+0000", "public-ip": "10.103.130.130", "downtime-date": 1642705824000, "remote_enum": "NOERR", "public-port": 12346, "lastupdated": 1642727714927, "local_enum": "DISTLOC" }, { "instance": 0, "vdevice-name": "169.254.10.10", "remote_enum-desc": "No Error.", "system-ip": "169.254.10.3", "remote-color": "default", "site-id": 202, "uuid": "387d8bf3-5306-41fe-9090-7ee61c91d9c3", "peer-type": "vmanage", "protocol": "dtls", "state": "tear_down", "private-ip": "10.103.202.202", "local_enum-desc": "TLOC Disabled.", "domain-id": 0, "rep-count": 0, "index": 5, "private-port": 12346, "vdevice-host-name": "vm3", "vh-org-name": "vIPtela Inc Regression", "local-color": "default", "downtime": "2022-01-20T19:09:22+0000", "vdevice-dataKey": "169.254.10.10-0-5-2022-01-20T19:09:22+0000", "public-ip": "10.103.202.202", "downtime-date": 1642705762000, "remote_enum": "NOERR", "public-port": 12346, "lastupdated": 1642727714927, "local_enum": "DISTLOC" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Security-read,Security-write" } }, "/device/control/connectionsinfo": { "get": { "tags": [ "Real-Time Monitoring - Device Control" ], "description": "Get connections list from device (Real Time)", "operationId": "createRealTimeConnectionList_RealTimeMonitoringDeviceControl_3103", "parameters": [ { "name": "peer-type", "in": "query", "description": "Peer type", "schema": { "type": "string", "enum": [ "vedge", "vsmart", "vmanage", "vbond" ] } }, { "name": "system-ip", "in": "query", "description": "Peer system IP", "schema": { "type": "string" } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Connections list": { "description": "Connections list", "value": { "data": [ { "vdevice-dataKey": "172.16.255.11---", "vdevice-name": "172.16.255.11", "rate": "Per-Control Connection Rate: 300 pps", "lastupdated": 1646962973344, "vdevice-host-name": "vm1" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Security-read,Security-write,Device Monitoring-read,Device Monitoring-write" } }, "/device/control/count": { "get": { "tags": [ "Real-Time Monitoring - Device Control" ], "description": "Get number of vedges and vsmart device in different control states", "operationId": "getTotalCountForDeviceStates", "parameters": [ { "name": "isCached", "in": "query", "description": "Device State cached", "schema": { "type": "boolean", "default": false } }, { "name": "site-id", "in": "query", "description": "Optional site ID to filter devices", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device state count": { "description": "Device state count", "value": { "data": [ { "name": "ControlStatus", "count": 7, "detailsURL": "", "status": "error", "statusList": [ { "name": "Controlup", "status": "up", "message": "devicesup", "detailsURL": "/dataservice/device/control/networksummary?state=up", "count": 7 }, { "name": "Partial", "status": "warning", "message": "devicesdown", "detailsURL": "/dataservice/device/control/networksummary?state=partial", "count": 0 }, { "name": "Controldown", "status": "error", "message": "devicesdown", "detailsURL": "/dataservice/device/control/networksummary?state=down", "count": 0 } ] } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/control/links": { "get": { "tags": [ "Real-Time Monitoring - Device Control" ], "description": "Get connections list", "operationId": "createLinkList", "parameters": [ { "name": "state", "in": "query", "description": "Device State", "required": true, "schema": { "type": "string", "example": "up" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Connections list": { "description": "Connections list", "value": { "data": [ { "state": "up", "color1": "default", "color2": "default", "lastupdated": "1646912547015", "linkKey": "172.16.255.19:default-172.16.255.26:default", "linkKeyDisplay": "172.16.255.19(default)-172.16.255.26(default)", "adeviceId": "172.16.255.26", "bdeviceId": "172.16.255.19", "asystem-ip": "172.16.255.26", "bsystem-ip": "172.16.255.19", "asite-id": "--", "bsite-id": "100", "ahost-name": "vm16", "bhost-name": "vm9", "apersonality": "vbond", "bpersonality": "vsmart" }, { "state": "up", "color1": "default", "color2": "default", "lastupdated": "1646912512113", "linkKey": "172.16.255.20:default-172.16.255.26:default", "linkKeyDisplay": "172.16.255.20(default)-172.16.255.26(default)", "adeviceId": "172.16.255.26", "bdeviceId": "172.16.255.20", "asystem-ip": "172.16.255.26", "bsystem-ip": "172.16.255.20", "asite-id": "--", "bsite-id": "200", "ahost-name": "vm16", "bhost-name": "vm10", "apersonality": "vbond", "bpersonality": "vsmart" }, { "state": "up", "color1": "default", "color2": "default", "lastupdated": "1646912347752", "linkKey": "172.16.255.22:default-172.16.255.26:default", "linkKeyDisplay": "172.16.255.22(default)-172.16.255.26(default)", "adeviceId": "172.16.255.26", "bdeviceId": "172.16.255.22", "asystem-ip": "172.16.255.26", "bsystem-ip": "172.16.255.22", "asite-id": "--", "bsite-id": "200", "ahost-name": "vm16", "bhost-name": "vm12", "apersonality": "vbond", "bpersonality": "vmanage" }, { "state": "up", "color1": "lte", "color2": "default", "lastupdated": "1646912547013", "linkKey": "172.16.255.14:lte-172.16.255.19:default", "linkKeyDisplay": "172.16.255.14(lte)-172.16.255.19(default)", "adeviceId": "172.16.255.14", "bdeviceId": "172.16.255.19", "asystem-ip": "172.16.255.14", "bsystem-ip": "172.16.255.19", "asite-id": "400", "bsite-id": "100", "ahost-name": "vm4", "bhost-name": "vm9", "apersonality": "vedge", "bpersonality": "vsmart" }, { "state": "up", "color1": "lte", "color2": "default", "lastupdated": "1646912512112", "linkKey": "172.16.255.14:lte-172.16.255.20:default", "linkKeyDisplay": "172.16.255.14(lte)-172.16.255.20(default)", "adeviceId": "172.16.255.14", "bdeviceId": "172.16.255.20", "asystem-ip": "172.16.255.14", "bsystem-ip": "172.16.255.20", "asite-id": "400", "bsite-id": "200", "ahost-name": "vm4", "bhost-name": "vm10", "apersonality": "vedge", "bpersonality": "vsmart" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/control/localproperties": { "get": { "tags": [ "Real-Time Monitoring - Device Control" ], "description": "Get local properties list (Real Time)", "operationId": "createLocalPropertiesListListRealTIme", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Local properties list": { "description": "Local properties list", "value": { "data": [ { "certificate-not-valid-before": "Jan 26 07:37:47 2022 GMT", "site-id": "100", "protocol": "dtls", "root-ca-chain-status": "Installed", "certificate-not-valid-after": "Jan 26 07:37:47 2023 GMT", "dns-name": "vbond", "vdevice-host-name": "vm1", "port-hopped": "TRUE", "device-role": "edge-router", "certificate-status": "Installed", "device-type": "vedge", "uuid": "a555e577-d513-4768-a695-93574a15f5cc", "sp-organization-name": "vIPtela Inc Regression", "lastupdated": 1643348428058, "region-id-set": "N/A", "keygen-interval": "1:00:00:00", "domain-id": "1", "time-since-port-hop": "1:21:43:52", "system-ip": "172.16.255.11", "board-serial": "12346580", "certificate-validity": "Valid", "max-controllers": "0", "tls-port": "0", "organization-name": "vIPtela Inc Regression", "vdevice-name": "172.16.255.11", "vsmart-list-version": "0", "number-vbond-peers": "0", "vdevice-dataKey": "172.16.255.11", "token": "Invalid", "number-active-wan-interfaces": "1", "register-interval": "0:00:00:30", "retry-interval": "0:00:00:15" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Security-read,Security-write" } }, "/device/control/networksummary": { "get": { "tags": [ "Real-Time Monitoring - Device Control" ], "description": "Get list of unreachable devices", "operationId": "networkSummary", "parameters": [ { "name": "state", "in": "query", "description": "Device State", "schema": { "type": "string", "example": "up" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "list of unreachable devices": { "description": "list of unreachable devices", "value": { "data": [ { "device-model": "vedge-cloud", "ompPeers": "2", "number-vsmart-peers": 2, "local-system-ip": "172.16.255.21", "system-ip": "172.16.255.21", "host-name": "vm11", "site-id": "100", "version": "20.9.999-1766", "uuid": "2b57ef1a-5eb2-4d8d-8676-cce19b56b26b", "board-serial": "12345962", "bfdSessions": "3", "device-type": "vedge", "lastupdated": 1646917368708, "reachability": "reachable", "controlConnections": "3", "uptime-date": 1646908860000, "controlConnectionsToVsmarts": "2" }, { "device-model": "vedge-cloud", "ompPeers": "2", "number-vsmart-peers": 2, "local-system-ip": "172.16.255.11", "system-ip": "172.16.255.11", "host-name": "vm1", "site-id": "100", "version": "20.9.999-1766", "uuid": "84d1ab4e-0cbf-4369-a290-08fafeb80f95", "board-serial": "12345974", "bfdSessions": "3", "device-type": "vedge", "lastupdated": 1646967284462, "reachability": "reachable", "controlConnections": "3", "uptime-date": 1646909100000, "controlConnectionsToVsmarts": "2" }, { "device-model": "vsmart", "ompPeers": "6", "number-vsmart-peers": 1, "local-system-ip": "172.16.255.19", "system-ip": "172.16.255.19", "host-name": "vm9", "site-id": "100", "version": "20.9.999-1766", "uuid": "9abd3af9-9087-497d-8b99-8fd0a7baa3f2", "board-serial": "12345967", "device-type": "vsmart", "lastupdated": 1646967277159, "reachability": "reachable", "controlConnections": "9", "uptime-date": 1646908920000, "controlConnectionsToVsmarts": "1" }, { "device-model": "vsmart", "ompPeers": "6", "number-vsmart-peers": 1, "local-system-ip": "172.16.255.20", "system-ip": "172.16.255.20", "host-name": "vm10", "site-id": "200", "version": "20.9.999-1766", "uuid": "43ba3223-9df7-4cc9-a059-a12e5382d79d", "board-serial": "12345961", "device-type": "vsmart", "lastupdated": 1646967275863, "reachability": "reachable", "controlConnections": "9", "uptime-date": 1646908860000, "controlConnectionsToVsmarts": "1" }, { "device-model": "vedge-cloud", "ompPeers": "2", "number-vsmart-peers": 2, "local-system-ip": "172.16.255.14", "system-ip": "172.16.255.14", "host-name": "vm4", "site-id": "400", "version": "20.9.999-1766", "uuid": "a66335c5-451f-4b93-a752-4116d688f347", "board-serial": "12345970", "bfdSessions": "4", "device-type": "vedge", "lastupdated": 1646967282559, "reachability": "reachable", "controlConnections": "3", "uptime-date": 1646908980000, "controlConnectionsToVsmarts": "2" }, { "device-model": "vedge-C8000V", "ompPeers": "2", "number-vsmart-peers": 2, "local-system-ip": "172.16.255.15", "system-ip": "172.16.255.15", "host-name": "vm5", "site-id": "500", "version": "17.09.01.0.154453", "uuid": "C8K-8bda7a5d-6b75-47ec-a658-b30ca54e30eb", "board-serial": "12345703", "bfdSessions": "4", "device-type": "vedge", "lastupdated": 1646967275462, "reachability": "reachable", "controlConnections": "3", "uptime-date": 1646909400000, "controlConnectionsToVsmarts": "2" }, { "device-model": "vedge-C8000V", "ompPeers": "2", "number-vsmart-peers": 2, "local-system-ip": "172.16.255.16", "system-ip": "172.16.255.16", "host-name": "vm6", "site-id": "600", "version": "17.09.01.0.154453", "uuid": "C8K-46aa4ddc-7468-45c2-9144-2d60c2f553f3", "board-serial": "12345702", "bfdSessions": "4", "device-type": "vedge", "lastupdated": 1646967277103, "reachability": "reachable", "controlConnections": "3", "uptime-date": 1646909400000, "controlConnectionsToVsmarts": "2" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/control/regionconnections": { "get": { "tags": [ "Real-Time Monitoring - Device Control" ], "description": "Get connections list from device (Real Time)", "operationId": "createRealTimeRegionConnectionList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Region Connections list": { "description": "Region Connections list", "value": "{ \"data\":[ { \"instance\":0, \"site-id\":129, \"domain-id\":1, \"vdevice-name\":\"169.254.10.10\", \"vdevice-host-name\":\"vm3\", \"local-private-ip\":\"10.103.129.129\", \"local-private-port\":12346, \"public-ip\":\"10.103.129.129\", \"public-port\":12346, \"region-idx\":1, \"peer-system-ip\":\"172.16.253.129\", \"color\":\"default\", \"lastupdated\":1642727162594, } ]}" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Security-read,Security-write,Device Monitoring-read,Device Monitoring-write" } }, "/device/control/statistics": { "get": { "tags": [ "Real-Time Monitoring - Device Control" ], "description": "Get connection statistics from device (Real Time)", "operationId": "getConnectionStatistics", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Connection statistics": { "description": "Connection statistics", "value": { "data": [ { "rx_challenge": "14", "challenge_failures": "0", "vdevice-name": "169.254.10.10", "tx_dtls_handshake": "21", "tx_register_replies": "0", "rx_challenge_ack": "14", "tx_octets": "24918292", "rx_registers": "0", "tx_dtls_handshake_failures": "7", "tx_vmanage_to_peer": "0", "tx_pkts": "330231", "tx_blocked": "0", "tx_dtls_handshake_done": "14", "rx_octets": "50924456", "tx_error": "0", "bid_failures_needing_reset": "0", "rx_error": "0", "rx_dtls_handshake_done": "0", "tx_challenge_ack_error": "0", "rx_challenge_resp": "0", "tx_challenge_error": "0", "tx_challenge_resp_error": "0", "tx_register_to_vmanage": "4", "tx_challenge": "0", "rx_connects": "0", "tx_registers": "15", "rx_pkts": "347847", "tx_connects": "0", "tx_challenge_gen_error": "0", "rx_register_to_vmanage": "0", "vdevice-host-name": "vm3", "tx_hello": "212412", "tx_challenge_ack": "0", "rx_hello": "212399", "tx_challenge_resp": "14", "rx_dtls_handshake": "0", "vdevice-dataKey": "169.254.10.10", "lastupdated": 1642730071268, "rx_dtls_handshake_failures": "0", "rx_register_replies": "15", "rx_vmanage_to_peer": "4" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Security-read,Security-write" } }, "/device/control/status": { "get": { "tags": [ "Real-Time Monitoring - Device Control" ], "description": "Get local device status", "operationId": "getLocalDeviceStatus", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Local device status": { "description": "Local device status", "value": { "data": [ { "type": "control", "name": "Control", "image": "images/control.png", "count": 0, "detailView": "dialog", "detailsURL": "/dataservice/device/control/links", "statusList": [ { "status": "up", "icon": "images/connection/connection-network-up.png", "color": "b0e276", "name": "up", "detailView": "dialog", "detailsURL": "/dataservice/device/control/links?state=up", "count": 0 }, { "status": "down", "icon": "images/connection/connection-network-down.png", "color": "fa7c7d", "name": "down", "detailView": "dialog", "detailsURL": "/dataservice/device/control/links?state=down", "count": 0 } ] } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/control/summary": { "get": { "tags": [ "Real-Time Monitoring - Device Control" ], "description": "Get connections summary from device (Real Time)", "operationId": "createConnectionsSummary", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Connections summary": { "description": "Connections summary", "value": { "data": [ { "instance": 0, "vdevice-dataKey": "172.16.255.14-0", "vdevice-name": "172.16.255.14", "vmanage_counts": 1, "lastupdated": 1588603863504, "vsmart_counts": 2, "vbond_counts": 0, "vdevice-host-name": "vm4" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Security-read,Security-write" } }, "/device/control/summary/device": { "get": { "tags": [ "Real-Time Monitoring - Device Control" ], "description": "Get device control status summary", "operationId": "getDeviceControlStatusSummary", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device control status summary": { "description": "Device control status summary", "value": { "data": [ { "name": "ControlConnection", "count": 3, "detailsURL": "", "status": "error", "statusList": [ { "name": "up", "message": "3up", "detailsURL": "/dataservice/device/control/connection?deviceId=172.16.255.11&state=up", "count": 3 } ] } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/control/synced/connections": { "get": { "tags": [ "Real-Time Monitoring - Device Control" ], "description": "Get connections list from vManage", "operationId": "createSyncedConnectionList", "parameters": [ { "name": "peer-type", "in": "query", "description": "Peer type", "schema": { "type": "string", "enum": [ "vedge", "vsmart", "vmanage", "vbond" ] } }, { "name": "system-ip", "in": "query", "description": "Peer system IP", "schema": { "type": "string" } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Connections list": { "description": "Connections list", "value": { "data": [ { "instance": 0, "vdevice-name": "172.16.255.11", "system-ip": "172.16.255.19", "remote-color": "default", "site-id": 100, "controller-group-id": 0, "peer-type": "vsmart", "shared-region-id-set": "N/A", "protocol": "dtls", "@rid": 1060, "state": "up", "private-ip": "10.0.5.19", "domain-id": 1, "behind-proxy": "No", "createTimeStamp": 1646912557634, "private-port": 12455, "vdevice-host-name": "vm1", "local-color": "lte", "v-org-name": "vIPtelaIncRegression", "vdevice-dataKey": "172.16.255.11-0-lte-172.16.255.19-default", "vmanage-system-ip": "172.16.255.11", "public-ip": "10.0.5.19", "public-port": 12455, "lastupdated": 1646967283468, "uptime-date": 1646967180000 }, { "instance": 0, "vdevice-name": "172.16.255.11", "system-ip": "172.16.255.20", "remote-color": "default", "site-id": 200, "controller-group-id": 0, "peer-type": "vsmart", "shared-region-id-set": "N/A", "protocol": "dtls", "@rid": 1063, "state": "up", "private-ip": "10.0.12.20", "domain-id": 1, "behind-proxy": "No", "createTimeStamp": 1646912560801, "private-port": 12456, "vdevice-host-name": "vm1", "local-color": "lte", "v-org-name": "vIPtelaIncRegression", "vdevice-dataKey": "172.16.255.11-0-lte-172.16.255.20-default", "vmanage-system-ip": "172.16.255.11", "public-ip": "10.0.12.20", "public-port": 12456, "lastupdated": 1646967283468, "uptime-date": 1646967180000 }, { "instance": 0, "vdevice-name": "172.16.255.11", "system-ip": "172.16.255.22", "remote-color": "default", "site-id": 200, "controller-group-id": 0, "peer-type": "vmanage", "protocol": "dtls", "@rid": 1068, "state": "up", "private-ip": "10.0.12.22", "domain-id": 0, "behind-proxy": "No", "createTimeStamp": 1646912562214, "private-port": 12446, "vdevice-host-name": "vm1", "local-color": "lte", "v-org-name": "vIPtelaIncRegression", "vdevice-dataKey": "172.16.255.11-0-lte-172.16.255.22-default", "vmanage-system-ip": "172.16.255.11", "public-ip": "10.0.12.22", "public-port": 12446, "lastupdated": 1646967283468, "uptime-date": 1646967180000 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Security-read,Security-write,Device Monitoring-read,Device Monitoring-write" } }, "/device/control/synced/localproperties": { "get": { "tags": [ "Real-Time Monitoring - Device Control" ], "description": "Get local properties list", "operationId": "createLocalPropertiesSyncedList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Local properties list": { "description": "Local properties list", "value": { "data": [ { "retry-interval": "0:00:00:16", "vdevice-name": "172.16.255.11", "device-role": "edge-router", "tls-port": "0", "max-controllers": "0", "system-ip": "172.16.255.11", "certificate-not-valid-before": "Mar1011:16:192022GMT", "site-id": "100", "certificate-not-valid-after": "Mar1011:16:192023GMT", "uuid": "84d1ab4e-0cbf-4369-a290-08fafeb80f95", "number-active-wan-interfaces": "1", "protocol": "dtls", "board-serial": "12345974", "vsmart-list-version": "0", "@rid": 1071, "certificate-status": "Installed", "device-type": "vedge", "port-hopped": "TRUE", "organization-name": "vIPtelaIncRegression", "domain-id": "1", "root-ca-chain-status": "Installed", "dns-name": "vbond", "createTimeStamp": 1646912563392, "sp-organization-name": "vIPtelaIncRegression", "vdevice-host-name": "vm1", "register-interval": "0:00:00:30", "token": "Invalid", "keygen-interval": "1:00:00:00", "vdevice-dataKey": "172.16.255.11", "certificate-validity": "Valid", "vmanage-system-ip": "172.16.255.11", "lastupdated": 1646963388706, "number-vbond-peers": "2" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Security-read,Security-write" } }, "/device/control/synced/waninterface": { "get": { "tags": [ "Real-Time Monitoring - Device Control" ], "description": "Get WAN interface list", "operationId": "createWanInterfaceSyncedList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "WAN interface list": { "description": "WAN interface list", "value": { "data": [ { "instance": 0, "low-bandwidth-link": "No", "color": "lte", "vdevice-name": "172.16.255.11", "nat-type": "N", "admin-state": "up", "interface": "ge0/2", "restrict-str": "no", "@rid": 1077, "private-ipv6": "::", "private-ip": "10.0.5.11", "per-wan-max-controllers": 2, "num-vsmarts": 2, "num-vmanages": 1, "preference": "0", "createTimeStamp": 1646912567192, "weight": 1, "index": 0, "private-port": 12407, "vdevice-host-name": "vm1", "vbond-as-stun-server": "no", "control-str": "yes", "carrier": "default", "last-resort": "No", "vdevice-dataKey": "172.16.255.11-0-0", "vmanage-connection-preference": "5", "vmanage-system-ip": "172.16.255.11", "public-ip": "10.0.5.11", "operation-state": "up", "public-port": 12407, "region-id": "Default", "lastupdated": 1646967283812, "wan-port-hopped": "TRUE" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Security-read,Security-write" } }, "/device/control/validdevices": { "get": { "tags": [ "Real-Time Monitoring - Device Control" ], "description": "Get vmanage valid device list (Real Time)", "operationId": "createValidDevicesListRealTime", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Device list": { "description": "Device list", "value": { "data": [ { "chassis-number": "00D132A6-F3D2-40BA-862B-A6D1A83EFAEA", "vdevice-dataKey": "172.16.255.22-00D132A6-F3D2-40BA-862B-A6D1A83EFAEA-12346574", "vdevice-name": "172.16.255.22", "serial-number": "12346574", "lastupdated": 1649645323938, "vdevice-host-name": "vm12" }, { "chassis-number": "C8K-299C77FA-B7B2-4644-BCF1-E15BC635194F", "vdevice-dataKey": "172.16.255.22-C8K-299C77FA-B7B2-4644-BCF1-E15BC635194F-12345703", "vdevice-name": "172.16.255.22", "serial-number": "12345703", "lastupdated": 1649645323938, "vdevice-host-name": "vm12" }, { "chassis-number": "C8K-9150A7F6-73E6-45BD-B14E-0A8F98A580F7", "vdevice-dataKey": "172.16.255.22-C8K-9150A7F6-73E6-45BD-B14E-0A8F98A580F7-12345705", "vdevice-name": "172.16.255.22", "serial-number": "12345705", "lastupdated": 1649645323938, "vdevice-host-name": "vm12" }, { "chassis-number": "C8K-A9DF16AA-14C2-4B60-8D65-05957111879E", "vdevice-dataKey": "172.16.255.22-C8K-A9DF16AA-14C2-4B60-8D65-05957111879E-12345967", "vdevice-name": "172.16.255.22", "serial-number": "12345967", "lastupdated": 1649645323938, "vdevice-host-name": "vm12" }, { "chassis-number": "C8K-D6E53254-74C7-4504-B8A7-50FBBC37073A", "vdevice-dataKey": "172.16.255.22-C8K-D6E53254-74C7-4504-B8A7-50FBBC37073A-12345707", "vdevice-name": "172.16.255.22", "serial-number": "12345707", "lastupdated": 1649645323938, "vdevice-host-name": "vm12" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Security-read,Security-write" } }, "/device/control/validvmanageid": { "get": { "tags": [ "Real-Time Monitoring - Device Control" ], "description": "Get valid vManage from device (Real Time)", "operationId": "getValidVManageIdRealTime", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "vManage": { "description": "vManage", "value": { "data": [ { "chassis-number": "387d8bf3-5306-41fe-9090-7ee61c91d9c3", "vdevice-dataKey": "169.254.10.10-", "vdevice-name": "169.254.10.10", "lastupdated": 1642746085123, "vdevice-host-name": "vm3" }, { "chassis-number": "59ddeeef-24ad-4bd3-9e55-f9760b640970", "vdevice-dataKey": "169.254.10.10-", "vdevice-name": "169.254.10.10", "lastupdated": 1642746085123, "vdevice-host-name": "vm3" }, { "chassis-number": "c0fd955c-7e0d-4b90-9626-55684f69a899", "vdevice-dataKey": "169.254.10.10-", "vdevice-name": "169.254.10.10", "lastupdated": 1642746085123, "vdevice-host-name": "vm3" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Security-read,Security-write" } }, "/device/control/validvsmarts": { "get": { "tags": [ "Real-Time Monitoring - Device Control" ], "description": "Get valid vSmart list from device (Real Time)", "operationId": "createValidVSmartsListRealTime", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "vSmart list": { "description": "vSmart list", "value": { "data": [ { "vdevice-dataKey": "169.254.10.10-12345701", "vdevice-name": "169.254.10.10", "serial-number": "12345701", "lastupdated": 1642743541771, "vdevice-host-name": "vm3" }, { "vdevice-dataKey": "169.254.10.10-12345702", "vdevice-name": "169.254.10.10", "serial-number": "12345702", "lastupdated": 1642743541771, "vdevice-host-name": "vm3" }, { "vdevice-dataKey": "169.254.10.10-12345703", "vdevice-name": "169.254.10.10", "serial-number": "12345703", "lastupdated": 1642743541771, "vdevice-host-name": "vm3" }, { "vdevice-dataKey": "169.254.10.10-12345704", "vdevice-name": "169.254.10.10", "serial-number": "12345704", "lastupdated": 1642743541771, "vdevice-host-name": "vm3" }, { "vdevice-dataKey": "169.254.10.10-12345705", "vdevice-name": "169.254.10.10", "serial-number": "12345705", "lastupdated": 1642743541771, "vdevice-host-name": "vm3" }, { "vdevice-dataKey": "169.254.10.10-12345706", "vdevice-name": "169.254.10.10", "serial-number": "12345706", "lastupdated": 1642743541771, "vdevice-host-name": "vm3" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Security-read,Security-write" } }, "/device/control/waninterface": { "get": { "tags": [ "Real-Time Monitoring - Device Control" ], "description": "Get WAN interface list (Real Time)", "operationId": "createWanInterfaceListList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "WAN interface list": { "description": "WAN interface list", "value": { "data": [ { "instance": 0, "low-bandwidth-link": "No", "color": "default", "vdevice-name": "169.254.10.10", "nat-type": "N", "admin-state": "up", "interface": "ge0/1", "restrict-str": "no", "private-ipv6": "::", "private-ip": "10.101.3.3", "per-wan-max-controllers": 2, "num-vsmarts": 2, "num-vmanages": 1, "preference": "0", "wan-time-since-port-hop": "0:11:14:02", "spi-change": "0:00:45:59", "index": 0, "weight": 1, "private-port": 12386, "last-conn-time": "0:11:13:42", "vbond-as-stun-server": "no", "vdevice-host-name": "vm3", "control-str": "yes", "carrier": "default", "vmanage-connection-preference": "5", "last-resort": "No", "vdevice-dataKey": "169.254.10.10-0-0", "public-ip": "10.101.3.3", "operation-state": "up", "public-port": 12386, "lastupdated": 1642746267569, "last-conn-time-date": 1642705800000, "wan-port-hopped": "TRUE" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Security-read,Security-write" } }, "/device/control/waninterface/color": { "get": { "tags": [ "Real-Time Monitoring - Device Control" ], "description": "Get port hop colors", "operationId": "getPortHopColor", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device port hop colors": { "description": "Device port hop colors", "value": { "data": [ { "color": "lte" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/counters": { "get": { "tags": [ "Monitoring - Device Details" ], "description": "Get device counters", "operationId": "getDeviceCounters", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "crashCount": { "type": "integer", "format": "int32", "example": 0 }, "expectedControlConnections": { "type": "integer", "format": "int32", "example": 3 }, "number-vsmart-control-connections": { "type": "integer", "format": "int32", "example": 3 }, "rebootCount": { "type": "integer", "format": "int32", "example": 2 }, "system-ip": { "type": "string" } }, "$$ref": "#/components/schemas/DeviceCountersData" } }, "header": { "type": "object", "properties": { "generatedOn": { "type": "integer", "format": "int64", "example": 1635224742597 } }, "$$ref": "#/components/schemas/DeviceResponseHeader" } }, "$$ref": "#/components/schemas/DeviceCountersResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/crashlog": { "get": { "tags": [ "Real-Time Monitoring - Crash Log" ], "description": "Get device crash logs from device", "operationId": "getDeviceCrashLogs", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device crash logs": { "description": "Device crash logs", "value": { "data": [ { "core-time": "Tue Feb 15 04:14:38 UTC 2022", "vdevice-dataKey": "169.254.10.12-0", "vdevice-name": "169.254.10.12", "index": 0, "lastupdated": 1645064726542, "core-filename": "vm5_htx_19219_20220215-041430-UTC.core.gz", "core-time-date": 1644898478000, "vdevice-host-name": "vm5" }, { "core-time": "Tue Feb 15 04:15:24 UTC 2022", "vdevice-dataKey": "169.254.10.12-1", "vdevice-name": "169.254.10.12", "index": 1, "lastupdated": 1645064726542, "core-filename": "vm5_htx_19539_20220215-041515-UTC.core.gz", "core-time-date": 1644898524000, "vdevice-host-name": "vm5" }, { "core-time": "Tue Feb 15 05:55:04 UTC 2022", "vdevice-dataKey": "169.254.10.12-2", "vdevice-name": "169.254.10.12", "index": 2, "lastupdated": 1645064726542, "core-filename": "vm5_htx_30530_20220215-055452-UTC.core.gz", "core-time-date": 1644904504000, "vdevice-host-name": "vm5" }, { "core-time": "Tue Feb 15 05:55:50 UTC 2022", "vdevice-dataKey": "169.254.10.12-3", "vdevice-name": "169.254.10.12", "index": 3, "lastupdated": 1645064726542, "core-filename": "vm5_htx_31380_20220215-055542-UTC.core.gz", "core-time-date": 1644904550000, "vdevice-host-name": "vm5" }, { "core-time": "Tue Feb 15 06:21:52 UTC 2022", "vdevice-dataKey": "169.254.10.12-4", "vdevice-name": "169.254.10.12", "index": 4, "lastupdated": 1645064726542, "core-filename": "vm5_htx_26426_20220215-062140-UTC.core.gz", "core-time-date": 1644906112000, "vdevice-host-name": "vm5" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Device Monitoring-read,Device Monitoring-write,Device Reboot-read,Device Reboot-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read,Software Upgrade-read,Software Upgrade-write,dca" } }, "/device/crashlog/details": { "get": { "tags": [ "Real-Time Monitoring - Crash Log" ], "description": "Get device crash logs for all device", "operationId": "getAllDeviceCrashLogs", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device crash logs": { "description": "Device crash logs", "value": { "data": [ { "core-time": "MonMay908:25:21UTC2022", "vdevice-name": "172.16.255.11", "index": 8, "lastupdated": 1652085255804, "core-filename": "vm1-system-report_20220509-082507-UTC.tar.gz", "core-time-date": 1652084721000, "vdevice-host-name": "vm1" }, { "core-time": "MonMay910:36:57UTC2022", "vdevice-name": "172.16.255.15", "index": 7, "lastupdated": 1652093038703, "core-filename": "vm5-system-report_20220509-103645-UTC.tar.gz", "core-time-date": 1652092617000, "vdevice-host-name": "vm5" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Device Monitoring-read,Device Monitoring-write,Device Reboot-read,Device Reboot-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read,Software Upgrade-read,Software Upgrade-write" } }, "/device/crashlog/log": { "get": { "tags": [ "Real-Time Monitoring - Crash Log" ], "description": "Get device crash info from device", "operationId": "getDeviceCrashInformation", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } }, { "name": "filename", "in": "query", "description": "Crash file name", "required": true, "schema": { "type": "string", "example": "vm1-system-report_20220509-082507-UTC.tar.gz" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "string" }, "examples": { "Device crash info": { "description": "Device crash info", "value": "/bootflash/.prst_sync/reload_info\n/bootflash/pd_info/\n/bootflash/pd_info/system_report_trigger.log\n/bootflash/pd_info/free_mb_output-20220509-082405-UTC.log\n/bootflash/pd_info/proc_cpuinfo-20220509-082405-UTC.log\n/bootflash/pd_info/proc_stat-20220509-082405-UTC.log\n/bootflash/pd_info/topnmemuse_output-20220509-082405-UTC.log\n/bootflash/pd_info/smap_output-20220509-082405-UTC.log\n/bootflash/pd_info/proc_interrupts-20220509-082405-UTC.log\n/bootflash/pd_info/proc_timer_list-20220509-082405-UTC.log\n/bootflash/pd_info/dmesg_output-20220509-082405-UTC.log\n/bootflash/pd_info/df_output-20220509-082405-UTC.log\n/bootflash/pd_info/proc_sched_debug-20220509-082405-UTC.log\n/bootflash/pd_info/proc_meminfo-20220509-082405-UTC.log\n/bootflash/pd_info/proc_loadavg-20220509-082405-UTC.log\n/bootflash/pd_info/top_output-20220509-082405-UTC.log\n/tmp/vm1-bootuplog-20220509-082507-UTC.log\n/tmp/cyan/cyan.log\n/tmp/tdlresolve/epoch_dir/\n/tmp/tdlresolve/epoch_dir/active\n/tmp/tdlresolve/epoch_dir/rp1current\n/tmp/tdlresolve/epoch_dir/rp0current\n/tmp/tdlresolve/epoch_dir/2022_05_09_05_04_5173.epoch\n/tmp/fp/trace/fman_fp_image_pman_F0-0.16083_2.20220509082503.bin\n/tmp/fp/trace/cpp_cp_svr_pman_F0-0.17117_2.20220509082454.bin\n/tmp/fp/trace/cpp_sp_svr_pman_F0-0.16525_2.20220509082431.bin\n/tmp/fp/trace/btman_F0-0.17522_1.20220509081731.bin\n/tmp/fp/trace/fman_fp_F0-0.16106_1.20220509070441.bin\n/tmp/fp/trace/cpp_cp_F0-0.17128_0.20220509050616.bin\n/tmp/fp/trace/btman_pman_F0-0.17512_1.20220509050615.bin\n/tmp/fp/trace/cman_fp_F0-0.17317_0.20220509050615.bin\n/tmp/fp/trace/cman_fp_pman_F0-0.17307_1.20220509050615.bin\n/tmp/fp/trace/cpp_cp_svr_pman_F0-0.17117_1.20220509050614.bin\n/tmp/fp/trace/cpp_driver_F0-0.16917_0.20220509050613.bin\n/tmp/fp/trace/cpp_driver_pman_F0-0.16904_1.20220509050612.bin\n/tmp/fp/trace/cpp_ha_F0-0.16736_0.20220509050612.bin\n/tmp/fp/trace/cpp_ha_top_level_server_pman_F0-0.16727_1.20220509050612.bin\n/tmp/fp/trace/cpp_sp_F0-0.16538_0.20220509050611.bin\n/tmp/fp/trace/cpp_sp_svr_pman_F0-0.16525_1.20220509050611.bin\n/tmp/fp/trace/qfpxucodexcxkv_F0-0.16334_0.20220509050611.bin\n/tmp/fp/trace/qfp_ucode_cxkv_pman_F0-0.16321_1.20220509050610.bin\n/tmp/fp/trace/fman_fp_image_pman_F0-0.16083_1.20220509050609.bin\n/tmp/fp/trace/pvp_F0-0.15610_0.20220509050607.bin\n/tmp/rp/trace/flashutil_R0-0.9480_0.20220509082506.bin\n/tmp/rp/trace/ndbmand_R0-0.20343_2.20220509082506.bin\n/tmp/rp/trace/ndbmand_R0-0.20343_1.20220509082506.bin\n/tmp/rp/trace/dmiauthd_pman_R0-0.20704_2.20220509082441.bin\n/tmp/rp/trace/dmiauthd_R0-0.20711_1.20220509082440.bin\n/tmp/rp/trace/cxpd_pman_R0-0.26162_2.20220509082431.bin\n/tmp/rp/trace/cfgmgr_pman_R0-0.23017_2.20220509082431.bin\n/tmp/rp/trace/ftmd_pman_R0-0.26542_2.20220509082431.bin\n/tmp/rp/trace/dbgd_pman_R0-0.26285_12.20220509082430.bin\n/tmp/rp/trace/ncsshd_bp_R0-0.20977_19.20220509082427.bin\n/tmp/rp/trace/ncsshd_bp_R0-0.20977_18.20220509082427.bin\n/tmp/rp/trace/plogd_R0-0.6454_15.20220509082427.bin\n/tmp/rp/trace/nginx_pman_R0-0.23917_3.20220509082420.bin\n/tmp/rp/trace/nginx_pman_R0-0.23917_2.20220509082420.bin\n/tmp/rp/trace/ofa_pman_R0-0.6786_1.20220509082414.bin\n/tmp/rp/trace/sessmgrd_pman_R0-0.14700_1.20220509082413.bin\n/tmp/rp/trace/install_mgr_pman_R0-0.16776_1.20220509082413.bin\n/tmp/rp/trace/flashutil_R0-0.6969_0.20220509082357.bin\n/tmp/rp/trace/brelay_R0-0.5073_0.20220509082312.bin\n/tmp/rp/trace/droputil_R0-0.7228_41.20220509082309.bin\n/tmp/rp/trace/vdaemon_pman_R0-0.23139_27.20220509082256.bin\n/tmp/rp/trace/brelay_R0-0.32610_0.20220509082120.bin\n/tmp/rp/trace/flashutil_R0-0.31555_0.20220509082116.bin\n/tmp/rp/trace/brelay_R0-0.28844_0.20220509082045.bin\n/tmp/rp/trace/in_telnetd_R0-0.28714_0.20220509082044.bin\n/tmp/rp/trace/plogd_R0-0.6454_14.20220509081556.bin\n/tmp/rp/trace/utd_R0-0.21164_0.20220509081511.bin\n/tmp/rp/trace/brelay_R0-0.17059_0.20220509081122.bin\n/tmp/rp/trace/IOSRP_R0-0.5718_7.20220509080821.bin\n/tmp/rp/trace/brelay_R0-0.12315_0.20220509080810.bin\n/tmp/rp/trace/in_telnetd_R0-0.12179_0.20220509080808.bin\n/tmp/rp/trace/brelay_R0-0.9102_0.20220509080557.bin\n/tmp/rp/trace/in_telnetd_R0-0.8987_0.20220509080557.bin\n/tmp/rp/trace/dbgd_pman_R0-0.26285_11.20220509080429.bin\n/tmp/rp/trace/utd_R0-0.5943_0.20220509080401.bin\n/tmp/rp/trace/brelay_R0-0.5873_0.20220509080400.bin\n/tmp/rp/trace/in_telnetd_R0-0.5740_0.20220509080359.bin\n/tmp/rp/trace/brelay_R0-0.4593_0.20220509080339.bin\n/tmp/rp/trace/in_telnetd_R0-0.4475_0.20220509080338.bin\n/tmp/rp/trace/ncsshd_bp_R0-0.20977_17.20220509080331.bin\n/tmp/rp/trace/netconfxsubsys_R0-0.25635_0.20220509075716.bin\n/tmp/rp/trace/ncsshd_R0-0.25630_0.20220509075714.bin\n/tmp/rp/trace/ncsshd_R0-0.23604_0.20220509075527.bin\n/tmp/rp/trace/ncsshd_R0-0.20871_0.20220509075321.bin\n/tmp/rp/trace/utd_R0-0.20557_0.20220509075306.bin\n/tmp/rp/trace/utf_R0-0.9196_1.20220509074907.bin\n/tmp/rp/trace/IOSRP_R0-0.5718_6.20220509074231.bin\n/tmp/rp/trace/btman_R0-0.9196_1.20220509072434.bin\n/tmp/rp/trace/vdaemon_R0-0.23144_1.20220509070058.bin\n/tmp/rp/trace/fman_rp_R0-0.7340_1.20220509065929.bin\n/tmp/rp/trace/ttm_R0-0.26803_0.20220509050940.bin\n/tmp/rp/trace/ttmd_pman_R0-0.26797_1.20220509050939.bin\n/tmp/rp/trace/ompd_R0-0.26673_0.20220509050939.bin\n/tmp/rp/trace/ompd_pman_R0-0.26667_1.20220509050938.bin\n/tmp/rp/trace/ftmd_R0-0.26547_0.20220509050937.bin\n/tmp/rp/trace/ftmd_pman_R0-0.26542_1.20220509050937.bin\n/tmp/rp/trace/fpmd_R0-0.26411_0.20220509050937.bin\n/tmp/rp/trace/fpmd_pman_R0-0.26405_1.20220509050936.bin\n/tmp/rp/trace/dbgd_R0-0.26292_0.20220509050936.bin\n/tmp/rp/trace/cxpd_R0-0.26200_0.20220509050936.bin\n/tmp/rp/trace/cxpd_pman_R0-0.26162_1.20220509050933.bin\n/tmp/rp/trace/nginx_pman_R0-0.23917_1.20220509050911.bin\n/tmp/rp/trace/cfgmgr_R0-0.23065_0.20220509050811.bin\n/tmp/rp/trace/cfgmgr_pman_R0-0.23017_1.20220509050809.bin\n/tmp/rp/trace/linux_iosd_image_pman_R0-0.5705_2.20220509050747.bin\n/tmp/rp/trace/vip_confd_startup_sh_pman_R0-0.21463_0.20220509050629.bin\n/tmp/rp/trace/ncsshd_R0-0.21219_0.20220509050628.bin\n/tmp/rp/trace/ncsshd_pman_R0-0.21213_0.20220509050628.bin\n/tmp/rp/trace/pubd_R0-0.20002_0.20220509050628.bin\n/tmp/rp/trace/pvp_R0-0.5111_1.20220509050628.bin\n/tmp/rp/trace/ndbmand_R0-0.20343_0.20220509050627.bin\n/tmp/rp/trace/ncsshd_bp_pman_R0-0.20969_0.20220509050627.bin\n/tmp/rp/trace/dmiauthd_pman_R0-0.20704_1.20220509050626.bin\n/tmp/rp/trace/dmiauthd_R0-0.20711_0.20220509050626.bin\n/tmp/rp/trace/inter_fru_1_255-F0-0.0.20220509050626.bin\n/tmp/rp/trace/ndbmand_pman_R0-0.20333_0.20220509050625.bin\n/tmp/rp/trace/pubd_pman_R0-0.19984_0.20220509050624.bin\n/tmp/rp/trace/pttcd_R0-0.19704_0.20220509050624.bin\n/tmp/rp/trace/pttcd_pman_R0-0.19672_0.20220509050624.bin\n/tmp/rp/trace/periodic_sh_pman_R0-0.19258_0.20220509050621.bin\n/tmp/rp/trace/sort_files_by_inode_sh_pman_R0-0.18984_0.20220509050620.bin\n/tmp/rp/trace/cedge_tanman_sh_pman_R0-0.18381_0.20220509050619.bin\n/tmp/rp/trace/reflector_R0-0.7564_1.20220509050619.bin\n/tmp/rp/trace/cli_agent_R0-0.8908_0.20220509050618.bin\n/tmp/rp/trace/cmand_R0-0.8532_0.20220509050618.bin\n/tmp/rp/trace/dbm_R0-0.8111_0.20220509050617.bin\n/tmp/rp/trace/smand_R0-0.6034_1.20220509050616.bin\n/tmp/rp/trace/emd_R0-0.7821_0.20220509050616.bin\n/tmp/rp/trace/hman_R0-0.7098_0.20220509050614.bin\n/tmp/rp/trace/install_mgr_R0-0.16783_0.20220509050612.bin\n/tmp/rp/trace/install_mgr_pman_R0-0.16776_0.20220509050612.bin\n/tmp/rp/trace/sec_key_agent_R0-0.6957_0.20220509050610.bin\n/tmp/rp/trace/lman_R0-0.16040_0.20220509050609.bin\n/tmp/rp/trace/lman_pman_R0-0.16028_1.20220509050608.bin\n/tmp/rp/trace/ofa_R0-0.6790_0.20220509050608.bin\n/tmp/rp/trace/smd_R0-0.14706_0.20220509050607.bin\n/tmp/rp/trace/repm_R0-0.6188_0.20220509050606.bin\n/tmp/rp/trace/sdavc_proxy_R0-0.15234_0.20220509050604.bin\n/tmp/rp/trace/sdavc_proxy_pman_R0-0.15219_1.20220509050604.bin\n/tmp/rp/trace/sessmgrd_pman_R0-0.14700_0.20220509050602.bin\n/tmp/rp/trace/vman_R0-0.14560_0.20220509050602.bin\n/tmp/rp/trace/vman_pman_R0-0.14542_1.20220509050601.bin\n/tmp/rp/trace/psd_R0-0.5391_0.20220509050558.bin\n/tmp/rp/trace/selinux_smu_R0-0.13554_0.20220509050556.bin\n/tmp/rp/trace/kernel_ftrace_log_R0-0.13535_0.20220509050556.bin\n/tmp/rp/trace/btman_pman_R0-0.9189_1.20220509050455.bin\n/tmp/rp/trace/bhytoolsd_R0-0.6308_0.20220509050455.bin\n/tmp/rp/trace/cli_agent_pman_R0-0.8886_0.20220509050447.bin\n/tmp/rp/trace/binos_R0-0.8442_0.20220509050436.bin\n/tmp/rp/trace/dbm_pman_R0-0.8103_0.20220509050428.bin\n/tmp/rp/trace/iptbl_R0-0.8093_0.20220509050428.bin\n/tmp/rp/trace/emd_pman_R0-0.7817_1.20220509050424.bin\n/tmp/rp/trace/fman_rp_pman_R0-0.7329_1.20220509050415.bin\n/tmp/rp/trace/hman_pman_R0-0.7093_1.20220509050413.bin\n/tmp/rp/trace/keyman_pman_R0-0.6954_1.20220509050409.bin\n/tmp/rp/trace/ofa_pman_R0-0.6786_0.20220509050405.bin\n/tmp/rp/trace/oom_R0-0.6535_0.20220509050400.bin\n/tmp/rp/trace/plogd_pman_R0-0.6432_0.20220509050357.bin\n/tmp/rp/trace/repm_pman_R0-0.6181_0.20220509050352.bin\n/tmp/rp/trace/smand_pman_R0-0.6030_1.20220509050349.bin\n/tmp/rp/trace/psd_pman_R0-0.5318_1.20220509050343.bin\n/tmp/rp/trace/psvp_R0-0.5042_0.20220509050336.bin\n/harddisk/tracelogs/cia-netconf-trace.20220509_080125.gz\n/harddisk/tracelogs/cyaninit_R0-0.5010_0.20220509050340.bin.gz\n/harddisk/tracelogs/cia-netconf-trace.20220509_072735.gz\n/harddisk/tracelogs/cia-netconf-trace.20220509_080738.gz\n/harddisk/tracelogs/dmi_ports_fetch_R0-0.19770_0.20220509050041.bin.gz\n/harddisk/tracelogs/cia-netconf-trace.20220509_075711.gz\n/harddisk/tracelogs/cia-netconf-trace.20220509_074912.gz\n/harddisk/tracelogs/cia-netconf-trace.20220509_070208.gz\n/harddisk/tracelogs/btman_rotate_immediate_R0-0.20030_0.20220509050102.bin.gz\n/harddisk/tracelogs/btman_rotate_immediate_R0-0.19856_0.20220509050042.bin.gz\n/harddisk/tracelogs/system_shell_R0-0.9105_0.20220509080558.bin\n/harddisk/tracelogs/cia-netconf-trace.20220509_073035.gz\n/harddisk/tracelogs/cia-netconf-trace.20220509_070720.gz\n/harddisk/tracelogs/cia-netconf-trace.20220509_080023.gz\n/harddisk/tracelogs/cia-netconf-trace.20220509_073738.gz\n/harddisk/tracelogs/utf_R0-0.9196_0.20220509050620.bin.gz\n/tmp/maroon_stats/pman_rp_0_7093.maroon\n/tmp/maroon_stats/pman_rp_0_20333.maroon\n/tmp/maroon_stats/pman_fp_0_16083.maroon\n/tmp/maroon_stats/pman_fp_0_17117.maroon\n/tmp/maroon_stats/pman_rp_0_20704.maroon\n/tmp/maroon_stats/pman_rp_0_21463.maroon\n/tmp/maroon_stats/pman_rp_0_14542.maroon\n/tmp/maroon_stats/pman_rp_0_21213.maroon\n/tmp/maroon_stats/pman_rp_0_26162.maroon\n/tmp/maroon_stats/pman_fp_0_16525.maroon\n/tmp/maroon_stats/pman_rp_0_26667.maroon\n/tmp/maroon_stats/pman_fp_0_16904.maroon\n/tmp/maroon_stats/pman_rp_0_26542.maroon\n/tmp/maroon_stats/pman_rp_0_23017.maroon\n/tmp/maroon_stats/pman_rp_0_26405.maroon\n/tmp/maroon_stats/pman_rp_0_26797.maroon\n/tmp/maroon_stats/pman_rp_0_6432.maroon\n/tmp/maroon_stats/pman_rp_0_20969.maroon\n/tmp/maroon_stats/pman_rp_0_23917.maroon\n/tmp/maroon_stats/pman_fp_0_16321.maroon\n/tmp/maroon_stats/pman_fp_0_17307.maroon\n/tmp/maroon_stats/pman_fp_0_16727.maroon\n/tmp/maroon_stats/pman_fp_0_17512.maroon\n/tmp/maroon_stats/pman_rp_0_5705.maroon\n/tmp/maroon_stats/pman_rp_0_6030.maroon\n/tmp/maroon_stats/pman_rp_0_5318.maroon\n/tmp/maroon_stats/pman_rp_0_19984.maroon\n/tmp/maroon_stats/pman_rp_0_19258.maroon\n/tmp/maroon_stats/pman_rp_0_7329.maroon\n/tmp/maroon_stats/pman_rp_0_8886.maroon\n/tmp/maroon_stats/pman_rp_0_6954.maroon\n/tmp/maroon_stats/pman_rp_0_6181.maroon\n/tmp/maroon_stats/pman_rp_0_6786.maroon\n/tmp/maroon_stats/pman_rp_0_9189.maroon\n/tmp/maroon_stats/pman_rp_0_8103.maroon\n/tmp/maroon_stats/pman_rp_0_7817.maroon\n/tmp/maroon_stats/pman_rp_0_14700.maroon\n/tmp/maroon_stats/pman_rp_0_15219.maroon\n/tmp/maroon_stats/pman_rp_0_18381.maroon\n/tmp/maroon_stats/pman_rp_0_18984.maroon\n/tmp/maroon_stats/pman_rp_0_16028.maroon\n/tmp/maroon_stats/pman_rp_0_16776.maroon\n/tmp/maroon_stats/pman_rp_0_19672.maroon\n/tmp/maroon_stats/pman_rp_0_8528.maroon\n/tmp/maroon_stats/rotee_rp_0_13790.maroon\n/tmp/maroon_stats/pman_rp_0_26285.maroon\n/tmp/maroon_stats/ucode_pkt_PPE0_fp_0_16334.maroon\n/tmp/maroon_stats/keyman_rp_0_6957.maroon\n/tmp/maroon_stats/fpmd_rp_0_26411.maroon\n/tmp/maroon_stats/cxpd_rp_0_26200.maroon\n/tmp/maroon_stats/dbgd_rp_0_26292.maroon\n/tmp/maroon_stats/ompd_rp_0_26673.maroon\n/tmp/maroon_stats/ttmd_rp_0_26803.maroon\n/tmp/maroon_stats/ftmd_rp_0_26547.maroon\n/tmp/maroon_stats/pman_rp_0_23139.maroon\n/tmp/maroon_stats/cfgmgr_rp_0_23065.maroon\n/tmp/maroon_stats/vdaemon_rp_0_23144.maroon\n/tmp/maroon_stats/dmiauthd_rp_0_20711.maroon\n/tmp/maroon_stats/pubd_rp_0_20002.maroon\n/tmp/maroon_stats/ndbmand_rp_0_20343.maroon\n/tmp/maroon_stats/ncsshd_bp_rp_0_20977.maroon\n/tmp/maroon_stats/rotee_FRU_SLOT_NUM_7228.maroon\n/tmp/maroon_stats/install_mgr_rp_0_16783.maroon\n/tmp/maroon_stats/lman_rp_0_16040.maroon\n/tmp/maroon_stats/btman_fp_0_17522.maroon\n/tmp/maroon_stats/cman_fp_fp_0_17317.maroon\n/tmp/maroon_stats/cpp_cp_svr_fp_0_17128.maroon\n/tmp/maroon_stats/vman_rp_0_14560.maroon\n/tmp/maroon_stats/cpp_driver_fp_0_16917.maroon\n/tmp/maroon_stats/cpp_sp_svr_fp_0_16538.maroon\n/tmp/maroon_stats/cpp_ha_top_leve_fp_0_16736.maroon\n/tmp/maroon_stats/fman_fp_image_fp_0_16106.maroon\n/tmp/maroon_stats/cli_agent_rp_0_8908.maroon\n/tmp/maroon_stats/dbm_rp_0_8111.maroon\n/tmp/maroon_stats/linux_iosd-imag_rp_0_5718.maroon\n/tmp/maroon_stats/btman_rp_0_9196.maroon\n/tmp/maroon_stats/fman_rp_rp_0_7340.maroon\n/tmp/maroon_stats/cmand_rp_0_8532.maroon\n/tmp/maroon_stats/emd_rp_0_7821.maroon\n/tmp/maroon_stats/plogd_rp_0_6454.maroon\n/tmp/maroon_stats/hman_rp_0_7098.maroon\n/tmp/maroon_stats/repm_rp_0_6188.maroon\n/tmp/maroon_stats/smand_rp_0_6034.maroon\n/tmp/maroon_stats/psd_rp_0_5391.maroon\n/tmp/maroon_stats/sessmgrd_rp_0_14706.maroon\n/var/log/audit/audit.log" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/crashlog/synced": { "get": { "tags": [ "Real-Time Monitoring - Crash Log" ], "description": "Get device crash logs synchronously from device", "operationId": "getDeviceCrashLogsSynced", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device crash logs": { "description": "Device crash logs", "value": { "data": [ { "vdevice-name": "172.16.255.11", "createTimeStamp": 1649439701737, "index": 0, "core-filename": "vm1-system-report_20220407-031603-UTC.tar.gz", "vdevice-host-name": "vm1", "core-time": "ThuApr703:16:10UTC2022", "vdevice-dataKey": "172.16.255.11-0", "@rid": 855, "vmanage-system-ip": "172.16.255.11", "lastupdated": 1649769370563, "core-time-date": 1649301370000 }, { "vdevice-name": "172.16.255.11", "createTimeStamp": 1651156427829, "index": 1, "core-filename": "vm1-system-report_20220428-124017-UTC.tar.gz", "vdevice-host-name": "vm1", "core-time": "ThuApr2812:40:32UTC2022", "vdevice-dataKey": "172.16.255.11-1", "@rid": 1224, "vmanage-system-ip": "172.16.255.11", "lastupdated": 1651156427519, "core-time-date": 1651149632000 }, { "vdevice-name": "172.16.255.11", "createTimeStamp": 1651156431854, "index": 2, "core-filename": "vm1-system-report_20220428-125006-UTC.tar.gz", "vdevice-host-name": "vm1", "core-time": "ThuApr2812:50:11UTC2022", "vdevice-dataKey": "172.16.255.11-2", "@rid": 1225, "vmanage-system-ip": "172.16.255.11", "lastupdated": 1651156427519, "core-time-date": 1651150211000 }, { "vdevice-name": "172.16.255.11", "createTimeStamp": 1651708111493, "index": 4, "core-filename": "vm1_ftmd_25306_20220504-112749-UTC.core.gz", "vdevice-host-name": "vm1", "core-time": "WedMay411:28:57UTC2022", "vdevice-dataKey": "172.16.255.11-4", "@rid": 1250, "vmanage-system-ip": "172.16.255.11", "lastupdated": 1651708111141, "core-time-date": 1651663737000 }, { "vdevice-name": "172.16.255.11", "createTimeStamp": 1651505130582, "index": 3, "core-filename": "vm1-system-report_20220504-040557-UTC.tar.gz", "vdevice-host-name": "vm1", "core-time": "WedMay404:06:43UTC2022", "vdevice-dataKey": "172.16.255.11-3", "@rid": 1463, "vmanage-system-ip": "172.16.255.11", "lastupdated": 1651637687479, "core-time-date": 1651637203000 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Device Monitoring-read,Device Monitoring-write,Device Reboot-read,Device Reboot-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read,Software Upgrade-read,Software Upgrade-write" } }, "/device/csp/containers/container": { "get": { "tags": [ "Real-Time Monitoring - Container Lifecycle" ], "description": "Get device container from device (Real Time)", "operationId": "createDeviceContainersInfo", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "device container": { "description": "device container", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "name": "ISRV", "uuid": "C8K-8f8cc50c-b05b-4a60-956b-5bdd8e79e5c0", "memory": "4096", "numcpu": "4", "disk_size": "4096", "image-name": "example.tar.gz", "container_type": "virtual", "port": "22", "state": "running", "error": "NA", "uptime": "4:20:09:2", "cpu_load": "2", "disk_used_mb": "2048", "memory_used_kb": "8192", "ip-address": "192.168.30.163", "ip-address-configured": "false", "netmask": "255.255.255.0", "default-gw": "127.0.1.254", "bridge": "ovs-data-br", "lastupdated": 1660244459596 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/csp/pnic": { "get": { "tags": [ "Real-Time Monitoring - RBAC" ], "description": "Get pnic interfaces from device", "operationId": "getPnicStats", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "PNIC interfaces": { "description": "PNIC interfaces", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "name": "eth0", "operational-speed": "1G", "operational-duplex": "full-duplex", "autoneg": "auto", "member_of": "pc", "link_state": "up", "lldp": "enabled", "mac_address": "d8:b1:90:ff:f5:88", "vdevice-dataKey": "172.16.255.15", "mtu": "900", "refcnt": "110", "bytes": "1469476983", "packets": "17749881", "errors": "0", "dropped": "0", "broadcast": "14159834", "multicast": "2889066", "tx-bytes": "198318715", "tx-packets": "272603", "tx-errors": "0", "tx-dropped": "0", "tx-broadcast": "14156964", "tx-multicast": "2888574", "lastupdated": 1661501479353, "pkt-capture": "ICMP" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Interface-read,Interface-write" } }, "/device/csp/pnic/synced": { "get": { "tags": [ "Real-Time Monitoring - RBAC" ], "description": "Get pnic stats from device", "operationId": "getPNICStatsFromDevice", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "PNIC stats": { "description": "PNIC stats", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "name": "eth0", "operational-speed": "1G", "operational-duplex": "full-duplex", "autoneg": "auto", "member_of": "pc", "link_state": "up", "lldp": "enabled", "mac_address": "d8:b1:90:ff:f5:88", "vdevice-dataKey": "172.16.255.15", "mtu": "900", "refcnt": "110", "bytes": "1469476983", "packets": "17749881", "errors": "0", "dropped": "0", "broadcast": "14159834", "multicast": "2889066", "tx-bytes": "198318715", "tx-packets": "272603", "tx-errors": "0", "tx-dropped": "0", "tx-broadcast": "14156964", "tx-multicast": "2888574", "lastupdated": 1661501479353, "pkt-capture": "ICMP" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Security-read,Security-write,Device Monitoring-read,Device Monitoring-write" } }, "/device/csp/rbac": { "get": { "tags": [ "Real-Time Monitoring - RBAC" ], "description": "Get RBAC interfaces from device", "operationId": "getRBACInterface", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device RBAC interface": { "description": "Device RBAC interface", "value": { "data": [ { "vdevice-name": "172.16.255.11", "vdevice-host-name": "vm1", "name": "rbac_user", "password": "Nbv12345", "role": "network-admin", "active": "true", "last_5_passwords": "Nbv12345", "last-login-ts": "21:43:28 UTC Mon Aug 27 2022", "lastupdated": 1661501479353, "vdevice-dataKey": "172.16.255.11" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Interface-read,Interface-write" } }, "/device/csp/resources/cpu-info/allocation": { "get": { "tags": [ "Real-Time Monitoring - NetworkHub Resources" ], "description": "Get NetworkHub CPU allocation info from device", "operationId": "getAllocationInfo", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "NetworkHub CPU allocation info": { "description": "NetworkHub CPU allocation info", "value": { "data": [ { "vdevice-name": "172.16.255.11", "vdevice-host-name": "vm1", "total-sockets": "1", "cores-per-socket": "8", "total-logical-cpus": "16", "logical-cpus-used-by-system": "2", "logical-cpus-used-by-vnfs": "4", "logical-cpus-used-dedicated": "12", "logical-cpus-used-sharable": "2", "lastupdated": 1661501479353, "vdevice-dataKey": "172.16.255.11" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/csp/resources/cpu-info/cpus": { "get": { "tags": [ "Real-Time Monitoring - NetworkHub Resources" ], "description": "Get NetworkHub CPU info from device", "operationId": "getCPUInfo", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "NetworkHub CPU info": { "description": "NetworkHub CPU info", "value": { "data": [ { "vdevice-name": "172.16.255.11", "vdevice-host-name": "vm1", "cpu-id": "7", "socket-id": "0", "vdevice-dataKey": "172.16.255.11", "core-id": "7", "system-use": false, "name": "ROUTER3", "vcpus": "4", "low-latency": true, "vcpu-id": "0", "lastupdated": 1661501479353 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/csp/resources/cpu-info/vnfs": { "get": { "tags": [ "Real-Time Monitoring - NetworkHub Resources" ], "description": "Get NetworkHub CPU VNF info from device", "operationId": "getVNFInfo", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "NetworkHub CPU VNF info": { "description": "NetworkHub CPU VNF info", "value": { "data": [ { "vdevice-name": "172.16.255.11", "vdevice-host-name": "vm1", "name": "ROUTER3", "vcpus": "4", "low-latency": true, "vcpu-id": "0", "socket-id": "0", "core-id": "7", "cpu-id": "7", "vdevice-dataKey": "172.16.255.11", "lastupdated": 1661501479353 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/csp/system/native": { "get": { "tags": [ "Real-Time Monitoring - System" ], "description": "Get device system native settings from device", "operationId": "createDeviceSystemSettingNativeInfo", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device system native settings": { "description": "Device system native settings", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "interface": "ge0/0", "ipv4_address": "192.168.2.1", "vdevice-dataKey": "172.16.255.15", "netmask": "255.255.255.0", "mac_address": "00:05:ad:00:10:41", "mtu": "1500", "txqueuelen": "16", "lastupdated": 1661501479353 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/csp/system/processlist": { "get": { "tags": [ "Real-Time Monitoring - System" ], "description": "Get device system process list from device", "operationId": "createDeviceSystemProcessList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device system process list": { "description": "Device system process list", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "pid": "1", "cpu": "3.5", "mem": "1,6", "vsz": "192156", "rss": "7424", "start": "Wed16", "time": "0:00.02", "vdevice-dataKey": "172.16.255.15", "cmd": "systemd", "lastupdated": 1661501479353 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/csp/system/settings": { "get": { "tags": [ "Real-Time Monitoring - System" ], "description": "Get device system settings from device", "operationId": "createDeviceSystemSetting", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device system settings": { "description": "Device system settings", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "interface": "ge0/0", "ipv4_address": "192.168.30.163", "ipv4_netmask": "255.255.255.0", "ipv4_dhcp": "enabled", "ipv4_expire": "-", "global_ipv6_address": "fe80::72db:98ff:fe07:1f35", "global_prefixlen": "0", "link_local_ipv6_address": "fe80::72db:98ff:fe07:1f35", "link_local_prefixlen": "0", "ipv6_dhcp": "enabled", "ipv6_slaac": "disabled", "vdevice-dataKey": "172.16.255.15", "ipv6_dhcp_state": "Stateful", "lastupdated": "1661501479353" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/csp/system/status": { "get": { "tags": [ "Real-Time Monitoring - System" ], "description": "Get device system status from device", "operationId": "createDeviceSystemStatus", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device system status": { "description": "Device system status", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "name": "wan-br", "status": "OK", "vdevice-dataKey": "172.16.255.15", "type": "default-bridge", "lastupdated": 1661501479353 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/ctsPac": { "get": { "tags": [ "Real-Time Monitoring - Trustsec" ], "description": "get Cisco TrustSec PAC information from device", "operationId": "getCtsPac", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "TrustSec PAC information": { "description": "TrustSec PAC information", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "pac-type": "Cisco Trustse", "authority-id": "Authority ", "initiator-id": "device1", "vdevice-dataKey": "172.16.255.15-vm5", "authority-id-info": "acs1", "pac-life-time": "13:59:27 PDT Jun 5 2022", "pac-refresh-time": "00:01:24", "pac-opaque": "000200B000030001000400101100E046659D4275B644BF946EFA49CD00060094000301008285A14CB259CA096487096D68D5F34D000000014C09A6AA00093A808ACA80B39EB656AF0BCA91F3564DF540447A11F9ECDFA4AEC3A193769B80066832495B8C40F6B5B46B685A68411B7DF049A32F2B03F89ECF948AC4BB85CF855CA186BEF8E2A8C69A7C0BE1BDF6EC27D826896A31821A7BA523C8BD90072CB8A8D0334F004D4B627D33001B0519D41738F7EDDF3A" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write" } }, "/device/devicestatus": { "get": { "tags": [ "Monitoring - Device Details" ], "description": "Get devices status per type", "operationId": "getDeviceOnlyStatus", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "example": 0 }, "detailsURL": { "type": "string", "example": "/dataservice/device?personality=vbond&status=error" }, "image": { "type": "string", "example": "images/vsmart.png" }, "name": { "type": "string", "example": "vSmart" }, "statusList": { "type": "array", "items": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "object", "properties": { "count": { "type": "integer", "format": "int64" }, "message": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" } }, "$$ref": "#/components/schemas/StatusObject" }, "$$ref": "#/components/schemas/StatusList" } }, "type": { "type": "string", "example": "vSmart" } }, "$$ref": "#/components/schemas/DeviceStatusData" }, "examples": { "Device Status": { "description": "Device Status", "value": "[\n {\n \"type\": \"vSmart\",\n \"name\": \"vSmart\",\n \"image\": \"images/vsmart.png\",\n \"count\": 3,\n \"detailView\": \"dialog\",\n \"detailsURL\": \"/dataservice/device?personality=vsmart\",\n \"statusList\": [\n {\n \"status\": \"error\",\n \"name\": \"Error\",\n \"detailView\": \"dialog\",\n \"detailsURL\": \"/dataservice/device?personality=vsmart&status=error\",\n \"color\": \"fa7c7d\",\n \"icon\": \"images/device/device-error.png\",\n \"count\": 0\n },\n {\n \"status\": \"warning\",\n \"name\": \"Warning\",\n \"detailView\": \"dialog\",\n \"detailsURL\": \"/dataservice/device?personality=vsmart&status=warning\",\n \"color\": \"f2ce60\",\n \"icon\": \"images/device/device-warning.png\",\n \"count\": 0\n },\n {\n \"status\": \"normal\",\n \"name\": \"Normal\",\n \"detailView\": \"dialog\",\n \"detailsURL\": \"/dataservice/device?personality=vsmart&status=normal\",\n \"color\": \"b0e276\",\n \"icon\": \"images/device/device-normal.png\",\n \"count\": 3\n },\n {\n \"status\": \"new\",\n \"name\": \"Discovered device\",\n \"detailView\": \"dialog\",\n \"detailsURL\": \"/dataservice/device?personality=vsmart&status=new\",\n \"color\": \"7c8afa\",\n \"icon\": \"images/device/device-new.png\",\n \"count\": 0\n }\n ]" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/dhcp/client": { "get": { "tags": [ "Real-Time Monitoring - DHCP" ], "description": "Get DHCP client from device (Real Time)", "operationId": "getDHCPClient", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DHCP client": { "description": "DHCP client", "value": { "data": [ { "lease-server-addr": "10.0.1.1", "state": "dhcp-client-state-bound", "if-name": "GigabitEthernet1", "dns-address-secondary": "0.0.0.0", "subnet-mask": "255.255.255.0", "client-addr": "10.0.1.5", "lease-remaining": "3143", "gateway-addr": "0.0.0.0", "dns-address": "10.0.1.1", "vdevice-dataKey": "169.254.10.12-Mgmt-intf-GigabitEthernet1", "vrf-name": "Mgmt-intf", "lastupdated": 1643101911868, "vdevice-host-name": "vm5", "vdevice-name": "169.254.10.12", "lease-time": "3600" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/dhcp/interface": { "get": { "tags": [ "Real-Time Monitoring - DHCP" ], "description": "Get DHCP interfaces from device (Real Time)", "operationId": "getDHCPInterface", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DHCP interfaces": { "description": "DHCP interfaces", "value": { "data": [ { "server": "10.0.1.1", "vdevice-dataKey": "169.254.10.10-512-eth0", "lease-time": "0:01:00:00", "vdevice-name": "169.254.10.10", "ifname": "eth0", "acquired-ip": "10.0.1.3/24", "dns": "10.0.1.1", "lastupdated": 1643013783968, "time-remaining": "0:00:31:25", "state": "bound", "vpn-id": "512", "vdevice-host-name": "vm3" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/dhcp/server": { "get": { "tags": [ "Real-Time Monitoring - DHCP" ], "description": "Get DHCP server from device (Real Time)", "operationId": "getDHCPServer", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DHCP server": { "description": "DHCP server", "value": { "data": [ { "vdevice-dataKey": "169.254.10.9-10-ge0/0-", "vdevice-name": "169.254.10.9", "ifname": "ge0/0", "lastupdated": 1655094784187, "vpn-id": "10", "vdevice-host-name": "vm2" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/dhcpv6/interface": { "get": { "tags": [ "Real-Time Monitoring - DHCP" ], "description": "Get DHCPv6 interfaces from device", "operationId": "getDHCPv6Interface", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device DHCP v6 interface": { "description": "Device DHCP v6 interface", "value": { "data": [ { "vdevice-dataKey": "169.254.10.10-512-eth0", "vdevice-name": "169.254.10.10", "ifname": "eth0", "lastupdated": 1646099652315, "state": "init", "vpn-id": "512", "vdevice-host-name": "vm3" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/dns/defense/device-registration": { "get": { "tags": [ "Real-Time Monitoring - Dns Defense" ], "description": "Get Dns Defense Device Registration", "operationId": "getDnsDefenseDeviceRegistration", "parameters": [ { "name": "deviceId", "in": "query", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "array", "items": { "required": [ "descr", "device-id", "lastupdated", "ni-name", "resp-code", "tag", "vdevice-dataKey", "vdevice-host-name", "vdevice-name" ], "type": "object", "properties": { "descr": { "type": "string", "example": "Device Id received successfully" }, "device-id": { "type": "string", "example": "f338f11b041b85ce" }, "lastupdated": { "type": "integer", "format": "int64", "example": 1717400936511 }, "ni-name": { "type": "string", "example": "222" }, "resp-code": { "type": "string", "example": "dns-def-rc-201" }, "tag": { "type": "string", "example": "vpn222" }, "vdevice-dataKey": { "type": "string", "example": "172.16.255.15-222-vpn222-f338f11b041b85ce-dns-def-rc-201" }, "vdevice-host-name": { "type": "string", "example": "vm5" }, "vdevice-name": { "type": "string", "example": "172.16.255.15" } }, "$$ref": "#/components/schemas/DeviceRegistrationItem" } } }, "$$ref": "#/components/schemas/DeviceRegistrationResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/dns/defense/info": { "get": { "tags": [ "Real-Time Monitoring - Dns Defense" ], "description": "Get Dns Defense Info", "operationId": "getDnsDefenseInfo", "parameters": [ { "name": "deviceId", "in": "query", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "array", "items": { "required": [ "dnscrypt", "last-success", "last-success-date", "lastupdated", "reg-done", "reg-req", "vdevice-dataKey", "vdevice-host-name", "vdevice-name" ], "type": "object", "properties": { "dnscrypt": { "type": "boolean", "example": true }, "last-success": { "type": "string", "example": "2025-10-29T04:11:40+00:00" }, "last-success-date": { "type": "integer", "format": "int64", "example": 1761711100000 }, "lastupdated": { "type": "integer", "format": "int64", "example": 1762499456581 }, "reg-done": { "type": "integer", "format": "int32", "example": 10 }, "reg-req": { "type": "integer", "format": "int32", "example": 10 }, "vdevice-dataKey": { "type": "string", "example": "172.16.255.15-10-10-True-2025-10-29T05:41:40+00:00" }, "vdevice-host-name": { "type": "string", "example": "vm5" }, "vdevice-name": { "type": "string", "example": "172.16.255.15" } }, "$$ref": "#/components/schemas/DnsDefenseInfoItem" } } }, "$$ref": "#/components/schemas/DnsDefenseInfoResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/dot1x/clients": { "get": { "tags": [ "Real-Time Monitoring - DOT1x" ], "description": "Get DOT1x client from device (Real Time)", "operationId": "getWLANDOT1xClients", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DOT1x client": { "description": "DOT1x client", "value": { "data": [ { "vdevice-name": "172.16.254.2", "vdevice-host-name": "vm3", "if-name": "ge0/1", "mac-address": "00:50:b6:0f:1c:84", "auth-state": "Authenticating", "auth-method": "Radius", "vlan": "12", "vpn": "-", "eap-method": "(PEAP)", "username": "admin", "session-time": "9", "connected-time": "9", "inactive-time": "0", "session-id": "57E1B641-00000001", "eapol-frames-rx": "50", "eapol-frames-tx": "50", "eapol-start-frames-rx": "50", "eapol-logoff-frames-rx": "50", "eapol-request-id-frames-tx": "50", "eapol-response-id-frames-rx": "50", "eapol-request-frames-tx": "50", "eapol-request-frames-rx": "50", "lastupdated": 1657853484627, "vdevice-dataKey": "172.16.254.2" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/dot1x/interfaces": { "get": { "tags": [ "Real-Time Monitoring - DOT1x" ], "description": "Get DOT1x interface from device (Real Time)", "operationId": "getWLANDOT1xInterfaces", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DOT1x interface": { "description": "DOT1x interface", "value": { "data": [ { "vdevice-name": "172.16.254.1", "vdevice-host-name": "vm2", "if-name": "ge0/1", "oper-state": "up", "host-mode": "Multi Auth", "ctrl-dir": "none", "mab-server": "true", "mab-local": "true", "wake-on-lan": "true", "reauth-timeout": "600", "inactivity-timeout": "3600", "guest-vlan": "11", "auth-fail-vlan": "12", "auth-reject-vlan": "13", "default-vlan": "", "primary-radius-server": "192.168.48.12", "secondary-radius-server": "192.168.48.11", "accounting-interval": "disabled", "nas-identifier": "none", "nas-ipaddr": "none", "num-clients": "1", "lastupdated": 1654066320000, "vdevice-dataKey": "172.16.254.1" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/dot1x/radius": { "get": { "tags": [ "Real-Time Monitoring - DOT1x" ], "description": "Get DOT1x Radius from device (Real Time)", "operationId": "getDOT1xRadius", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DOT1x Radius": { "description": "DOT1x Radius", "value": { "data": [ { "vdevice-name": "172.16.254.1", "vdevice-host-name": "vm2", "if-name": "ge0/1", "ip-address": "192.168.48.11", "vpn": "512", "is-primary": "true", "auth-port": "1812", "auth-is-current": "true", "auth-round-trip-time": "0", "auth-access-requests": "10", "auth-access-retransmissions": "0", "auth-access-accepts": "1", "auth-access-rejects": "0", "auth-access-challenges": "9", "auth-malformed-access-responses": "0", "auth-bad-authenticators": "0", "auth-pending-requests": "0", "auth-timeouts": "0", "auth-unknown-types": "0", "auth-packets-dropped": "0", "acct-port": "1813", "acct-is-current": "true", "acct-round-trip-time": "0", "acct-requests": "5", "acct-retransmissions": "0", "acct-responses": "2", "acct-malformed-responses": "0", "acct-bad-authenticators": "0", "acct-pending-requests": "0", "acct-timeouts": "3", "acct-unknown-types": "0", "acct-packets-dropped": "0", "vdevice-dataKey": "172.16.254.1", "lastupdated": 1654066320000 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/dpi/application-mapping": { "get": { "tags": [ "Real-Time Monitoring - DPI" ], "description": "Get DPI supported application list from device", "operationId": "getSupportedApplicationList", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "DPI supported application list": { "description": "DPI supported application list", "value": { "data": [ { "name": "an", "family": "network-service", "familyShort": "network_service", "longname": "ActiveNetworks", "appId": "861" }, { "name": "bb", "family": "network-management", "familyShort": "network_management", "longname": "Systemsandnetworkmonitoringtool", "appId": "50333632" }, { "name": "fc", "family": "network-service", "familyShort": "network_service", "longname": "FibreChannel", "appId": "16777349" }, { "name": "il", "family": "network-service", "familyShort": "network_service", "longname": "InternalLinkTransportProtocol", "appId": "16777256" }, { "name": "ns", "family": "network-service", "familyShort": "network_service", "longname": "NetworkSystems", "appId": "50332408" }, { "name": "sm", "family": "network-service", "familyShort": "network_service", "longname": "SM", "appId": "16777338" }, { "name": "st", "family": "network-service", "familyShort": "network_service", "longname": "Stream", "appId": "16777221" }, { "name": "3pc", "family": "network-service", "familyShort": "network_service", "longname": "ThirdPartyConnectProtocol", "appId": "16777250" }, { "name": "acp", "family": "network-service", "familyShort": "network_service", "longname": "AeolonCoreProtocol", "appId": "50332247" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/dpi/application/fields": { "get": { "tags": [ "Real-Time Monitoring - DPI" ], "description": "Get DPI query field from device", "operationId": "getDPIDeviceFieldJSON", "parameters": [ { "name": "isDeviceDashBoard", "in": "query", "description": "Flag whether is device dashboard request", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DPI query field": { "description": "DPI query field", "value": { "data": [ { "isRequired": true, "fieldData": { "type": "dateList" }, "dataType": "date", "property": "entry_time", "name": "EventTime", "options": [ { "enableDateFields": false, "number": "24", "value": "Last24hours", "key": "last_24_hours" }, { "enableDateFields": false, "number": "12", "value": "Last12hours", "key": "last_12_hours" }, { "enableDateFields": false, "number": "6", "value": "Last6hours", "key": "last_6_hours" }, { "enableDateFields": false, "number": "3", "value": "Last3hours", "key": "last_3_hours" }, { "enableDateFields": false, "number": "1", "value": "Last1hour", "key": "last_1_hour" }, { "enableDateFields": false, "number": "168", "value": "Last7days", "key": "last_168_hours" } ] }, { "isRequired": true, "fieldData": { "type": "url", "url": "dataservice/device/action/vpn" }, "dataType": "int", "property": "vpn_id", "name": "VPN", "multiSelect": false }, { "isRequired": true, "dataType": "string", "property": "vdevice_name", "name": "Devicename", "multiSelect": false, "isHidden": true } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/dpi/applications": { "get": { "tags": [ "Real-Time Monitoring - DPI" ], "description": "Get DPI applications from device (Real Time)", "operationId": "createDPICollectorList", "parameters": [ { "name": "vpn-id", "in": "query", "description": "VPN Id", "schema": { "type": "string", "enum": [ "0", "512" ] } }, { "name": "application", "in": "query", "description": "Application", "schema": { "type": "string" } }, { "name": "family", "in": "query", "description": "Family", "schema": { "type": "string" } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)((\\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)?$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "DPI applications": { "description": "DPI applications", "value": { "data": [ { "vdevice-name": "172.16.255.11", "vdevice-host-name": "vm1", "vpn-id": "1", "application": "st", "family": "network_service", "expired-flows": "0", "last-seen": 1655736428995, "packets": "1000", "octets": "100", "lastupdated": 1655736428995 }, { "vdevice-name": "172.16.255.11", "vdevice-host-name": "vm1", "vpn-id": "1", "application": "st", "family": "network-management", "expired-flows": "0", "last-seen": 1655736428995, "packets": "1000", "octets": "100", "lastupdated": 1655736428995 }, { "vdevice-name": "172.16.255.11", "vdevice-host-name": "vm1", "vpn-id": "1", "application": "st", "family": "network-service", "expired-flows": "0", "last-seen": 1655736428995, "packets": "1000", "octets": "100", "lastupdated": 1655736428995 }, { "vdevice-name": "172.16.255.11", "vdevice-host-name": "vm1", "vpn-id": "1", "application": "st", "family": "network-management", "expired-flows": "0", "last-seen": 1655736428995, "packets": "1000", "octets": "100", "lastupdated": 1655736428995 }, { "vdevice-name": "172.16.255.11", "vdevice-host-name": "vm1", "vpn-id": "1", "application": "st", "family": "network-service", "expired-flows": "0", "last-seen": 1655736428995, "packets": "1000", "octets": "100", "lastupdated": 1655736428995 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write" } }, "/device/dpi/common/applications": { "get": { "tags": [ "Real-Time Monitoring - DPI" ], "description": "Get DPI common application list from device", "operationId": "getCommonApplicationList", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "DPI common application list": { "description": "DPI common application list", "value": { "data": [ { "name": "3com-amp3", "familyShort": "network-service", "longname": "3ComAMP3", "family": "NetworkService", "qosmosName": "3com-amp3", "qosmosFamily": "network-service", "trafficClass": "bulk-data", "businessRelevance": "default" }, { "name": "3com-tsmux", "familyShort": "network-service", "longname": "3ComTSMUX", "family": "NetworkService", "qosmosName": "3com-tsmux", "qosmosFamily": "network-service", "trafficClass": "bulk-data", "businessRelevance": "default" }, { "name": "3pc", "familyShort": "network-service", "longname": "ThirdPartyConnect", "family": "NetworkService", "qosmosName": "3pc", "qosmosFamily": "network_service", "trafficClass": "bulk-data", "businessRelevance": "default" }, { "name": "4chan", "familyShort": "web", "longname": "4CHAN", "family": "Web", "qosmosName": "4chan", "qosmosFamily": "web", "trafficClass": "transactional-data", "businessRelevance": "business-irrelevant" }, { "name": "58-city", "familyShort": "web", "longname": "58City", "family": "Web", "qosmosName": "58com", "qosmosFamily": "web", "trafficClass": "transactional-data", "businessRelevance": "business-irrelevant" }, { "name": "914c/g", "familyShort": "terminal", "longname": "TexasInstruments914Terminal", "family": "Terminal", "qosmosName": "914c/g", "qosmosFamily": "terminal", "trafficClass": "ops-admin-mgmt", "businessRelevance": "business-relevant" }, { "name": "9pfs", "familyShort": "network-service", "longname": "9P", "family": "NetworkService", "qosmosName": "9p", "qosmosFamily": "network-service", "trafficClass": "bulk-data", "businessRelevance": "default" }, { "name": "abc-news", "familyShort": "web", "longname": "ABCNews", "family": "Web", "qosmosName": "abcnews", "qosmosFamily": "web", "trafficClass": "transactional-data", "businessRelevance": "business-irrelevant" }, { "name": "acap", "familyShort": "network-management", "longname": "ApplicationConfigurationAccessProtocol", "family": "NetworkManagement", "qosmosName": "acap", "qosmosFamily": "network-management", "trafficClass": "ops-admin-mgmt", "businessRelevance": "business-relevant" }, { "name": "acas", "familyShort": "network-service", "longname": "ACAServices", "family": "NetworkService", "qosmosName": "acas", "qosmosFamily": "network-service", "trafficClass": "bulk-data", "businessRelevance": "default" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/dpi/device/fields": { "get": { "tags": [ "Real-Time Monitoring - DPI" ], "description": "Get DPI field from device", "operationId": "getDPIFieldJSON", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DPI field": { "description": "DPI field", "value": { "data": [ { "property": "entry_time", "name": "EventTime", "isRequired": true, "dataType": "date", "fieldData": { "type": "dateList" }, "options": [ { "key": "last_24_hours", "value": "Last24hours", "number": "24", "enableDateFields": false }, { "key": "last_12_hours", "value": "Last12hours", "number": "12", "enableDateFields": false }, { "key": "last_6_hours", "value": "Last6hours", "number": "6", "enableDateFields": false }, { "key": "last_3_hours", "value": "Last3hours", "number": "3", "enableDateFields": false }, { "key": "last_1_hour", "value": "Last1hour", "number": "1", "enableDateFields": false }, { "key": "last_168_hours", "value": "Last7days", "number": "168", "enableDateFields": false } ] }, { "property": "application", "name": "Application", "isRequired": true, "multiSelect": false, "dataType": "string" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/dpi/devicedetails/fields": { "get": { "tags": [ "Real-Time Monitoring - DPI" ], "description": "Get DPI detailed field from device", "operationId": "getDPIDeviceDetailsFieldJSON", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DPI detailed field": { "description": "DPI detailed field", "value": { "data": [ { "property": "entry_time", "name": "EventTime", "isRequired": true, "dataType": "date", "fieldData": { "type": "dateList" }, "options": [ { "key": "last_24_hours", "value": "Last24hours", "number": "24", "enableDateFields": false }, { "key": "last_12_hours", "value": "Last12hours", "number": "12", "enableDateFields": false }, { "key": "last_6_hours", "value": "Last6hours", "number": "6", "enableDateFields": false }, { "key": "last_3_hours", "value": "Last3hours", "number": "3", "enableDateFields": false }, { "key": "last_1_hour", "value": "Last1hour", "number": "1", "enableDateFields": false }, { "key": "last_168_hours", "value": "Last7days", "number": "168", "enableDateFields": false } ] }, { "property": "application", "name": "Application", "isRequired": true, "multiSelect": false, "dataType": "string" }, { "property": "vdevice_name", "name": "Devicename", "isRequired": true, "multiSelect": false, "dataType": "string" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/dpi/flows": { "get": { "tags": [ "Real-Time Monitoring - DPI" ], "description": "Get DPI flow list from device (Real Time)", "operationId": "createDPIFlowsList", "parameters": [ { "name": "vpn-id", "in": "query", "description": "VPN Id", "schema": { "type": "string", "enum": [ "0", "512" ] } }, { "name": "src-ip", "in": "query", "description": "Source IP", "schema": { "type": "string" } }, { "name": "application", "in": "query", "description": "Application", "schema": { "type": "string" } }, { "name": "family", "in": "query", "description": "Family", "schema": { "type": "string" } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)((\\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)?$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "DPI flows": { "description": "DPI flows", "value": { "data": [ { "vdevice-name": "172.16.255.11", "vdevice-host-name": "vm1", "vpn-id": "1", "src-ip": "1.1.1.1", "dst-ip": "2.2.2.2", "src-port": "80", "dst-port": "8080", "proto": "ipsec", "application": "st", "family": "network-service", "active-since": "2022-06-14T17:07:39+0000", "active-since-date": 1655736428995, "lastupdated": 1655736428995 }, { "vdevice-name": "172.16.255.11", "vdevice-host-name": "vm1", "vpn-id": "1", "src-ip": "1.1.1.1", "dst-ip": "2.2.2.3", "src-port": "80", "dst-port": "8080", "proto": "ipsec", "application": "st", "family": "network-service", "active-since": "2022-06-14T17:07:39+0000", "active-since-date": 1655736428995, "lastupdated": 1655736428995 }, { "vdevice-name": "172.16.255.11", "vdevice-host-name": "vm1", "vpn-id": "1", "src-ip": "1.1.1.1", "dst-ip": "2.2.2.4", "src-port": "80", "dst-port": "8080", "proto": "ipsec", "application": "st", "family": "network-service", "active-since": "2022-06-14T17:07:39+0000", "active-since-date": 1655736428995, "lastupdated": 1655736428995 }, { "vdevice-name": "172.16.255.11", "vdevice-host-name": "vm1", "vpn-id": "1", "src-ip": "1.1.1.1", "dst-ip": "2.2.2.5", "src-port": "80", "dst-port": "8080", "proto": "ipsec", "application": "st", "family": "network-service", "active-since": "2022-06-14T17:07:39+0000", "active-since-date": 1655736428995, "lastupdated": 1655736428995 }, { "vdevice-name": "172.16.255.11", "vdevice-host-name": "vm1", "vpn-id": "1", "src-ip": "1.1.1.1", "dst-ip": "2.2.2.6", "src-port": "80", "dst-port": "8080", "proto": "ipsec", "application": "st", "family": "network-service", "active-since": "2022-06-14T17:07:39+0000", "active-since-date": 1655736428995, "lastupdated": 1655736428995 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write" } }, "/device/dpi/qosmos-static/applications": { "get": { "tags": [ "Real-Time Monitoring - DPI" ], "description": "Get DPI QoSMos static application list", "operationId": "getQosmosStaticApplicationList", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "DPI QoSMos static application list": { "description": "DPI QoSMos static application list", "value": { "data": [ { "name": "9p", "family": "FileServer", "familyShort": "file_server", "longname": "Plan9FilesystemProtocol", "appId": "3430" }, { "name": "ah", "family": "NetworkService", "familyShort": "network_service", "longname": "AuthenticationHeader", "appId": "720" }, { "name": "dr", "family": "Web", "familyShort": "web", "longname": "Dr.dk", "appId": "2043" }, { "name": "dv", "family": "Web", "familyShort": "web", "longname": "DV.is", "appId": "1861" }, { "name": "hs", "family": "Web", "familyShort": "web", "longname": "Hs.fi(HelsinginSanomat)", "appId": "2097" }, { "name": "il", "family": "NetworkService", "familyShort": "network_service", "longname": "InternetLink(Transportprotocol)", "appId": "637" }, { "name": "ip", "family": "NetworkService", "familyShort": "network_service", "longname": "InternetProtocol", "appId": "81" }, { "name": "ja", "family": "Web", "familyShort": "web", "longname": "Ja.is", "appId": "1897" }, { "name": "mk", "family": "Web", "familyShort": "web", "longname": "Mk.co.kr", "appId": "1213" }, { "name": "mq", "family": "ApplicationService", "familyShort": "application_service", "longname": "IBMWebsphereMQ", "appId": "312" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/dpi/qosmos/applications": { "get": { "tags": [ "Real-Time Monitoring - DPI" ], "description": "Get DPI QoSMos application list from device", "operationId": "getQosmosApplicationList", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "DPI QoSMos application list": { "description": "DPI QoSMos application list", "value": { "data": [ { "name": "an", "family": "network-service", "familyShort": "network_service", "longname": "ActiveNetworks", "appId": "861" }, { "name": "bna", "family": "network-service", "familyShort": "network_service", "longname": "BNA", "appId": "803" }, { "name": "box", "family": "web", "familyShort": "web", "longname": "Box", "appId": "1074" }, { "name": "dls", "family": "network-service", "familyShort": "network_service", "longname": "DirectoryLocationService", "appId": "1078" }, { "name": "dmp", "family": "audio-video", "familyShort": "audio_video", "longname": "CiscoDigitalMediaPlayer", "appId": "1422" }, { "name": "apple-location-services", "family": "application-service", "familyShort": "application_service", "longname": "AppleLocationServices", "appId": "294" }, { "name": "apple-push-notification", "family": "application-service", "familyShort": "application_service", "longname": "ApplePushNotificationService", "appId": "1169" }, { "name": "sixtofour-ipv6-tunneled", "family": "network-service", "familyShort": "network_service", "longname": "SixtofourIPv6Tunneled", "appId": "1223" }, { "name": "internet-audio-streaming", "family": "instant-messaging", "familyShort": "instant_messaging", "longname": "InternetAudioStreamingWebApps", "appId": "1514" }, { "name": "internet-video-streaming", "family": "web", "familyShort": "web", "longname": "InternetVideoStreamingWebApps", "appId": "1513" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Device Monitoring-read" } }, "/device/dpi/summary": { "get": { "tags": [ "Real-Time Monitoring - DPI" ], "description": "Get DPI summary from device (Real Time)", "operationId": "createDPISummaryRealTime", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)((\\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)?$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DPI applications": { "description": "DPI applications", "value": { "data": [ { "flows-expired": "0", "vdevice-dataKey": "169.254.10.10", "flows-created": "0", "vdevice-name": "169.254.10.10", "current-flows": "0", "peak-rate": "0", "current-rate": "0", "lastupdated": 1643014386555, "vdevice-host-name": "vm3", "status": "disable", "peak-flows": "0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write" } }, "/device/dpi/supported-applications": { "get": { "tags": [ "Real-Time Monitoring - DPI" ], "description": "Get supported applications from device (Real Time)", "operationId": "createDPIStatistics", "parameters": [ { "name": "application", "in": "query", "description": "Application", "schema": { "type": "string" } }, { "name": "family", "in": "query", "description": "Family", "schema": { "type": "string" } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)((\\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)?$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "DPI applications": { "description": "DPI applications", "value": { "data": [ { "family-long-name": "network-service", "vdevice-dataKey": "169.254.10.10-an", "application": "an", "vdevice-name": "169.254.10.10", "lastupdated": 1643014674675, "family": "network_service", "application-long-name": "Active Networks", "vdevice-host-name": "vm3" }, { "family-long-name": "network-management", "vdevice-dataKey": "169.254.10.10-bb", "application": "bb", "vdevice-name": "169.254.10.10", "lastupdated": 1643014674675, "family": "network_management", "application-long-name": "Systems and network monitoring tool", "vdevice-host-name": "vm3" }, { "family-long-name": "network-service", "vdevice-dataKey": "169.254.10.10-fc", "application": "fc", "vdevice-name": "169.254.10.10", "lastupdated": 1643014674675, "family": "network_service", "application-long-name": "Fibre Channel", "vdevice-host-name": "vm3" }, { "family-long-name": "network-service", "vdevice-dataKey": "169.254.10.10-il", "application": "il", "vdevice-name": "169.254.10.10", "lastupdated": 1643014674675, "family": "network_service", "application-long-name": "Internal Link Transport Protocol", "vdevice-host-name": "vm3" }, { "family-long-name": "network-service", "vdevice-dataKey": "169.254.10.10-ns", "application": "ns", "vdevice-name": "169.254.10.10", "lastupdated": 1643014674675, "family": "network_service", "application-long-name": "Network Systems", "vdevice-host-name": "vm3" }, { "family-long-name": "network-service", "vdevice-dataKey": "169.254.10.10-sm", "application": "sm", "vdevice-name": "169.254.10.10", "lastupdated": 1643014674675, "family": "network_service", "application-long-name": "SM", "vdevice-host-name": "vm3" }, { "family-long-name": "network-service", "vdevice-dataKey": "169.254.10.10-st", "application": "st", "vdevice-name": "169.254.10.10", "lastupdated": 1643014674675, "family": "network_service", "application-long-name": "Stream", "vdevice-host-name": "vm3" }, { "family-long-name": "network-service", "vdevice-dataKey": "169.254.10.10-3pc", "application": "3pc", "vdevice-name": "169.254.10.10", "lastupdated": 1643014674675, "family": "network_service", "application-long-name": "Third Party Connect Protocol", "vdevice-host-name": "vm3" }, { "family-long-name": "network-service", "vdevice-dataKey": "169.254.10.10-acp", "application": "acp", "vdevice-name": "169.254.10.10", "lastupdated": 1643014674675, "family": "network_service", "application-long-name": "Aeolon Core Protocol", "vdevice-host-name": "vm3" }, { "family-long-name": "erp", "vdevice-dataKey": "169.254.10.10-adp", "application": "adp", "vdevice-name": "169.254.10.10", "lastupdated": 1643014674675, "family": "erp", "application-long-name": "Automatic Data Processing", "vdevice-host-name": "vm3" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write" } }, "/device/dre/auto-bypass-stats": { "get": { "tags": [ "Real-Time Monitoring - DRE" ], "description": "Get DRE auto-bypass statistics", "operationId": "getDreAutoBypassStats", "parameters": [ { "name": "appqoe-dre-auto-bypass-server-ip", "in": "query", "description": "Server IP", "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } }, { "name": "appqoe-dre-auto-bypass-port", "in": "query", "description": "Port", "schema": { "type": "number" } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DRE Auto-Bypass Stats": { "description": "DRE Auto-Bypass Stats", "value": { "data": [ { "vdevice-name": "172.16.255.16", "vdevice-host-name": "vm6", "appqoe-dre-auto-bypass-server-ip": "10.0.0.1", "appqoe-dre-auto-bypass-port": "9088", "appqoe-dre-auto-bypass-state": "Monitor", "appqoe-dre-auto-bypass-dre-lan-bytes": 48887002724, "appqoe-dre-auto-bypass-dre-wan-bytes": 49401300299, "appqoe-dre-auto-bypass-dre-comp": 0, "appqoe-dre-auto-bypass-last-update": "13:41:51", "appqoe-dre-auto-bypass-entry-creation-time": "03:08:53", "lastupdated": 1645775163290, "vdevice-dataKey": "172.16.255.16" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write,Template Configuration-read,Template Configuration-write" } }, "/device/dre/dre-stats": { "get": { "tags": [ "Real-Time Monitoring - DRE" ], "description": "Get DRE statistics", "operationId": "getDreStats", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DRE Stats": { "description": "DRE Stats", "value": { "data": [ { "vdevice-name": "172.16.255.16", "vdevice-host-name": "vm6", "data-total-cons": 325071, "data-max-cons": 704, "data-active-cons": 0, "data-total-orig-bytes": 6743098654720, "data-total-opt-bytes": 3039763103744, "data-reduction-ratio": 54, "data-cache-status": "Active", "data-cache-size": 426322690048, "data-cache-used-percent": 93, "data-cache-oldest-data": "17:13:53:40", "data-data-replaced": 0, "lastupdated": 1645775163290, "vdevice-dataKey": "172.16.255.16" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write,Template Configuration-read,Template Configuration-write" } }, "/device/dre/dre-status": { "get": { "tags": [ "Real-Time Monitoring - DRE" ], "description": "Get DRE status", "operationId": "getDreStatus", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DRE Status": { "description": "DRE Status", "value": { "data": [ { "lastupdated": 1645775163290, "appqoe-dre-status-health-status": "dre-status-disabled", "vdevice-dataKey": "169.254.10.12", "vdevice-name": "169.254.10.12", "vdevice-host-name": "vm5" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write,Template Configuration-read,Template Configuration-write" } }, "/device/dre/peer-stats": { "get": { "tags": [ "Real-Time Monitoring - DRE" ], "description": "Get DRE peer statistics", "operationId": "getDrePeerStats", "parameters": [ { "name": "appqoe-dre-stats-peer-system-ip", "in": "query", "description": "System IP", "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } }, { "name": "appqoe-dre-stats-peer-peer-no", "in": "query", "description": "Peer Number", "schema": { "type": "number" } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DRE Peer Stats": { "description": "DRE Peer Stats", "value": { "data": [ { "vdevice-name": "172.16.255.16", "vdevice-host-name": "vm6", "appqoe-dre-stats-peer-peer-no": "0", "appqoe-dre-stats-peer-system-ip": "209.165.201.1", "appqoe-dre-stats-peer-hostname": "dreopt", "appqoe-dre-stats-peer-active-cons": "0", "appqoe-dre-stats-peer-total-cons": "3714", "lastupdated": 1652171693495, "vdevice-dataKey": "172.16.255.16" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write,Template Configuration-read,Template Configuration-write" } }, "/device/dualStaticRouteTracker": { "get": { "tags": [ "Real-Time Monitoring - Dual Static Route Tracker Service" ], "description": "Get dual static route tracker info from device", "operationId": "getDualStaticRouteTrackerInfo", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Dual static route tracker info": { "description": "Dual static route tracker info", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/eigrp/interface": { "get": { "tags": [ "Real-Time Monitoring - EIGRP" ], "description": "Get EIGRP interface list from device (Real Time)", "operationId": "createEIGRPInterface", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "EIGRP interface list": { "description": "EIGRP interface list", "value": { "data": [ { "vdevice-name": "169.254.10.13", "vdevice-host-name": "vm6", "name": "GigabitEthernet0", "passive": "GigabitEthernet0/0", "hello-interval": "5", "hold-timer": "15", "auth-mode": "md5", "lastupdated": 1654586532070, "vdevice-dataKey": "169.254.10.13-eigrp-af-ipv4-0.0.0.0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/eigrp/route": { "get": { "tags": [ "Real-Time Monitoring - EIGRP" ], "description": "Get EIGRP route from device (Real Time)", "operationId": "createEIGRPRoute", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "EIGRP route": { "description": "EIGRP route", "value": { "data": [ { "vdevice-name": "169.254.10.13", "afi": "eigrp-af-ipv4", "origin": "eigrp-origin-redistributed", "infosource": "0.0.0.0", "omp-tag": "0", "succ-metric": "0", "vdevice-host-name": "vm6", "nexthop": "172.16.254.2", "vdevice-dataKey": "169.254.10.13-eigrp-af-ipv4-0.0.0.0", "metric": "1", "lastupdated": 1654586532070 }, { "vdevice-name": "169.254.10.13", "afi": "eigrp-af-ipv4", "origin": "eigrp-origin-redistributed", "infosource": "0.0.0.0", "omp-tag": "0", "succ-metric": "0", "vdevice-host-name": "vm6", "nexthop": "172.16.254.4", "vdevice-dataKey": "169.254.10.13-eigrp-af-ipv4-0.0.0.0", "metric": "1", "lastupdated": 1654586532070 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/eigrp/topology": { "get": { "tags": [ "Real-Time Monitoring - EIGRP" ], "description": "Get EIGRP topology info from device (Real Time)", "operationId": "createEIGRPTopology", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "EIGRP topology info": { "description": "EIGRP topology info", "value": { "data": [ { "vdevice-host-name": "vm5", "vdevice-dataKey": "172.16.255.15-0----", "vdevice-name": "172.16.255.15", "topo-id": "0", "lastupdated": 1649307997571 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/enableSDAVC/{deviceIP}/{enable}": { "post": { "tags": [ "Monitoring - Device Details" ], "description": "Enable/Disable SDAVC on device", "operationId": "enableSDAVCOnDevice", "parameters": [ { "name": "deviceIP", "in": "path", "description": "Device IP", "required": true, "schema": { "type": "string" } }, { "name": "enable", "in": "path", "description": "Enable/Disable flag", "required": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/endpointTracker": { "get": { "tags": [ "Real-Time Monitoring - Endpoint Tracker Service" ], "description": "Get endpoint tracker info from device", "operationId": "getEndpointTrackerInfo", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Endpoint tracker info": { "description": "Endpoint tracker info", "value": { "data": [ { "record-name": "test", "if-name": "GigabitEthernet1", "lastupdated": 1650794336441, "actual-delay": "4294967295", "vdevice-dataKey": "172.16.255.15-vm5-GigabitEthernet1", "state": "tracker-if-state-down", "vdevice-host-name": "vm5", "vdevice-name": "172.16.255.15" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/endpointTrackerGroup": { "get": { "tags": [ "Real-Time Monitoring - Endpoint Tracker Group Service" ], "description": "Get endpoint tracker group info from device", "operationId": "getEndpointTrackerGroupInfo", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Endpoint tracker group info": { "description": "Endpoint tracker group info", "value": { "data": [ { "oper": "tracker-group-oper-and", "name": "tracker1", "vdevice-dataKey": "172.16.255.15-vm5-tracker3_tracker-group", "elem-state": "tracker-if-state-down", "lastupdated": 1650866884165, "actual-delay": "4294967295", "group-name": "tracker3", "group-state": "tracker-if-state-down", "attach-point-name": "tracker3_tracker-group", "vdevice-host-name": "vm5", "vdevice-name": "172.16.255.15" }, { "oper": "tracker-group-oper-and", "name": "tracker2", "vdevice-dataKey": "172.16.255.15-vm5-tracker3_tracker-group", "elem-state": "tracker-if-state-down", "lastupdated": 1650866884165, "actual-delay": "4294967295", "group-name": "tracker3", "group-state": "tracker-if-state-down", "attach-point-name": "tracker3_tracker-group", "vdevice-host-name": "vm5", "vdevice-name": "172.16.255.15" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/environmentData": { "get": { "tags": [ "Real-Time Monitoring - Trustsec" ], "description": "get Cisco TrustSec Environment Data information from device", "operationId": "getEnvironmentData", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "TrustSec environment data information": { "description": "TrustSec environment data information", "value": { "data": [ { "status": "env-download-in-progress", "device-sgt": 0, "last-updated-time": "1970-01-01T00:00:00+00:00", "lastupdated": 1652325611225, "vdevice-dataKey": "172.16.255.15-vm5", "next-refresh-time": "1970-01-01T00:00:00+00:00", "vdevice-host-name": "vm5", "vdevice-name": "172.16.255.15", "life-time": "0", "total-num-servers": 0 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write" } }, "/device/environmentData/radiusServer": { "get": { "tags": [ "Real-Time Monitoring - Trustsec" ], "description": "get Cisco TrustSec Environment Data Radius Server list from device", "operationId": "getRadiusServer", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "TrustSec environment data radius server list information": { "description": "TrustSec environment data radius server list information", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "ip-addr": "0.0.0.0", "port-num": "1812", "is-alive": "TRUE", "auto-test": "TRUE", "keywrap": "-", "idle-time": "3600", "dead-time": "60", "lastupdated": 1652325611225, "vdevice-dataKey": "172.16.255.15-vm5" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write" } }, "/device/featurelist": { "get": { "tags": [ "Real-Time Monitoring - Device Feature List" ], "description": "Get feature lists from device (Real Time)", "operationId": "getFeatureList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Feature lists": { "description": "Feature lists", "value": { "data": [ { "vdevice-dataKey": "172.16.255.11-statistics-collection-1.0", "vdevice-name": "172.16.255.11", "name": "statistics-collection", "lastupdated": 1647222469375, "version": "1.0", "vdevice-host-name": "vm1" }, { "vdevice-dataKey": "172.16.255.11-upgrade-confirm-1.0", "vdevice-name": "172.16.255.11", "name": "upgrade-confirm", "lastupdated": 1647222469375, "version": "1.0", "vdevice-host-name": "vm1" }, { "vdevice-dataKey": "172.16.255.11-vmanage-mode-2.0", "vdevice-name": "172.16.255.11", "name": "vmanage-mode", "lastupdated": 1647222469375, "version": "2.0", "vdevice-host-name": "vm1" }, { "vdevice-dataKey": "172.16.255.11-dpi-statistics-2.0", "vdevice-name": "172.16.255.11", "name": "dpi-statistics", "lastupdated": 1647222469375, "version": "2.0", "vdevice-host-name": "vm1" }, { "vdevice-dataKey": "172.16.255.11-cert-serial-hashing-1.0", "vdevice-name": "172.16.255.11", "name": "cert-serial-hashing", "lastupdated": 1647222469375, "version": "1.0", "vdevice-host-name": "vm1" }, { "vdevice-dataKey": "172.16.255.11-upgrade-1.0", "vdevice-name": "172.16.255.11", "name": "upgrade", "lastupdated": 1647222469375, "version": "1.0", "vdevice-host-name": "vm1" }, { "vdevice-dataKey": "172.16.255.11-cert-serial-version-1.0", "vdevice-name": "172.16.255.11", "name": "cert-serial-version", "lastupdated": 1647222469375, "version": "1.0", "vdevice-host-name": "vm1" }, { "vdevice-dataKey": "172.16.255.11-vbond-standalone-1.0", "vdevice-name": "172.16.255.11", "name": "vbond-standalone", "lastupdated": 1647222469375, "version": "1.0", "vdevice-host-name": "vm1" }, { "vdevice-dataKey": "172.16.255.11-tools-2.0", "vdevice-name": "172.16.255.11", "name": "tools", "lastupdated": 1647222469375, "version": "2.0", "vdevice-host-name": "vm1" }, { "vdevice-dataKey": "172.16.255.11-admin-tech-options-1.0", "vdevice-name": "172.16.255.11", "name": "admin-tech-options", "lastupdated": 1647222469375, "version": "1.0", "vdevice-host-name": "vm1" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/featurelist/synced": { "get": { "tags": [ "Real-Time Monitoring - Device Feature List" ], "description": "Get feature lists synchronously from device", "operationId": "getSyncedFeatureList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Feature lists": { "description": "Feature lists", "value": { "data": [ { "vdevice-dataKey": "172.16.255.11-statistics-collection-1.0", "@rid": 632, "vdevice-name": "172.16.255.11", "vmanage-system-ip": "172.16.255.11", "createTimeStamp": 1646912241600, "name": "statistics-collection", "lastupdated": 1646912240766, "vdevice-host-name": "vm1", "version": "1.0" }, { "vdevice-dataKey": "172.16.255.11-upgrade-confirm-1.0", "@rid": 639, "vdevice-name": "172.16.255.11", "vmanage-system-ip": "172.16.255.11", "createTimeStamp": 1646912243273, "name": "upgrade-confirm", "lastupdated": 1646912240766, "vdevice-host-name": "vm1", "version": "1.0" }, { "vdevice-dataKey": "172.16.255.11-vmanage-mode-2.0", "@rid": 646, "vdevice-name": "172.16.255.11", "vmanage-system-ip": "172.16.255.11", "createTimeStamp": 1646912247190, "name": "vmanage-mode", "lastupdated": 1646912240766, "vdevice-host-name": "vm1", "version": "2.0" }, { "vdevice-dataKey": "172.16.255.11-dpi-statistics-2.0", "@rid": 654, "vdevice-name": "172.16.255.11", "vmanage-system-ip": "172.16.255.11", "createTimeStamp": 1646912250128, "name": "dpi-statistics", "lastupdated": 1646912240766, "vdevice-host-name": "vm1", "version": "2.0" }, { "vdevice-dataKey": "172.16.255.11-cert-serial-hashing-1.0", "@rid": 662, "vdevice-name": "172.16.255.11", "vmanage-system-ip": "172.16.255.11", "createTimeStamp": 1646912255235, "name": "cert-serial-hashing", "lastupdated": 1646912240766, "vdevice-host-name": "vm1", "version": "1.0" }, { "vdevice-dataKey": "172.16.255.11-upgrade-1.0", "@rid": 669, "vdevice-name": "172.16.255.11", "vmanage-system-ip": "172.16.255.11", "createTimeStamp": 1646912260609, "name": "upgrade", "lastupdated": 1646912240766, "vdevice-host-name": "vm1", "version": "1.0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/featuresupport": { "get": { "tags": [ "Monitoring - Device Details" ], "description": "Get device feature support summary info", "operationId": "getDeviceFeatureSupport", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "cellular": { "type": "boolean", "example": true }, "sdrouting": { "type": "boolean", "example": true } }, "$$ref": "#/components/schemas/DeviceFeatureSupportData" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/geofence/status": { "get": { "tags": [ "Real-Time Monitoring - Geo-fencing" ], "description": "Get Geo-fencing Status from device", "operationId": "getGeofenceStatus", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Geo-fencing Status": { "description": "Geo-fencing Status", "value": { "data": [ { "geofence-config-status": "Geofencing-Disabled", "vdevice-dataKey": "169.254.10.12", "vdevice-name": "169.254.10.12", "lastupdated": 1645089720394, "current-location-status": "Location-Invalid", "current-device-location-timestamp": "2022-02-15T06:39:22+00:00", "vdevice-host-name": "vm5" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/hardware/alarms": { "get": { "tags": [ "Real-Time Monitoring - Hardware" ], "description": "Get hardware alarm list from device", "operationId": "createAlarmList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Hardware alarm list": { "description": "Hardware alarm list", "value": { "data": [ { "alarm-time": "2022-04-26T02:28:26+00:00", "vdevice-dataKey": "10.0.0.121-22-0", "vdevice-name": "10.0.0.121", "alarm-id": "22", "alarm-description": "PowerSupply/FANModuleMissing", "lastupdated": 1652171693495, "alarm-instance": "0", "alarm-category": "alarm-severity-critical", "vdevice-host-name": "Router", "alarm-name": "PowerSupplyBay1" }, { "alarm-time": "2022-04-26T02:28:26+00:00", "vdevice-dataKey": "10.0.0.121-62-0", "vdevice-name": "10.0.0.121", "alarm-id": "62", "alarm-description": "PowerOverEthernetModuleMissing", "lastupdated": 1652171693495, "alarm-instance": "0", "alarm-category": "alarm-severity-info", "vdevice-host-name": "Router", "alarm-name": "POEBay0" }, { "alarm-time": "2022-04-26T02:28:26+00:00", "vdevice-dataKey": "10.0.0.121-82-0", "vdevice-name": "10.0.0.121", "alarm-id": "82", "alarm-description": "PowerOverEthernetModuleMissing", "lastupdated": 1652171693495, "alarm-instance": "0", "alarm-category": "alarm-severity-info", "vdevice-host-name": "Router", "alarm-name": "POEBay1" }, { "alarm-time": "2022-04-26T02:29:44+00:00", "vdevice-dataKey": "10.0.0.121-1090-1", "vdevice-name": "10.0.0.121", "alarm-id": "1090", "alarm-description": "TransceiverMissing-LinkDown", "lastupdated": 1652171693495, "alarm-instance": "1", "alarm-category": "alarm-severity-info", "vdevice-host-name": "Router", "alarm-name": "subslot0/0transceivercontainer0" }, { "alarm-time": "2022-04-26T02:29:44+00:00", "vdevice-dataKey": "10.0.0.121-1100-1", "vdevice-name": "10.0.0.121", "alarm-id": "1100", "alarm-description": "TransceiverMissing-LinkDown", "lastupdated": 1652171693495, "alarm-instance": "1", "alarm-category": "alarm-severity-info", "vdevice-host-name": "Router", "alarm-name": "subslot0/0transceivercontainer1" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/hardware/environment": { "get": { "tags": [ "Real-Time Monitoring - Hardware" ], "description": "Get hardware environment list from device", "operationId": "createEnvironmentList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Hardware environment list": { "description": "Hardware environment list", "value": { "data": [ { "vdevice-dataKey": "169.254.10.10-Interface module-0", "vdevice-name": "169.254.10.10", "hw-class": "PIM", "hw-item": "Interface module", "hw-dev-index": 0, "lastupdated": 1643076101789, "vdevice-host-name": "vm3", "measurement": "Present: yes; Powered On: no; Fault: no", "status": "Down" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/hardware/errors": { "get": { "tags": [ "Real-Time Monitoring - Hardware" ], "description": "Get hardware error list from device", "operationId": "createErrorAlarmList", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Hardware error list": { "description": "Hardware error list", "value": { "data": [ { "vdevice-dataKey": "169.254.10.10-Interface module-0", "vdevice-name": "169.254.10.10", "vdevice-host-name": "vm3", "alarm-id": "22", "alarm-instance": "0", "alarm-name": "POEBay0", "alarm-time": "2022-04-26T02:28:26+00:00", "alarm-category": "alarm-severity-critical", "alarm-description": "PowerSupply/FANModuleMissing", "lastupdated": 1652171693495 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/hardware/inventory": { "get": { "tags": [ "Real-Time Monitoring - Hardware" ], "description": "Get hardware inventory list from device", "operationId": "createInventoryList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Hardware inventory list": { "description": "Hardware inventory list", "value": { "data": [ { "hw-type": "Chassis", "vdevice-dataKey": "169.254.10.10-Chassis-0", "vdevice-name": "169.254.10.10", "hw-dev-index": 0, "serial-number": "sim", "part-number": "vEdge-Cloud", "lastupdated": 1643076350328, "version": "1.0", "vdevice-host-name": "vm3", "hw-description": "vEdge-Cloud" }, { "hw-type": "PIM", "vdevice-dataKey": "169.254.10.10-PIM-0", "vdevice-name": "169.254.10.10", "hw-dev-index": 0, "serial-number": "None", "part-number": "ge-8", "lastupdated": 1643076350328, "version": "None", "vdevice-host-name": "vm3", "hw-description": "Max 8 x 1GE VM ports" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/hardware/status/summary": { "get": { "tags": [ "Real-Time Monitoring - Hardware" ], "description": "Get hardware status summary from device", "operationId": "createStatusSummary", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Hardware status summary": { "description": "Hardware status summary", "value": { "data": [ { "vdevice-name": "10.0.0.121", "createTimeStamp": 1611557599955, "current-reading": "1015", "vdevice-host-name": "Router", "sensor-name": "voltage", "vdevice-dataKey": "10.0.0.121-V:Vcore-A-R0", "@rid": 927, "vmanage-system-ip": "10.0.0.121", "sensor-units": "millivolts", "name": "V:Vcore-A", "lastupdated": 1652152463462, "location": "R0", "state": "Normal" }, { "vdevice-name": "10.0.0.121", "createTimeStamp": 1611557593593, "current-reading": "31", "vdevice-host-name": "Router", "sensor-name": "temperature", "vdevice-dataKey": "10.0.0.121-Temp:Temp1-P0", "@rid": 1731, "vmanage-system-ip": "10.0.0.121", "sensor-units": "celsius", "name": "Temp:Temp1", "lastupdated": 1651807463843, "location": "P0", "state": "Normal" }, { "vdevice-name": "10.0.0.121", "createTimeStamp": 1611557593651, "current-reading": "25", "vdevice-host-name": "Router", "sensor-name": "temperature", "vdevice-dataKey": "10.0.0.121-Temp:Temp2-P0", "@rid": 1760, "vmanage-system-ip": "10.0.0.121", "sensor-units": "celsius", "name": "Temp:Temp2", "lastupdated": 1652152463462, "location": "P0", "state": "Normal" }, { "vdevice-name": "10.0.0.121", "createTimeStamp": 1611557599821, "current-reading": "1508", "vdevice-host-name": "Router", "sensor-name": "voltage", "vdevice-dataKey": "10.0.0.121-V:1.5v-A-R0", "@rid": 1881, "vmanage-system-ip": "10.0.0.121", "sensor-units": "millivolts", "name": "V:1.5v-A", "lastupdated": 1652152463462, "location": "R0", "state": "Normal" }, { "vdevice-name": "10.0.0.121", "createTimeStamp": 1611557593684, "current-reading": "28", "vdevice-host-name": "Router", "sensor-name": "temperature", "vdevice-dataKey": "10.0.0.121-Temp:Temp3-P0", "@rid": 2044, "vmanage-system-ip": "10.0.0.121", "sensor-units": "celsius", "name": "Temp:Temp3", "lastupdated": 1651999921808, "location": "P0", "state": "Normal" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/hardware/synced/alarms": { "get": { "tags": [ "Real-Time Monitoring - Hardware" ], "description": "Get hardware alarm list synchronously from device", "operationId": "createSyncedAlarmList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Hardware alarm list": { "description": "Hardware alarm list", "value": { "data": [ { "vdevice-name": "10.0.0.121", "alarm-id": "22", "alarm-description": "PowerSupply/FANModuleMissing", "createTimeStamp": 1650884158338, "alarm-instance": "0", "vdevice-host-name": "Router", "alarm-time": "2022-04-26T02:28:26+00:00", "vdevice-dataKey": "10.0.0.121-22-0", "@rid": 3034, "vmanage-system-ip": "10.0.0.121", "lastupdated": 1650941679362, "alarm-category": "alarm-severity-critical", "alarm-name": "PowerSupplyBay1" }, { "vdevice-name": "10.0.0.121", "alarm-id": "62", "alarm-description": "PowerOverEthernetModuleMissing", "createTimeStamp": 1650884158392, "alarm-instance": "0", "vdevice-host-name": "Router", "alarm-time": "2022-04-26T02:28:26+00:00", "vdevice-dataKey": "10.0.0.121-62-0", "@rid": 3035, "vmanage-system-ip": "10.0.0.121", "lastupdated": 1650941679362, "alarm-category": "alarm-severity-info", "alarm-name": "POEBay0" }, { "vdevice-name": "10.0.0.121", "alarm-id": "82", "alarm-description": "PowerOverEthernetModuleMissing", "createTimeStamp": 1650884158434, "alarm-instance": "0", "vdevice-host-name": "Router", "alarm-time": "2022-04-26T02:28:26+00:00", "vdevice-dataKey": "10.0.0.121-82-0", "@rid": 3036, "vmanage-system-ip": "10.0.0.121", "lastupdated": 1650941679362, "alarm-category": "alarm-severity-info", "alarm-name": "POEBay1" }, { "vdevice-name": "10.0.0.121", "alarm-id": "1090", "alarm-description": "TransceiverMissing-LinkDown", "createTimeStamp": 1650884158484, "alarm-instance": "1", "vdevice-host-name": "Router", "alarm-time": "2022-04-26T02:29:44+00:00", "vdevice-dataKey": "10.0.0.121-1090-1", "@rid": 3037, "vmanage-system-ip": "10.0.0.121", "lastupdated": 1650941679362, "alarm-category": "alarm-severity-info", "alarm-name": "subslot0/0transceivercontainer0" }, { "vdevice-name": "10.0.0.121", "alarm-id": "1100", "alarm-description": "TransceiverMissing-LinkDown", "createTimeStamp": 1650884158543, "alarm-instance": "1", "vdevice-host-name": "Router", "alarm-time": "2022-04-26T02:29:44+00:00", "vdevice-dataKey": "10.0.0.121-1100-1", "@rid": 3042, "vmanage-system-ip": "10.0.0.121", "lastupdated": 1650941679362, "alarm-category": "alarm-severity-info", "alarm-name": "subslot0/0transceivercontainer1" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/hardware/synced/environment": { "get": { "tags": [ "Real-Time Monitoring - Hardware" ], "description": "Get hardware environment list synchronously from device", "operationId": "createSyncedEnvironmentList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Hardware environment list": { "description": "Hardware environment list", "value": { "data": [ { "vdevice-name": "172.16.255.11", "hw-dev-index": 0, "createTimeStamp": 1647316012518, "vdevice-host-name": "vm1", "measurement": "Present:yes;PoweredOn:no;Fault:no", "vdevice-dataKey": "172.16.255.11-Interfacemodule-0", "@rid": 1156, "hw-item": "Interfacemodule", "hw-class": "PIM", "vmanage-system-ip": "172.16.255.11", "lastupdated": 1647316012314, "status": "Down" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/hardware/synced/inventory": { "get": { "tags": [ "Real-Time Monitoring - Hardware" ], "description": "Get hardware inventory list synchronously from device", "operationId": "createSyncedInventoryList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Hardware inventory list": { "description": "Hardware inventory list", "value": { "data": [ { "vdevice-name": "172.16.255.11", "serial-number": "sim", "hw-dev-index": 0, "createTimeStamp": 1647316018898, "version": "1.0", "vdevice-host-name": "vm1", "hw-description": "vEdge-Cloud", "hw-type": "Chassis", "vdevice-dataKey": "172.16.255.11-Chassis-0", "@rid": 1163, "vmanage-system-ip": "172.16.255.11", "part-number": "vEdge-Cloud", "lastupdated": 1647316017498 }, { "vdevice-name": "172.16.255.11", "serial-number": "None", "hw-dev-index": 0, "createTimeStamp": 1647316036497, "version": "None", "vdevice-host-name": "vm1", "hw-description": "Max8x1GEVMports", "hw-type": "PIM", "vdevice-dataKey": "172.16.255.11-PIM-0", "@rid": 1169, "vmanage-system-ip": "172.16.255.11", "part-number": "ge-8", "lastupdated": 1647316017498 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/hardware/system": { "get": { "tags": [ "Real-Time Monitoring - Hardware" ], "description": "Get hardware system data list from device", "operationId": "createSystemList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Hardware system data list": { "description": "Hardware system data list", "value": [ { "last-reboot-reason": "reload", "software-version": "Cisco IOS Software [Cupertino], Virtual XE Software (X86_64_LINUX_IOSD-UNIVERSALK9-M), Experimental Version 17.8.20211216:090342 [BLD_POLARIS_DEV_LATEST_20211216_061759:/nobackup/mcpre/s2c-build-ws 101]\nCopyright (c) 1986-2021 by Cisco Systems, Inc.\nCompiled Thu 16-Dec-21 01:03 by mcpre", "lastupdated": 1643186341301, "vdevice-dataKey": "172.16.255.15-2022-01-26T08:40:53.165+00:00-2022-01-26T08:37:03+00:00", "boot-time": "2022-01-26T08:37:03+00:00", "rommon-version": "IOS-XE ROMMON", "current-time": "2022-01-26T08:40:53.165+00:00", "vdevice-host-name": "vm5", "vdevice-name": "172.16.255.15" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/hardware/threshold": { "get": { "tags": [ "Real-Time Monitoring - Hardware" ], "description": "Get hardware temperature list from device", "operationId": "createTempThresholdList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Hardware temperature list": { "description": "Hardware temperature list", "value": { "data": [ { "vdevice-name": "169.254.10.9", "vdevice-host-name": "vm2", "hw-sensor-type": "Board", "hw-dev-index": "0", "fan-speed-normal": "64", "yellow-alarm-normal": "65", "yellow-alarm-bad-fan": "60", "red-alarm-normal": "80", "red-alarm-bad-fan": "75", "lastupdated": 1658194642863, "vdevice-dataKey": "169.254.10.9-Interface module-0" }, { "vdevice-name": "169.254.10.9", "vdevice-host-name": "vm2", "hw-sensor-type": "CPU Junction", "hw-dev-index": "1", "fan-speed-normal": "64", "yellow-alarm-normal": "65", "yellow-alarm-bad-fan": "60", "red-alarm-normal": "80", "red-alarm-bad-fan": "75", "lastupdated": 1658194642863, "vdevice-dataKey": "169.254.10.9-Interface module-1" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/hardwarehealth/detail": { "get": { "tags": [ "Monitoring - Device Details" ], "description": "Get hardware health details for device", "operationId": "getHardwareHealthDetails", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device Id", "schema": { "type": "string" } }, { "name": "state", "in": "query", "description": "Device state", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "bfdSessions": { "type": "string", "example": "3" }, "board-serial": { "type": "string", "example": "12346568" }, "controlConnections": { "type": "string", "example": "3" }, "cpuLoadDisplay": { "type": "string", "example": "39.27" }, "device-model": { "type": "string", "example": "vedge-cloud" }, "device-type": { "type": "string", "example": "vedge" }, "hardwareState": { "type": "string", "example": "normal" }, "host-name": { "type": "string", "example": "vm11" }, "lastupdated": { "type": "integer", "format": "int64", "example": 1635371851165 }, "local-system-ip": { "type": "string", "example": "172.16.255.21" }, "memUsageDisplay": { "type": "string", "example": "52.0" }, "number-vsmart-peers": { "type": "integer", "format": "int32", "example": 2 }, "ompPeers": { "type": "string", "example": "2" }, "reachability": { "type": "string", "example": "reachable" }, "site-id": { "type": "string", "example": "100" }, "system-ip": { "type": "string", "example": "172.16.255.21" }, "uptime-date": { "type": "integer", "format": "int64", "example": 1635324240000 }, "uuid": { "type": "string", "example": "63e8518c-e76f-4d5f-a4c7-28ffb669526b" }, "version": { "type": "string", "example": "20.7.999-1133" } }, "$$ref": "#/components/schemas/DeviceHardwareHealthDetail" } }, "examples": { "Device hardware health details": { "description": "Device hardware health details", "value": { "data": [ { "bfdSessions": "3", "memUsageDisplay": "52.0", "site-id": "100", "device-type": "vedge", "version": "20.7.999-1133", "hardwareState": "normal", "uptime-date": 1635324240000, "uuid": "63e8518c-e76f-4d5f-a4c7-28ffb669526b", "lastupdated": 1635371851165, "reachability": "reachable", "device-model": "vedge-cloud", "host-name": "vm11", "local-system-ip": "172.16.255.21", "cpuLoadDisplay": "39.27", "controlConnections": "3", "board-serial": "12346568", "number-vsmart-peers": 2, "system-ip": "172.16.255.21", "ompPeers": "2" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/hardwarehealth/summary": { "get": { "tags": [ "Monitoring - Device Details" ], "description": "Get hardware health summary for device", "operationId": "getHardwareHealthSummary", "parameters": [ { "name": "isCached", "in": "query", "description": "Status cached", "schema": { "type": "boolean", "default": false } }, { "name": "vpnId", "in": "query", "description": "VPN Id", "required": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Device hardware health": { "description": "Device hardware health", "value": { "data": [ { "count": 5, "status": "error", "statusList": [ { "status": "up", "count": 5, "message": "5 {normal=5, warning=0, error=0}", "name": "normal", "detailsURL": "/dataservice/device/hardwarehealth/detail?state=normal" }, { "status": "warning", "count": 0, "message": "0 {normal=5, warning=0, error=0}", "name": "warning", "detailsURL": "/dataservice/device/hardwarehealth/detail?state=warning" }, { "status": "down", "count": 0, "message": "0 {normal=5, warning=0, error=0}", "name": "error", "detailsURL": "/dataservice/device/hardwarehealth/detail?state=error" } ] } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/igmp/groups": { "get": { "tags": [ "Real-Time Monitoring - IGMP" ], "description": "Get IGMP neighbor list from device", "operationId": "createIGMPGroupsList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "IGMP neighbor": { "description": "IGMP neighbor", "value": { "data": [ { "if-name": "ge0/0", "v1-members-present": "false", "vdevice-dataKey": "169.254.10.10", "vdevice-name": "169.254.10.10", "lastupdated": 1643076514019, "state": "members-present", "vpn-id": "10", "event": "init-event", "vdevice-host-name": "vm3", "group": "225.225.0.1", "uptime": "0:06:38:43" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/igmp/interface": { "get": { "tags": [ "Real-Time Monitoring - IGMP" ], "description": "Get IGMP interface list from device", "operationId": "createIGMPInterfaceList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "IGMP interface": { "description": "IGMP interface", "value": { "data": [ { "vdevice-name": "169.254.10.10", "if-addr": "100.100.3.101/24", "vpn-id": "10", "vdevice-host-name": "vm3", "querier": "true", "querier-ip": "100.100.3.101", "if-name": "ge0/0", "vdevice-dataKey": "169.254.10.10-10-ge0/0", "group-count": 1, "query-interval": "0:00:00:51", "lastupdated": 1643076670382, "state": "querier", "event": "init-event" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/igmp/statistics": { "get": { "tags": [ "Real-Time Monitoring - IGMP" ], "description": "Get IGMP statistics list from device", "operationId": "createIGMPStatisticsList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "IGMP statistics": { "description": "IGMP statistics", "value": { "data": [ { "rx_group_query": 0, "vdevice-name": "169.254.10.10", "tx_group_query": 0, "vpn-id": "10", "rx_v2_report": 0, "rx_unknown": 0, "vdevice-host-name": "vm3", "rx_v1_report": 0, "rx_leave": 0, "tx_general_query": 194, "vdevice-dataKey": "169.254.10.10", "rx_general_query": 0, "tx_error": 0, "lastupdated": 1643076824172, "rx_error": 0 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/igmp/summary": { "get": { "tags": [ "Real-Time Monitoring - IGMP" ], "description": "Get IGMP summary from device", "operationId": "createIGMPSummary", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "IGMP summary": { "description": "IGMP summary", "value": { "data": [ { "last-member-query-response-time": "3", "querier-timeout": "255", "vdevice-dataKey": "169.254.10.10", "vdevice-name": "169.254.10.10", "query-interval": "125", "query-response-time": "10", "lastupdated": 1643076984762, "version": "2", "last-member-query-count": "2", "vdevice-host-name": "vm3" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/ignition/status": { "get": { "tags": [ "Real-Time Monitoring - Ignition Status" ], "description": "Get Ignition Status Information", "operationId": "getIgnitionStatus", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Ignition Status": { "description": "Ignition Status", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "pm5", "lastupdated": 1717400936511, "ignition-mgmt": "Enabled", "input-volt": "23.45 V", "pwr-state": "Bootloader", "undervoltage": "16.45 V", "overvoltage": "31.52 V", "battery-type": "12v", "sense": "Enabled", "shutdown-time": "14 s", "undervoltage-time-delay": "14 s", "overvoltage-time-delay": "14 s", "ignition-off-time-delay": "14 s", "sense-on-threshold": "31.52 V", "sense-off-threshold": "31.52 V", "vdevice-dataKey": "172.16.255.15-1" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/insecure-config": { "get": { "tags": [ "Real-Time Monitoring - Insecure Device Configuration" ], "description": "Get device insecure configuration", "operationId": "getDeviceInsecureConfiguration", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - System IP (retrieved from the system_ip field of the /health/devices API)", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "10.1.1.15" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "array", "items": { "required": [ "description", "insecure-cli", "lastupdated", "module", "reason", "remediation", "vdevice-dataKey", "vdevice-host-name", "vdevice-name" ], "type": "object", "properties": { "description": { "type": "string", "description": "Description for insecure CLI", "example": "authentication protocol for the user." }, "index": { "type": "integer", "description": "Insecure CLI index", "format": "int64", "example": 1 }, "insecure-cli": { "type": "string", "description": "Insecure device CLI", "example": "snmp user {user} auth-protocol {auth-protocol}" }, "lastupdated": { "type": "integer", "description": "Unix timestamp of the last update.", "format": "int64", "example": 1756980504273 }, "module": { "type": "string", "description": "Module owning insecure configuration CLI", "example": "SNMP_USER_AUTHENTICATION" }, "reason": { "type": "string", "description": "Reason for configuration CLI being marked insecure", "example": "SHA-256 provides a more secure hashing algorithm compared to MD5 or SHA-1." }, "remediation": { "type": "string", "description": "Remediation action for insecure configuration CLI", "example": "Use SHA-256 for stronger authentication." }, "vdevice-dataKey": { "type": "string", "example": "172.16.255.30-SNMP_USER_AUTHENTICATION" }, "vdevice-host-name": { "type": "string", "description": "Device host name", "example": "host_1721625530" }, "vdevice-name": { "type": "string", "description": "Device IP", "example": "172.16.255.30" } }, "$$ref": "#/components/schemas/InsecureConfigItem" } } }, "$$ref": "#/components/schemas/DeviceInsecureConfigResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,Device Monitoring-read" } }, "/device/interface": { "get": { "tags": [ "Real-Time Monitoring - Interface" ], "description": "Get device interfaces", "operationId": "getDeviceInterface", "parameters": [ { "name": "vpn-id", "in": "query", "description": "VPN Id", "schema": { "type": "string" } }, { "name": "ifname", "in": "query", "description": "IF Name", "schema": { "type": "string", "enum": [ "ge0/0", "ge0/1", "ge0/2", "ge0/3", "ge0/4", "ge0/5", "ge0/6", "ge0/7", "system", "eth0" ] } }, { "name": "af-type", "in": "query", "description": "AF Type", "schema": { "type": "string", "enum": [ "ipv4", "ipv6" ] } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device interface": { "description": "Device interface", "value": { "data": [ { "vdevice-name": "169.254.10.10", "rx-errors": 0, "tx-kbps": 18, "if-admin-status": "Up", "duplex": "full", "tcp-mss-adjust": "1416", "tx-errors": 0, "tx-pps": 13, "ifname": "ge0/1", "rx-pps": 14, "af-type": "ipv4", "shaping-rate": 0, "if-oper-status": "Up", "auto-neg": "false", "ifindex": 2, "allow-service": "dhcp dns icmp https", "if-tracker-status": "NA", "num-flaps": "0", "rx-packets": 6544375, "secondary-address": "", "vpn-id": "0", "vdevice-host-name": "vm3", "mtu": "1500", "rx-drops": 48131, "tx-drops": 2, "uptime": "4:20:14:13", "ipv6-address": "-", "secondary": "false", "ip-address": "10.101.3.3/16", "hwaddr": "52:54:00:a1:4f:47", "speed-mbps": "1000", "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv4", "tx-octets": 1238809794, "tx-packets": 6404951, "rx-octets": 1209186254, "rx-kbps": 19, "lastupdated": 1643077714908, "port-type": "transport", "uptime-date": 1642659240000, "encap-type": "null" }, { "vdevice-name": "169.254.10.10", "rx-errors": 0, "tx-kbps": 0, "if-admin-status": "Up", "duplex": "full", "tcp-mss-adjust": "1416", "tx-errors": 0, "tx-pps": 0, "ifname": "ge0/1", "rx-pps": 0, "af-type": "ipv6", "shaping-rate": 0, "if-oper-status": "Up", "auto-neg": "false", "ipv6-admin-status": "Up", "ifindex": 2, "allow-service": "dhcp dns icmp https", "if-tracker-status": "NA", "num-flaps": "0", "rx-packets": 3644, "vpn-id": "0", "vdevice-host-name": "vm3", "mtu": "1500", "rx-drops": 0, "tx-drops": 0, "uptime": "4:20:14:13", "ipv6-address": "-", "hwaddr": "52:54:00:a1:4f:47", "speed-mbps": "1000", "ip-address": "-", "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv6", "tx-octets": 9140, "tx-packets": 128, "rx-octets": 405455, "rx-kbps": 0, "lastupdated": 1643077714908, "port-type": "transport", "uptime-date": 1642659240000, "encap-type": "null" }, { "vdevice-name": "169.254.10.10", "rx-errors": 0, "tx-kbps": 0, "if-admin-status": "Down", "tcp-mss-adjust": "1416", "tx-errors": 0, "tx-pps": 0, "ifname": "ge0/2", "rx-pps": 0, "af-type": "ipv4", "shaping-rate": 0, "if-oper-status": "Down", "ifindex": 3, "if-tracker-status": "NA", "num-flaps": "0", "rx-packets": 0, "vpn-id": "0", "vdevice-host-name": "vm3", "mtu": "1500", "rx-drops": 0, "tx-drops": 0, "ipv6-address": "-", "hwaddr": "52:54:00:39:5a:01", "ip-address": "-", "vdevice-dataKey": "169.254.10.10-0-ge0/2-ipv4", "tx-octets": 0, "tx-packets": 0, "rx-octets": 0, "rx-kbps": 0, "lastupdated": 1643077714908, "port-type": "service", "encap-type": "null" }, { "vdevice-name": "169.254.10.10", "rx-errors": 0, "tx-kbps": 0, "if-admin-status": "Down", "tcp-mss-adjust": "1416", "tx-errors": 0, "tx-pps": 0, "ifname": "ge0/2", "rx-pps": 0, "af-type": "ipv6", "shaping-rate": 0, "if-oper-status": "Down", "ipv6-admin-status": "Up", "ifindex": 3, "if-tracker-status": "NA", "num-flaps": "0", "rx-packets": 0, "vpn-id": "0", "vdevice-host-name": "vm3", "mtu": "1500", "rx-drops": 0, "tx-drops": 0, "ipv6-address": "-", "hwaddr": "52:54:00:39:5a:01", "ip-address": "-", "vdevice-dataKey": "169.254.10.10-0-ge0/2-ipv6", "tx-octets": 0, "tx-packets": 0, "rx-octets": 0, "rx-kbps": 0, "lastupdated": 1643077714908, "port-type": "service", "encap-type": "null" }, { "vdevice-name": "169.254.10.10", "rx-errors": 0, "tx-kbps": 0, "if-admin-status": "Down", "tcp-mss-adjust": "1416", "tx-errors": 0, "tx-pps": 0, "ifname": "ge0/3", "rx-pps": 0, "af-type": "ipv4", "shaping-rate": 0, "if-oper-status": "Down", "ifindex": 4, "if-tracker-status": "NA", "num-flaps": "0", "rx-packets": 0, "vpn-id": "0", "vdevice-host-name": "vm3", "mtu": "1500", "rx-drops": 0, "tx-drops": 0, "ipv6-address": "-", "hwaddr": "52:54:00:2d:a0:f5", "ip-address": "-", "vdevice-dataKey": "169.254.10.10-0-ge0/3-ipv4", "tx-octets": 0, "tx-packets": 0, "rx-octets": 0, "rx-kbps": 0, "lastupdated": 1643077714908, "port-type": "service", "encap-type": "null" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/interface/arp_stats": { "get": { "tags": [ "Real-Time Monitoring - Interface" ], "description": "Get interface ARP statistics", "operationId": "getDeviceInterfaceARPStats", "parameters": [ { "name": "vpn-id", "in": "query", "description": "VPN Id", "schema": { "type": "string" } }, { "name": "ifname", "in": "query", "description": "IF Name", "schema": { "type": "string", "enum": [ "ge0/0", "ge0/1", "ge0/2", "ge0/3", "ge0/4", "ge0/5", "ge0/6", "ge0/7", "system", "eth0" ] } }, { "name": "af-type", "in": "query", "description": "AF Type", "schema": { "type": "string", "enum": [ "ipv4", "ipv6" ] } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "ARP statistics": { "description": "ARP statistics", "value": { "data": [ { "tx-arp-rate-limit-drops": "0", "rx-arp-rate-limit-drops": "0", "vdevice-name": "169.254.10.10", "rx-arp-non-local-drops": "45746", "rx-arp-requests": "296", "vpn-id": "0", "vdevice-host-name": "vm3", "rx-arp-reply-drops": "0", "ipv6-address": "-", "tx-arp-requests": "12281", "ip-address": "-", "tx-arp-replies": "304", "tx-no-arp-drops": "2", "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv4", "rx-arp-replies": "12281", "ifname": "ge0/1", "tx-arp-request-fail": "0", "af-type": "ipv4", "lastupdated": 1643077098782, "arp-add-fails": "1" }, { "tx-arp-rate-limit-drops": "0", "rx-arp-rate-limit-drops": "0", "vdevice-name": "169.254.10.10", "rx-arp-non-local-drops": "0", "rx-arp-requests": "0", "vpn-id": "0", "vdevice-host-name": "vm3", "rx-arp-reply-drops": "0", "ipv6-address": "-", "tx-arp-requests": "0", "ip-address": "-", "tx-arp-replies": "1", "tx-no-arp-drops": "0", "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv6", "rx-arp-replies": "0", "ifname": "ge0/1", "tx-arp-request-fail": "0", "af-type": "ipv6", "lastupdated": 1643077098782, "arp-add-fails": "0" }, { "tx-arp-rate-limit-drops": "0", "rx-arp-rate-limit-drops": "0", "vdevice-name": "169.254.10.10", "rx-arp-non-local-drops": "0", "rx-arp-requests": "0", "vpn-id": "0", "vdevice-host-name": "vm3", "rx-arp-reply-drops": "0", "ipv6-address": "-", "tx-arp-requests": "0", "ip-address": "-", "tx-arp-replies": "0", "tx-no-arp-drops": "0", "vdevice-dataKey": "169.254.10.10-0-ge0/2-ipv4", "rx-arp-replies": "0", "ifname": "ge0/2", "tx-arp-request-fail": "0", "af-type": "ipv4", "lastupdated": 1643077098782, "arp-add-fails": "0" }, { "tx-arp-rate-limit-drops": "0", "rx-arp-rate-limit-drops": "0", "vdevice-name": "169.254.10.10", "rx-arp-non-local-drops": "0", "rx-arp-requests": "0", "vpn-id": "0", "vdevice-host-name": "vm3", "rx-arp-reply-drops": "0", "ipv6-address": "-", "tx-arp-requests": "0", "ip-address": "-", "tx-arp-replies": "0", "tx-no-arp-drops": "0", "vdevice-dataKey": "169.254.10.10-0-ge0/2-ipv6", "rx-arp-replies": "0", "ifname": "ge0/2", "tx-arp-request-fail": "0", "af-type": "ipv6", "lastupdated": 1643077098782, "arp-add-fails": "0" }, { "tx-arp-rate-limit-drops": "0", "rx-arp-rate-limit-drops": "0", "vdevice-name": "169.254.10.10", "rx-arp-non-local-drops": "0", "rx-arp-requests": "0", "vpn-id": "0", "vdevice-host-name": "vm3", "rx-arp-reply-drops": "0", "ipv6-address": "-", "tx-arp-requests": "0", "ip-address": "-", "tx-arp-replies": "0", "tx-no-arp-drops": "0", "vdevice-dataKey": "169.254.10.10-0-ge0/3-ipv4", "rx-arp-replies": "0", "ifname": "ge0/3", "tx-arp-request-fail": "0", "af-type": "ipv4", "lastupdated": 1643077098782, "arp-add-fails": "0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/interface/error_stats": { "get": { "tags": [ "Real-Time Monitoring - Interface" ], "description": "Get interface error stats", "operationId": "getDeviceInterfaceErrorStats", "parameters": [ { "name": "vpn-id", "in": "query", "description": "VPN Id", "schema": { "type": "string" } }, { "name": "ifname", "in": "query", "description": "IF Name", "schema": { "type": "string", "enum": [ "ge0/0", "ge0/1", "ge0/2", "ge0/3", "ge0/4", "ge0/5", "ge0/6", "ge0/7", "system", "eth0" ] } }, { "name": "af-type", "in": "query", "description": "AF Type", "schema": { "type": "string", "enum": [ "ipv4", "ipv6" ] } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Error stats": { "description": "Error stats", "value": { "data": [ { "tx-icmp-policer-drops": "0", "rx-arp-rate-limit-drops": "0", "tx-icmp-mirrored-drops": "0", "vdevice-name": "169.254.10.10", "cpu-policer-drops": "2078", "interface-disabled": "0", "rx-arp-reply-drops": "0", "tx-no-arp-drops": "2", "ifname": "ge0/1", "split-horizon-drops": "0", "tx-arp-request-fail": "0", "af-type": "ipv4", "arp-add-fails": "1", "rx-policer-remark": "0", "mirror-drops": "0", "tx-arp-rate-limit-drops": "0", "rx-ip-ttl-expired": "0", "rx-arp-non-local-drops": "46027", "vpn-id": "0", "vdevice-host-name": "vm3", "ipv6-address": "-", "rx-policer-drops": "0", "bad-label": "0", "ip-address": "-", "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv4", "route-lookup-fail": "0", "lastupdated": 1643079662907, "rx-non-ip-drops": "0", "filter-drops": "0" }, { "tx-icmp-policer-drops": "0", "rx-arp-rate-limit-drops": "0", "tx-icmp-mirrored-drops": "0", "vdevice-name": "169.254.10.10", "cpu-policer-drops": "0", "interface-disabled": "0", "rx-arp-reply-drops": "0", "tx-no-arp-drops": "0", "ifname": "ge0/1", "split-horizon-drops": "0", "tx-arp-request-fail": "0", "af-type": "ipv6", "arp-add-fails": "0", "rx-policer-remark": "0", "mirror-drops": "0", "tx-arp-rate-limit-drops": "0", "rx-ip-ttl-expired": "0", "rx-arp-non-local-drops": "0", "vpn-id": "0", "vdevice-host-name": "vm3", "ipv6-address": "-", "rx-policer-drops": "0", "bad-label": "0", "ip-address": "-", "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv6", "route-lookup-fail": "0", "lastupdated": 1643079662907, "rx-non-ip-drops": "0", "filter-drops": "0" }, { "tx-icmp-policer-drops": "0", "rx-arp-rate-limit-drops": "0", "tx-icmp-mirrored-drops": "0", "vdevice-name": "169.254.10.10", "cpu-policer-drops": "0", "interface-disabled": "0", "rx-arp-reply-drops": "0", "tx-no-arp-drops": "0", "ifname": "ge0/2", "split-horizon-drops": "0", "tx-arp-request-fail": "0", "af-type": "ipv4", "arp-add-fails": "0", "rx-policer-remark": "0", "mirror-drops": "0", "tx-arp-rate-limit-drops": "0", "rx-ip-ttl-expired": "0", "rx-arp-non-local-drops": "0", "vpn-id": "0", "vdevice-host-name": "vm3", "ipv6-address": "-", "rx-policer-drops": "0", "bad-label": "0", "ip-address": "-", "vdevice-dataKey": "169.254.10.10-0-ge0/2-ipv4", "route-lookup-fail": "0", "lastupdated": 1643079662907, "rx-non-ip-drops": "0", "filter-drops": "0" }, { "tx-icmp-policer-drops": "0", "rx-arp-rate-limit-drops": "0", "tx-icmp-mirrored-drops": "0", "vdevice-name": "169.254.10.10", "cpu-policer-drops": "0", "interface-disabled": "0", "rx-arp-reply-drops": "0", "tx-no-arp-drops": "0", "ifname": "ge0/2", "split-horizon-drops": "0", "tx-arp-request-fail": "0", "af-type": "ipv6", "arp-add-fails": "0", "rx-policer-remark": "0", "mirror-drops": "0", "tx-arp-rate-limit-drops": "0", "rx-ip-ttl-expired": "0", "rx-arp-non-local-drops": "0", "vpn-id": "0", "vdevice-host-name": "vm3", "ipv6-address": "-", "rx-policer-drops": "0", "bad-label": "0", "ip-address": "-", "vdevice-dataKey": "169.254.10.10-0-ge0/2-ipv6", "route-lookup-fail": "0", "lastupdated": 1643079662907, "rx-non-ip-drops": "0", "filter-drops": "0" }, { "tx-icmp-policer-drops": "0", "rx-arp-rate-limit-drops": "0", "tx-icmp-mirrored-drops": "0", "vdevice-name": "169.254.10.10", "cpu-policer-drops": "0", "interface-disabled": "0", "rx-arp-reply-drops": "0", "tx-no-arp-drops": "0", "ifname": "ge0/3", "split-horizon-drops": "0", "tx-arp-request-fail": "0", "af-type": "ipv4", "arp-add-fails": "0", "rx-policer-remark": "0", "mirror-drops": "0", "tx-arp-rate-limit-drops": "0", "rx-ip-ttl-expired": "0", "rx-arp-non-local-drops": "0", "vpn-id": "0", "vdevice-host-name": "vm3", "ipv6-address": "-", "rx-policer-drops": "0", "bad-label": "0", "ip-address": "-", "vdevice-dataKey": "169.254.10.10-0-ge0/3-ipv4", "route-lookup-fail": "0", "lastupdated": 1643079662907, "rx-non-ip-drops": "0", "filter-drops": "0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/interface/ipv6Stats": { "get": { "tags": [ "Real-Time Monitoring - Interface" ], "description": "Get interface IPv6 stats", "operationId": "getDeviceInterfaceIpv6Stats", "parameters": [ { "name": "vpn-id", "in": "query", "description": "VPN Id", "schema": { "type": "string" } }, { "name": "ifname", "in": "query", "description": "IF Name", "schema": { "type": "string", "enum": [ "ge0/0", "ge0/1", "ge0/2", "ge0/3", "ge0/4", "ge0/5", "ge0/6", "ge0/7", "system", "eth0" ] } }, { "name": "af-type", "in": "query", "description": "AF Type", "schema": { "type": "string", "enum": [ "ipv4", "ipv6" ] } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Interface IPv6 stats": { "description": "Interface IPv6 stats", "value": { "data": [ { "in-forwarded-pkts": "0", "vdevice-name": "169.254.10.12", "out-pkts": "0", "in-forwarded-octets": "0", "in-discarded-pkts": "0", "out-forwarded-octets": "0", "in-error-pkts": "0", "vdevice-host-name": "vm5", "in-pkts": "0", "out-forwarded-pkts": "0", "out-octets": "0", "out-discarded-pkts": "0", "in-octets": "0", "vdevice-dataKey": "169.254.10.12-", "name": "GigabitEthernet1", "lastupdated": 1645602691945, "out-error-pkts": "0" }, { "in-forwarded-pkts": "0", "vdevice-name": "169.254.10.12", "out-pkts": "0", "in-forwarded-octets": "0", "in-discarded-pkts": "0", "out-forwarded-octets": "0", "in-error-pkts": "0", "vdevice-host-name": "vm5", "in-pkts": "0", "out-forwarded-pkts": "0", "out-octets": "0", "out-discarded-pkts": "0", "in-octets": "0", "vdevice-dataKey": "169.254.10.12-", "name": "GigabitEthernet2", "lastupdated": 1645602691945, "out-error-pkts": "0" }, { "in-forwarded-pkts": "0", "vdevice-name": "169.254.10.12", "out-pkts": "0", "in-forwarded-octets": "0", "in-discarded-pkts": "0", "out-forwarded-octets": "0", "in-error-pkts": "0", "vdevice-host-name": "vm5", "in-pkts": "0", "out-forwarded-pkts": "0", "out-octets": "0", "out-discarded-pkts": "0", "in-octets": "0", "vdevice-dataKey": "169.254.10.12-", "name": "GigabitEthernet3", "lastupdated": 1645602691946, "out-error-pkts": "0" }, { "in-forwarded-pkts": "0", "vdevice-name": "169.254.10.12", "out-pkts": "0", "in-forwarded-octets": "0", "in-discarded-pkts": "0", "out-forwarded-octets": "0", "in-error-pkts": "0", "vdevice-host-name": "vm5", "in-pkts": "0", "out-forwarded-pkts": "0", "out-octets": "0", "out-discarded-pkts": "0", "in-octets": "0", "vdevice-dataKey": "169.254.10.12-", "name": "GigabitEthernet4", "lastupdated": 1645602691946, "out-error-pkts": "0" }, { "in-forwarded-pkts": "0", "vdevice-name": "169.254.10.12", "out-pkts": "0", "in-forwarded-octets": "0", "in-discarded-pkts": "0", "out-forwarded-octets": "0", "in-error-pkts": "0", "vdevice-host-name": "vm5", "in-pkts": "0", "out-forwarded-pkts": "0", "out-octets": "0", "out-discarded-pkts": "0", "in-octets": "0", "vdevice-dataKey": "169.254.10.12-", "name": "GigabitEthernet5", "lastupdated": 1645602691946, "out-error-pkts": "0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/interface/pkt_size": { "get": { "tags": [ "Real-Time Monitoring - Interface" ], "description": "Get interface packet size", "operationId": "getDeviceInterfacePktSizes", "parameters": [ { "name": "vpn-id", "in": "query", "description": "VPN Id", "schema": { "type": "string" } }, { "name": "ifname", "in": "query", "description": "IF Name", "schema": { "type": "string", "enum": [ "ge0/0", "ge0/1", "ge0/2", "ge0/3", "ge0/4", "ge0/5", "ge0/6", "ge0/7", "system", "eth0" ] } }, { "name": "af-type", "in": "query", "description": "AF Type", "schema": { "type": "string", "enum": [ "ipv4", "ipv6" ] } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Interface packet size": { "description": "Interface packet size", "value": { "data": [ { "ip-address": "-", "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv4", "vdevice-name": "169.254.10.10", "ifname": "ge0/1", "num-flaps": "0", "af-type": "ipv4", "lastupdated": 1643080426479, "vpn-id": "0", "vdevice-host-name": "vm3", "ipv6-address": "-" }, { "ip-address": "-", "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv6", "vdevice-name": "169.254.10.10", "ifname": "ge0/1", "num-flaps": "0", "af-type": "ipv6", "lastupdated": 1643080426479, "vpn-id": "0", "vdevice-host-name": "vm3", "ipv6-address": "-" }, { "ip-address": "-", "vdevice-dataKey": "169.254.10.10-0-ge0/2-ipv4", "vdevice-name": "169.254.10.10", "ifname": "ge0/2", "num-flaps": "0", "af-type": "ipv4", "lastupdated": 1643080426479, "vpn-id": "0", "vdevice-host-name": "vm3", "ipv6-address": "-" }, { "ip-address": "-", "vdevice-dataKey": "169.254.10.10-0-ge0/2-ipv6", "vdevice-name": "169.254.10.10", "ifname": "ge0/2", "num-flaps": "0", "af-type": "ipv6", "lastupdated": 1643080426479, "vpn-id": "0", "vdevice-host-name": "vm3", "ipv6-address": "-" }, { "ip-address": "-", "vdevice-dataKey": "169.254.10.10-0-ge0/3-ipv4", "vdevice-name": "169.254.10.10", "ifname": "ge0/3", "num-flaps": "0", "af-type": "ipv4", "lastupdated": 1643080426479, "vpn-id": "0", "vdevice-host-name": "vm3", "ipv6-address": "-" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/interface/port_stats": { "get": { "tags": [ "Real-Time Monitoring - Interface" ], "description": "Get interface port stats", "operationId": "getDeviceInterfacePortStats", "parameters": [ { "name": "vpn-id", "in": "query", "description": "VPN Id", "schema": { "type": "string" } }, { "name": "ifname", "in": "query", "description": "IF Name", "schema": { "type": "string", "enum": [ "ge0/0", "ge0/1", "ge0/2", "ge0/3", "ge0/4", "ge0/5", "ge0/6", "ge0/7", "system", "eth0" ] } }, { "name": "af-type", "in": "query", "description": "AF Type", "schema": { "type": "string", "enum": [ "ipv4", "ipv6" ] } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Interface port stats": { "description": "Interface port stats", "value": { "data": [ { "ip-address": "-", "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv4", "vdevice-name": "169.254.10.10", "ifname": "ge0/1", "af-type": "ipv4", "lastupdated": 1643080839352, "vpn-id": "0", "vdevice-host-name": "vm3", "ipv6-address": "-" }, { "ip-address": "-", "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv6", "vdevice-name": "169.254.10.10", "ifname": "ge0/1", "af-type": "ipv6", "lastupdated": 1643080839352, "vpn-id": "0", "vdevice-host-name": "vm3", "ipv6-address": "-" }, { "ip-address": "-", "vdevice-dataKey": "169.254.10.10-0-ge0/2-ipv4", "vdevice-name": "169.254.10.10", "ifname": "ge0/2", "af-type": "ipv4", "lastupdated": 1643080839352, "vpn-id": "0", "vdevice-host-name": "vm3", "ipv6-address": "-" }, { "ip-address": "-", "vdevice-dataKey": "169.254.10.10-0-ge0/2-ipv6", "vdevice-name": "169.254.10.10", "ifname": "ge0/2", "af-type": "ipv6", "lastupdated": 1643080839352, "vpn-id": "0", "vdevice-host-name": "vm3", "ipv6-address": "-" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/interface/qosStats": { "get": { "tags": [ "Real-Time Monitoring - Interface" ], "description": "Get interface QOS stats", "operationId": "getDeviceInterfaceQosStats", "parameters": [ { "name": "vpn-id", "in": "query", "description": "VPN Id", "schema": { "type": "string" } }, { "name": "ifname", "in": "query", "description": "IF Name", "schema": { "type": "string", "enum": [ "ge0/0", "ge0/1", "ge0/2", "ge0/3", "ge0/4", "ge0/5", "ge0/6", "ge0/7", "system", "eth0" ] } }, { "name": "af-type", "in": "query", "description": "AF Type", "schema": { "type": "string", "enum": [ "ipv4", "ipv6" ] } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Interface QOS stats": { "description": "Interface QOS stats", "value": { "data": [ { "drop-bytes": "0", "vdevice-name": "169.254.10.13", "early-drop-bytes": "0", "early-drop-pkts": "0", "classified-bytes": "771", "vdevice-host-name": "vm6", "has-child": "false", "vdevice-dataKey": "169.254.10.13-GigabitEthernet2-vpn10_qos_policy-Queue0", "classified-pkts": "3", "classifier-entry-name": "Queue0", "policy-name": "vpn10_qos_policy", "output-bytes": "771", "name": "GigabitEthernet2", "lastupdated": 1654656462183, "drop-pkts": "0", "output-pkts": "3" }, { "drop-bytes": "0", "vdevice-name": "169.254.10.13", "early-drop-bytes": "0", "early-drop-pkts": "0", "classified-bytes": "0", "vdevice-host-name": "vm6", "has-child": "false", "vdevice-dataKey": "169.254.10.13-GigabitEthernet2-vpn10_qos_policy-class-default", "classified-pkts": "0", "classifier-entry-name": "class-default", "output-bytes": "0", "policy-name": "vpn10_qos_policy", "name": "GigabitEthernet2", "lastupdated": 1654656462183, "drop-pkts": "0", "output-pkts": "0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/interface/queue_stats": { "get": { "tags": [ "Real-Time Monitoring - Interface" ], "description": "Get interface queue stats", "operationId": "getDeviceInterfaceQueueStats", "parameters": [ { "name": "vpn-id", "in": "query", "description": "VPN Id", "schema": { "type": "string" } }, { "name": "ifname", "in": "query", "description": "IF Name", "schema": { "type": "string", "enum": [ "ge0/0", "ge0/1", "ge0/2", "ge0/3", "ge0/4", "ge0/5", "ge0/6", "ge0/7", "system", "eth0" ] } }, { "name": "af-type", "in": "query", "description": "AF Type", "schema": { "type": "string", "enum": [ "ipv4", "ipv6" ] } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Interface queue stats": { "description": "Interface queue stats", "value": { "data": [ { "qnum": "0", "max-depth": "0", "queued-packets": "0", "vdevice-name": "169.254.10.10", "avg-queue": "0", "red-drop-packets": "0", "vpn-id": "0", "queued-bytes": "0", "tail-drop-bytes": "0", "vdevice-host-name": "vm3", "red-drop-bytes": "0", "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv4-0", "ifname": "ge0/1", "tx-packets": "0", "queue-pps": "0", "af-type": "ipv4", "tx-bytes": "0", "lastupdated": 1643081385319, "queue-depth": "0", "queue-drop-pps": "0", "tail-drop-packets": "0" }, { "qnum": "2", "max-depth": "0", "queued-packets": "0", "vdevice-name": "169.254.10.10", "avg-queue": "0", "red-drop-packets": "0", "queued-bytes": "0", "tail-drop-bytes": "0", "vpn-id": "0", "vdevice-host-name": "vm3", "red-drop-bytes": "0", "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv4-2", "ifname": "ge0/1", "tx-packets": "0", "queue-pps": "0", "tx-bytes": "0", "af-type": "ipv4", "lastupdated": 1643081385319, "queue-depth": "0", "queue-drop-pps": "0", "tail-drop-packets": "0" }, { "qnum": "3", "max-depth": "0", "queued-packets": "0", "vdevice-name": "169.254.10.10", "avg-queue": "0", "red-drop-packets": "0", "queued-bytes": "0", "tail-drop-bytes": "0", "vpn-id": "0", "vdevice-host-name": "vm3", "red-drop-bytes": "0", "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv4-3", "ifname": "ge0/1", "tx-packets": "0", "queue-pps": "0", "tx-bytes": "0", "af-type": "ipv4", "lastupdated": 1643081385319, "queue-depth": "0", "queue-drop-pps": "0", "tail-drop-packets": "0" }, { "qnum": "4", "max-depth": "0", "queued-packets": "0", "vdevice-name": "169.254.10.10", "avg-queue": "0", "red-drop-packets": "0", "queued-bytes": "0", "tail-drop-bytes": "0", "vpn-id": "0", "vdevice-host-name": "vm3", "red-drop-bytes": "0", "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv4-4", "ifname": "ge0/1", "tx-packets": "0", "queue-pps": "0", "tx-bytes": "0", "af-type": "ipv4", "lastupdated": 1643081385319, "queue-depth": "0", "queue-drop-pps": "0", "tail-drop-packets": "0" }, { "qnum": "5", "max-depth": "0", "queued-packets": "0", "vdevice-name": "169.254.10.10", "avg-queue": "0", "red-drop-packets": "0", "queued-bytes": "0", "tail-drop-bytes": "0", "vpn-id": "0", "vdevice-host-name": "vm3", "red-drop-bytes": "0", "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv4-5", "ifname": "ge0/1", "tx-packets": "0", "queue-pps": "0", "tx-bytes": "0", "af-type": "ipv4", "lastupdated": 1643081385319, "queue-depth": "0", "queue-drop-pps": "0", "tail-drop-packets": "0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/interface/serial": { "get": { "tags": [ "Real-Time Monitoring - Interface" ], "description": "Get serial interface", "operationId": "getDeviceSerialInterface", "parameters": [ { "name": "vpn-id", "in": "query", "description": "VPN Id", "schema": { "type": "string" } }, { "name": "ifname", "in": "query", "description": "IF Name", "schema": { "type": "string", "enum": [ "ge0/0", "ge0/1", "ge0/2", "ge0/3", "ge0/4", "ge0/5", "ge0/6", "ge0/7", "system", "eth0" ] } }, { "name": "af-type", "in": "query", "description": "AF Type", "schema": { "type": "string", "enum": [ "ipv4", "ipv6" ] } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Serial interface": { "description": "Serial interface", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "ifname": "eth0", "crc-type": "32", "loopback": "Green", "keepalive": "3", "timeslot": "10", "vdevice-dataKey": "172.16.255.15", "subrate": "100000", "lastupdated": "1661309393233" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/interface/stats": { "get": { "tags": [ "Real-Time Monitoring - Interface" ], "description": "Get interface stats", "operationId": "getDeviceInterfaceStats", "parameters": [ { "name": "vpn-id", "in": "query", "description": "VPN Id", "schema": { "type": "string" } }, { "name": "ifname", "in": "query", "description": "IF Name", "schema": { "type": "string", "enum": [ "ge0/0", "ge0/1", "ge0/2", "ge0/3", "ge0/4", "ge0/5", "ge0/6", "ge0/7", "system", "eth0" ] } }, { "name": "af-type", "in": "query", "description": "AF Type", "schema": { "type": "string", "enum": [ "ipv4", "ipv6" ] } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Interface stats": { "description": "Interface stats", "value": { "data": [ { "vdevice-name": "169.254.10.10", "rx-packets": "6634251", "rx-errors": "0", "tx-kbps": "18", "tx-errors": "0", "tx-pps": "13", "vpn-id": "0", "dot1x-rx-pkts": "0", "vdevice-host-name": "vm3", "rx-drops": "48776", "tx-drops": "2", "ipv6-address": "-", "dot1x-tx-pkts": "0", "ip-address": "-", "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv4", "ifname": "ge0/1", "rx-pps": "13", "tx-octets": "1255701145", "tx-packets": "6493413", "af-type": "ipv4", "rx-octets": "1225652937", "rx-kbps": "19", "lastupdated": 1643083561267 }, { "vdevice-name": "169.254.10.10", "rx-packets": "3694", "rx-errors": "0", "tx-kbps": "0", "tx-errors": "0", "tx-pps": "0", "vpn-id": "0", "dot1x-rx-pkts": "0", "vdevice-host-name": "vm3", "rx-drops": "0", "tx-drops": "0", "ipv6-address": "-", "dot1x-tx-pkts": "0", "ip-address": "-", "vdevice-dataKey": "169.254.10.10-0-ge0/1-ipv6", "ifname": "ge0/1", "rx-pps": "0", "tx-octets": "9280", "tx-packets": "130", "af-type": "ipv6", "rx-octets": "411008", "rx-kbps": "0", "lastupdated": 1643083561267 }, { "vdevice-name": "169.254.10.10", "rx-packets": "0", "rx-errors": "0", "tx-kbps": "0", "tx-errors": "0", "tx-pps": "0", "vpn-id": "0", "dot1x-rx-pkts": "0", "vdevice-host-name": "vm3", "rx-drops": "0", "tx-drops": "0", "ipv6-address": "-", "dot1x-tx-pkts": "0", "ip-address": "-", "vdevice-dataKey": "169.254.10.10-0-ge0/2-ipv4", "ifname": "ge0/2", "rx-pps": "0", "tx-octets": "0", "tx-packets": "0", "af-type": "ipv4", "rx-octets": "0", "rx-kbps": "0", "lastupdated": 1643083561267 }, { "vdevice-name": "169.254.10.10", "rx-packets": "0", "rx-errors": "0", "tx-kbps": "0", "tx-errors": "0", "tx-pps": "0", "vpn-id": "0", "dot1x-rx-pkts": "0", "vdevice-host-name": "vm3", "rx-drops": "0", "tx-drops": "0", "ipv6-address": "-", "dot1x-tx-pkts": "0", "ip-address": "-", "vdevice-dataKey": "169.254.10.10-0-ge0/2-ipv6", "ifname": "ge0/2", "rx-pps": "0", "tx-octets": "0", "tx-packets": "0", "af-type": "ipv6", "rx-octets": "0", "rx-kbps": "0", "lastupdated": 1643083561267 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/interface/synced": { "get": { "tags": [ "Real-Time Monitoring - Interface" ], "description": "Get device interfaces synchronously", "operationId": "getSyncedDeviceInterface", "parameters": [ { "name": "vpn-id", "in": "query", "description": "VPN Id", "schema": { "type": "string" } }, { "name": "ifname", "in": "query", "description": "IF Name", "schema": { "type": "string", "enum": [ "ge0/0", "ge0/1", "ge0/2", "ge0/3", "ge0/4", "ge0/5", "ge0/6", "ge0/7", "system", "eth0" ] } }, { "name": "af-type", "in": "query", "description": "AF Type", "schema": { "type": "string", "enum": [ "ipv4", "ipv6" ] } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device interface": { "description": "Device interface", "value": { "data": [ { "vdevice-name": "172.16.255.11", "if-admin-status": "Up", "duplex": "full", "tcp-mss-adjust": "1416", "@rid": 855, "ifname": "ge0/1", "af-type": "ipv4", "shaping-rate": 0, "if-oper-status": "Up", "auto-neg": "false", "ifindex": 2, "if-tracker-status": "NA", "createTimeStamp": 1647315879734, "secondary-address": "", "vpn-id": "0", "vdevice-host-name": "vm1", "mtu": "1500", "ipv6-address": "-", "secondary": "false", "ip-address": "10.0.26.11/24", "hwaddr": "52:54:00:db:d9:1b", "speed-mbps": "1000", "vdevice-dataKey": "172.16.255.11-0-ge0/1-ipv4", "vmanage-system-ip": "172.16.255.11", "lastupdated": 1647315879722, "port-type": "service", "encap-type": "null" }, { "vdevice-name": "172.16.255.11", "if-admin-status": "Up", "duplex": "full", "tcp-mss-adjust": "1416", "@rid": 869, "ifname": "ge0/2", "af-type": "ipv4", "shaping-rate": 0, "if-oper-status": "Up", "auto-neg": "false", "ifindex": 3, "allow-service": "dhcpdnsicmphttps", "if-tracker-status": "NA", "createTimeStamp": 1647315880679, "secondary-address": "", "vpn-id": "0", "vdevice-host-name": "vm1", "mtu": "1500", "ipv6-address": "-", "secondary": "false", "ip-address": "10.0.5.11/24", "hwaddr": "52:54:00:5b:92:ab", "speed-mbps": "1000", "vdevice-dataKey": "172.16.255.11-0-ge0/2-ipv4", "vmanage-system-ip": "172.16.255.11", "lastupdated": 1647315879722, "port-type": "transport", "encap-type": "null" }, { "ifindex": 4, "vdevice-name": "172.16.255.11", "if-tracker-status": "NA", "if-admin-status": "Down", "createTimeStamp": 1647315881312, "tcp-mss-adjust": "1416", "vpn-id": "0", "vdevice-host-name": "vm1", "mtu": "1500", "ipv6-address": "-", "hwaddr": "52:54:00:36:5b:37", "ip-address": "-", "vdevice-dataKey": "172.16.255.11-0-ge0/3-ipv4", "@rid": 883, "ifname": "ge0/3", "vmanage-system-ip": "172.16.255.11", "af-type": "ipv4", "lastupdated": 1647315879722, "shaping-rate": 0, "port-type": "service", "if-oper-status": "Down", "encap-type": "null" }, { "vdevice-name": "172.16.255.11", "if-admin-status": "Up", "duplex": "full", "tcp-mss-adjust": "1416", "@rid": 897, "ifname": "ge0/4", "af-type": "ipv4", "shaping-rate": 0, "if-oper-status": "Up", "auto-neg": "false", "ifindex": 5, "if-tracker-status": "NA", "createTimeStamp": 1647315882880, "secondary-address": "", "vpn-id": "0", "vdevice-host-name": "vm1", "mtu": "1500", "ipv6-address": "-", "secondary": "false", "ip-address": "10.0.7.11/24", "hwaddr": "52:54:00:67:74:f1", "speed-mbps": "1000", "vdevice-dataKey": "172.16.255.11-0-ge0/4-ipv4", "vmanage-system-ip": "172.16.255.11", "lastupdated": 1647315879722, "port-type": "service", "encap-type": "null" }, { "ifindex": 6, "vdevice-name": "172.16.255.11", "if-tracker-status": "NA", "if-admin-status": "Down", "createTimeStamp": 1647315883461, "tcp-mss-adjust": "1416", "vpn-id": "0", "vdevice-host-name": "vm1", "mtu": "1500", "ipv6-address": "-", "hwaddr": "52:54:00:0f:c2:a7", "ip-address": "-", "vdevice-dataKey": "172.16.255.11-0-ge0/5-ipv4", "@rid": 908, "ifname": "ge0/5", "vmanage-system-ip": "172.16.255.11", "af-type": "ipv4", "lastupdated": 1647315879722, "shaping-rate": 0, "port-type": "service", "if-oper-status": "Down", "encap-type": "null" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/interface/trustsec": { "get": { "tags": [ "Real-Time Monitoring - Interface" ], "description": "Get policy filter memory usage from device", "operationId": "trustsec", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Policy filter memory usage": { "description": "Policy filter memory usage", "value": { "data": [ { "mode": "cts-ndac-mode-manual", "if-name": "GigabitEthernet2", "sgt-propagate": "cts-sgt-propagate-enabled", "vdevice-dataKey": "169.254.10.13-vm6-GigabitEthernet2", "vdevice-name": "169.254.10.13", "trusted": "cts-manual-untrusted", "lastupdated": 1654654895429, "peer-sgt": 0, "vdevice-host-name": "vm6" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write" } }, "/device/interface/vpn": { "get": { "tags": [ "Real-Time Monitoring - Interface" ], "description": "Get device interfaces per VPN", "operationId": "generateDeviceInterfaceVPN", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device interface": { "description": "Device interface", "value": { "data": [ { "index": 0, "vpnId": "0", "ifname": "ge0/1" }, { "index": 1, "vpnId": "0", "ifname": "ge0/2" }, { "index": 2, "vpnId": "0", "ifname": "ge0/3" }, { "index": 3, "vpnId": "0", "ifname": "ge0/4" }, { "index": 4, "vpnId": "0", "ifname": "ge0/5" }, { "index": 5, "vpnId": "0", "ifname": "ge0/6" }, { "index": 6, "vpnId": "0", "ifname": "ge0/7" }, { "index": 7, "vpnId": "0", "ifname": "system" }, { "index": 8, "vpnId": "1", "ifname": "ge0/0" }, { "index": 9, "vpnId": "512", "ifname": "eth0" }, { "index": 10, "vpnId": "65528", "ifname": "loopback65528" }, { "index": 11, "vpnId": "65530", "ifname": "loopback65530" }, { "index": 12, "vpnId": "65530", "ifname": "loopback65531" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/ip/fib": { "get": { "tags": [ "Real-Time Monitoring - IP" ], "description": "Get FIB list from Manager, Controller, Validator and vEdge device (Real Time)", "operationId": "createFibList", "parameters": [ { "name": "vpn-id", "in": "query", "description": "VPN Id", "schema": { "type": "string", "enum": [ "0", "512" ] } }, { "name": "address-family", "in": "query", "description": "Address family", "schema": { "type": "string", "enum": [ "IPv4", "IPv6" ] } }, { "name": "prefix", "in": "query", "description": "IP prefix", "schema": { "type": "string" } }, { "name": "tloc", "in": "query", "description": "tloc IP", "schema": { "type": "string" } }, { "name": "color", "in": "query", "description": "tloc color", "schema": { "type": "string", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "FIB list": { "description": "FIB list", "value": { "data": [ { "nexthop-address": "10.0.5.13", "vdevice-dataKey": "172.16.255.21-0-0.0.0.0/0", "vdevice-name": "172.16.255.21", "prefix": "0.0.0.0/0", "lastupdated": 1649641392351, "out-ifname": "ge0/1", "vpn-id": 0, "vdevice-host-name": "vm11", "address-family": "ipv4" }, { "vdevice-dataKey": "172.16.255.21-0-10.0.5.0/24", "vdevice-name": "172.16.255.21", "prefix": "10.0.5.0/24", "lastupdated": 1649641392351, "out-ifname": "ge0/1", "vpn-id": 0, "vdevice-host-name": "vm11", "address-family": "ipv4" }, { "vdevice-dataKey": "172.16.255.21-0-10.0.5.21/32", "vdevice-name": "172.16.255.21", "prefix": "10.0.5.21/32", "lastupdated": 1649641392351, "out-ifname": "ge0/1", "vpn-id": 0, "vdevice-host-name": "vm11", "address-family": "ipv4" }, { "vdevice-dataKey": "172.16.255.21-0-10.0.100.0/24", "vdevice-name": "172.16.255.21", "prefix": "10.0.100.0/24", "lastupdated": 1649641392351, "out-ifname": "ge0/7", "vpn-id": 0, "vdevice-host-name": "vm11", "address-family": "ipv4" }, { "vdevice-dataKey": "172.16.255.21-0-10.0.100.21/32", "vdevice-name": "172.16.255.21", "prefix": "10.0.100.21/32", "lastupdated": 1649641392351, "out-ifname": "ge0/7", "vpn-id": 0, "vdevice-host-name": "vm11", "address-family": "ipv4" }, { "vdevice-dataKey": "172.16.255.21-0-100.0.0.0/24", "vdevice-name": "172.16.255.21", "prefix": "100.0.0.0/24", "lastupdated": 1649641392351, "out-ifname": "ge0/6", "vpn-id": 0, "vdevice-host-name": "vm11", "address-family": "ipv4" }, { "vdevice-dataKey": "172.16.255.21-0-100.0.0.11/32", "vdevice-name": "172.16.255.21", "prefix": "100.0.0.11/32", "lastupdated": 1649641392351, "out-ifname": "ge0/6", "vpn-id": 0, "vdevice-host-name": "vm11", "address-family": "ipv4" }, { "nexthop-address": "100.0.0.1", "vdevice-dataKey": "172.16.255.21-0-100.2.0.0/24", "vdevice-name": "172.16.255.21", "prefix": "100.2.0.0/24", "lastupdated": 1649641392351, "out-ifname": "ge0/6", "vpn-id": 0, "vdevice-host-name": "vm11", "address-family": "ipv4" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write,System-read,System-write" } }, "/device/ip/ipRoutes": { "get": { "tags": [ "Real-Time Monitoring - IP" ], "description": "Get ietf routing list from device", "operationId": "createIetfRoutingList", "parameters": [ { "name": "routing-instance-name", "in": "query", "description": "VPN Id", "schema": { "type": "string" } }, { "name": "address-family", "in": "query", "description": "Address family", "schema": { "type": "string" } }, { "name": "outgoing-interface", "in": "query", "description": "Outgoing Interface", "schema": { "type": "string" } }, { "name": "source-protocol", "in": "query", "description": "Source Protocol", "schema": { "type": "string" } }, { "name": "next-hop-address", "in": "query", "description": "Next Hop Address", "schema": { "type": "string" } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "ietf routing list": { "description": "ietf routing list", "value": { "data": [ { "protocol-type": "direct", "vdevice-name": "169.254.10.12", "route-destination-prefix": "0.0.0.0/0", "route-source-protocol": "static", "next-hop-next-hop-address": "10.102.254.254", "routing-instance-name": "default", "protocol-name": "0", "route-route-preference": "1", "vdevice-host-name": "vm5", "rib-default-rib": "false", "rib-address-family": "ipv4", "vdevice-dataKey": "169.254.10.12--", "router-id": "0.0.0.0", "route-metric": "0", "lastupdated": 1645080304580 }, { "protocol-type": "direct", "vdevice-name": "169.254.10.12", "route-destination-prefix": "10.101.0.0/16", "route-source-protocol": "direct", "next-hop-next-hop-address": "0.0.0.0", "routing-instance-name": "default", "protocol-name": "0", "route-route-preference": "0", "vdevice-host-name": "vm5", "rib-default-rib": "false", "rib-address-family": "ipv4", "vdevice-dataKey": "169.254.10.12--", "router-id": "0.0.0.0", "next-hop-outgoing-interface": "GigabitEthernet3", "route-metric": "0", "lastupdated": 1645080304580 }, { "protocol-type": "direct", "vdevice-name": "169.254.10.12", "route-destination-prefix": "10.101.5.5/32", "route-source-protocol": "direct", "next-hop-next-hop-address": "0.0.0.0", "routing-instance-name": "default", "protocol-name": "0", "route-route-preference": "0", "vdevice-host-name": "vm5", "rib-default-rib": "false", "rib-address-family": "ipv4", "vdevice-dataKey": "169.254.10.12--", "router-id": "0.0.0.0", "next-hop-outgoing-interface": "GigabitEthernet3", "route-metric": "0", "lastupdated": 1645080304580 }, { "protocol-type": "direct", "vdevice-name": "169.254.10.12", "route-destination-prefix": "10.102.0.0/16", "route-source-protocol": "direct", "next-hop-next-hop-address": "0.0.0.0", "routing-instance-name": "default", "protocol-name": "0", "route-route-preference": "0", "vdevice-host-name": "vm5", "rib-default-rib": "false", "rib-address-family": "ipv4", "vdevice-dataKey": "169.254.10.12--", "router-id": "0.0.0.0", "next-hop-outgoing-interface": "GigabitEthernet5", "route-metric": "0", "lastupdated": 1645080304580 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write,System-read,System-write" } }, "/device/ip/mfiboil": { "get": { "tags": [ "Real-Time Monitoring - IP" ], "description": "Get IP MFIB OIL list from device (Real Time)", "operationId": "createIPMfibOilList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "IP MFIB OIL list": { "description": "IP MFIB OIL list", "value": { "data": [ { "vdevice-dataKey": "169.254.10.11-10-", "vdevice-name": "169.254.10.11", "lastupdated": 1654849997281, "source": "0.0.0.0", "vpn-id": 10, "vdevice-host-name": "vm4", "group": "224.0.1.39" }, { "vdevice-dataKey": "169.254.10.11-10-", "vdevice-name": "169.254.10.11", "lastupdated": 1654849997281, "source": "0.0.0.0", "vpn-id": 10, "vdevice-host-name": "vm4", "group": "224.0.1.40" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write,System-read,System-write" } }, "/device/ip/mfibstats": { "get": { "tags": [ "Real-Time Monitoring - IP" ], "description": "Get IP MFIB statistics list from device (Real Time)", "operationId": "createIPMfibStatsList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "IP MFIB statistics list": { "description": "IP MFIB statistics list", "value": { "data": [ { "tx-octet-rate": 0, "tx-pkts": 0, "vdevice-name": "169.254.10.11", "rx-octet-rate": 0, "rx-packet-rate": 0, "source": "0.0.0.0", "rpf-failure": 0, "vpn-id": 10, "vdevice-host-name": "vm4", "tx-packet-rate": 0, "tx-policy-drop": 0, "avg_replication": "0.00", "vdevice-dataKey": "169.254.10.11-10-", "rx-policy-drop": 0, "tx-octets": 0, "rx-octets": 0, "tx-to-pim-pkts": 0, "lastupdated": 1654850155929, "tx-invalid-oil-failure": 0, "rx-pkts": "0", "group": "224.0.1.39" }, { "tx-octet-rate": 0, "tx-pkts": 0, "vdevice-name": "169.254.10.11", "rx-octet-rate": 0, "rx-packet-rate": 0, "source": "0.0.0.0", "rpf-failure": 0, "vpn-id": 10, "vdevice-host-name": "vm4", "tx-packet-rate": 0, "tx-policy-drop": 0, "avg_replication": "0.00", "vdevice-dataKey": "169.254.10.11-10-", "rx-policy-drop": 0, "tx-octets": 0, "rx-octets": 0, "tx-to-pim-pkts": 0, "lastupdated": 1654850155929, "tx-invalid-oil-failure": 0, "rx-pkts": "0", "group": "224.0.1.40" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write,System-read,System-write" } }, "/device/ip/mfibsummary": { "get": { "tags": [ "Real-Time Monitoring - IP" ], "description": "Get IP MFIB summary list from device (Real Time)", "operationId": "createIPMfibSummaryList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "IP MFIB summary list": { "description": "IP MFIB summary list", "value": { "data": [ { "upstream-tunnel": "0.0.0.0", "vdevice-dataKey": "169.254.10.11-10-224.0.1.39", "vdevice-name": "169.254.10.11", "upstream-if": "---", "lastupdated": 1654850209775, "source": "0.0.0.0", "vpn-id": 10, "num-tunnel-oils": "0", "vdevice-host-name": "vm4", "group": "224.0.1.39", "num-service-oils": "0" }, { "upstream-tunnel": "0.0.0.0", "vdevice-dataKey": "169.254.10.11-10-224.0.1.40", "vdevice-name": "169.254.10.11", "upstream-if": "---", "lastupdated": 1654850209775, "source": "0.0.0.0", "vpn-id": 10, "num-tunnel-oils": "0", "vdevice-host-name": "vm4", "group": "224.0.1.40", "num-service-oils": "0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write,System-read,System-write" } }, "/device/ip/nat/filter": { "get": { "tags": [ "Real-Time Monitoring - IP" ], "description": "Get NAT filter list from device", "operationId": "createNatFilterList", "parameters": [ { "name": "nat-vpn-id", "in": "query", "description": "NAT VPN Id", "schema": { "type": "string" } }, { "name": "nat-ifname", "in": "query", "description": "NAT interface name", "schema": { "type": "string" } }, { "name": "private-source-address", "in": "query", "description": "Private source address", "schema": { "type": "string" } }, { "name": "proto", "in": "query", "description": "Protocol", "schema": { "type": "string", "enum": [ "icm", "tcp", "udp" ] } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "NAT filter list": { "description": "NAT filter list", "value": { "data": [ { "vdevice-name": "172.16.254.1", "vdevice-host-name": "vm2", "nat-vpn-id": "0", "nat-ifname": "ge0/0", "private-vpn-id": "0", "proto": "icmp", "private-source-address": "10.1.15.15", "private-dest-address": "10.1.14.14", "private-source-port": "4697", "public-source-address": "10.1.15.15", "public-dest-address": "10.1.14.14", "public-source-port": "64931", "public-dest-port": "64931", "filter-state": "established", "idle-timeout": "0:00:00:41", "idle-timeout-date": "-", "outbound-packets": "1", "outbound-octets": "98", "inbound-packets": "1", "inbound-octets": "98", "lastupdated": 1657853484627, "vdevice-dataKey": "172.16.254.1-10-224.0.1.40" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write,System-read,System-write" } }, "/device/ip/nat/interface": { "get": { "tags": [ "Real-Time Monitoring - IP" ], "description": "Get NAT interface list from device (Real Time)", "operationId": "createNatInterfaceList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "NAT interface list": { "description": "NAT interface list", "value": { "data": [ { "fib-filter-count": 0, "vdevice-name": "169.254.10.9", "lastupdated": 1654525771150, "vpn-id": 0, "vdevice-dataKey": "169.254.10.9-0", "mapping-type": "endpoint-independent", "filter-count": 0, "vdevice-host-name": "vm2", "ifname": "ipsec10", "filter-type": "address-port-restricted" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write,System-read,System-write" } }, "/device/ip/nat/interfacestatistics": { "get": { "tags": [ "Real-Time Monitoring - IP" ], "description": "Get NAT interface statistics list from device", "operationId": "createNatInterfaceStatisticsList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "NAT interface statistics list": { "description": "NAT interface statistics list", "value": [ { "out2in-drops": 0, "in2out-drops": 0, "vdevice-dataKey": "172.16.255.15-0-0", "vdevice-host-name": "vm5", "initialized": 9223372036854776000, "entry-timeouts": 0, "pool-stats-drop": "0", "limit-entry-add-fail": "0", "outsides": 0, "packets-punted": "0", "lastupdated": 1645079319277, "mapping-stats-drop": "0", "misses": 0, "interrupt-switched": 0, "frag-pak-count": "0", "statics": 0, "flows": 0, "entries": "0", "vdevice-name": "172.16.255.15", "hits": 0, "portlist-req-fail": "0", "ipalias-add-fail": 0, "insides": 0, "statics-sorted": 0 } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write,System-read,System-write" } }, "/device/ip/nat/translation": { "get": { "tags": [ "Real-Time Monitoring - IP" ], "description": "Get NAT translation list from device (Real Time)", "operationId": "createNatTranslationList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "NAT translation list": { "description": "NAT translation list", "value": { "data": [ { "inside-local-addr": "10.1.15.15", "outside-local-port": "50", "vdevice-name": "172.16.255.15", "inside-global-port": "50", "flags": "0", "outside-global-port": "50", "vdevice-host-name": "vm5", "vrfid": "0", "protocol": "1", "outside-local-addr": "10.1.16.16", "vdevice-dataKey": "172.16.255.15-10.1.15.15-10.1.16.16-10.1.15.15-10.1.16.16-50", "outside-global-addr": "10.1.16.16", "inside-local-port": "50", "lastupdated": 1651038839092, "application-type": "0", "inside-global-addr": "10.1.15.15" }, { "inside-local-addr": "10.1.15.15", "outside-local-port": "51", "vdevice-name": "172.16.255.15", "inside-global-port": "51", "flags": "0", "outside-global-port": "51", "vdevice-host-name": "vm5", "vrfid": "0", "protocol": "1", "outside-local-addr": "10.1.16.16", "vdevice-dataKey": "172.16.255.15-10.1.15.15-10.1.16.16-10.1.15.15-10.1.16.16-51", "outside-global-addr": "10.1.16.16", "inside-local-port": "51", "lastupdated": 1651038839092, "application-type": "0", "inside-global-addr": "10.1.15.15" }, { "inside-local-addr": "10.1.15.15", "outside-local-port": "49", "vdevice-name": "172.16.255.15", "inside-global-port": "49", "flags": "0", "outside-global-port": "49", "vdevice-host-name": "vm5", "vrfid": "0", "protocol": "1", "outside-local-addr": "10.1.16.16", "vdevice-dataKey": "172.16.255.15-10.1.15.15-10.1.16.16-10.1.15.15-10.1.16.16-49", "outside-global-addr": "10.1.16.16", "inside-local-port": "49", "lastupdated": 1651038839092, "application-type": "0", "inside-global-addr": "10.1.15.15" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write,System-read,System-write" } }, "/device/ip/nat64/translation": { "get": { "tags": [ "Real-Time Monitoring - IP" ], "description": "Get NAT64 interface list from device", "operationId": "createNat64TranslationList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "NAT64 interface list": { "description": "NAT64 interface list", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "vrf-name": "1", "protocol": "icmp", "orig-ipv6-src-addr": "2001:DB8:3001::9", "orig-ipv6-dst-addr": "2800:1503:2000:1:1::0a01:7102", "orig-src-port": 2654, "orig-dst-port": 2654, "translated-src-addr": "10.1.113.2", "translated-dst-addr": "50.50.50.50", "translated-src-port": "2654", "translated-dst-port": "2654", "lastupdated": 1660727547133 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write,System-read,System-write" } }, "/device/ip/routetable": { "get": { "tags": [ "Real-Time Monitoring - IP" ], "description": "Get route table list from device (Real Time)", "operationId": "createRouteTableList", "parameters": [ { "name": "vpn-id", "in": "query", "description": "VPN Id", "schema": { "type": "string", "enum": [ "0", "512" ] } }, { "name": "address-family", "in": "query", "description": "Address family", "schema": { "type": "string", "enum": [ "IPv4", "IPv6" ] } }, { "name": "prefix", "in": "query", "description": "IP prefix", "schema": { "type": "string" } }, { "name": "protocol", "in": "query", "description": "IP protocol", "schema": { "type": "string" } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Route table list": { "description": "Route table list", "value": { "data": [ { "rstatus": "F S", "protocol": "static", "vdevice-dataKey": "169.254.10.10-0-0.0.0.0/0", "vdevice-name": "169.254.10.10", "prefix": "0.0.0.0/0", "lastupdated": 1643160579908, "nexthop-addr": "10.101.254.254", "vpn-id": 0, "nexthop-type": "ipv4", "vdevice-host-name": "vm3", "address-family": "ipv4", "nexthop-ifname": "ge0/1" }, { "color": "default", "vdevice-name": "169.254.10.10", "prefix": "10.0.5.0/24", "ip": "172.16.254.4", "encap": "ipsec", "vpn-id": 10, "nexthop-label": "1047", "nexthop-type": "ipv4-indirect", "vdevice-host-name": "vm3", "rstatus": "F S", "protocol": "omp", "vdevice-dataKey": "169.254.10.10-10-10.0.5.0/24", "lastupdated": 1643160579908, "address-family": "ipv4" }, { "rstatus": "F S", "protocol": "connected", "vdevice-dataKey": "169.254.10.10-512-fcff::/120", "vdevice-name": "169.254.10.10", "prefix": "fcff::/120", "lastupdated": 1643160579908, "vpn-id": 512, "nexthop-type": "ipv6", "vdevice-host-name": "vm3", "address-family": "ipv6", "nexthop-ifname": "loop0.2" }, { "rstatus": "F S", "protocol": "connected", "vdevice-dataKey": "169.254.10.10-65528-192.168.0.0/24", "vdevice-name": "169.254.10.10", "prefix": "192.168.0.0/24", "lastupdated": 1643160579908, "vpn-id": 65528, "nexthop-type": "ipv4", "vdevice-host-name": "vm3", "address-family": "ipv4", "nexthop-ifname": "loopback65528" }, { "rstatus": "F S", "protocol": "connected", "vdevice-dataKey": "169.254.10.10-65530-192.168.0.0/24", "vdevice-name": "169.254.10.10", "prefix": "192.168.0.0/24", "lastupdated": 1643160579908, "vpn-id": 65530, "nexthop-type": "ipv4", "vdevice-host-name": "vm3", "address-family": "ipv4", "nexthop-ifname": "loopback65530" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write,System-read,System-write" } }, "/device/ip/v4fib": { "get": { "tags": [ "Real-Time Monitoring - IPv4 FIB" ], "description": "Get IPv4 FIB list from Manager, Controller, Validator and vEdge device (Real Time)", "operationId": "createIPv4FibList", "parameters": [ { "name": "vpn-id", "in": "query", "description": "VPN Id", "schema": { "type": "string", "enum": [ "0", "512" ] } }, { "name": "prefix", "in": "query", "description": "IP prefix", "schema": { "type": "string" } }, { "name": "tloc", "in": "query", "description": "tloc IP", "schema": { "type": "string" } }, { "name": "color", "in": "query", "description": "tloc color", "schema": { "type": "string", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "FIB list": { "description": "FIB list", "value": { "data": [ { "path-id": 1, "vdevice-dataKey": "169.254.10.10-512-10.0.1.0/24", "vdevice-name": "169.254.10.10", "prefix": "10.0.1.0/24", "lastupdated": 1643096072514, "out-ifname": "eth0", "vpn-id": 512, "vdevice-host-name": "vm3" }, { "path-id": 1, "vdevice-dataKey": "169.254.10.10-512-10.0.1.3/32", "vdevice-name": "169.254.10.10", "prefix": "10.0.1.3/32", "lastupdated": 1643096072514, "out-ifname": "eth0", "vpn-id": 512, "vdevice-host-name": "vm3" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write,System-read,System-write" } }, "/device/ip/v6fib": { "get": { "tags": [ "Real-Time Monitoring - IPv6 FIB" ], "description": "Get IPv6 FIB list from Manager, Controller, Validator and vEdge device (Real Time)", "operationId": "createIPv6FibList", "parameters": [ { "name": "vpn-id", "in": "query", "description": "VPN Id", "schema": { "type": "string", "enum": [ "0", "512" ] } }, { "name": "prefix", "in": "query", "description": "IP prefix", "schema": { "type": "string" } }, { "name": "tloc", "in": "query", "description": "tloc IP", "schema": { "type": "string" } }, { "name": "color", "in": "query", "description": "tloc color", "schema": { "type": "string", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "FIB list": { "description": "FIB list", "value": { "data": [ { "path-id": 1, "vdevice-dataKey": "169.254.10.10-0-fe80::3274:7d86:eb7f:4a3c/128", "vdevice-name": "169.254.10.10", "prefix": "fe80::3274:7d86:eb7f:4a3c/128", "lastupdated": 1643096311251, "out-ifname": "vmanage_system", "vpn-id": 0, "vdevice-host-name": "vm3" }, { "path-id": 1, "vdevice-dataKey": "169.254.10.10-0-fe80::40b8:4592:c183:592c/128", "vdevice-name": "169.254.10.10", "prefix": "fe80::40b8:4592:c183:592c/128", "lastupdated": 1643096311251, "out-ifname": "system", "vpn-id": 0, "vdevice-host-name": "vm3" }, { "path-id": 1, "vdevice-dataKey": "169.254.10.10-0-fe80::5054:ff:fea1:4f47/128", "vdevice-name": "169.254.10.10", "prefix": "fe80::5054:ff:fea1:4f47/128", "lastupdated": 1643096311251, "out-ifname": "ge0/1", "vpn-id": 0, "vdevice-host-name": "vm3" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write,System-read,System-write" } }, "/device/ipsec/identity": { "get": { "tags": [ "Real-Time Monitoring - IPsec" ], "description": "Get Crypto IPSEC identity entry from device", "operationId": "createCryptoIpsecIdentity", "parameters": [ { "name": "remote-tloc-address", "in": "query", "description": "Remote TLOC address", "schema": { "type": "string" } }, { "name": "remote-tloc-color", "in": "query", "description": "Remote tloc color", "schema": { "type": "string", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] } }, { "name": "local-tloc-color", "in": "query", "description": "Local tloc color", "schema": { "type": "string", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Crypto IPSEC identity entry": { "description": "Crypto IPSEC identity entry", "value": { "data": [ { "vdevice-name": "169.254.10.12", "local-ident-addr": "10.102.5.5", "local-endpt-addr": "10.102.5.5", "remote-ident-protocol": "0", "interface": "Tunnel5", "vpn-id": "0", "vdevice-host-name": "vm5", "local-ident-mask": "255.255.255.255", "local-ident-protocol": "0", "vdevice-dataKey": "169.254.10.12", "plaintext-mtu": "1438", "lastupdated": 1644890148156, "remote-ident-addr": "10.101.3.3", "remote-endpt-addr": "10.101.3.3", "remote-ident-mask": "255.255.255.255", "dh-group": "crypto-dh-grouptype-none" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Security-read,Security-write" } }, "/device/ipsec/ike/inbound": { "get": { "tags": [ "Real-Time Monitoring - IPsec" ], "description": "Get IPsec IKE inbound connection list from device", "operationId": "createIkeInboundList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "IPsec IKE local inbound connection list": { "description": "IPsec IKE local inbound connection list", "value": { "data": [ { "vdevice-name": "169.254.10.9", "vdevice-host-name": "vm2", "source-ip": "2.2.2.2", "source-port": "4500", "dest-ip": "3.3.3.3", "dest-port": "4500", "new-spi": "257", "old-spi": "256", "cipher-suite": "aes256-cbc-sha1", "new-key-hash": "****01be", "old-key-hash": "****a0df", "ext-seq": "11", "lastupdated": "1654066322656", "vdevice-dataKey": "169.254.10.9-10-ipsec1" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Security-read,Security-write" } }, "/device/ipsec/ike/outbound": { "get": { "tags": [ "Real-Time Monitoring - IPsec" ], "description": "Get IPsec IKE outbound connection list from device", "operationId": "createIkeOutboundList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "IPsec IKE outbound connection list": { "description": "IPsec IKE outbound connection list", "value": { "data": [ { "vdevice-name": "169.254.10.9", "vdevice-host-name": "vm2", "source-ip": "2.2.2.2", "source-port": "4500", "dest-ip": "3.3.3.3", "dest-port": "4500", "spi": "257", "cipher-suite": "aes256-cbc-sha1", "keyhash": "****55b5", "tunnel-mtu": "1418", "ext-seq": "11", "lastupdated": "1654066322656", "vdevice-dataKey": "169.254.10.9-10-ipsec1" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Security-read,Security-write" } }, "/device/ipsec/ike/sessions": { "get": { "tags": [ "Real-Time Monitoring - IPsec" ], "description": "Get IPsec IKE sessions from device", "operationId": "createIkeSessions", "parameters": [ { "name": "remote-tloc-address", "in": "query", "description": "Remote TLOC address", "schema": { "type": "string" } }, { "name": "remote-tloc-color", "in": "query", "description": "Remote tloc color", "schema": { "type": "string", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "IPsec IKE sessions": { "description": "IPsec IKE sessions", "value": { "data": [ { "dest-ip": "3.3.3.3", "source-port": 4500, "vdevice-name": "169.254.10.9", "vpn-id": "10", "version": "1", "vdevice-host-name": "vm2", "uptime": "0:00:00:00", "if-name": "ipsec1", "dest-port": 4500, "vdevice-dataKey": "169.254.10.9-10-ipsec1", "cipher-suite": "aes256-cbc-sha1", "lastupdated": 1654066322656, "source-ip": "2.2.2.2", "state": "INTF_CREATED", "uptime-date": 1654066320000, "dh-group": "16 (MODP-4096)" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Security-read,Security-write" } }, "/device/ipsec/ikev1": { "get": { "tags": [ "Real-Time Monitoring - IPsec" ], "description": "Get Crypto IKEv1 SA entry from device", "operationId": "createCryptov1LocalSAList", "parameters": [ { "name": "remote-tloc-address", "in": "query", "description": "Remote TLOC address", "schema": { "type": "string" } }, { "name": "remote-tloc-color", "in": "query", "description": "Remote tloc color", "schema": { "type": "string", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Crypto IKEv1 SA entry": { "description": "Crypto IKEv1 SA entry", "value": { "data": [ { "init-spi": "NzA4MjczNjM1RTYwOUE0MQ==", "remote-ip-addr": "10.1.16.16", "vdevice-name": "172.16.255.15", "sa-status": "crypto-sa-status-active", "lifetime": 84025, "vdevice-host-name": "vm5", "local-ip-addr": "10.1.15.15", "my-auth-method": "crypto-ikev2-auth-psk", "ivrf": "none", "local-port": 500, "peer-auth-method": "crypto-ikev2-auth-psk", "vdevice-dataKey": "172.16.255.15", "fvrf": "none", "resp-spi": "MDkzRDYwQ0YwQzUxMDcxMg==", "encr-alg": "crypto-encr-alg-aes-cbc", "remote-port": 500, "hash-algo": "crypto-hash-alg-auth-hmac-sha256", "lastupdated": 1657094847813, "sa-id": "1002", "dh-group": "crypto-dh-grouptype-group16" }, { "init-spi": "NTlCQjQyNzVEOURCMEExNg==", "remote-ip-addr": "10.1.16.16", "vdevice-name": "172.16.255.15", "sa-status": "crypto-sa-status-active", "lifetime": 84026, "vdevice-host-name": "vm5", "local-ip-addr": "10.1.15.15", "my-auth-method": "crypto-ikev2-auth-psk", "ivrf": "none", "local-port": 500, "peer-auth-method": "crypto-ikev2-auth-psk", "vdevice-dataKey": "172.16.255.15", "fvrf": "none", "resp-spi": "RTlFMUZEN0VCQUZGNDNGQQ==", "encr-alg": "crypto-encr-alg-aes-cbc", "remote-port": 500, "hash-algo": "crypto-hash-alg-auth-hmac-sha256", "lastupdated": 1657094847813, "sa-id": "1003", "dh-group": "crypto-dh-grouptype-group16" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Security-read,Security-write" } }, "/device/ipsec/ikev2": { "get": { "tags": [ "Real-Time Monitoring - IPsec" ], "description": "Get Crypto IKEv2 SA entry from device", "operationId": "createCryptov2LocalSAList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Crypto IKEv2 SA entry": { "description": "Crypto IKEv2 SA entry", "value": { "data": [ { "init-spi": "MkVENzFDRUMxODUyNDVDNA==", "remote-ip-addr": "10.1.16.16", "vdevice-name": "172.16.255.15", "sa-status": "crypto-sa-status-active", "lifetime": 86400, "vdevice-host-name": "vm5", "local-ip-addr": "10.1.15.15", "my-auth-method": "crypto-ikev2-auth-psk", "ivrf": "1", "local-port": 500, "peer-auth-method": "crypto-ikev2-auth-psk", "vdevice-dataKey": "172.16.255.15", "fvrf": "none", "resp-spi": "MzY1RjFGMUMxODgxNTY5Qg==", "encr-alg": "crypto-encr-alg-aes-cbc", "remote-port": 500, "hash-algo": "crypto-hash-alg-auth-hmac-sha512", "lastupdated": 1657274365619, "sa-id": "1", "dh-group": "crypto-dh-grouptype-group24" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Security-read,Security-write" } }, "/device/ipsec/inbound": { "get": { "tags": [ "Real-Time Monitoring - IPsec" ], "description": "Get IPsec inbound connection list from device (Real Time)", "operationId": "createInBoundList", "parameters": [ { "name": "remote-tloc-address", "in": "query", "description": "Remote TLOC address", "schema": { "type": "string" } }, { "name": "remote-tloc-color", "in": "query", "description": "Remote tloc color", "schema": { "type": "string", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] } }, { "name": "local-tloc-color", "in": "query", "description": "Local tloc color", "schema": { "type": "string", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "IPsec inbound connection list": { "description": "IPsec inbound connection list", "value": { "data": [ { "dest-ip": "10.101.3.3", "source-port": 12386, "vdevice-name": "169.254.10.10", "vdevice-host-name": "vm3", "remote-tloc-address": "172.16.254.1", "negotiated-encryption-algo": "AES-GCM-256", "dest-port": 12406, "vdevice-dataKey": "169.254.10.10-172.16.254.2", "local-tloc-address": "172.16.254.2", "lastupdated": 1643163071849, "source-ip": "10.101.2.2", "remote-tloc-color": "default", "local-tloc-color": "default" }, { "dest-ip": "10.101.3.3", "source-port": 12406, "vdevice-name": "169.254.10.10", "vdevice-host-name": "vm3", "remote-tloc-address": "172.16.254.3", "negotiated-encryption-algo": "AES-GCM-256", "dest-port": 12406, "vdevice-dataKey": "169.254.10.10-172.16.254.2", "local-tloc-address": "172.16.254.2", "lastupdated": 1643163071849, "source-ip": "10.101.4.4", "remote-tloc-color": "default", "local-tloc-color": "default" }, { "dest-ip": "10.101.3.3", "source-port": 12406, "vdevice-name": "169.254.10.10", "vdevice-host-name": "vm3", "remote-tloc-address": "172.16.254.4", "negotiated-encryption-algo": "AES-GCM-256", "dest-port": 12406, "vdevice-dataKey": "169.254.10.10-172.16.254.2", "local-tloc-address": "172.16.254.2", "lastupdated": 1643163071849, "source-ip": "10.102.5.5", "remote-tloc-color": "default", "local-tloc-color": "default" }, { "dest-ip": "10.101.3.3", "source-port": 12406, "vdevice-name": "169.254.10.10", "vdevice-host-name": "vm3", "remote-tloc-address": "172.16.254.5", "negotiated-encryption-algo": "AES-GCM-256", "dest-port": 12406, "vdevice-dataKey": "169.254.10.10-172.16.254.2", "local-tloc-address": "172.16.254.2", "lastupdated": 1643163071849, "source-ip": "10.102.6.6", "remote-tloc-color": "default", "local-tloc-color": "default" }, { "dest-ip": "10.101.3.3", "source-port": 12406, "vdevice-name": "169.254.10.10", "vdevice-host-name": "vm3", "remote-tloc-address": "172.16.254.16", "negotiated-encryption-algo": "AES-GCM-256", "dest-port": 12406, "vdevice-dataKey": "169.254.10.10-172.16.254.2", "local-tloc-address": "172.16.254.2", "lastupdated": 1643163071849, "source-ip": "10.102.16.16", "remote-tloc-color": "default", "local-tloc-color": "default" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Security-read,Security-write" } }, "/device/ipsec/localsa": { "get": { "tags": [ "Real-Time Monitoring - IPsec" ], "description": "Get IPsec local SA list from device", "operationId": "createLocalSAList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "IPsec local SA list": { "description": "IPsec local SA list", "value": { "data": [ { "tloc-color": "default", "vdevice-dataKey": "169.254.10.10-172.16.254.2", "vdevice-name": "169.254.10.10", "port": 12406, "tloc-address": "172.16.254.2", "ipv6": "::", "ip": "10.101.3.3", "lastupdated": 1643166514716, "encrypt-key-hash": "*****386b", "spi": "286", "auth-key-hash": "*****386b", "vdevice-host-name": "vm3" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Security-read,Security-write" } }, "/device/ipsec/outbound": { "get": { "tags": [ "Real-Time Monitoring - IPsec" ], "description": "Get IPsec outbound connection list from device (Real Time)", "operationId": "createOutBoundList", "parameters": [ { "name": "remote-tloc-address", "in": "query", "description": "Remote TLOC address", "schema": { "type": "string" } }, { "name": "remote-tloc-color", "in": "query", "description": "Remote tloc color", "schema": { "type": "string", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "IPsec outbound connection list": { "description": "IPsec outbound connection list", "value": { "data": [ { "dest-ip": "10.101.2.2", "integrity-used": "ip-udp-esp", "source-port": 12426, "vdevice-name": "169.254.10.10", "spi": 262, "auth-key-hash": "*****2450", "vdevice-host-name": "vm3", "remote-tloc-address": "172.16.254.1", "dest-port": 12386, "vdevice-dataKey": "169.254.10.10-10.101.3.3", "tunnel-mtu": 1441, "lastupdated": 1643334538276, "source-ip": "10.101.3.3", "remote-tloc-color": "default", "encrypt-key-hash": "*****2450" }, { "dest-ip": "10.101.4.4", "integrity-used": "ip-udp-esp", "source-port": 12426, "vdevice-name": "169.254.10.10", "spi": 289, "auth-key-hash": "*****3b7e", "vdevice-host-name": "vm3", "remote-tloc-address": "172.16.254.3", "dest-port": 12366, "vdevice-dataKey": "169.254.10.10-10.101.3.3", "tunnel-mtu": 1441, "lastupdated": 1643334538276, "source-ip": "10.101.3.3", "remote-tloc-color": "default", "encrypt-key-hash": "*****3b7e" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Security-read,Security-write" } }, "/device/ipsec/pwk/inbound": { "get": { "tags": [ "Real-Time Monitoring - IPsec" ], "description": "Get IPSEC pairwise key inbound entry from device", "operationId": "createIPsecPWKInboundConnections", "parameters": [ { "name": "remote-tloc-address", "in": "query", "description": "Remote TLOC address", "schema": { "type": "string" } }, { "name": "remote-tloc-color", "in": "query", "description": "Remote tloc color", "schema": { "type": "string", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] } }, { "name": "local-tloc-color", "in": "query", "description": "Local tloc color", "schema": { "type": "string", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "IPSEC pairwise key inbound entry": { "description": "IPSEC pairwise key inbound entry", "value": { "data": [ { "dest-ip": "10.101.5.5", "local-tloc-index": "32770", "source-port": "12366", "pkey-hash": " ", "vdevice-name": "169.254.10.12", "nonce-hash": " ", "is-ah-auth": "true", "pwk-spi": "0", "vdevice-host-name": "vm5", "pkey-id": "0", "ss-hash": " ", "remote-tloc-address": "172.16.254.1", "dest-port": "12346", "vdevice-dataKey": "169.254.10.12", "d-key-hash": " ", "local-tloc-address": "172.16.254.4", "lastupdated": 1645154066644, "remote-tloc-color": "lte", "source-ip": "10.102.2.2", "local-tloc-color": "default", "sa-index": "7", "remote-tloc-index": "32775" }, { "dest-ip": "10.101.5.5", "local-tloc-index": "32770", "source-port": "12366", "pkey-hash": " ", "vdevice-name": "169.254.10.12", "nonce-hash": " ", "is-ah-auth": "true", "pwk-spi": "0", "vdevice-host-name": "vm5", "pkey-id": "0", "ss-hash": " ", "remote-tloc-address": "172.16.254.1", "dest-port": "12346", "vdevice-dataKey": "169.254.10.12", "d-key-hash": " ", "local-tloc-address": "172.16.254.4", "lastupdated": 1645154066644, "remote-tloc-color": "3g", "source-ip": "10.101.2.2", "local-tloc-color": "default", "sa-index": "19", "remote-tloc-index": "32781" }, { "dest-ip": "10.101.5.5", "local-tloc-index": "32770", "source-port": "12366", "pkey-hash": " ", "vdevice-name": "169.254.10.12", "nonce-hash": " ", "is-ah-auth": "true", "pwk-spi": "0", "vdevice-host-name": "vm5", "pkey-id": "0", "ss-hash": " ", "remote-tloc-address": "172.16.254.2", "dest-port": "12346", "vdevice-dataKey": "169.254.10.12", "d-key-hash": " ", "local-tloc-address": "172.16.254.4", "lastupdated": 1645154066644, "remote-tloc-color": "lte", "source-ip": "10.102.3.3", "local-tloc-color": "default", "sa-index": "11", "remote-tloc-index": "32777" }, { "dest-ip": "10.101.5.5", "local-tloc-index": "32770", "source-port": "12366", "pkey-hash": " ", "vdevice-name": "169.254.10.12", "nonce-hash": " ", "is-ah-auth": "true", "pwk-spi": "0", "vdevice-host-name": "vm5", "pkey-id": "0", "ss-hash": " ", "remote-tloc-address": "172.16.254.2", "dest-port": "12346", "vdevice-dataKey": "169.254.10.12", "d-key-hash": " ", "local-tloc-address": "172.16.254.4", "lastupdated": 1645154066645, "remote-tloc-color": "3g", "source-ip": "10.101.3.3", "local-tloc-color": "default", "sa-index": "9", "remote-tloc-index": "32776" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Security-read,Security-write" } }, "/device/ipsec/pwk/localsa": { "get": { "tags": [ "Real-Time Monitoring - IPsec" ], "description": "Get IPSEC pairwise key local SA entry from device", "operationId": "createIPsecPWKLocalSA", "parameters": [ { "name": "remote-tloc-address", "in": "query", "description": "Remote TLOC address", "schema": { "type": "string" } }, { "name": "remote-tloc-color", "in": "query", "description": "Remote tloc color", "schema": { "type": "string", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] } }, { "name": "local-tloc-color", "in": "query", "description": "Local tloc color", "schema": { "type": "string", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "IPSEC pairwise key local SA entry": { "description": "IPSEC pairwise key local SA entry", "value": { "data": [ { "tloc-color": "default", "pkey-hash": " ", "vdevice-name": "169.254.10.12", "nonce-hash": " ", "tloc-address": "172.16.254.4", "tloc-index": "32770", "ip": "10.101.5.5", "spi": "262", "vdevice-host-name": "vm5", "pkey-id": "0", "vdevice-dataKey": "169.254.10.12", "port": "12346", "lastupdated": 1645153823323, "sa-index": "9" }, { "tloc-color": "default", "pkey-hash": " ", "vdevice-name": "169.254.10.12", "nonce-hash": " ", "tloc-address": "172.16.254.4", "tloc-index": "32770", "ip": "10.101.5.5", "spi": "263", "vdevice-host-name": "vm5", "pkey-id": "0", "vdevice-dataKey": "169.254.10.12", "port": "12346", "lastupdated": 1645153823323, "sa-index": "11" }, { "tloc-color": "3g", "pkey-hash": " ", "vdevice-name": "169.254.10.12", "nonce-hash": " ", "tloc-address": "172.16.254.4", "tloc-index": "32771", "ip": "10.102.5.5", "spi": "262", "vdevice-host-name": "vm5", "pkey-id": "0", "vdevice-dataKey": "169.254.10.12", "port": "12346", "lastupdated": 1645153823323, "sa-index": "10" }, { "tloc-color": "3g", "pkey-hash": " ", "vdevice-name": "169.254.10.12", "nonce-hash": " ", "tloc-address": "172.16.254.4", "tloc-index": "32771", "ip": "10.102.5.5", "spi": "263", "vdevice-host-name": "vm5", "pkey-id": "0", "vdevice-dataKey": "169.254.10.12", "port": "12346", "lastupdated": 1645153823323, "sa-index": "12" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Security-read,Security-write" } }, "/device/ipsec/pwk/outbound": { "get": { "tags": [ "Real-Time Monitoring - IPsec" ], "description": "Get IPSEC pairwise key outbound entry from device", "operationId": "createIPsecPWKOutboundConnections", "parameters": [ { "name": "remote-tloc-address", "in": "query", "description": "Remote TLOC address", "schema": { "type": "string" } }, { "name": "remote-tloc-color", "in": "query", "description": "Remote tloc color", "schema": { "type": "string", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] } }, { "name": "local-tloc-color", "in": "query", "description": "Local tloc color", "schema": { "type": "string", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "IPSEC pairwise key outbound entry": { "description": "IPSEC pairwise key outbound entry", "value": { "data": [ { "pkey-id": "0", "vdevice-dataKey": "172.16.255.15", "nonce-hash": " ", "pkey-hash": " ", "vdevice-host-name": "vm5", "e-key-hash": "a600", "local-tloc-color": "lte", "dest-ip": "10.0.5.11", "source-ip": "10.1.15.15", "remote-tloc-index": "32772", "lastupdated": 1645156239932, "sa-index": "183", "remote-tloc-address": "172.16.255.11", "tloc-index": "32772", "dest-port": "12367", "source-port": "12346", "local-tloc-index": "32770", "vdevice-name": "172.16.255.15", "remote-tloc-color": "lte", "ss-hash": " ", "spi": "302", "local-tloc-address": "172.16.255.15", "is-ah-auth": "true", "pwk-spi": "0" }, { "pkey-id": "0", "vdevice-dataKey": "172.16.255.15", "nonce-hash": " ", "pkey-hash": " ", "vdevice-host-name": "vm5", "e-key-hash": "b13e", "local-tloc-color": "lte", "dest-ip": "10.0.5.21", "source-ip": "10.1.15.15", "remote-tloc-index": "32771", "lastupdated": 1645156239933, "sa-index": "182", "remote-tloc-address": "172.16.255.21", "tloc-index": "32771", "dest-port": "12377", "source-port": "12346", "local-tloc-index": "32770", "vdevice-name": "172.16.255.15", "remote-tloc-color": "lte", "ss-hash": " ", "spi": "302", "local-tloc-address": "172.16.255.15", "is-ah-auth": "true", "pwk-spi": "0" }, { "pkey-id": "0", "vdevice-dataKey": "172.16.255.15", "nonce-hash": " ", "pkey-hash": " ", "vdevice-host-name": "vm5", "e-key-hash": "59f1", "local-tloc-color": "lte", "dest-ip": "10.1.14.14", "source-ip": "10.1.15.15", "remote-tloc-index": "32774", "lastupdated": 1645156239933, "sa-index": "184", "remote-tloc-address": "172.16.255.14", "tloc-index": "32774", "dest-port": "12366", "source-port": "12346", "local-tloc-index": "32770", "vdevice-name": "172.16.255.15", "remote-tloc-color": "lte", "ss-hash": " ", "spi": "302", "local-tloc-address": "172.16.255.15", "is-ah-auth": "true", "pwk-spi": "0" }, { "pkey-id": "0", "vdevice-dataKey": "172.16.255.15", "nonce-hash": " ", "pkey-hash": " ", "vdevice-host-name": "vm5", "e-key-hash": "61b6", "local-tloc-color": "lte", "dest-ip": "10.1.16.16", "source-ip": "10.1.15.15", "remote-tloc-index": "32773", "lastupdated": 1645156239933, "sa-index": "181", "remote-tloc-address": "172.16.255.16", "tloc-index": "32773", "dest-port": "12366", "source-port": "12346", "local-tloc-index": "32770", "vdevice-name": "172.16.255.15", "remote-tloc-color": "lte", "ss-hash": " ", "spi": "302", "local-tloc-address": "172.16.255.15", "is-ah-auth": "true", "pwk-spi": "0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Security-read,Security-write" } }, "/device/ipv6/nd6": { "get": { "tags": [ "Real-Time Monitoring - Device" ], "description": "Get ipv6 data from device", "operationId": "getIpv6Data", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "object", "properties": { "deviceIp": { "type": "string" } }, "description": "This is the valid DeviceIP", "$$ref": "#/components/schemas/DeviceIP" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "IP v6 data": { "description": "IP v6 data", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "vrf-name": "8", "if-name": "Et0/0", "ip": "FE80::A8BB:CCFF:FE01:F500", "mac-address": "AA:BB:CC:01:F5:00", "state": "REACHABLE", "idle-timer": "8850", "uptime": "01:34:16", "lastupdated": 1660727547133 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write,System-read,System-write" } }, "/device/keyvalue": { "get": { "tags": [ "Monitoring - Device Details" ], "description": "Get vEdge inventory as key value (key as systemIp value as hostName)", "operationId": "getDeviceListAsKeyValue", "parameters": [ { "name": "site-id", "in": "query", "description": "Optional site ID to filter devices", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "vEdge inventory": { "description": "vEdge inventory", "value": { "header": { "generatedOn": 1635297986225 }, "data": [ { "key": "172.16.255.128", "value": "vm128 (172.16.255.128)" }, { "key": "172.16.253.129", "value": "vm129 (172.16.253.129)" }, { "key": "172.16.255.130", "value": "vm130 (172.16.255.130)" }, { "key": "172.16.253.131", "value": "vm131 (172.16.253.131)" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/lacp/info": { "get": { "tags": [ "Real-Time Monitoring - Lacp" ], "description": "Get device lacp port channel info list (Real Time)", "operationId": "getLacpInterfaceList", "parameters": [ { "name": "channel-group", "in": "query", "description": "Channel-group", "schema": { "type": "string" } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device lacp info": { "description": "Device lacp info", "value": { "data": [ { "ayer-type": "l3-etherchannel", "vdevice-name": "10.0.0.121", "channel-group": "1", "vdevice-host-name": "ISR4451-X", "total-no-of-links-bundled": 2, "total-no-of-links-standby": 0, "total-no-of-links-down": 0, "vdevice-dataKey": "10.0.0.121-1", "total-no-of-links": 2, "port-channel-up": "true", "lastupdated": 1650883014316, "total-no-of-links-suspended": "0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Interface-read,Interface-write" } }, "/device/lacp/members": { "get": { "tags": [ "Real-Time Monitoring - Lacp" ], "description": "Get device lacp port channel interface table (Real Time)", "operationId": "getLacpMembers", "parameters": [ { "name": "channel-group", "in": "query", "description": "Channel-group", "schema": { "type": "string" } }, { "name": "ifName", "in": "query", "description": "Interface Name", "schema": { "type": "string" } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device lacp port channel interface": { "description": "Device lacp port channel interface", "value": { "data": [ { "flood-packets": "0", "max-macs": 1024, "move": 0, "vdevice-name": "10.0.0.121", "learn": 0, "age-time": 300, "rx-packets": "0", "rx-routed-packets": "0", "num-macs": 4, "routing-interface": "Vlan1", "vdevice-host-name": "ISR4451-X", "vdevice-dataKey": "10.0.0.121-1", "vlan": "1", "tx-octets": "0", "tx-packets": "0", "name": "default", "rx-octets": "0", "lastupdated": 1650882963285, "bridge-id": "1", "flood-octets": "0", "tx-routed-packets": "0", "age": 0 }, { "flood-packets": "0", "max-macs": 1024, "move": 0, "vdevice-name": "10.0.0.121", "learn": 0, "age-time": 300, "rx-packets": "0", "rx-routed-packets": "0", "num-macs": 0, "routing-interface": "null", "vdevice-host-name": "ISR4451-X", "vdevice-dataKey": "10.0.0.121-1002", "vlan": "1002", "tx-octets": "0", "tx-packets": "0", "name": "fddi-default", "rx-octets": "0", "lastupdated": 1650882963285, "bridge-id": "1002", "flood-octets": "0", "tx-routed-packets": "0", "age": 0 }, { "flood-packets": "0", "max-macs": 1024, "move": 0, "vdevice-name": "10.0.0.121", "learn": 0, "age-time": 300, "rx-packets": "0", "rx-routed-packets": "0", "num-macs": 0, "routing-interface": "null", "vdevice-host-name": "ISR4451-X", "vdevice-dataKey": "10.0.0.121-1003", "vlan": "1003", "tx-octets": "0", "tx-packets": "0", "name": "token-ring-default", "rx-octets": "0", "lastupdated": 1650882963285, "bridge-id": "1003", "flood-octets": "0", "tx-routed-packets": "0", "age": 0 }, { "flood-packets": "0", "max-macs": 1024, "move": 0, "vdevice-name": "10.0.0.121", "learn": 0, "age-time": 300, "rx-packets": "0", "rx-routed-packets": "0", "num-macs": 0, "routing-interface": "null", "vdevice-host-name": "ISR4451-X", "vdevice-dataKey": "10.0.0.121-1004", "vlan": "1004", "tx-octets": "0", "tx-packets": "0", "name": "fddinet-default", "rx-octets": "0", "lastupdated": 1650882963285, "bridge-id": "1004", "flood-octets": "0", "tx-routed-packets": "0", "age": 0 }, { "flood-packets": "0", "max-macs": 1024, "move": 0, "vdevice-name": "10.0.0.121", "learn": 0, "age-time": 300, "rx-packets": "0", "rx-routed-packets": "0", "num-macs": 0, "routing-interface": "null", "vdevice-host-name": "ISR4451-X", "vdevice-dataKey": "10.0.0.121-1005", "vlan": "1005", "tx-octets": "0", "tx-packets": "0", "name": "trnet-default", "rx-octets": "0", "lastupdated": 1650882963285, "bridge-id": "1005", "flood-octets": "0", "tx-routed-packets": "0", "age": 0 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Interface-read,Interface-write" } }, "/device/license/evaluation": { "get": { "tags": [ "Real-Time Monitoring - License Info" ], "description": "Get license evaluation info from device", "operationId": "getLicenseEvalInfo", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "License evaluation info": { "description": "License evaluation info", "value": { "data": [ { "vdevice-dataKey": "169.254.10.14", "vdevice-name": "169.254.10.14", "lastupdated": 1646031617468, "eval-expired": "false", "eval-in-use": "false", "time-left": "0", "vdevice-host-name": "vm16" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/license/pak": { "get": { "tags": [ "Real-Time Monitoring - License Info" ], "description": "Get license pak info from device", "operationId": "getLicensePAKInfo", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "License pak info": { "description": "License pak info", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "singleton_id": 10, "store": "Primary License Storage", "storeindex": 0, "version": "1.0", "feature_name": "test_subscr", "type": "Evaluation", "state": "Active, Not in Use, EULA accepted", "count": "Non-Counted", "priority": "Low", "lastupdated": 660244459596 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/license/privacy": { "get": { "tags": [ "Real-Time Monitoring - License Info" ], "description": "Get license privacy info from device", "operationId": "getLicensePrivacyInfo", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "License privacy info": { "description": "License privacy info", "value": { "data": [ {}, { "lastupdated": 1646030987293, "hostname": "false", "vdevice-dataKey": "169.254.10.14", "vdevice-name": "169.254.10.14", "version": "false", "vdevice-host-name": "vm16" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/license/registration": { "get": { "tags": [ "Real-Time Monitoring - License Info" ], "description": "Get license registration info from device", "operationId": "getLicenseRegInfo", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "License info": { "description": "License info", "value": { "data": [ { "vdevice-dataKey": "169.254.10.12", "vdevice-name": "169.254.10.12", "always-enabled": "true", "lastupdated": 1645754331129, "vdevice-host-name": "vm5", "smart-enabled": "false" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/license/udi": { "get": { "tags": [ "Real-Time Monitoring - License Info" ], "description": "Get license UDI info from device", "operationId": "getLicenseUDIInfo", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "License UDI info": { "description": "License UDI info", "value": { "data": [ { "mac-address": "00:00:00:00:00:00", "vdevice-dataKey": "169.254.10.14", "vdevice-name": "169.254.10.14", "lastupdated": 1646030100474, "pid": "CSR1000V", "sn": "9PBHZUBMD18", "vdevice-host-name": "vm16" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/license/usage": { "get": { "tags": [ "Real-Time Monitoring - License Info" ], "description": "Get license usage info from device", "operationId": "getLicenseUsageInfo", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "License usage info": { "description": "License usage info", "value": { "data": [ { "vdevice-name": "172.16.254.4", "vdevice-host-name": "vm5", "entitlement-tag": "WAN_License", "short-name": "-", "license-name": "WAN_License", "description": "-", "count": "8", "enforcement-mode": "Blocking", "post-paid": "false", "subscription-id": "968BA1CF-C146-4ADF-A300-308DCF718EEE", "lastupdated": 1646031617468, "vdevice-dataKey": "172.16.254.4" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/logging": { "get": { "tags": [ "Real-Time Monitoring - AAA" ], "description": "Get logging from device (Real Time)", "operationId": "getLoggingFromDevice", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Logging": { "description": "Logging", "value": { "data": [ { "disk_priority": "info", "disk_filerotate": 10, "vdevice-dataKey": "169.254.10.10", "vdevice-name": "169.254.10.10", "host_priority": "emerg", "lastupdated": 1643178776334, "disk_status": "enabled", "disk_filename": "vsyslog", "disk_filesize": 10, "host_status": "disabled", "host_vpn_id": 0, "vdevice-host-name": "vm3" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Interface-read,Interface-write" } }, "/device/models": { "get": { "tags": [ "Monitoring - Device Details" ], "description": "Get all device models supported by the vManage", "operationId": "listAllDeviceModels", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "cpuCountAttribute": { "type": "object", "properties": { "attributeField": { "type": "string", "example": "total_cpu_count" }, "enable": { "type": "boolean", "example": true } }, "$$ref": "#/components/schemas/DeviceCpuCount" }, "deviceClass": { "type": "string", "example": "cisco-router" }, "deviceType": { "type": "string", "example": "vedge" }, "displayName": { "type": "string", "example": "ISR4461" }, "interfaces": { "type": "object", "properties": { "day0": { "type": "array", "description": "day0 interfaces", "example": [ "GigabitEthernet0/0/0" ], "items": { "type": "string", "description": "day0 interface", "example": "GigabitEthernet0/0/0" } }, "lan": { "type": "array", "description": "lan interfaces", "example": [ "GigabitEthernet", "TenGigabitEthernet", "Loopback" ], "items": { "type": "string", "description": "lan interface", "example": "GigabitEthernet" } }, "mgmt": { "type": "array", "description": "mgmt interfaces", "example": [ "GigabitEthernet", "TenGigabitEthernet", "Loopback" ], "items": { "type": "string", "description": "mgmt interface", "example": "GigabitEthernet" } }, "wan": { "type": "array", "description": "wan interfaces", "example": [ "GigabitEthernet", "TenGigabitEthernet", "Loopback" ], "items": { "type": "string", "description": "wan interface", "example": "GigabitEthernet" } } }, "$$ref": "#/components/schemas/DeviceInterface" }, "isCliSupported": { "type": "boolean", "example": true }, "name": { "type": "string", "example": "vedge-ISR-4461" }, "onboardCert": { "type": "boolean", "example": true }, "templateClass": { "type": "string", "example": "cedge" }, "templateSupported": { "type": "boolean", "example": true } }, "$$ref": "#/components/schemas/DeviceModelsData" } }, "header": { "type": "object", "properties": { "generatedOn": { "type": "integer", "format": "int64", "example": 1635224742597 } }, "$$ref": "#/components/schemas/DeviceResponseHeader" } }, "$$ref": "#/components/schemas/DeviceModelsResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/models/{uuid}": { "get": { "tags": [ "Monitoring - Device Details" ], "description": "Get device model for the device", "operationId": "getDeviceModels", "parameters": [ { "name": "uuid", "in": "path", "description": "Device uuid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device model": { "description": "Device model", "value": { "name": "vedge-cloud", "displayName": "vEdge Cloud", "deviceType": "vedge", "isCliSupported": true, "templateSupported": true, "deviceClass": "viptela-router", "cpuCountAttribute": { "enable": true, "attributeField": "linux_cpu_count" }, "onboardCert": false } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/monitor": { "get": { "tags": [ "Monitoring - Device Details" ], "description": "Get all monitoring details of the devices", "operationId": "listAllMonitorDetailsDevices", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Monitor device details": { "description": "Monitor device details", "value": { "header": { "generatedOn": 1635227574211, "viewKeys": { "uniqueKey": [], "preferenceKey": "grid-MonitorDeviceDetails" }, "columns": [ { "title": "Status", "property": "status", "display": "icon", "iconProperty": "status-icon", "colorProperty": "status-color", "hideable": false, "dataType": "string" }, { "title": "Device Type", "property": "device-type", "display": "keyvalue", "keyvalueProperty": "device-type", "keyvalue": [ { "key": "vsmart", "value": "vSmart" }, { "key": "vbond", "value": "vBond" }, { "key": "vmanage", "value": "vManage" }, { "key": "vedge", "value": "WAN Edge" } ], "dataType": "string" } ], "fields": [ { "property": "status", "dataType": "string", "display": "icon" }, { "property": "host-name", "dataType": "string", "display": "iconAndText" } ] }, "data": [ { "device-model": "vmanage", "device-type": "vmanage", "system-ip": "169.254.10.1", "host-name": "vm200", "site-id": "200", "layoutLevel": 1, "status": "normal" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/multicast/replicator": { "get": { "tags": [ "Real-Time Monitoring - Multicast" ], "description": "Get replicator list from device", "operationId": "createReplicatorList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Replicator list": { "description": "Replicator list", "value": { "data": [ { "vdevice-dataKey": "169.254.10.9", "vdevice-name": "169.254.10.9", "replicator-status": "UP", "replicator-address": "172.16.254.1", "lastupdated": 1655109179818, "vpn-id": "10", "vdevice-host-name": "vm2" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/multicast/rpf": { "get": { "tags": [ "Real-Time Monitoring - Multicast" ], "description": "Get RPF list from device", "operationId": "createRpfList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "RPF list": { "description": "RPF list", "value": { "data": [ { "vdevice-name": "172.16.254.1", "vdevice-host-name": "vm2", "vpn-id": "1", "rpf-address": "10.20.25.18", "rpf-status": "resolved", "nexthop-count": "1", "nbr-addr": "-", "rpf-if-name": "ge0/4", "rpf-tunnel": "-", "vdevice-dataKey": "172.16.254.1", "lastupdated": 1644997246553 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/multicast/topology": { "get": { "tags": [ "Real-Time Monitoring - Multicast" ], "description": "Get topology list from device", "operationId": "createTopologyList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Topology list": { "description": "Topology list", "value": { "data": [ { "vdevice-name": "172.16.254.1", "vdevice-host-name": "vm2", "vpn-id": "1", "group": "225.0.0.0", "source": "0.0.0.0", "join-type": "(*,G)", "rp-address": "58.0.1.100", "replicator": "172.16.255.14", "upstream-neighbor": "172.16.255.14", "upstream-state": "joined", "upstream-interface": "172.16.255.14", "up-time": "0:01:26:52", "up-time-date": "18 07 2022 16:26:52 A z", "expires": "0:00:00:31", "expires-date": "20 07 2022 16:26:52 A z", "oif-tunnel": "-", "vdevice-dataKey": "172.16.254.1", "lastupdated": 1644997246553 }, { "vdevice-name": "172.16.254.1", "vdevice-host-name": "vm2", "vpn-id": "1", "group": "225.0.0.9", "source": "56.0.1.100", "join-type": "(*,G)", "rp-address": "-", "replicator": "-", "upstream-neighbor": "56.0.1.100", "upstream-state": "joined", "upstream-interface": "ge0/0", "up-time": "0:16:26:52", "up-time-date": "18 07 2022 16:26:52 A z", "expires": "0:16:26:52", "expires-date": "20 07 2022 16:26:52 A z", "oif-tunnel": "172.16.255.14", "vdevice-dataKey": "172.16.254.1", "lastupdated": 1644997246553 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/multicast/tunnel": { "get": { "tags": [ "Real-Time Monitoring - Multicast" ], "description": "Get PIM tunnel from device", "operationId": "createPimTunnelList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "PIM tunnel": { "description": "PIM tunnel", "value": { "data": [ { "tunnel-status": "UP", "vdevice-dataKey": "169.254.10.10", "vdevice-name": "169.254.10.10", "replicator": "no", "lastupdated": 1643179140806, "vpn-id": "10", "vdevice-host-name": "vm3", "tunnel-address": "172.16.254.1" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/ndv6": { "get": { "tags": [ "Real-Time Monitoring - IPv6 Neighbours" ], "description": "Get IPv6 Neighbors from device (Real Time)", "operationId": "getIpv6Interface", "parameters": [ { "name": "vpn-id", "in": "query", "description": "VPN Id", "schema": { "type": "string", "enum": [ "0", "512" ] } }, { "name": "if-name", "in": "query", "description": "Interface name", "schema": { "type": "string", "enum": [ "ge0/0", "ge0/1", "ge0/2", "ge0/3", "ge0/4", "ge0/5", "ge0/6", "ge0/7", "system", "eth0" ] } }, { "name": "mac", "in": "query", "description": "Mac address", "schema": { "type": "string" } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "IPv6 Neighbors": { "description": "IPv6 Neighbors", "value": { "data": [ { "if-name": "ge0/1", "vdevice-dataKey": "169.254.10.10-0-ge0/1", "vdevice-name": "169.254.10.10", "ip": "fe80::5054:ff:fea1:4f47", "lastupdated": 1643172402186, "state": "static", "vpn-id": "0", "uptime-date": 1642659240000, "vdevice-host-name": "vm3", "mac": "52:54:00:a1:4f:47", "uptime": "5:22:32:19" }, { "if-name": "ge0/1", "idle-timer": "0:00:00:00", "vdevice-dataKey": "169.254.10.10-0-ge0/1", "vdevice-name": "169.254.10.10", "ip": "fe80::5054:ff:fecf:dad8", "lastupdated": 1643172402186, "state": "dynamic", "vpn-id": "0", "uptime-date": 1643048160000, "vdevice-host-name": "vm3", "mac": "52:54:00:cf:da:d8", "uptime": "1:10:30:01" }, { "if-name": "ge0/1", "idle-timer": "0:00:00:00", "vdevice-dataKey": "169.254.10.10-0-ge0/1", "vdevice-name": "169.254.10.10", "ip": "fe80::fc54:ff:fea1:4f47", "lastupdated": 1643172402186, "state": "dynamic", "vpn-id": "0", "uptime-date": 1642670640000, "vdevice-host-name": "vm3", "mac": "fe:54:00:a1:4f:47", "uptime": "5:19:21:53" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Interface-read,Interface-write" } }, "/device/nms/running": { "get": { "tags": [ "Real-Time Monitoring - NMS" ], "description": "Get nms running state from device", "operationId": "getRunning", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device Id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Nms running": { "description": "Nms running", "value": { "data": [ { "vdevice-host-name": "vm12", "vdevice-dataKey": "172.16.255.22-true", "running": "true", "vdevice-name": "172.16.255.22", "lastupdated": 1642648535452 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/ntp/associations": { "get": { "tags": [ "Real-Time Monitoring - NTP" ], "description": "Get NTP peer associations list from device (Real Time)", "operationId": "createAssociationsList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "NTP peer associations list": { "description": "NTP peer associations list", "value": { "data": [ { "count": 1, "status": "8011", "idx": 1, "last_event": "mobilize", "vdevice-name": "172.16.255.11", "associd": "51657", "auth": "none", "reachability": "no", "lastupdated": 1647428253985, "conf": "yes", "vdevice-host-name": "vm1", "vdevice-dataKey": "172.16.255.11-1-51657", "condition": "reject" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/ntp/peer": { "get": { "tags": [ "Real-Time Monitoring - NTP" ], "description": "Get NTP peer list from device (Real Time)", "operationId": "createPeerList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "NTP peer associations list": { "description": "NTP peer associations list", "value": { "data": [ { "index": 1, "remote": "10.10.10.10", "reach": "0", "when": "-", "lastupdated": 1647576150422, "st": "16", "delay": "0.000", "vdevice-dataKey": "172.16.255.11-1", "offset": "+0.000", "vdevice-host-name": "vm1", "jitter": "0.000", "poll": "512", "type": "u", "refid": ".INIT.", "vdevice-name": "172.16.255.11" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/ntp/status": { "get": { "tags": [ "Real-Time Monitoring - NTP" ], "description": "Get NTP status list from device (Real Time)", "operationId": "createNTPStatusList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "NTP peer associations list": { "description": "NTP peer associations list", "value": { "data": [ { "sys-poll": "3", "stratum": "16", "lastupdated": 1647483667971, "root-delay": "0.0", "vdevice-dataKey": "172.16.255.15-3", "reftime": "1970-01-01T00:00:00+00:00", "offset": "0.0", "kod-type": "ntp-ref-init", "root-disp": "38.5", "vdevice-host-name": "vm5", "vdevice-name": "172.16.255.15" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/omp/cloudx": { "get": { "tags": [ "Real-Time Monitoring - OMP" ], "description": "Get CloudExpress routes received list", "operationId": "createOMPCloudXRecv", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "CloudExpress routes received list": { "description": "CloudExpress routes received list", "value": { "data": [ { "vdevice-name": "172.16.254.1", "vdevice-host-name": "vm2", "vpn-id": "1", "originator": "172.16.255.14", "app-id": "1", "app-name": "salesforce", "to-peer": "172.16.255.19", "from-peer": "172.16.255.20", "status": "C,I,R", "latency": "0", "loss": "0", "vdevice-dataKey": "172.16.254.1", "lastupdated": 1658131633272 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" } }, "/device/omp/links": { "get": { "tags": [ "Real-Time Monitoring - OMP" ], "description": "Get OMP connection list", "operationId": "createOMPLinkList", "parameters": [ { "name": "state", "in": "query", "description": "Connection state", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "OMP connection list": { "description": "OMP connection list", "value": { "data": [ { "state": "up", "lastupdated": "1646804216515", "linkKey": "172.16.255.16-172.16.255.20", "adeviceId": "172.16.255.16", "bdeviceId": "172.16.255.20", "asystem-ip": "172.16.255.16", "bsystem-ip": "172.16.255.20", "asite-id": "600", "bsite-id": "200", "ahost-name": "vm6", "bhost-name": "vm10", "apersonality": "vedge", "bpersonality": "vsmart" }, { "state": "up", "lastupdated": "1646804204258", "linkKey": "172.16.255.16-172.16.255.19", "adeviceId": "172.16.255.16", "bdeviceId": "172.16.255.19", "asystem-ip": "172.16.255.16", "bsystem-ip": "172.16.255.19", "asite-id": "600", "bsite-id": "100", "ahost-name": "vm6", "bhost-name": "vm9", "apersonality": "vedge", "bpersonality": "vsmart" }, { "state": "up", "lastupdated": "1646804204257", "linkKey": "172.16.255.15-172.16.255.19", "adeviceId": "172.16.255.15", "bdeviceId": "172.16.255.19", "asystem-ip": "172.16.255.15", "bsystem-ip": "172.16.255.19", "asite-id": "500", "bsite-id": "100", "ahost-name": "vm5", "bhost-name": "vm9", "apersonality": "vedge", "bpersonality": "vsmart" }, { "state": "up", "lastupdated": "1646804216515", "linkKey": "172.16.255.15-172.16.255.20", "adeviceId": "172.16.255.15", "bdeviceId": "172.16.255.20", "asystem-ip": "172.16.255.15", "bsystem-ip": "172.16.255.20", "asite-id": "500", "bsite-id": "200", "ahost-name": "vm5", "bhost-name": "vm10", "apersonality": "vedge", "bpersonality": "vsmart" }, { "state": "up", "lastupdated": "1646804204257", "linkKey": "172.16.255.14-172.16.255.19", "adeviceId": "172.16.255.14", "bdeviceId": "172.16.255.19", "asystem-ip": "172.16.255.14", "bsystem-ip": "172.16.255.19", "asite-id": "400", "bsite-id": "100", "ahost-name": "vm4", "bhost-name": "vm9", "apersonality": "vedge", "bpersonality": "vsmart" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/omp/mcastautodiscoveradvt": { "get": { "tags": [ "Real-Time Monitoring - OMP" ], "description": "Get OMP multicast autodiscover advertised list", "operationId": "createOMPMcastAutoDiscoverAdvt", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "OMP multicast autodiscover advertised list": { "description": "OMP multicast autodiscover advertised list", "value": { "data": [ { "vdevice-dataKey": "169.254.10.10-ipv4-10", "vdevice-name": "169.254.10.10", "lastupdated": 1643180905996, "source-originator": "172.16.254.2", "vpn-id": "10", "vdevice-host-name": "vm3", "address-family": "ipv4", "to-peer": "172.16.253.129" }, { "vdevice-dataKey": "169.254.10.10-ipv4-10", "vdevice-name": "169.254.10.10", "lastupdated": 1643180905996, "source-originator": "172.16.254.2", "vpn-id": "10", "vdevice-host-name": "vm3", "address-family": "ipv4", "to-peer": "172.16.255.130" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" } }, "/device/omp/mcastautodiscoverrecv": { "get": { "tags": [ "Real-Time Monitoring - OMP" ], "description": "Get OMP multicast autodiscover received list", "operationId": "createOMPMcastAutoDiscoverRecv", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "OMP multicast autodiscover received list": { "description": "OMP multicast autodiscover received list", "value": { "data": [ { "vdevice-dataKey": "169.254.10.10-ipv4-10", "vdevice-name": "169.254.10.10", "from-peer": "172.16.253.129", "lastupdated": 1643181632850, "source-originator": "172.16.254.1", "vpn-id": "10", "vdevice-host-name": "vm3", "address-family": "ipv4", "status": "C I R" }, { "vdevice-dataKey": "169.254.10.10-ipv4-10", "vdevice-name": "169.254.10.10", "from-peer": "172.16.255.130", "lastupdated": 1643181632851, "source-originator": "172.16.254.1", "vpn-id": "10", "vdevice-host-name": "vm3", "address-family": "ipv4", "status": "C I R" }, { "vdevice-dataKey": "169.254.10.10-ipv4-10", "vdevice-name": "169.254.10.10", "from-peer": "0.0.0.0", "lastupdated": 1643181632852, "source-originator": "172.16.254.2", "vpn-id": "10", "vdevice-host-name": "vm3", "address-family": "ipv4", "status": "C Red R" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" } }, "/device/omp/mcastroutesadvt": { "get": { "tags": [ "Real-Time Monitoring - OMP" ], "description": "Get OMP multicast routes advertised list", "operationId": "createOMPMcastRoutesAdvt", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "OMP multicast routes advertised list": { "description": "OMP multicast routes advertised list", "value": { "data": [ { "vdevice-name": "172.16.254.1", "vdevice-host-name": "vm2", "address-family": "ipv4", "vpn-id": "1", "source-originator": "172.16.255.14", "destination": "172.16.255.16", "group": "225.0.0.1", "source": "0.0.0.0", "rp": "10.20.25.18", "to-peer": "172.16.255.20", "vdevice-dataKey": "172.16.254.1-ipv4-10", "lastupdated": 0 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" } }, "/device/omp/mcastroutesrecv": { "get": { "tags": [ "Real-Time Monitoring - OMP" ], "description": "Get OMP multicast routes received list", "operationId": "createOMPMcastRoutesRecv", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "OMP multicast routes received list": { "description": "OMP multicast routes received list", "value": { "data": [ { "vdevice-name": "172.16.254.1", "vdevice-host-name": "vm2", "address-family": "ipv4", "vpn-id": "1", "source-originator": "172.16.255.14", "destination": "172.16.255.16", "group": "225.0.0.1", "source": "0.0.0.0", "from-peer": "172.16.255.19", "status": "C,I,R", "vdevice-dataKey": "172.16.254.1-ipv4-10", "lastupdated": 1658131633272 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" } }, "/device/omp/peers": { "get": { "tags": [ "Real-Time Monitoring - OMP" ], "description": "Get OMP session list (Real Time)", "operationId": "createOMPSessionList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "OP session list": { "description": "OP session list", "value": { "data": [ { "domain-id": 1, "vdevice-name": "169.254.10.10", "refresh": "supported", "site-id": 129, "type": "vsmart", "vdevice-host-name": "vm3", "up-time-date": 1643135160000, "vdevice-dataKey": "169.254.10.10-172.16.253.129-vsmart", "peer": "172.16.253.129", "up-time": "0:12:57:30", "legit": "yes", "lastupdated": 1643181828115, "state": "up" }, { "domain-id": 1, "vdevice-name": "169.254.10.10", "refresh": "supported", "site-id": 130, "type": "vsmart", "vdevice-host-name": "vm3", "up-time-date": 1643135160000, "vdevice-dataKey": "169.254.10.10-172.16.255.130-vsmart", "peer": "172.16.255.130", "up-time": "0:12:57:30", "legit": "yes", "lastupdated": 1643181828115, "state": "up" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" } }, "/device/omp/routes/advertised": { "get": { "tags": [ "Real-Time Monitoring - OMP" ], "description": "Get OMP advertised routes list (Real Time)", "operationId": "createAdvertisedRoutesList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "OMP advertised routes list": { "description": "OMP advertised routes list", "value": { "data": [ { "overlay-id": "1", "color": "default", "vdevice-name": "169.254.10.10", "prefix": "100.100.3.0/24", "ip": "172.16.254.2", "label": "1069", "encap": "ipsec", "site-id": "3", "originator": "172.16.254.2", "vpn-id": "10", "vdevice-host-name": "vm3", "path-id": "65", "protocol": "connected", "vdevice-dataKey": "169.254.10.10-10", "metric": "0", "lastupdated": 1643179668956, "to-peer": "172.16.253.129" }, { "overlay-id": "1", "color": "default", "vdevice-name": "169.254.10.10", "prefix": "100.100.3.0/24", "ip": "172.16.254.2", "label": "1069", "encap": "ipsec", "site-id": "3", "originator": "172.16.254.2", "vpn-id": "10", "vdevice-host-name": "vm3", "path-id": "65", "protocol": "connected", "vdevice-dataKey": "169.254.10.10-10", "metric": "0", "lastupdated": 1643179668956, "to-peer": "172.16.255.130" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" } }, "/device/omp/routes/advertised/ompIpv6": { "get": { "tags": [ "Real-Time Monitoring - OMP" ], "description": "Get OMP advertised routes list (Real Time)", "operationId": "createAdvertisedRoutesListIpv6", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "OMP advertised routes list": { "description": "OMP advertised routes list", "value": { "data": [ { "color": "lte", "vdevice-name": "172.16.255.16", "prefix": "2001:a14:19::/64", "ip": "172.16.255.16", "advertise-id": "70", "label": "1003", "encap": "ipsec", "site-id": "600", "originator": "172.16.255.16", "vpn-id": "1", "vdevice-host-name": "vm6", "tenant-id": "0", "path-id": "70", "protocol": "connected", "vdevice-dataKey": "172.16.255.16-1", "metric": "0", "lastupdated": 1653905306196, "to-peer": "172.16.255.19" }, { "color": "lte", "vdevice-name": "172.16.255.16", "prefix": "2001:a14:19::/64", "ip": "172.16.255.16", "advertise-id": "70", "label": "1003", "encap": "ipsec", "site-id": "600", "originator": "172.16.255.16", "vpn-id": "1", "vdevice-host-name": "vm6", "tenant-id": "0", "path-id": "70", "protocol": "connected", "vdevice-dataKey": "172.16.255.16-1", "metric": "0", "lastupdated": 1653905306196, "to-peer": "172.16.255.20" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/omp/routes/received": { "get": { "tags": [ "Real-Time Monitoring - OMP" ], "description": "Get OMP received routes list (Real Time)", "operationId": "createReceivedRoutesList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "OMP received routes list": { "description": "OMP received routes list", "value": { "data": [ { "overlay-id": "1", "color": "default", "vdevice-name": "169.254.10.10", "prefix": "10.0.5.0/24", "ip": "172.16.254.4", "from-peer": "172.16.253.129", "label": "1047", "encap": "ipsec", "site-id": "5", "originator": "172.16.254.4", "vpn-id": "10", "vdevice-host-name": "vm3", "path-id": "42", "protocol": "connected", "vdevice-dataKey": "169.254.10.10-10", "metric": "0", "lastupdated": 1643182041519, "attribute-type": "installed", "status": "C I R" }, { "overlay-id": "1", "color": "default", "vdevice-name": "169.254.10.10", "prefix": "10.0.5.0/24", "ip": "172.16.254.4", "from-peer": "172.16.255.130", "label": "1047", "encap": "ipsec", "site-id": "5", "originator": "172.16.254.4", "vpn-id": "10", "vdevice-host-name": "vm3", "path-id": "42", "protocol": "connected", "vdevice-dataKey": "169.254.10.10-10", "metric": "0", "lastupdated": 1643182041519, "attribute-type": "installed", "status": "C R" }, { "overlay-id": "1", "color": "default", "vdevice-name": "169.254.10.10", "prefix": "10.0.16.0/24", "ip": "172.16.254.16", "from-peer": "172.16.253.129", "label": "1014", "encap": "ipsec", "site-id": "16", "originator": "172.16.254.16", "vpn-id": "10", "vdevice-host-name": "vm3", "path-id": "38", "protocol": "connected", "vdevice-dataKey": "169.254.10.10-10", "metric": "0", "lastupdated": 1643182041519, "attribute-type": "installed", "status": "C I R" }, { "overlay-id": "1", "color": "default", "vdevice-name": "169.254.10.10", "prefix": "10.0.16.0/24", "ip": "172.16.254.16", "from-peer": "172.16.255.130", "label": "1014", "encap": "ipsec", "site-id": "16", "originator": "172.16.254.16", "vpn-id": "10", "vdevice-host-name": "vm3", "path-id": "38", "protocol": "connected", "vdevice-dataKey": "169.254.10.10-10", "metric": "0", "lastupdated": 1643182041519, "attribute-type": "installed", "status": "C R" }, { "overlay-id": "1", "color": "default", "vdevice-name": "169.254.10.10", "prefix": "100.100.2.0/24", "ip": "172.16.254.1", "from-peer": "172.16.253.129", "label": "1018", "encap": "ipsec", "site-id": "2", "originator": "172.16.254.1", "vpn-id": "10", "vdevice-host-name": "vm3", "path-id": "29", "protocol": "connected", "vdevice-dataKey": "169.254.10.10-10", "metric": "0", "lastupdated": 1643182041519, "attribute-type": "installed", "status": "C I R" }, { "overlay-id": "1", "color": "default", "vdevice-name": "169.254.10.10", "prefix": "100.100.2.0/24", "ip": "172.16.254.1", "from-peer": "172.16.255.130", "label": "1018", "encap": "ipsec", "site-id": "2", "originator": "172.16.254.1", "vpn-id": "10", "vdevice-host-name": "vm3", "path-id": "29", "protocol": "connected", "vdevice-dataKey": "169.254.10.10-10", "metric": "0", "lastupdated": 1643182041519, "attribute-type": "installed", "status": "C R" }, { "overlay-id": "1", "color": "default", "vdevice-name": "169.254.10.10", "prefix": "100.100.3.0/24", "ip": "172.16.254.2", "from-peer": "0.0.0.0", "label": "1069", "encap": "ipsec", "site-id": "3", "originator": "172.16.254.2", "vpn-id": "10", "vdevice-host-name": "vm3", "path-id": "65", "protocol": "connected", "vdevice-dataKey": "169.254.10.10-10", "metric": "0", "lastupdated": 1643182041520, "attribute-type": "installed", "status": "C Red R" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" } }, "/device/omp/routes/received/ompIpv6": { "get": { "tags": [ "Real-Time Monitoring - OMP" ], "description": "Get OMP received routes list (Real Time)", "operationId": "createReceivedRoutesListIpv6", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "OMP received routes list": { "description": "OMP received routes list", "value": { "data": [ { "path-id": "830", "vdevice-dataKey": "172.16.255.16-1", "vdevice-name": "172.16.255.16", "prefix": "2001:a14:18::/64", "from-peer": "172.16.255.19", "lastupdated": 1653904719952, "label": "1003", "vpn-id": "1", "vdevice-host-name": "vm6", "tenant-id": "0", "status": "C I R" }, { "path-id": "861", "vdevice-dataKey": "172.16.255.16-1", "vdevice-name": "172.16.255.16", "prefix": "2001:a14:18::/64", "from-peer": "172.16.255.20", "lastupdated": 1653904719952, "label": "1003", "vpn-id": "1", "vdevice-host-name": "vm6", "tenant-id": "0", "status": "C R" }, { "path-id": "70", "vdevice-dataKey": "172.16.255.16-1", "vdevice-name": "172.16.255.16", "prefix": "2001:a14:19::/64", "from-peer": "0.0.0.0", "lastupdated": 1653904719952, "label": "1003", "vpn-id": "1", "vdevice-host-name": "vm6", "tenant-id": "0", "status": "C Red R" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/omp/services": { "get": { "tags": [ "Real-Time Monitoring - OMP" ], "description": "Get OMP services list", "operationId": "createOMPServices", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "OMP services list": { "description": "OMP services list", "value": { "data": [ { "path-id": "65", "vdevice-dataKey": "169.254.10.10-10-VPN-172.16.254.2", "vdevice-name": "169.254.10.10", "service": "VPN", "from-peer": "0.0.0.0", "lastupdated": 1643250832867, "originator": "172.16.254.2", "label": "1077", "vpn-id": "10", "vdevice-host-name": "vm3", "address-family": "ipv4", "status": "C Red R" }, { "vdevice-dataKey": "169.254.10.10-10-VPN-172.16.254.2", "vdevice-name": "169.254.10.10", "service": "VPN", "lastupdated": 1643250832868, "originator": "172.16.254.2", "vpn-id": "10", "vdevice-host-name": "vm3", "address-family": "ipv4", "to-peer": "172.16.253.129" }, { "vdevice-dataKey": "169.254.10.10-10-VPN-172.16.254.2", "vdevice-name": "169.254.10.10", "service": "VPN", "lastupdated": 1643250832869, "originator": "172.16.254.2", "vpn-id": "10", "vdevice-host-name": "vm3", "address-family": "ipv4", "to-peer": "172.16.255.130" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" } }, "/device/omp/status": { "get": { "tags": [ "Real-Time Monitoring - OMP" ], "description": "Get device OMP status", "operationId": "getDeviceOMPStatus", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device OMP status": { "description": "Device OMP status", "value": { "data": [ { "type": "omp", "name": "OMP", "image": "images/omp.png", "count": 0, "detailView": "dialog", "detailsURL": "/dataservice/device/omp/links", "statusList": [ { "status": "up", "icon": "images/connection/connection-network-up.png", "color": "b0e276", "name": "up", "detailView": "dialog", "detailsURL": "/dataservice/device/omp/links?state=up", "count": 0 }, { "status": "down", "icon": "images/connection/connection-network-down.png", "color": "fa7c7d", "name": "down", "detailView": "dialog", "detailsURL": "/dataservice/device/omp/links?state=down", "count": 0 } ] } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/omp/summary": { "get": { "tags": [ "Real-Time Monitoring - OMP" ], "description": "Get OMP summary", "operationId": "createOMPSummary", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "OMP summary": { "description": "OMP summary", "value": { "data": [ { "tlocs-sent": 4, "policy-sent": 0, "mcast-routes-sent": 0, "packets-sent": 81579, "vdevice-name": "169.254.10.10", "inform-sent": 14, "packets-received": 81956, "routes-received": 18, "tlocs-received": 22, "mcast-routes-installed": 0, "update-sent": 84, "devicetype": "vedge", "mcast-routes-received": 0, "hello-received": 81472, "alert-sent": 0, "update-received": 468, "vsmart-peers": 2, "operstate": "UP", "policy-received": 0, "handshake-received": 2, "handshake-sent": 2, "alert-received": 0, "services-sent": 4, "vdevice-host-name": "vm3", "inform-received": 14, "vdevice-dataKey": "169.254.10.10--", "tlocs-installed": 10, "services-installed": 0, "ompuptime": "9:11:16:34", "services-received": 2, "lastupdated": 1645494228477, "routes-sent": 4, "hello-sent": 81479, "routes-installed": 8, "adminstate": "UP" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" } }, "/device/omp/synced/peers": { "get": { "tags": [ "Real-Time Monitoring - OMP" ], "description": "Get OP session list", "operationId": "createSyncedOMPSessionList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "OP session list": { "description": "OP session list", "value": { "data": [ { "domain-id": 1, "vdevice-name": "172.16.255.11", "createTimeStamp": 1646804055895, "refresh": "supported", "site-id": 100, "type": "vsmart", "vdevice-host-name": "vm1", "vdevice-dataKey": "172.16.255.11-172.16.255.19-vsmart", "@rid": 568, "vmanage-system-ip": "172.16.255.11", "peer": "172.16.255.19", "legit": "yes", "lastupdated": 1646804055844, "region-id": "None", "state": "up" }, { "domain-id": 1, "vdevice-name": "172.16.255.11", "createTimeStamp": 1646804061584, "refresh": "supported", "site-id": 200, "type": "vsmart", "vdevice-host-name": "vm1", "vdevice-dataKey": "172.16.255.11-172.16.255.20-vsmart", "@rid": 574, "vmanage-system-ip": "172.16.255.11", "peer": "172.16.255.20", "legit": "yes", "lastupdated": 1646804055844, "region-id": "None", "state": "up" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" } }, "/device/omp/tlocs/advertised": { "get": { "tags": [ "Real-Time Monitoring - OMP" ], "description": "Get advertised TLOCs list (Real Time)", "operationId": "createAdvertisedTlocsList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Advertised TLOCs list": { "description": "Advertised TLOCs list", "value": { "data": [ { "color": "default", "vdevice-name": "169.254.10.10", "ip": "172.16.254.2", "tloc-auth-type": "sha1-hmac ah-sha1-hmac", "preference": "0", "weight": "1", "encap": "ipsec", "site-id": "3", "originator": "172.16.254.2", "vdevice-host-name": "vm3", "tloc-public-ip": "10.101.3.3", "tloc-public-port": "12406", "tloc-private-ip": "10.101.3.3", "vdevice-dataKey": "169.254.10.10-ipv4-172.16.254.2", "tloc-private-port": "12406", "tloc-spi": "286", "lastupdated": 1643179953349, "tloc-encrypt-type": "aes256", "tloc-proto": "0", "address-family": "ipv4", "to-peer": "172.16.253.129" }, { "color": "default", "vdevice-name": "169.254.10.10", "ip": "172.16.254.2", "tloc-auth-type": "sha1-hmac ah-sha1-hmac", "preference": "0", "weight": "1", "encap": "ipsec", "site-id": "3", "originator": "172.16.254.2", "vdevice-host-name": "vm3", "tloc-public-ip": "10.101.3.3", "tloc-public-port": "12406", "tloc-private-ip": "10.101.3.3", "vdevice-dataKey": "169.254.10.10-ipv4-172.16.254.2", "tloc-private-port": "12406", "tloc-spi": "286", "lastupdated": 1643179953351, "tloc-encrypt-type": "aes256", "tloc-proto": "0", "address-family": "ipv4", "to-peer": "172.16.255.130" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" } }, "/device/omp/tlocs/received": { "get": { "tags": [ "Real-Time Monitoring - OMP" ], "description": "Get received TLOCs list (Real Time)", "operationId": "createReceivedTlocsList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Received TLOCs list": { "description": "Received TLOCs list", "value": { "data": [ { "bfd-status": "up", "color": "default", "vdevice-name": "169.254.10.10", "ip": "172.16.254.1", "tloc-auth-type": "sha1-hmac ah-sha1-hmac", "preference": "0", "from-peer": "172.16.253.129", "weight": "1", "encap": "ipsec", "site-id": "2", "originator": "172.16.254.1", "vdevice-host-name": "vm3", "tloc-public-ip": "10.101.2.2", "tloc-public-port": "12386", "tloc-private-ip": "10.101.2.2", "vdevice-dataKey": "169.254.10.10-ipv4-172.16.254.1", "tloc-private-port": "12386", "tloc-spi": "263", "lastupdated": 1643185163270, "tloc-encrypt-type": "aes256", "tloc-proto": "0", "address-family": "ipv4" }, { "bfd-status": "up", "color": "default", "vdevice-name": "169.254.10.10", "ip": "172.16.254.2", "tloc-auth-type": "sha1-hmac ah-sha1-hmac", "preference": "0", "from-peer": "0.0.0.0", "weight": "1", "encap": "ipsec", "site-id": "3", "originator": "172.16.254.2", "vdevice-host-name": "vm3", "tloc-public-ip": "10.101.3.3", "tloc-public-port": "12406", "tloc-private-ip": "10.101.3.3", "vdevice-dataKey": "169.254.10.10-ipv4-172.16.254.2", "tloc-private-port": "12406", "tloc-spi": "287", "lastupdated": 1643185163276, "tloc-encrypt-type": "aes256", "tloc-proto": "0", "address-family": "ipv4" }, { "bfd-status": "up", "color": "default", "vdevice-name": "169.254.10.10", "ip": "172.16.254.3", "tloc-auth-type": "sha1-hmac ah-sha1-hmac", "preference": "0", "from-peer": "172.16.255.130", "weight": "1", "encap": "ipsec", "site-id": "4", "originator": "172.16.254.3", "vdevice-host-name": "vm3", "tloc-public-ip": "10.101.4.4", "tloc-public-port": "12406", "tloc-private-ip": "10.101.4.4", "vdevice-dataKey": "169.254.10.10-ipv4-172.16.254.3", "tloc-private-port": "12406", "tloc-spi": "284", "lastupdated": 1643185163281, "tloc-encrypt-type": "aes256", "tloc-proto": "0", "address-family": "ipv4" }, { "bfd-status": "up", "color": "default", "vdevice-name": "169.254.10.10", "ip": "172.16.254.4", "tloc-auth-type": "sha1-hmac ah-sha1-hmac", "preference": "0", "from-peer": "172.16.255.130", "weight": "1", "encap": "ipsec", "site-id": "5", "originator": "172.16.254.4", "vdevice-host-name": "vm3", "tloc-public-ip": "10.102.5.5", "tloc-public-port": "12406", "tloc-private-ip": "10.102.5.5", "vdevice-dataKey": "169.254.10.10-ipv4-172.16.254.4", "tloc-private-port": "12406", "tloc-spi": "288", "lastupdated": 1643185163286, "tloc-encrypt-type": "aes256", "tloc-proto": "0", "address-family": "ipv4" }, { "bfd-status": "up", "color": "default", "vdevice-name": "169.254.10.10", "ip": "172.16.254.5", "tloc-auth-type": "sha1-hmac ah-sha1-hmac", "preference": "0", "from-peer": "172.16.253.129", "weight": "1", "encap": "ipsec", "site-id": "6", "originator": "172.16.254.5", "vdevice-host-name": "vm3", "tloc-public-ip": "10.102.6.6", "tloc-public-port": "12406", "tloc-private-ip": "10.102.6.6", "vdevice-dataKey": "169.254.10.10-ipv4-172.16.254.5", "tloc-private-port": "12406", "tloc-spi": "292", "lastupdated": 1643185163290, "tloc-encrypt-type": "aes256", "tloc-proto": "0", "address-family": "ipv4" }, { "bfd-status": "up", "color": "default", "vdevice-name": "169.254.10.10", "ip": "172.16.254.16", "tloc-auth-type": "sha1-hmac ah-sha1-hmac", "preference": "0", "from-peer": "172.16.253.129", "weight": "1", "encap": "ipsec", "site-id": "16", "originator": "172.16.254.16", "vdevice-host-name": "vm3", "tloc-public-ip": "10.102.16.16", "tloc-public-port": "12406", "tloc-private-ip": "10.102.16.16", "vdevice-dataKey": "169.254.10.10-ipv4-172.16.254.16", "tloc-private-port": "12406", "tloc-spi": "287", "lastupdated": 1643185163295, "tloc-encrypt-type": "aes256", "tloc-proto": "0", "address-family": "ipv4" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write" } }, "/device/ondemand/local": { "get": { "tags": [ "Real-Time Monitoring - Show On Demand Local" ], "description": "Get on-demand local (Real Time)", "operationId": "getOnDemandLocal", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "On Demand Local list": { "description": "On Demand Local list", "value": { "data": [ { "status": "-", "site-id": "5", "on-demand": "no", "lastupdated": 1642667823842, "idle-timeout-expiry": "10", "vdevice-dataKey": "169.254.10.12-", "vdevice-host-name": "vm5", "vdevice-name": "169.254.10.12", "system-ip": "172.16.254.4" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/ondemand/remote": { "get": { "tags": [ "Real-Time Monitoring - Show On Demand Remote" ], "description": "Get on-demand remote (Real Time)", "operationId": "getOnDemandRemote", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "On Demand Remote list": { "description": "On Demand Remote list", "value": { "data": [ { "status": "-", "site-id": "3", "on-demand": "no", "lastupdated": 1642745561447, "idle-timeout-expiry": "-", "vdevice-dataKey": "169.254.10.9-", "vdevice-host-name": "vm2", "vdevice-name": "169.254.10.9", "system-ip": "172.16.254.2" }, { "status": "-", "site-id": "4", "on-demand": "no", "lastupdated": 1642745561447, "idle-timeout-expiry": "-", "vdevice-dataKey": "169.254.10.9-", "vdevice-host-name": "vm2", "vdevice-name": "169.254.10.9", "system-ip": "172.16.254.3" }, { "status": "-", "site-id": "5", "on-demand": "no", "lastupdated": 1642745561447, "idle-timeout-expiry": "-", "vdevice-dataKey": "169.254.10.9-", "vdevice-host-name": "vm2", "vdevice-name": "169.254.10.9", "system-ip": "172.16.254.4" }, { "status": "-", "site-id": "6", "on-demand": "no", "lastupdated": 1642745561447, "idle-timeout-expiry": "-", "vdevice-dataKey": "169.254.10.9-", "vdevice-host-name": "vm2", "vdevice-name": "169.254.10.9", "system-ip": "172.16.254.5" }, { "status": "-", "site-id": "16", "on-demand": "no", "lastupdated": 1642745561447, "idle-timeout-expiry": "-", "vdevice-dataKey": "169.254.10.9-", "vdevice-host-name": "vm2", "vdevice-name": "169.254.10.9", "system-ip": "172.16.254.16" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/orchestrator/connections": { "get": { "tags": [ "Real-Time Monitoring - Orchestrator" ], "description": "Get connection list from device", "operationId": "createConnectionListFromDevice", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Connection list": { "description": "Connection list", "value": { "data": [ { "peer-region-id-set": "N/A", "domain-id": 1, "site-id": 100, "local-color": "default", "uptime": "1:23:51:47", "lastupdated": 1649761493102, "vdevice-dataKey": "172.16.255.26-vsmart-172.16.255.19", "state": "up", "private-port": 12355, "public-port": 12355, "public-ip": "10.0.5.19", "uptime-date": 1649589180000, "peer-type": "vsmart", "vdevice-host-name": "vm16", "private-ip": "10.0.5.19", "vdevice-name": "172.16.255.26", "system-ip": "172.16.255.19" }, { "peer-region-id-set": "N/A", "domain-id": 1, "site-id": 100, "local-color": "default", "uptime": "1:23:51:46", "lastupdated": 1649761493102, "vdevice-dataKey": "172.16.255.26-vsmart-172.16.255.19", "state": "up", "private-port": 12455, "public-port": 12455, "public-ip": "10.0.5.19", "uptime-date": 1649589180000, "peer-type": "vsmart", "vdevice-host-name": "vm16", "private-ip": "10.0.5.19", "vdevice-name": "172.16.255.26", "system-ip": "172.16.255.19" }, { "peer-region-id-set": "N/A", "domain-id": 1, "site-id": 200, "local-color": "default", "uptime": "1:23:51:47", "lastupdated": 1649761493102, "vdevice-dataKey": "172.16.255.26-vsmart-172.16.255.20", "state": "up", "private-port": 12356, "public-port": 12356, "public-ip": "10.0.12.20", "uptime-date": 1649589180000, "peer-type": "vsmart", "vdevice-host-name": "vm16", "private-ip": "10.0.12.20", "vdevice-name": "172.16.255.26", "system-ip": "172.16.255.20" }, { "peer-region-id-set": "N/A", "domain-id": 1, "site-id": 200, "local-color": "default", "uptime": "1:23:51:46", "lastupdated": 1649761493102, "vdevice-dataKey": "172.16.255.26-vsmart-172.16.255.20", "state": "up", "private-port": 12456, "public-port": 12456, "public-ip": "10.0.12.20", "uptime-date": 1649589180000, "peer-type": "vsmart", "vdevice-host-name": "vm16", "private-ip": "10.0.12.20", "vdevice-name": "172.16.255.26", "system-ip": "172.16.255.20" }, { "domain-id": 0, "site-id": 200, "local-color": "default", "uptime": "1:23:51:45", "lastupdated": 1649761493102, "vdevice-dataKey": "172.16.255.26-vmanage-172.16.255.22", "state": "up", "private-port": 12346, "public-port": 12346, "public-ip": "10.0.12.22", "uptime-date": 1649589180000, "peer-type": "vmanage", "vdevice-host-name": "vm16", "private-ip": "10.0.12.22", "vdevice-name": "172.16.255.26", "system-ip": "172.16.255.22" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Security-read,Security-write" } }, "/device/orchestrator/connectionshistory": { "get": { "tags": [ "Real-Time Monitoring - Orchestrator" ], "description": "Get connection history list from device", "operationId": "createConnectionHistoryList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Connection history list": { "description": "Connection history list", "value": { "data": [ { "remote-color": "default", "index": 0, "site-id": 500, "public-port": 12386, "peer-type": "vedge", "local_enum": "RXTRDWN", "rep-count": 0, "local-color": "default", "remote_enum": "DISCVBD", "lastupdated": 1649764706061, "vdevice-dataKey": "172.16.255.26-0-2022-04-10T12:23:23+0000", "state": "up", "domain-id": 1, "private-port": 12386, "public-ip": "10.1.15.15", "downtime": "2022-04-10T12:23:23+0000", "vdevice-host-name": "vm16", "private-ip": "10.1.15.15", "remote_enum-desc": "DisconnectvBondafterregisterreply.", "local_enum-desc": "ReceivedTeardown.", "vdevice-name": "172.16.255.26" }, { "remote-color": "default", "index": 1, "site-id": 100, "public-port": 12386, "peer-type": "vedge", "local_enum": "RXTRDWN", "rep-count": 0, "local-color": "default", "remote_enum": "DISCVBD", "lastupdated": 1649764706061, "vdevice-dataKey": "172.16.255.26-1-2022-04-10T11:48:32+0000", "state": "up", "domain-id": 1, "private-port": 12386, "public-ip": "10.0.5.11", "downtime": "2022-04-10T11:48:32+0000", "vdevice-host-name": "vm16", "private-ip": "10.0.5.11", "remote_enum-desc": "DisconnectvBondafterregisterreply.", "local_enum-desc": "ReceivedTeardown.", "vdevice-name": "172.16.255.26" }, { "remote-color": "default", "index": 2, "site-id": 0, "public-port": 12387, "peer-type": "unknown", "local_enum": "DHSTMO", "rep-count": 0, "local-color": "default", "remote_enum": "NOERR", "lastupdated": 1649764706061, "vdevice-dataKey": "172.16.255.26-2-2022-04-10T11:48:21+0000", "state": "connect", "domain-id": 0, "private-port": 0, "public-ip": "10.0.5.11", "downtime": "2022-04-10T11:48:21+0000", "vdevice-host-name": "vm16", "private-ip": "::", "remote_enum-desc": "NoError.", "local_enum-desc": "DTLSHandShakeTimeout.", "vdevice-name": "172.16.255.26" }, { "remote-color": "lte", "index": 3, "site-id": 600, "public-port": 12366, "peer-type": "vedge", "local_enum": "RXTRDWN", "rep-count": 0, "local-color": "lte", "remote_enum": "DISCVBD", "lastupdated": 1649764706061, "vdevice-dataKey": "172.16.255.26-3-2022-04-10T11:13:44+0000", "state": "up", "domain-id": 1, "private-port": 12366, "public-ip": "10.1.16.16", "downtime": "2022-04-10T11:13:44+0000", "vdevice-host-name": "vm16", "private-ip": "10.1.16.16", "remote_enum-desc": "DisconnectvBondafterregisterreply.", "local_enum-desc": "ReceivedTeardown.", "vdevice-name": "172.16.255.26" }, { "remote-color": "lte", "index": 4, "site-id": 100, "public-port": 12377, "peer-type": "vedge", "local_enum": "RXTRDWN", "rep-count": 0, "local-color": "lte", "remote_enum": "DISCVBD", "lastupdated": 1649764706061, "vdevice-dataKey": "172.16.255.26-4-2022-04-10T11:13:41+0000", "state": "up", "domain-id": 1, "private-port": 12377, "public-ip": "10.0.5.21", "downtime": "2022-04-10T11:13:41+0000", "vdevice-host-name": "vm16", "private-ip": "10.0.5.21", "remote_enum-desc": "DisconnectvBondafterregisterreply.", "local_enum-desc": "ReceivedTeardown.", "vdevice-name": "172.16.255.26" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Security-read,Security-write" } }, "/device/orchestrator/localproperties": { "get": { "tags": [ "Real-Time Monitoring - Orchestrator" ], "description": "Get local properties list from device", "operationId": "createLocalPropertiesListList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Local properties list": { "description": "Local properties list", "value": { "data": [ { "certificate-not-valid-before": "Apr1010:34:032022GMT", "certificate-status": "Installed", "protocol": "dtls", "uuid": "0a3c20df-82d6-43d4-b27f-a67864d35950", "root-ca-chain-status": "Installed", "certificate-not-valid-after": "Apr1010:34:032023GMT", "sp-organization-name": "vIPtelaIncRegression", "lastupdated": 1649766458903, "certificate-validity": "Valid", "vdevice-dataKey": "172.16.255.26", "vedge-list-version": "0", "number-active-wan-interfaces": "1", "system-ip": "172.16.255.26", "organization-name": "vIPtelaIncRegression", "vdevice-host-name": "vm16", "device-type": "vbond", "vdevice-name": "172.16.255.26", "vsmart-list-version": "0", "board-serial": "12346571" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Security-read,Security-write" } }, "/device/orchestrator/proxymapping": { "get": { "tags": [ "Real-Time Monitoring - Orchestrator" ], "description": "Get reverse proxy mapping from vbond", "operationId": "createReverseProxyMappingList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Reverse proxy mapping": { "description": "Reverse proxy mapping", "value": { "data": [ { "vdevice-name": "172.16.255.26", "vdevice-host-name": "vm16", "uuid": "1b852227-4a15-48be-8637-3e995b934578", "private-ip": "10.0.12.19", "private-port": "23456", "proxy-ip": "10.0.37.19", "proxy-port": "23456", "lastupdated": 1658198416779, "vdevice-dataKey": "172.16.255.26" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Security-read,Security-write,Device Monitoring-read,Device Monitoring-write" } }, "/device/orchestrator/statistics": { "get": { "tags": [ "Real-Time Monitoring - Orchestrator" ], "description": "Get statistics from device", "operationId": "getStatistics", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Statistics": { "description": "Statistics", "value": { "data": [ { "tx_challenge_ack": 13, "tx_registers": 0, "rx_pkts": 168816, "tx_error": 0, "vdevice-dataKey": "172.16.255.26", "tx_challenge": 15, "rx_challenge_ack": 0, "tx_dtls_handshake_done": 0, "vdevice-host-name": "vm16", "tx_dtls_handshake_failures": 0, "tx_challenge_gen_error": 0, "rx_connects": 0, "rx_octets": 42608317, "rx_registers": 64644, "lastupdated": 1649768154244, "rx_challenge_resp": 15, "tx_register_replies": 64644, "tx_challenge_ack_error": 0, "rx_challenge": 0, "tx_dtls_handshake": 0, "rx_dtls_handshake_done": 15, "rx_dtls_handshake_failures": 0, "rx_error": 0, "challenge_failures": 2, "tx_challenge_resp_error": 0, "vdevice-name": "172.16.255.26", "tx_blocked": 0, "tx_connects": 64671, "tx_octets": 63147501, "tx_challenge_error": 0, "rx_register_replies": 0, "tx_challenge_resp": 0, "tx_pkts": 242150, "rx_dtls_handshake": 70 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Security-read,Security-write" } }, "/device/orchestrator/summary": { "get": { "tags": [ "Real-Time Monitoring - Orchestrator" ], "description": "Get connection summary from device", "operationId": "createConnectionSummary", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Connection summary": { "description": "Connection summary", "value": { "data": [ { "protocol": "dtls", "listening_port": 12346, "listening_ip": "0.0.0.0", "vsmart_counts": 4, "vmanage_counts": 2, "lastupdated": 1649816906161, "instance": 0, "vdevice-host-name": "vm16", "vdevice-dataKey": "172.16.255.26-0", "listening_ipv6": "::", "vedge_counts": 0, "vdevice-name": "172.16.255.26" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Security-read,Security-write" } }, "/device/orchestrator/validvedges": { "get": { "tags": [ "Real-Time Monitoring - Orchestrator" ], "description": "Get valid device list from device", "operationId": "createValidDevicesList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Valid device list": { "description": "Valid device list", "value": { "data": [ { "vdevice-host-name": "vm16", "vdevice-dataKey": "172.16.255.26-1BFB0237-AFCA-4583-BF0C-BECD124565D6-12346572", "serial-number": "12346572", "validity": "valid", "lastupdated": 1649818236214, "chassis-number": "1BFB0237-AFCA-4583-BF0C-BECD124565D6", "vdevice-name": "172.16.255.26" }, { "vdevice-host-name": "vm16", "vdevice-dataKey": "172.16.255.26-33418D3F-286E-4256-A7CB-7BF3A70E1ED8-12346570", "serial-number": "12346570", "validity": "valid", "lastupdated": 1649818236214, "chassis-number": "33418D3F-286E-4256-A7CB-7BF3A70E1ED8", "vdevice-name": "172.16.255.26" }, { "vdevice-host-name": "vm16", "vdevice-dataKey": "172.16.255.26-4D0318BF-472E-4114-B72D-A5E99C5AFAD7-12346580", "serial-number": "12346580", "validity": "valid", "lastupdated": 1649818236214, "chassis-number": "4D0318BF-472E-4114-B72D-A5E99C5AFAD7", "vdevice-name": "172.16.255.26" }, { "vdevice-host-name": "vm16", "vdevice-dataKey": "172.16.255.26-ADC329CC-701C-42D6-84C6-245F09C25583-12346578", "serial-number": "12346578", "validity": "valid", "lastupdated": 1649818236214, "chassis-number": "ADC329CC-701C-42D6-84C6-245F09C25583", "vdevice-name": "172.16.255.26" }, { "vdevice-host-name": "vm16", "vdevice-dataKey": "172.16.255.26-C685BD5F-6C3F-46C8-B58A-D59F2F1A6E2E-12346575", "serial-number": "12346575", "validity": "valid", "lastupdated": 1649818236214, "chassis-number": "C685BD5F-6C3F-46C8-B58A-D59F2F1A6E2E", "vdevice-name": "172.16.255.26" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Security-read,Security-write" } }, "/device/orchestrator/validvmanageid": { "get": { "tags": [ "Real-Time Monitoring - Orchestrator" ], "description": "Get valid vManage Id from device", "operationId": "getValidVManageId", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Valid vManage Id": { "description": "Valid vManage Id", "value": { "data": [ { "chassis-number": "a52d3492-755a-4a02-9a3d-8bdf2dc1d241", "vdevice-dataKey": "172.16.255.26-", "vdevice-name": "172.16.255.26", "lastupdated": 1649823209136, "vdevice-host-name": "vm16" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Security-read,Security-write" } }, "/device/orchestrator/validvsmarts": { "get": { "tags": [ "Real-Time Monitoring - Orchestrator" ], "description": "Get valid vSmart list from device", "operationId": "createValidVSmartsList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Valid vSmart list": { "description": "Valid vSmart list", "value": { "data": [ { "vdevice-host-name": "vm16", "vdevice-dataKey": "172.16.255.26-12346567", "serial-number": "12346567", "vdevice-name": "172.16.255.26", "lastupdated": 1649824251432 }, { "vdevice-host-name": "vm16", "vdevice-dataKey": "172.16.255.26-12346569", "serial-number": "12346569", "vdevice-name": "172.16.255.26", "lastupdated": 1649824251432 }, { "vdevice-host-name": "vm16", "vdevice-dataKey": "172.16.255.26-12346573", "serial-number": "12346573", "vdevice-name": "172.16.255.26", "lastupdated": 1649824251432 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Security-read,Security-write" } }, "/device/ospf/database": { "get": { "tags": [ "Real-Time Monitoring - OSPF" ], "description": "Get OSPF database list from device (Real Time)", "operationId": "createOSPFDatabaseList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "OSPF database list": { "description": "OSPF database list", "value": { "data": [ { "area": 0, "link-id": "172.16.255.11", "data": "10.2.2.11", "vdevice-name": "172.16.255.11", "link-count": "1", "vpn-id": 1, "vdevice-host-name": "vm1", "adv-router": "172.16.255.11", "lsa-type": "router", "router-link-id": "10.2.2.12", "router-link-type": "transit", "sequence": "2147483652", "vdevice-dataKey": "172.16.255.11-1-0", "checksum": "50110", "lastupdated": 1646791144576, "tos-metric": "10", "age": "153" }, { "area": 0, "link-id": "172.16.255.12", "data": "10.2.2.12", "vdevice-name": "172.16.255.11", "link-count": "2", "vpn-id": 1, "vdevice-host-name": "vm1", "adv-router": "172.16.255.12", "lsa-type": "router", "router-link-id": "10.2.2.12", "router-link-type": "transit", "sequence": "2147483655", "vdevice-dataKey": "172.16.255.11-1-0", "checksum": "52821", "lastupdated": 1646791144576, "tos-metric": "10", "age": "153" }, { "area": 0, "link-id": "172.16.255.21", "data": "10.2.3.21", "vdevice-name": "172.16.255.11", "link-count": "1", "vpn-id": 1, "vdevice-host-name": "vm1", "adv-router": "172.16.255.21", "lsa-type": "router", "router-link-id": "10.2.3.21", "router-link-type": "transit", "sequence": "2147483651", "vdevice-dataKey": "172.16.255.11-1-0", "checksum": "8760", "lastupdated": 1646791144576, "tos-metric": "10", "age": "154" }, { "area": 0, "sequence": "2147483649", "link-id": "10.2.2.12", "vdevice-dataKey": "172.16.255.11-1-0", "vdevice-name": "172.16.255.11", "checksum": "63980", "lastupdated": 1646791144576, "vpn-id": 1, "vdevice-host-name": "vm1", "adv-router": "172.16.255.12", "age": "154", "lsa-type": "network" }, { "area": 0, "sequence": "2147483649", "link-id": "10.2.3.21", "vdevice-dataKey": "172.16.255.11-1-0", "vdevice-name": "172.16.255.11", "checksum": "59106", "lastupdated": 1646791144576, "vpn-id": 1, "vdevice-host-name": "vm1", "adv-router": "172.16.255.21", "age": "155", "lsa-type": "network" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/ospf/databaseexternal": { "get": { "tags": [ "Real-Time Monitoring - OSPF" ], "description": "Get OSPF external database list from device (Real Time)", "operationId": "createOSPFDatabaseExternal", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "OSPF external database list": { "description": "OSPF external database list", "value": { "data": [ { "link-id": "10.20.25.0", "options-flags": "EDN", "vdevice-name": "172.16.255.11", "prefix": "10.20.25.0/24", "metric-type": "type2", "length": 36, "flags": 11, "vpn-id": 1, "vdevice-host-name": "vm1", "adv-router": "172.16.255.11", "forwarding-addr": "0.0.0.0", "sequence": 2147483650, "vdevice-dataKey": "172.16.255.11-1-10.20.25.0", "metric": "16777214", "checksum": 62048, "options": 130, "lastupdated": 1646791949860, "tag": 0, "age": 958 }, { "link-id": "10.20.25.0", "options-flags": "EDN", "vdevice-name": "172.16.255.11", "prefix": "10.20.25.0/24", "metric-type": "type2", "length": 36, "flags": 6, "vpn-id": 1, "vdevice-host-name": "vm1", "adv-router": "172.16.255.21", "forwarding-addr": "0.0.0.0", "sequence": 2147483650, "vdevice-dataKey": "172.16.255.11-1-10.20.25.0", "metric": "16777214", "checksum": 46738, "options": 130, "lastupdated": 1646791949860, "tag": 0, "age": 959 }, { "link-id": "172.16.255.112", "options-flags": "E", "vdevice-name": "172.16.255.11", "prefix": "172.16.255.112/32", "metric-type": "type2", "length": 36, "flags": 6, "vpn-id": 1, "vdevice-host-name": "vm1", "adv-router": "172.16.255.12", "forwarding-addr": "0.0.0.0", "sequence": 2147483651, "vdevice-dataKey": "172.16.255.11-1-172.16.255.112", "metric": "20", "checksum": 58083, "options": 2, "lastupdated": 1646791949860, "tag": 0, "age": 958 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/ospf/databasesummary": { "get": { "tags": [ "Real-Time Monitoring - OSPF" ], "description": "Get OSPF database summary list from device (Real Time)", "operationId": "createOSPFDatabaseSummaryList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "OSPF database summary list": { "description": "OSPF database summary list", "value": { "data": [ { "vdevice-dataKey": "172.16.255.11-1-0", "router-lsa": 3, "total-lsa": 5, "vdevice-name": "172.16.255.11", "summary-lsa": 0, "nssa-lsa": 0, "network-lsa": 2, "lastupdated": 1646792331519, "area-id": 0, "vpn-id": 1, "asbr-summary-lsa": 0, "vdevice-host-name": "vm1" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/ospf/interface": { "get": { "tags": [ "Real-Time Monitoring - OSPF" ], "description": "Get OSPF interface list from device (Real Time)", "operationId": "createOSPFInterface", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "OSPF interface list": { "description": "OSPF interface list", "value": { "data": [ { "lastupdated": 1646026461327, "vdevice-dataKey": "169.254.10.14-0-1--", "vdevice-name": "169.254.10.14", "router-id": "0", "vdevice-host-name": "vm16", "instance-id": "1" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/ospf/neighbor": { "get": { "tags": [ "Real-Time Monitoring - OSPF" ], "description": "Get OSPF neighbor list from device (Real Time)", "operationId": "createOSPFNeighbors", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "OSPF neighbor list": { "description": "OSPF neighbor list", "value": { "data": [ { "lastupdated": 1646027273671, "vdevice-dataKey": "169.254.10.14-0-1---", "vdevice-name": "169.254.10.14", "router-id": "0", "vdevice-host-name": "vm16", "instance-id": "1" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/ospf/process": { "get": { "tags": [ "Real-Time Monitoring - OSPF" ], "description": "Get OSPF process list from device (Real Time)", "operationId": "createOSPFProcess", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "OSPF process list": { "description": "OSPF process list", "value": { "data": [ { "ls-ack-sent": "5", "summary-lsa-checksum": "0", "vdevice-name": "172.16.255.11", "spf-max-holdtime": "10000", "spf-holdtime": "1000", "number-areas": "1", "rfc1583-compatible": "true", "lsa-count": "5", "external-lsa-checksum": "166869", "router-id": "172.16.255.11", "hello-received": "172", "ignore-down-bit": "false", "area-id": "0", "dbd-received": "2", "network-lsa-checksum": "123086", "summary-lsa-count": "0", "router-lsa-count": "3", "router-lsa-checksum": "111691", "spf-delay": "200", "spf-hold-multiplier": "1", "external-lsa-count": "3", "ls-ack-received": "5", "asbr-lsa-count": "0", "vpn-id": "1", "vdevice-host-name": "vm1", "spf-last-exec-time": "1663", "backbone-area": "true", "network-lsa-count": "2", "ls-req-sent": "1", "asbr-lsa-checksum": "0", "dbd-sent": "3", "vdevice-dataKey": "172.16.255.11-1-", "lsa-refresh-interval": "10", "ls-upd-received": "12", "nssa-lsa-count": "0", "ls-req-received": "1", "num-full-adj-routers": "1", "spf-exec-count": "3", "lastupdated": 1646792665279, "ls-upd-sent": "8", "nssa-lsa-checksum": "0", "hello-sent": "172", "num-interfaces": "1" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/ospf/routes": { "get": { "tags": [ "Real-Time Monitoring - OSPF" ], "description": "Get OSPF route list from device (Real Time)", "operationId": "createOSPFRoutesList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "OSPF route list": { "description": "OSPF route list", "value": { "data": [ { "cost": "10", "dest-type": "router", "vdevice-name": "172.16.255.11", "prefix": "172.16.255.12/32", "flags": "2", "info-id": "0", "vpn-id": "1", "vdevice-host-name": "vm1", "if-name": "ge0/0", "vdevice-dataKey": "172.16.255.11-1-router-172.16.255.12/32-0", "route-type": "router", "lastupdated": 1646793742274, "area-id": "0", "next-hop": "10.2.2.12", "path-type": "intra-area" }, { "cost": "20", "dest-type": "router", "vdevice-name": "172.16.255.11", "prefix": "172.16.255.21/32", "flags": "2", "info-id": "0", "vpn-id": "1", "vdevice-host-name": "vm1", "if-name": "ge0/0", "vdevice-dataKey": "172.16.255.11-1-router-172.16.255.21/32-0", "route-type": "router", "lastupdated": 1646793742276, "area-id": "0", "next-hop": "10.2.2.12", "path-type": "intra-area" }, { "cost": "10", "dest-type": "network", "vdevice-name": "172.16.255.11", "prefix": "10.2.2.0/24", "flags": "0", "info-id": "0", "vpn-id": "1", "vdevice-host-name": "vm1", "if-name": "ge0/0", "vdevice-dataKey": "172.16.255.11-1-network-10.2.2.0/24-0", "route-type": "network", "lastupdated": 1646793742276, "area-id": "0", "next-hop": "0.0.0.0", "path-type": "intra-area" }, { "cost": "20", "dest-type": "network", "vdevice-name": "172.16.255.11", "prefix": "10.2.3.0/24", "flags": "0", "info-id": "0", "vpn-id": "1", "vdevice-host-name": "vm1", "if-name": "ge0/0", "vdevice-dataKey": "172.16.255.11-1-network-10.2.3.0/24-0", "route-type": "network", "lastupdated": 1646793742276, "area-id": "0", "next-hop": "10.2.2.12", "path-type": "intra-area" }, { "dest-type": "network", "vdevice-name": "172.16.255.11", "prefix": "172.16.255.112/32", "flags": "78", "info-id": "0", "vpn-id": "1", "vdevice-host-name": "vm1", "type2-cost": "20", "if-name": "ge0/0", "vdevice-dataKey": "172.16.255.11-1-external-172.16.255.112/32-0", "route-type": "external", "lastupdated": 1646793742276, "tag": "0", "next-hop": "10.2.2.12", "path-type": "external2" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/ospf/v3interface": { "get": { "tags": [ "Real-Time Monitoring - OSPF" ], "description": "Get OSPF v3 interface list from device (Real Time)", "operationId": "createOSPFv3Interface", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "OSPF v3 interface list": { "description": "OSPF v3 interface list", "value": { "data": [ { "router-id": "90.90.90.90", "af": "ospfv3-address-family-ipv4", "area-id": "300", "lastupdated": 1649681917917, "vpn-id": "10", "vdevice-dataKey": "172.16.255.15-10-ospfv3-address-family-ipv4--90.90.90.90-300-", "process-id": "10", "vdevice-host-name": "vm5", "vdevice-name": "172.16.255.15" }, { "router-id": "100.100.5.101", "af": "ospfv3-address-family-ipv6", "area-id": "300", "lastupdated": 1649681917917, "vpn-id": "10", "vdevice-dataKey": "172.16.255.15-10-ospfv3-address-family-ipv6--100.100.5.101-300-", "process-id": "10", "vdevice-host-name": "vm5", "vdevice-name": "172.16.255.15" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/ospf/v3neighbor": { "get": { "tags": [ "Real-Time Monitoring - OSPF" ], "description": "Get OSPF v3 neighbor list from device (Real Time)", "operationId": "createOSPFv3Neighbors", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "OSPF v3 neighbor list": { "description": "OSPF v3 neighbor list", "value": { "data": [ { "router-id": "90.90.90.90", "af": "ospfv3-address-family-ipv4", "area-id": "300", "lastupdated": 1649682289885, "vpn-id": "10", "vdevice-dataKey": "172.16.255.15-10-ospfv3-address-family-ipv4--90.90.90.90-300--", "process-id": "10", "vdevice-host-name": "vm5", "vdevice-name": "172.16.255.15" }, { "router-id": "100.100.5.101", "af": "ospfv3-address-family-ipv6", "area-id": "300", "lastupdated": 1649682289885, "vpn-id": "10", "vdevice-dataKey": "172.16.255.15-10-ospfv3-address-family-ipv6--100.100.5.101-300--", "process-id": "10", "vdevice-host-name": "vm5", "vdevice-name": "172.16.255.15" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/pim/interface": { "get": { "tags": [ "Real-Time Monitoring - PIM" ], "description": "Get PIM interface list from device", "operationId": "createPIMInterfaceList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "PIM interface list": { "description": "PIM interface list", "value": { "data": [ { "if-name": "ge0/0", "dr-address": "100.100.3.101", "vdevice-dataKey": "169.254.10.10", "vdevice-name": "169.254.10.10", "if-addr": "100.100.3.101/24", "neighbor-count": 0, "hello-interval": 30, "lastupdated": 1643258686605, "join-prune-interval": 60, "vpn-id": "10", "priority": 1, "vdevice-host-name": "vm3" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/pim/neighbor": { "get": { "tags": [ "Real-Time Monitoring - PIM" ], "description": "Get PIM neighbor list from device", "operationId": "createPIMNeighborList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "PIM neighbor list": { "description": "PIM neighbor list", "value": { "data": [ { "vdevice-name": "169.254.10.9", "vdevice-host-name": "vm2", "vpn-id": "1", "if-name": "ge0/0.1", "nbr-addr": "10.0.9.11", "up-time": "0:12:12:12", "up-time-date": "0:12:12:12 2022/07/19", "expires": "0:23:01:44", "expires-date": "0:23:01:44 2022/07/19", "priority": "1", "hold-time": "105", "dr-address": "10.0.9.14", "lastupdated": 1658198416779, "vdevice-dataKey": "169.254.10.9" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/pim/rp-mapping": { "get": { "tags": [ "Real-Time Monitoring - PIM" ], "description": "Get PIM Rp-mapping list from device", "operationId": "createPIMRpMappingList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "PIM Rp-mapping list": { "description": "PIM Rp-mapping list", "value": { "data": [ { "vdevice-name": "169.254.10.9", "vdevice-host-name": "vm2", "vpn-id": "1", "type": "Auto-RP", "group": "225.0.0.0/24", "rp-address": "225.0.0.0/24", "lastupdated": 1658198416779, "vdevice-dataKey": "169.254.10.9" }, { "vdevice-name": "169.254.10.9", "vdevice-host-name": "vm2", "vpn-id": "2", "type": "Auto-RP", "group": "227.0.0.0/24", "rp-address": "58.0.2.100 ", "lastupdated": 1658198416779, "vdevice-dataKey": "169.254.10.9" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/pim/statistics": { "get": { "tags": [ "Real-Time Monitoring - PIM" ], "description": "Get PIM statistics list from device", "operationId": "createPIMStatisticsList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "PIM statistics list": { "description": "PIM statistics list", "value": { "data": [ { "hello-rx": 0, "unknown-rx": 0, "vdevice-name": "169.254.10.10", "vpn-id": "10", "vdevice-host-name": "vm3", "bad-rx": 0, "join-prune-tx": 0, "vdevice-dataKey": "169.254.10.10", "join-prune-rx": 0, "auto-rp-mapping-rx": 0, "unsupported-rx": 0, "lastupdated": 1643259067333, "assert-rx": 0, "auto-rp-announce-rx": 0, "assert-tx": 0, "hello-tx": 1090 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/pki/trustpoint": { "get": { "tags": [ "Real-Time Monitoring - Pki Trustpoint" ], "description": "Get device pki trustpoint", "operationId": "getDevicePkiTrustpoint", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device pki trustpoint": { "description": "Device pki trustpoint", "value": { "data": [ { "cert/subject-name": "cn=Cisco Root CA M1,o=Cisco", "cert/issuer-name": "cn=Cisco Root CA M1,o=Cisco", "vdevice-dataKey": "172.16.255.15-Trustpool", "vdevice-name": "172.16.255.15", "cert/validity-end": "2033-11-18T21:59:46+00:00", "cert/serial-number": "2ED20E7347D333834B4FDD0DD7B6967E", "lastupdated": 1687777199956, "cert/validity-start": "2008-11-18T21:50:24+00:00", "label": "Trustpool", "tp-authenticated": "true", "vdevice-host-name": "vm5", "cert/md5-fp": "F0F28550B0B8394B327BB8472FD1B807" }, { "cert/subject-name": "cn=Cisco Root CA 2048,o=Cisco Systems", "cert/issuer-name": "cn=Cisco Root CA 2048,o=Cisco Systems", "vdevice-dataKey": "172.16.255.15-Trustpool1", "vdevice-name": "172.16.255.15", "cert/validity-end": "2029-05-14T20:25:42+00:00", "cert/serial-number": "5FF87B282B54DC8D42A315B568C9ADFF", "lastupdated": 1687777199956, "cert/validity-start": "2004-05-14T20:17:12+00:00", "label": "Trustpool1", "tp-authenticated": "true", "vdevice-host-name": "vm5", "cert/md5-fp": "BE395ABE078AB1121725CC1D46343CB2" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/policer": { "get": { "tags": [ "Real-Time Monitoring - Policer" ], "description": "Get policed interface list from device", "operationId": "getPolicedInterface", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Policed interface": { "description": "Policed interface", "value": { "data": [ { "oos-bytes": "0", "oos-action": "drop", "vdevice-dataKey": "169.254.10.10-10", "vdevice-name": "169.254.10.10", "rate": 81920, "oos-pkts": "0", "name": "TCPOPT_SYN_POLICER", "index": 10, "lastupdated": 1643264577448, "burst": 10240, "vdevice-host-name": "vm3", "direction": "in" }, { "oos-bytes": "0", "oos-action": "drop", "vdevice-dataKey": "169.254.10.10-11", "vdevice-name": "169.254.10.10", "rate": 100000000, "oos-pkts": "0", "name": "TCPOPT_DATA_POLICER", "index": 11, "lastupdated": 1643264577448, "burst": 12500000, "vdevice-host-name": "vm3", "direction": "in" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/policy/accesslistassociations": { "get": { "tags": [ "Real-Time Monitoring - Policy" ], "description": "Get access list associations from device", "operationId": "createPolicyAccessListAssociations", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Access list associations": { "description": "Access list associations", "value": { "data": [ { "vdevice-dataKey": "172.16.255.16-pol-acl-test", "vdevice-name": "172.16.255.16", "name": "pol-acl-test", "lastupdated": 1653374017047, "vdevice-host-name": "vm6" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/policy/accesslistcounters": { "get": { "tags": [ "Real-Time Monitoring - Policy" ], "description": "Get access list counter from device", "operationId": "createPolicyAccessListCounters", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Access list counter": { "description": "Access list counter", "value": { "data": [ { "vdevice-dataKey": "172.16.255.16-pol-acl-test", "counter-name": "default_action_count", "vdevice-name": "172.16.255.16", "bytes": "0", "name": "pol-acl-test", "lastupdated": 1653374287187, "vdevice-host-name": "vm6", "packets": "0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/policy/accesslistnames": { "get": { "tags": [ "Real-Time Monitoring - Policy" ], "description": "Get access list names from device", "operationId": "createPolicyAccessListNames", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Access list names": { "description": "Access list names", "value": { "data": [ { "vdevice-dataKey": "172.16.255.16-pol-acl-test", "vdevice-name": "172.16.255.16", "name": "pol-acl-test", "lastupdated": 1653374338991, "vdevice-host-name": "vm6" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/policy/accesslistpolicers": { "get": { "tags": [ "Real-Time Monitoring - Policy" ], "description": "Get access list policers from device", "operationId": "createPolicyAccessListPolicers", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Access list policers": { "description": "Access list policers", "value": { "data": [ { "name": "pol-acl-test", "lastupdated": 1653374393223, "vdevice-dataKey": "172.16.255.16-pol-acl-test-", "vdevice-name": "172.16.255.16", "vdevice-host-name": "vm6" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/policy/approutepolicyfilter": { "get": { "tags": [ "Real-Time Monitoring - Policy" ], "description": "Get approute policy filter from device", "operationId": "createPolicyAppRoutePolicyFilter", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Approute policy filter": { "description": "Approute policy filter", "value": { "data": [ { "vdevice-name": "172.16.255.16", "vdevice-host-name": "vm6", "policy-name": "accept_nat", "vpn-name": "vpn_1", "counter-name": "natpool1", "packets": 18179, "bytes": "27448882", "vdevice-dataKey": "172.16.255.16-accept_nat-vpn_1-natpool1", "lastupdated": 1656400527112 }, { "vdevice-name": "172.16.255.16", "vdevice-host-name": "vm6", "policy-name": "accept_nat", "vpn-name": "vpn_1", "counter-name": "natpool2", "packets": 18229, "bytes": "27441234", "vdevice-dataKey": "172.16.255.16-accept_nat-vpn_1-natpool2", "lastupdated": 1656400527112 }, { "vdevice-name": "172.16.255.16", "vdevice-host-name": "vm6", "policy-name": "accept_nat", "vpn-name": "vpn_1", "counter-name": "natpool3", "packets": 18888, "bytes": "27444442", "vdevice-dataKey": "172.16.255.16-accept_nat-vpn_1-natpool3", "lastupdated": 1656400527112 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/policy/datapolicyfilter": { "get": { "tags": [ "Real-Time Monitoring - Policy" ], "description": "Get data policy filters from device", "operationId": "createPolicDataPolicyFilter", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Data policy filter": { "description": "Data policy filter", "value": { "data": [ { "vpn-name": "vpn_1", "vdevice-dataKey": "172.16.255.15-accept_nat-vpn_1-natpool1", "counter-name": "natpool1", "vdevice-name": "172.16.255.15", "bytes": "27448882", "policy-name": "accept_nat", "lastupdated": 1656400527112, "vdevice-host-name": "vm5", "packets": 18179 }, { "vpn-name": "vpn_1", "vdevice-dataKey": "172.16.255.15-accept_nat-vpn_1-natpool2", "counter-name": "natpool2", "vdevice-name": "172.16.255.15", "bytes": "27042692", "policy-name": "accept_nat", "lastupdated": 1656400527112, "vdevice-host-name": "vm5", "packets": 17910 }, { "vpn-name": "vpn_1", "vdevice-dataKey": "172.16.255.15-accept_nat-vpn_1-natpool3", "counter-name": "natpool3", "vdevice-name": "172.16.255.15", "bytes": "26630462", "policy-name": "accept_nat", "lastupdated": 1656400527112, "vdevice-host-name": "vm5", "packets": 17637 }, { "vpn-name": "vpn_1", "vdevice-dataKey": "172.16.255.15-accept_nat-vpn_1-natpool4", "counter-name": "natpool4", "vdevice-name": "172.16.255.15", "bytes": "26252860", "policy-name": "accept_nat", "lastupdated": 1656400527112, "vdevice-host-name": "vm5", "packets": 17386 }, { "vpn-name": "vpn_1", "vdevice-dataKey": "172.16.255.15-accept_nat-vpn_1-natpool5", "counter-name": "natpool5", "vdevice-name": "172.16.255.15", "bytes": "25849690", "policy-name": "accept_nat", "lastupdated": 1656400527112, "vdevice-host-name": "vm5", "packets": 17119 }, { "vpn-name": "vpn_1", "vdevice-dataKey": "172.16.255.15-accept_nat-vpn_1-default_action_count", "counter-name": "default_action_count", "vdevice-name": "172.16.255.15", "bytes": "0", "policy-name": "accept_nat", "lastupdated": 1656400527112, "vdevice-host-name": "vm5", "packets": 0 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/policy/filtermemoryusage": { "get": { "tags": [ "Real-Time Monitoring - Policy" ], "description": "Get data policy filter memory usage from device", "operationId": "createPolicyFilterMemoryUsage", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Data policy filter memory usage": { "description": "Data policy filter memory usage", "value": { "data": [ { "filter-max": "512", "vdevice-dataKey": "169.254.10.10-0", "vdevice-name": "169.254.10.10", "blocks-used": "0", "blocks-max": "1048576", "filter-used": "0", "lastupdated": 1643266183894, "vdevice-host-name": "vm3" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/policy/iptosgtbindings": { "get": { "tags": [ "Real-Time Monitoring - Policy" ], "description": "show ip to sgt binding from Vsmart", "operationId": "showVsmartIptoSgtBinding", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device Id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "SDWAN policy from vSmart": { "description": "SDWAN policy from vSmart", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/policy/iptouserbindings": { "get": { "tags": [ "Real-Time Monitoring - Policy" ], "description": "show ip to user binding from Vsmart", "operationId": "showVsmartIptoUserBinding", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device Id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "SDWAN policy from vSmart": { "description": "SDWAN policy from vSmart", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/policy/ipv6/accesslistassociations": { "get": { "tags": [ "Real-Time Monitoring - Policy" ], "description": "Get access list associations from device", "operationId": "createPolicyAccessListAssociationsIpv6", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Access list associations": { "description": "Access list associations", "value": { "data": [ { "vdevice-dataKey": "172.16.255.16-ipv6_pol-acl-test", "vdevice-name": "172.16.255.16", "name": "ipv6_pol-acl-test", "lastupdated": 1653376026043, "vdevice-host-name": "vm6" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/policy/ipv6/accesslistcounters": { "get": { "tags": [ "Real-Time Monitoring - Policy" ], "description": "Get access list counters from device", "operationId": "createPolicyAccessListCountersIpv6", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Access list counters": { "description": "Access list counters", "value": { "data": [ { "vdevice-dataKey": "172.16.255.16-ipv6_pol-acl-test", "counter-name": "default_action_count", "vdevice-name": "172.16.255.16", "bytes": "0", "name": "ipv6_pol-acl-test", "lastupdated": 1653376073433, "vdevice-host-name": "vm6", "packets": "0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/policy/ipv6/accesslistnames": { "get": { "tags": [ "Real-Time Monitoring - Policy" ], "description": "Get access list names from device", "operationId": "createPolicyAccessListNamesIpv6", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Access list names": { "description": "Access list names", "value": { "data": [ { "vdevice-dataKey": "172.16.255.16-ipv6_pol-acl-test", "vdevice-name": "172.16.255.16", "name": "ipv6_pol-acl-test", "lastupdated": 1653376118299, "vdevice-host-name": "vm6" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/policy/ipv6/accesslistpolicers": { "get": { "tags": [ "Real-Time Monitoring - Policy" ], "description": "Get access list policers from device", "operationId": "createPolicyAccessListPolicersIpv6", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Access list policers": { "description": "Access list policers", "value": { "data": [ { "name": "ipv6_pol-acl-test", "lastupdated": 1653376169819, "vdevice-dataKey": "172.16.255.16-ipv6_pol-acl-test-", "vdevice-name": "172.16.255.16", "vdevice-host-name": "vm6" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/policy/pxgridstatus": { "get": { "tags": [ "Real-Time Monitoring - Policy" ], "description": "show Pxgrid status From Vsmart", "operationId": "showVsmartPxGridStatus", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device Id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "SDWAN policy from vSmart": { "description": "SDWAN policy from vSmart", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/policy/pxgridusersessions": { "get": { "tags": [ "Real-Time Monitoring - Policy" ], "description": "show Pxgrid sessions From Vsmart", "operationId": "showVsmartPxGridUserSessions", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device Id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "SDWAN policy from vSmart": { "description": "SDWAN policy from vSmart", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/policy/qosmapinfo": { "get": { "tags": [ "Real-Time Monitoring - Policy" ], "description": "Get QoS map information from device", "operationId": "createPolicQosMapInfo", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "QoS map information": { "description": "QoS map information", "value": { "data": [ { "lastupdated": 1654481032855, "vdevice-dataKey": "169.254.10.9-policy_qos_map", "vdevice-name": "169.254.10.9", "qos-map-name": "policy_qos_map", "vdevice-host-name": "vm2" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/policy/qosschedulerinfo": { "get": { "tags": [ "Real-Time Monitoring - Policy" ], "description": "Get QoS scheduler information from device", "operationId": "createPolicQosSchedulerInfo", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "QoS scheduler information": { "description": "QoS scheduler information", "value": { "data": [ { "vdevice-dataKey": "169.254.10.9-policy_qos_map_0", "vdevice-name": "169.254.10.9", "qos-map-name": "policy_qos_map", "buffer-percent": "100", "lastupdated": 1654481134775, "bandwidth-percent": "100", "qos-scheduler-name": "policy_qos_map_0", "vdevice-host-name": "vm2" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/policy/rewriteassociations": { "get": { "tags": [ "Real-Time Monitoring - Policy" ], "description": "Get rewrite associations information from device", "operationId": "createPolicyRewriteAssociationsInfo", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Rewrite associations information": { "description": "Rewrite associations information", "value": { "data": [ { "name": "vpn10_rewrite_policy", "lastupdated": 1654562464357, "vdevice-dataKey": "169.254.10.9-vpn10_rewrite_policy", "vdevice-name": "169.254.10.9", "vdevice-host-name": "vm2" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/policy/userusergroupbindings": { "get": { "tags": [ "Real-Time Monitoring - Policy" ], "description": "Show User-Usergroup bindings from Vsmart", "operationId": "showVsmartUserUsergroupBindings", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device Id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "SDWAN policy from vSmart": { "description": "SDWAN policy from vSmart", "value": [ { "omp-update-state": "omp-updated", "vdevice-dataKey": "172.16.255.19", "vdevice-name": "172.16.255.19", "user-groups": "User Identity Groups:Employee", "lastupdated": 1646677354863, "vdevice-host-name": "vm9", "username": "TestUser0" }, { "omp-update-state": "omp-updated", "vdevice-dataKey": "172.16.255.19", "vdevice-name": "172.16.255.19", "user-groups": "User Identity Groups:TestUserGroup-1", "lastupdated": 1646677354863, "vdevice-host-name": "vm9", "username": "TestUser0" }, { "omp-update-state": "omp-updated", "vdevice-dataKey": "172.16.255.19", "vdevice-name": "172.16.255.19", "user-groups": "User Identity Groups:Employee", "lastupdated": 1646677354863, "vdevice-host-name": "vm9", "username": "TestUser1" }, { "omp-update-state": "omp-updated", "vdevice-dataKey": "172.16.255.19", "vdevice-name": "172.16.255.19", "user-groups": "User Identity Groups:TestUserGroup-1", "lastupdated": 1646677354863, "vdevice-host-name": "vm9", "username": "TestUser1" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/policy/vsmart": { "get": { "tags": [ "Real-Time Monitoring - Policy" ], "description": "show Sdwan Policy From Vsmart", "operationId": "showSdwanPolicyFromVsmart", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "SDWAN policy from vSmart": { "description": "SDWAN policy from vSmart", "value": { "data": [ { "vdevice-name": "169.254.10.9", "vdevice-host-name": "vm2", "name": "dp1", "app-list": "SSH_policy", "vpn-list": "vpn_1_list", "vpn-id": "1", "lastupdated": 1658198416779, "vdevice-dataKey": "169.254.10.9" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/policy/zbfwdropstatistics": { "get": { "tags": [ "Real-Time Monitoring - Policy" ], "description": "Get zone drop statistics from device", "operationId": "getZoneDropStatistics", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Zone drop statistics": { "description": "Zone drop statistics", "value": { "data": [ { "l4-tcp-l7-ooo-seg": "0", "l4-icmp-err-l4-invalid-seq": "0", "policy-action-drop": "0", "l4-icmp-err-no-ip-no-icmp": "0", "l7-type-drop": "0", "l4-scb-close": "0", "l4-tcp-invalid-seg-synsent-state": "0", "l4-tcp-syn-flood-drop": "0", "l4-icmp-internal-err-no-nat": "0", "l4-tcp-invalid-seq": "0", "l7-no-seg": "0", "no-new-session": "0", "l4-icmp-internal-err-get-stat-blk-fail": "0", "syncookie-max-dst": "0", "insp-internal-err-get-stat-blk-fail": "0", "l4-invalid-hdr": "0", "l4-icmp-internal-err-alloc-fail": "0", "l4-tcp-invalid-seg-pkt-win-overflow": "0", "no-forwarding-zone": "0", "l4-icmp-too-many-err-pkts": "0", "fdb-err": "0", "no-session": "0", "insp-dstaddr-lookup-fail": "0", "l4-session-limit": "0", "insp-class-action-drop": "0", "l4-tcp-rst-to-resp": "0", "l4-tcp-stray-seg": "0", "not-initiator": "0", "backpressure": "0", "l4-tcp-invalid-tcp-initiator": "0", "l4-icmp-pkt-too-short": "0", "zone-mismatch": "0", "l4-tcp-unexpect-tcp-payload": "0", "l7-no-frag": "0", "l4-tcp-invalid-seg-pyld-after-fin-send": "0", "l4-icmp-err-policy-not-present": "0", "l7-alg-ret-drop": "0", "l4-tcp-internal-err-synflood-alloc-hostdb-fail": "0", "insp-classification-fail": "0", "l4-tcp-invalid-win-scale-option": "0", "l4-tcp-syn-in-win": "0", "policy-icmp-action-drop": "0", "vdevice-name": "169.254.10.12", "lisp-inner-ipv6-insane": "0", "l4-tcp-rst-in-win": "0", "l4-tcp-retrans-invalid-flags": "0", "catch-all": "0", "l4-icmp-err-l4-invalid-ack": "0", "syncookie-trigger": "0", "l7-unknown-proto": "0", "l4-tcp-syn-with-data": "0", "l4-tcp-invalid-seg-pkt-too-old": "0", "l4-icmp-err-classification-fail": "0", "l4-icmp-internal-err-dir-not-identified": "0", "l4-internal-err-undefined-dir": "0", "insp-policy-not-present": "0", "syncookie-internal-err-alloc-fail": "0", "lisp-header-restore-fail": "0", "l4-tcp-synflood-blackout-drop": "0", "l4-tcp-invalid-ack-flag": "0", "insp-pam-lookup-fail": "0", "l4-icmp-scb-close": "0", "invalid-zone": "0", "ha-ar-standby": "0", "vdevice-host-name": "vm5", "l4-tcp-invalid-seg-synrcvd-state": "0", "l4-tcp-invalid-ack-num": "0", "l7-promote-fail-no-policy": "0", "l4-too-many-pkts": "0", "l4-icmp-err-pkts-burst": "0", "l7-promote-fail-no-zone-pair": "0", "vdevice-dataKey": "169.254.10.12-0", "l4-icmp-err-multiple-unreach": "0", "policy-fragment-drop": "0", "l4-tcp-invalid-flags": "0", "lisp-inner-ipv4-insane": "0", "lastupdated": 1645666649064, "l4-max-halfsession": "0", "insp-sess-miss-policy-not-present": "0", "l4-icmp-pkt-no-ip-hdr": "0", "insp-policy-misconfigure": "0", "lisp-inner-pkt-insane": "0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/policy/zbfwstatistics": { "get": { "tags": [ "Real-Time Monitoring - Policy" ], "description": "Get zone based firewall statistics from device", "operationId": "getZbfwStatistics", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Zone based firewall statistics": { "description": "Zone based firewall statistics", "value": { "data": [ { "no-pair-diff-zone-dropped": "0", "tcp-retrans-seg": "0", "flow-add-fail": "0", "vdevice-name": "169.254.10.10", "tcp-drop-stray-seg": "0", "tcp-drop-invalid-seg-pkt-too-old": "0", "zbf-pkts": "0", "state-check-fail": "0", "unsupported-proto": "0", "no-pair-same-zone-allowed": "0", "zone-no-zone-inet-denied": "0", "tcp-drop-invalid-seg-synsent-state": "0", "max-halfopen-exceeded": "0", "tcp-drop-invalid-flags": "0", "tcp-drop-unexpect-tcp-pyld": "0", "num-flow-entries": "0", "tcp-ooo-seg": "0", "tcp-drop-invalid-seg-synrcvd-state": "0", "tcp-drop-no-syn-in-listen-state": "0", "tcp-drop-invalid-ack-flag": "0", "fragments": "0", "zone-no-zone-dropped": "0", "no-zone-no-zone-allowed": "0", "tcp-drop-invalid-ack-num": "0", "policy-change-dropped": "0", "tcp-drop-rst-to-resp": "0", "tcp-drop-syn-with-data": "0", "tcp-drop-syn-in-win": "0", "tcp-drop-invalid-dir": "0", "tcp-drop-invalid-win-scale-option": "0", "frag-fail": "0", "tcp-drop-retrans-invalid-flags": "0", "tcp-drop-internal-invalid-tcp-state": "0", "tcp-drop-rst-in-win": "0", "tcp-drop-invalid-seg-pkt-win-overflow": "0", "vdevice-host-name": "vm3", "vdevice-dataKey": "169.254.10.10-", "lastupdated": 1643271305369, "tcp-drop-invalid-seq": "0", "zone-no-zone-inet-allowed": "0", "tcp-drop-invalid-seg-pyld-after-fin-send": "0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/policy/zonepairsessions": { "get": { "tags": [ "Real-Time Monitoring - Policy" ], "description": "Get zone pair sessions from device", "operationId": "getZonePairSessions", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Zone pair session": { "description": "Zone pair session", "value": { "data": [ { "src-ip": "10.1.15.15", "dst-ip": "10.0.5.19", "src-vpn-id": "65534", "vdevice-name": "172.16.255.15", "src-port": 12426, "zp-name": "self_to_inet", "dst-vrf": "0", "dst-port": 12455, "vdevice-host-name": "vm5", "total-responder-bytes": "115724", "protocol": "PROTO_L4_UDP", "vdevice-dataKey": "13", "lastupdated": 1655955518778, "state": "open", "dst-vpn-id": "0", "total-initiator-bytes": "103518", "classmap-name": "3", "session-id": "13", "src-vrf": "0" }, { "src-ip": "10.0.1.1", "dst-ip": "10.0.1.255", "src-vpn-id": "0", "vdevice-name": "172.16.255.15", "src-port": 123, "zp-name": "inet_to_self", "dst-vrf": "0", "dst-port": 123, "vdevice-host-name": "vm5", "total-responder-bytes": "0", "protocol": "PROTO_L7_NTP", "vdevice-dataKey": "28", "lastupdated": 1655955518778, "state": "opening", "dst-vpn-id": "65534", "total-initiator-bytes": "48", "classmap-name": "3", "session-id": "28", "src-vrf": "0" }, { "src-ip": "10.1.15.15", "dst-ip": "10.0.12.22", "src-vpn-id": "65534", "vdevice-name": "172.16.255.15", "src-port": 12426, "zp-name": "self_to_inet", "dst-vrf": "0", "dst-port": 12446, "vdevice-host-name": "vm5", "total-responder-bytes": "918966", "protocol": "PROTO_L4_UDP", "vdevice-dataKey": "15", "lastupdated": 1655955518778, "state": "open", "dst-vpn-id": "0", "total-initiator-bytes": "5037561", "classmap-name": "3", "session-id": "15", "src-vrf": "0" }, { "src-ip": "10.1.15.15", "dst-ip": "10.0.12.20", "src-vpn-id": "65534", "vdevice-name": "172.16.255.15", "src-port": 12426, "zp-name": "self_to_inet", "dst-vrf": "0", "dst-port": 12456, "vdevice-host-name": "vm5", "total-responder-bytes": "116455", "protocol": "PROTO_L4_UDP", "vdevice-dataKey": "14", "lastupdated": 1655955518778, "state": "open", "dst-vpn-id": "0", "total-initiator-bytes": "107116", "classmap-name": "3", "session-id": "14", "src-vrf": "0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/policy/zonepairstatistics": { "get": { "tags": [ "Real-Time Monitoring - Policy" ], "description": "Get zone pair statistics from device", "operationId": "getZonePairs", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Zone pair statistics": { "description": "Zone pair statistics", "value": { "data": [ { "max-active-conn": "0", "class-action": "Inspect Drop", "vdevice-name": "172.16.255.15", "src-zone-name": "employee", "pkts-counter": "0", "max-halfopen-conn": "0", "vdevice-host-name": "vm5", "zonepair-name": "employee-inet", "class-name": "cmap_1", "attempted-conn": "0", "match-type-id": "3", "match-type": "access-group name", "current-active-conn": "0", "current-halfopen-conn": "0", "vdevice-dataKey": "172.16.255.15-employee-inet-cmap_1", "time-since-last-session-create": "0", "current-terminating-conn": "0", "policy-name": "fw_policy1", "match-name": "acl1_1", "lastupdated": 1655267493875, "max-terminating-conn": "0", "dst-zone-name": "internet", "bytes-counter": "0" }, { "max-active-conn": "0", "class-action": "Inspect Drop", "vdevice-name": "172.16.255.15", "src-zone-name": "employee", "pkts-counter": "0", "max-halfopen-conn": "0", "vdevice-host-name": "vm5", "class-name": "class-default", "zonepair-name": "employee-inet", "attempted-conn": "0", "current-active-conn": "0", "current-halfopen-conn": "0", "vdevice-dataKey": "172.16.255.15-employee-inet-class-default", "time-since-last-session-create": "0", "current-terminating-conn": "0", "policy-name": "fw_policy1", "lastupdated": 1655267493875, "max-terminating-conn": "0", "dst-zone-name": "internet", "bytes-counter": "0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/policy/zonepolicyfilter": { "get": { "tags": [ "Real-Time Monitoring - Policy" ], "description": "Get zone policy filter from device", "operationId": "getZonePolicyFilters", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Zone policy filter": { "description": "Zone policy filter", "value": { "data": [ { "vdevice-name": "169.254.10.9", "vdevice-host-name": "vm2", "name": "ZONE-POLICY-1", "counter-name": "counter_seq_1", "packets": "2", "bytes": "196", "lastupdated": 1658198416779, "vdevice-dataKey": "169.254.10.9-ZONE-POLICY-1" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write" } }, "/device/powerconsumption": { "get": { "tags": [ "Real-Time Monitoring - Power Consumption" ], "description": "Get Power Consumption Information", "operationId": "getPowerConsumption", "parameters": [ { "name": "deviceId", "in": "query", "required": true, "schema": { "type": "object", "properties": { "deviceIp": { "type": "string" } }, "description": "This is the valid DeviceIP", "$$ref": "#/components/schemas/DeviceIP" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "component-cname": { "type": "string", "example": "Slot0" }, "lastupdated": { "type": "integer", "format": "int64", "example": 1717400936511 }, "platform-property-configurable": { "type": "string", "example": "false" }, "platform-property-name": { "type": "string", "example": "cpld-versio" }, "value-string": { "type": "string", "example": "20061845" }, "vdevice-dataKey": { "type": "string", "example": "172.16.255.15-Slot0-cpld-version" }, "vdevice-host-name": { "type": "string", "example": "pm5" }, "vdevice-name": { "type": "string", "example": "172.16.255.15" } }, "$$ref": "#/components/schemas/RealTimeData" } } }, "$$ref": "#/components/schemas/PowerConsumptionRealTime" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/ppp/interface": { "get": { "tags": [ "Real-Time Monitoring - PIM" ], "description": "Get PPP interface list from device (Real Time)", "operationId": "createPPPInterfaceList", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "PPP interface list": { "description": "PPP interface list", "value": { "data": [ { "vdevice-dataKey": "169.254.10.9-ppp1", "vdevice-name": "169.254.10.9", "ifname": "ppp1", "lastupdated": 1654477366044, "pppoe-interface": "ge0/0", "vpn-id": "0", "vdevice-host-name": "vm2" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Interface-read,Interface-write" } }, "/device/pppoe/session": { "get": { "tags": [ "Real-Time Monitoring - PPPoE" ], "description": "Get PPPoE session list from device", "operationId": "createPPPoEInterfaceList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "object", "properties": { "deviceIp": { "type": "string" } }, "description": "This is the valid DeviceIP", "$$ref": "#/components/schemas/DeviceIP" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "PPPoE session list": { "description": "PPPoE session list", "value": { "data": [ { "vdevice-name": "169.254.10.9", "vdevice-host-name": "vm2", "vpn-id": "0", "ifname": "ge0/1", "session-id": "1", "server-mac": "00:0c:29:2e:20:1a", "local-mac": "00:0c:29:be:27:f5", "ppp-interface": "ppp1", "ac-name": "branch100", "service-name": "-", "vdevice-dataKey": "169.254.10.9", "lastupdated": 1658198416779 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Interface-read,Interface-write" } }, "/device/pppoe/statistic": { "get": { "tags": [ "Real-Time Monitoring - PPPoE" ], "description": "Get PPPoE statistics from device", "operationId": "createPPPoENeighborList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "object", "properties": { "deviceIp": { "type": "string" } }, "description": "This is the valid DeviceIP", "$$ref": "#/components/schemas/DeviceIP" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "PPPoE statistics": { "description": "PPPoE statistics", "value": { "data": [ { "pppoe-pads-pkts": "0", "pppoe-ipcp-pkts": "0", "vdevice-name": "169.254.10.10", "pppoe-lcp-pkts": "0", "pppoe-tx-session-drops": "0", "pppoe-pado-pkts": "0", "pppoe-padt-pkts": "0", "pppoe-padr-pkts": "0", "vdevice-host-name": "vm3", "pppoe-tx-pkts": "0", "pppoe-inv-discovery-pkts": "0", "pppoe-rx-session-drops": "0", "vdevice-dataKey": "169.254.10.10", "pppoe-ccp-pkts": "0", "lastupdated": 1643355873158, "pppoe-rx-pkts": "0", "pppoe-padi-pkts": "0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Interface-read,Interface-write" } }, "/device/qfp/cpustat": { "get": { "tags": [ "Real-Time Monitoring - QFP" ], "description": "Get QFP cpu status", "operationId": "cpustat", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "cpp-num": { "type": "string", "example": "0" }, "dp-stats-load": { "type": "string", "example": "1" }, "lastupdated": { "type": "integer", "format": "int32", "example": 170151880 }, "period": { "type": "string", "example": "cpp-period-1min" }, "total-input-bytes": { "type": "string", "example": "28992" }, "total-input-pkts": { "type": "string", "example": "30" }, "total-output-bytes": { "type": "string", "example": "48896" }, "total-output-pkts": { "type": "string", "example": "25" }, "vdevice-dataKey": { "type": "string", "example": "172.16.255.15-cpp-period-1min" }, "vdevice-host-name": { "type": "string", "example": "vm5" }, "vdevice-name": { "type": "string", "example": "172.16.255.15" } }, "$$ref": "#/components/schemas/QfpCpuState" }, "examples": { "QFP cpu status": { "description": "QFP cpu status", "value": [ { "total-input-bytes": "28992", "period": "cpp-period-1min", "vdevice-dataKey": "172.16.255.15-cpp-period-1min", "cpp-num": "0", "vdevice-name": "172.16.255.15", "total-output-pkts": "25", "total-output-bytes": "48896", "lastupdated": 1701518800889, "total-input-pkts": "30", "dp-stats-load": "1", "vdevice-host-name": "vm5" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write,Security-read,Security-write" } }, "/device/qfp/memstat": { "get": { "tags": [ "Real-Time Monitoring - QFP" ], "description": "Get QFP memory status", "operationId": "memstat", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "dramFree": { "type": "integer", "format": "int32", "example": 135600128 }, "dramInUse": { "type": "integer", "format": "int32", "example": 132835328 }, "dramLowestFreeWaterMark": { "type": "integer", "format": "int32", "example": 135600128 }, "dramTotal": { "type": "integer", "format": "int32", "example": 268435456 }, "iramFree": { "type": "integer", "format": "int32", "example": 1885184 }, "iramInUse": { "type": "integer", "format": "int32", "example": 211968 }, "iramLowestFreeWaterMark": { "type": "integer", "format": "int32", "example": 1885184 }, "iramTotal": { "type": "integer", "format": "int32", "example": 2097152 }, "lastupdated": { "type": "integer", "format": "int32", "example": 170151880 }, "sramFree": { "type": "integer", "format": "int32", "example": 0 }, "sramInUse": { "type": "integer", "format": "int32", "example": 0 }, "sramLowestFreeWaterMark": { "type": "integer", "format": "int32", "example": 0 }, "sramTotal": { "type": "integer", "format": "int32", "example": 0 }, "vdevice-dataKey": { "type": "string", "example": "172.16.255.15-cpp-period-1min" }, "vdevice-host-name": { "type": "string", "example": "vm5" }, "vdevice-name": { "type": "string", "example": "172.16.255.15" } }, "$$ref": "#/components/schemas/QfpMemoryState" }, "examples": { "QFP memory status": { "description": "QFP memory status", "value": [ { "iramInUse": 211968, "sramFree": 0, "vdevice-name": "172.16.255.15", "dramFree": 135600128, "iramTotal": 2097152, "iramFree": 1885184, "iramLowestFreeWaterMark": 1885184, "dramLowestFreeWaterMark": 135600128, "sramTotal": 0, "vdevice-host-name": "vm5", "sramInUse": 0, "sramLowestFreeWaterMark": 0, "vdevice-dataKey": "172.16.255.15", "lastupdated": 1701517192456, "dramTotal": 268435456, "dramInUse": 132835328 } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/qfp/qfpdrop": { "get": { "tags": [ "Real-Time Monitoring - QFP" ], "description": "Get Qfp Drop Info", "operationId": "getQfpDrop", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "appnav-acgreloaddelay-octets": { "type": "number", "example": 0 }, "appnav-acgreloaddelay-pkts": { "type": "number", "example": 0 }, "appnav-badroute-octets": { "type": "number", "example": 0 }, "appnav-badroute-pkts": { "type": "number", "example": 0 }, "appnav-internal-err-octets": { "type": "number", "example": 0 }, "appnav-internal-err-pkts": { "type": "number", "example": 0 }, "appnav-inv-flow-state-octets": { "type": "number", "example": 0 }, "appnav-inv-flow-state-pkts": { "type": "number", "example": 0 }, "appnav-nosvcctx-octets": { "type": "number", "example": 0 }, "appnav-nosvcctx-pkts": { "type": "number", "example": 0 }, "appnav-notunnel-octets": { "type": "number", "example": 0 }, "appnav-notunnel-pkts": { "type": "number", "example": 0 }, "appnav-sn-pkt-invalid-octets": { "type": "number", "example": 0 }, "appnav-sn-pkt-invalid-pkts": { "type": "number", "example": 0 }, "appnav-unexpected-pkt-octets": { "type": "number", "example": 0 }, "appnav-unexpected-pkt-pkts": { "type": "number", "example": 0 }, "ar-fnf-clnup-octets": { "type": "number", "example": 0 }, "ar-fnf-clnup-pkts": { "type": "number", "example": 0 }, "ar-rx-octets": { "type": "number", "example": 0 }, "ar-rx-pkts": { "type": "number", "example": 0 }, "ar-standby-octets": { "type": "number", "example": 0 }, "ar-standby-pkts": { "type": "number", "example": 0 }, "ar-tx-octets": { "type": "number", "example": 0 }, "ar-tx-pkts": { "type": "number", "example": 0 }, "attn-invalid-spid-octets": { "type": "number", "example": 0 }, "attn-invalid-spid-pkts": { "type": "number", "example": 0 }, "bad-adj-octets": { "type": "number", "example": 0 }, "bad-adj-pkts": { "type": "number", "example": 0 }, "bad-coff-buffer-octets": { "type": "number", "example": 0 }, "bad-coff-buffer-pkts": { "type": "number", "example": 0 }, "bad-dist-fifo-octets": { "type": "number", "example": 0 }, "bad-dist-fifo-pkts": { "type": "number", "example": 0 }, "bad-ip-checksum-octets": { "type": "number", "example": 0 }, "bad-ip-checksum-pkts": { "type": "number", "example": 0 }, "bad-len-octets": { "type": "number", "example": 0 }, "bad-len-pkts": { "type": "number", "example": 0 }, "bad-uidb-idx-octets": { "type": "number", "example": 0 }, "bad-uidb-idx-pkts": { "type": "number", "example": 0 }, "bad-uidb-sub-idx-octets": { "type": "number", "example": 0 }, "bad-uidb-sub-idx-pkts": { "type": "number", "example": 0 }, "bad-us-jib-hdr-octets": { "type": "number", "example": 0 }, "bad-us-jib-hdr-pkts": { "type": "number", "example": 0 }, "bfd-octets": { "type": "number", "example": 0 }, "bfd-pkts": { "type": "number", "example": 0 }, "bier-invalid-replica-record-octets": { "type": "number", "example": 0 }, "bier-invalid-replica-record-pkts": { "type": "number", "example": 0 }, "bier-snaity-octets": { "type": "number", "example": 0 }, "bier-snaity-pkts": { "type": "number", "example": 0 }, "bqs-oor-octets": { "type": "number", "example": 0 }, "bqs-oor-pak-pri-octets": { "type": "number", "example": 0 }, "bqs-oor-pak-pri-pkts": { "type": "number", "example": 0 }, "bqs-oor-pkts": { "type": "number", "example": 0 }, "bqs-oor-pri-octets": { "type": "number", "example": 0 }, "bqs-oor-pri-pkts": { "type": "number", "example": 0 }, "bqs-oor-vital-octets": { "type": "number", "example": 0 }, "bqs-oor-vital-pkts": { "type": "number", "example": 0 }, "bundle-oce-octets": { "type": "number", "example": 0 }, "bundle-oce-pkts": { "type": "number", "example": 0 }, "cable-arp-autoreply-octets": { "type": "number", "example": 0 }, "cable-arp-autoreply-pkts": { "type": "number", "example": 0 }, "cable-dhcp-bad-len-octets": { "type": "number", "example": 0 }, "cable-dhcp-bad-len-pkts": { "type": "number", "example": 0 }, "cable-lc2sup-punt-octets": { "type": "number", "example": 0 }, "cable-lc2sup-punt-pkts": { "type": "number", "example": 0 }, "cable-mc-invalid-replica-record-octets": { "type": "number", "example": 0 }, "cable-mc-invalid-replica-record-pkts": { "type": "number", "example": 0 }, "cable-oob-us-pkt-invalid-octets": { "type": "number", "example": 0 }, "cable-oob-us-pkt-invalid-pkts": { "type": "number", "example": 0 }, "cable-oob-us-sess-invalid-octets": { "type": "number", "example": 0 }, "cable-oob-us-sess-invalid-pkts": { "type": "number", "example": 0 }, "cable-oob-us-src-id-invalid-octets": { "type": "number", "example": 0 }, "cable-oob-us-src-id-invalid-pkts": { "type": "number", "example": 0 }, "cable-p2pl-oce-ptr-null-octets": { "type": "number", "example": 0 }, "cable-p2pl-oce-ptr-null-pkts": { "type": "number", "example": 0 }, "cable-prereg-not-cm-octets": { "type": "number", "example": 0 }, "cable-prereg-not-cm-pkts": { "type": "number", "example": 0 }, "cable-prng-exp-octets": { "type": "number", "example": 0 }, "cable-prng-exp-pkts": { "type": "number", "example": 0 }, "cable-recycle-queue-octets": { "type": "number", "example": 0 }, "cable-recycle-queue-pkts": { "type": "number", "example": 0 }, "capwap-err-octets": { "type": "number", "example": 0 }, "capwap-err-pkts": { "type": "number", "example": 0 }, "capwap-no-uidb-octets": { "type": "number", "example": 0 }, "capwap-no-uidb-pkts": { "type": "number", "example": 0 }, "capwap-reass-alloc-err-octets": { "type": "number", "example": 0 }, "capwap-reass-alloc-err-pkts": { "type": "number", "example": 0 }, "capwap-reass-frag-consm-octets": { "type": "number", "example": 0 }, "capwap-reass-frag-consm-pkts": { "type": "number", "example": 0 }, "capwap-reass-frag-err-octets": { "type": "number", "example": 0 }, "capwap-reass-frag-err-pkts": { "type": "number", "example": 0 }, "cbl-oob-add-hdr-fail-octets": { "type": "number", "example": 0 }, "cbl-oob-add-hdr-fail-pkts": { "type": "number", "example": 0 }, "cbl-oob-null-repl-info-octets": { "type": "number", "example": 0 }, "cbl-oob-null-repl-info-pkts": { "type": "number", "example": 0 }, "cbl-oob-null-repllist-octets": { "type": "number", "example": 0 }, "cbl-oob-null-repllist-pkts": { "type": "number", "example": 0 }, "cbl-oob-recycle-tail-octets": { "type": "number", "example": 0 }, "cbl-oob-recycle-tail-pkts": { "type": "number", "example": 0 }, "cbl-oob-repl-end-octets": { "type": "number", "example": 0 }, "cbl-oob-repl-end-pkts": { "type": "number", "example": 0 }, "cbl-oob-repl-fail-octets": { "type": "number", "example": 0 }, "cbl-oob-repl-fail-pkts": { "type": "number", "example": 0 }, "cbl-oob-repl-sess-invalid-octets": { "type": "number", "example": 0 }, "cbl-oob-repl-sess-invalid-pkts": { "type": "number", "example": 0 }, "cbl-oob-repl-uidb-invalid-octets": { "type": "number", "example": 0 }, "cbl-oob-repl-uidb-invalid-pkts": { "type": "number", "example": 0 }, "cbl-rep-arl-drop-octets": { "type": "number", "example": 0 }, "cbl-rep-arl-drop-pkts": { "type": "number", "example": 0 }, "cbl-req-arl-drop-octets": { "type": "number", "example": 0 }, "cbl-req-arl-drop-pkts": { "type": "number", "example": 0 }, "cbl-sid-exceed-octets": { "type": "number", "example": 0 }, "cbl-sid-exceed-pkts": { "type": "number", "example": 0 }, "cblbf-fwdint-down-octets": { "type": "number", "example": 0 }, "cblbf-fwdint-down-pkts": { "type": "number", "example": 0 }, "cblbf-null-repllist-octets": { "type": "number", "example": 0 }, "cblbf-null-repllist-pkts": { "type": "number", "example": 0 }, "cblbf-recycle-tail-octets": { "type": "number", "example": 0 }, "cblbf-recycle-tail-pkts": { "type": "number", "example": 0 }, "cblbf-repl-end-octets": { "type": "number", "example": 0 }, "cblbf-repl-end-pkts": { "type": "number", "example": 0 }, "cblbf-repl-fail-octets": { "type": "number", "example": 0 }, "cblbf-repl-fail-pkts": { "type": "number", "example": 0 }, "cblbf-repl-start-octets": { "type": "number", "example": 0 }, "cblbf-repl-start-pkts": { "type": "number", "example": 0 }, "ccm-tx-octets": { "type": "number", "example": 0 }, "ccm-tx-pkts": { "type": "number", "example": 0 }, "cgacl-action-octets": { "type": "number", "example": 0 }, "cgacl-action-pkts": { "type": "number", "example": 0 }, "cgacl-err-octets": { "type": "number", "example": 0 }, "cgacl-err-pkts": { "type": "number", "example": 0 }, "cgacl-inv-stats-octets": { "type": "number", "example": 0 }, "cgacl-inv-stats-pkts": { "type": "number", "example": 0 }, "cgacl-lookup-miss-octets": { "type": "number", "example": 0 }, "cgacl-lookup-miss-pkts": { "type": "number", "example": 0 }, "cgacl-match-octets": { "type": "number", "example": 0 }, "cgacl-match-pkts": { "type": "number", "example": 0 }, "cgacl-pkt-type-octets": { "type": "number", "example": 0 }, "cgacl-pkt-type-pkts": { "type": "number", "example": 0 }, "choice-oce-octets": { "type": "number", "example": 0 }, "choice-oce-pkts": { "type": "number", "example": 0 }, "cmd-format-octets": { "type": "number", "example": 0 }, "cmd-format-pkts": { "type": "number", "example": 0 }, "coff-output-octets": { "type": "number", "example": 0 }, "coff-output-pkts": { "type": "number", "example": 0 }, "conf-sw-sess-octets": { "type": "number", "example": 0 }, "conf-sw-sess-pkts": { "type": "number", "example": 0 }, "cstp-cdtp-inv-frame-octets": { "type": "number", "example": 0 }, "cstp-cdtp-inv-frame-pkts": { "type": "number", "example": 0 }, "cstp-cdtp-no-tunnel-octets": { "type": "number", "example": 0 }, "cstp-cdtp-no-tunnel-pkts": { "type": "number", "example": 0 }, "cstp-cdtp-unsup-frame-octets": { "type": "number", "example": 0 }, "cstp-cdtp-unsup-frame-pkts": { "type": "number", "example": 0 }, "cts-format-octets": { "type": "number", "example": 0 }, "cts-format-pkts": { "type": "number", "example": 0 }, "cts-not-enable-octets": { "type": "number", "example": 0 }, "cts-not-enable-pkts": { "type": "number", "example": 0 }, "cwfrag-err-octets": { "type": "number", "example": 0 }, "cwfrag-err-pkts": { "type": "number", "example": 0 }, "cws-ctx-id-not-found-conn-octets": { "type": "number", "example": 0 }, "cws-ctx-id-not-found-conn-pkts": { "type": "number", "example": 0 }, "cws-ctx-id-not-found-mob-octets": { "type": "number", "example": 0 }, "cws-ctx-id-not-found-mob-pkts": { "type": "number", "example": 0 }, "cws-inter-error-octets": { "type": "number", "example": 0 }, "cws-inter-error-pkts": { "type": "number", "example": 0 }, "dapr-noroute-octets": { "type": "number", "example": 0 }, "dapr-noroute-pkts": { "type": "number", "example": 0 }, "dca-drop-octets": { "type": "number", "example": 0 }, "dca-drop-pkts": { "type": "number", "example": 0 }, "dialer-list-octets": { "type": "number", "example": 0 }, "dialer-list-pkts": { "type": "number", "example": 0 }, "disabled-octets": { "type": "number", "example": 0 }, "disabled-pkts": { "type": "number", "example": 0 }, "discard-octets": { "type": "number", "example": 0 }, "discard-pkts": { "type": "number", "example": 0 }, "discontinuity-time": { "type": "string", "format": "date-time", "example": "2025-02-19T00:00:00Z" }, "discontinuity-time-date": { "type": "integer", "format": "int64", "example": 1739771335000 }, "dlep-mcast-inv-enc-octets": { "type": "number", "example": 0 }, "dlep-mcast-inv-enc-pkts": { "type": "number", "example": 0 }, "dlep-mcast-phy2vmi-octets": { "type": "number", "example": 0 }, "dlep-mcast-phy2vmi-pkts": { "type": "number", "example": 0 }, "dlep-mcast-vmi2phy-octets": { "type": "number", "example": 0 }, "dlep-mcast-vmi2phy-pkts": { "type": "number", "example": 0 }, "dlep-uncfgd-octets": { "type": "number", "example": 0 }, "dlep-uncfgd-pkts": { "type": "number", "example": 0 }, "dpss-octets": { "type": "number", "example": 0 }, "dpss-pkts": { "type": "number", "example": 0 }, "dsa-no-ip-octets": { "type": "number", "example": 0 }, "dsa-no-ip-pkts": { "type": "number", "example": 0 }, "dsp-octets": { "type": "number", "example": 0 }, "dsp-pkts": { "type": "number", "example": 0 }, "dtls-err-octets": { "type": "number", "example": 0 }, "dtls-err-pkts": { "type": "number", "example": 0 }, "ec-bundle-enq-octets": { "type": "number", "example": 0 }, "ec-bundle-enq-pkts": { "type": "number", "example": 0 }, "ec-link-tx-octets": { "type": "number", "example": 0 }, "ec-link-tx-pkts": { "type": "number", "example": 0 }, "ecfm-octets": { "type": "number", "example": 0 }, "ecfm-pkts": { "type": "number", "example": 0 }, "epbr-octets": { "type": "number", "example": 0 }, "epbr-pkts": { "type": "number", "example": 0 }, "epc-octets": { "type": "number", "example": 0 }, "epc-pkts": { "type": "number", "example": 0 }, "erspan-octets": { "type": "number", "example": 0 }, "erspan-pkts": { "type": "number", "example": 0 }, "esf-acct-exceed-drop-octets": { "type": "number", "example": 0 }, "esf-acct-exceed-drop-pkts": { "type": "number", "example": 0 }, "esf-drl-drop-octets": { "type": "number", "example": 0 }, "esf-drl-drop-pkts": { "type": "number", "example": 0 }, "esf-ffr-drop-octets": { "type": "number", "example": 0 }, "esf-ffr-drop-pkts": { "type": "number", "example": 0 }, "esf-l4r-bad-config-octets": { "type": "number", "example": 0 }, "esf-l4r-bad-config-pkts": { "type": "number", "example": 0 }, "esf-l4r-trans-sess-limit-octets": { "type": "number", "example": 0 }, "esf-l4r-trans-sess-limit-pkts": { "type": "number", "example": 0 }, "esf-l4r-trans-unavail-octets": { "type": "number", "example": 0 }, "esf-l4r-trans-unavail-pkts": { "type": "number", "example": 0 }, "esf-pbhk-bad-config-octets": { "type": "number", "example": 0 }, "esf-pbhk-bad-config-pkts": { "type": "number", "example": 0 }, "esf-pbhk-port-notfound-octets": { "type": "number", "example": 0 }, "esf-pbhk-port-notfound-pkts": { "type": "number", "example": 0 }, "esf-pbhk-port-removed-octets": { "type": "number", "example": 0 }, "esf-pbhk-port-removed-pkts": { "type": "number", "example": 0 }, "esf-pbhk-port-unavail-octets": { "type": "number", "example": 0 }, "esf-pbhk-port-unavail-pkts": { "type": "number", "example": 0 }, "esf-pbhk-unalloc-octets": { "type": "number", "example": 0 }, "esf-pbhk-unalloc-pkts": { "type": "number", "example": 0 }, "esf-tc-drop-octets": { "type": "number", "example": 0 }, "esf-tc-drop-pkts": { "type": "number", "example": 0 }, "ess-bad-sess-uidb-octets": { "type": "number", "example": 0 }, "ess-bad-sess-uidb-pkts": { "type": "number", "example": 0 }, "ess-cac-octets": { "type": "number", "example": 0 }, "ess-cac-pkts": { "type": "number", "example": 0 }, "ess-inject-bad-hdr-octets": { "type": "number", "example": 0 }, "ess-inject-bad-hdr-pkts": { "type": "number", "example": 0 }, "ess-inv-switch-mode-octets": { "type": "number", "example": 0 }, "ess-inv-switch-mode-pkts": { "type": "number", "example": 0 }, "ess-ipsub-classifier-drop-octets": { "type": "number", "example": 0 }, "ess-ipsub-classifier-drop-pkts": { "type": "number", "example": 0 }, "ess-ipsub-drop-octets": { "type": "number", "example": 0 }, "ess-ipsub-drop-pkts": { "type": "number", "example": 0 }, "ess-ipsub-fsol-drop-octets": { "type": "number", "example": 0 }, "ess-ipsub-fsol-drop-pkts": { "type": "number", "example": 0 }, "ess-ipsub-ka-drop-octets": { "type": "number", "example": 0 }, "ess-ipsub-ka-drop-pkts": { "type": "number", "example": 0 }, "ess-l2-hdr-too-big-octets": { "type": "number", "example": 0 }, "ess-l2-hdr-too-big-pkts": { "type": "number", "example": 0 }, "ess-no-encap-info-octets": { "type": "number", "example": 0 }, "ess-no-encap-info-pkts": { "type": "number", "example": 0 }, "ess-pi-inv-subtype-octets": { "type": "number", "example": 0 }, "ess-pi-inv-subtype-pkts": { "type": "number", "example": 0 }, "ess-pi-state-err-octets": { "type": "number", "example": 0 }, "ess-pi-state-err-pkts": { "type": "number", "example": 0 }, "ess-pktsb-missed-octets": { "type": "number", "example": 0 }, "ess-pktsb-missed-pkts": { "type": "number", "example": 0 }, "ess-unbound-session-octets": { "type": "number", "example": 0 }, "ess-unbound-session-pkts": { "type": "number", "example": 0 }, "ess-unprov-session-octets": { "type": "number", "example": 0 }, "ess-unprov-session-pkts": { "type": "number", "example": 0 }, "ess-unsup-pkt-type-octets": { "type": "number", "example": 0 }, "ess-unsup-pkt-type-pkts": { "type": "number", "example": 0 }, "evc-efp-egress-filter-octets": { "type": "number", "example": 0 }, "evc-efp-egress-filter-pkts": { "type": "number", "example": 0 }, "ext-drop-path-octets": { "type": "number", "example": 0 }, "ext-drop-path-pkts": { "type": "number", "example": 0 }, "fbd-oom-err-octets": { "type": "number", "example": 0 }, "fbd-oom-err-pkts": { "type": "number", "example": 0 }, "fhs-pkt-dropped-octets": { "type": "number", "example": 0 }, "fhs-pkt-dropped-pkts": { "type": "number", "example": 0 }, "fhs-pkt-invalid-octets": { "type": "number", "example": 0 }, "fhs-pkt-invalid-pkts": { "type": "number", "example": 0 }, "fia-error-octets": { "type": "number", "example": 0 }, "fia-error-pkts": { "type": "number", "example": 0 }, "firewall-backpressure-octets": { "type": "number", "example": 0 }, "firewall-backpressure-pkts": { "type": "number", "example": 0 }, "firewall-invalid-zone-octets": { "type": "number", "example": 0 }, "firewall-invalid-zone-pkts": { "type": "number", "example": 0 }, "firewall-l4-insp-octets": { "type": "number", "example": 0 }, "firewall-l4-insp-pkts": { "type": "number", "example": 0 }, "firewall-l4-octets": { "type": "number", "example": 0 }, "firewall-l4-pkts": { "type": "number", "example": 0 }, "firewall-l7-octets": { "type": "number", "example": 0 }, "firewall-l7-pkts": { "type": "number", "example": 0 }, "firewall-no-forwarding-octets": { "type": "number", "example": 0 }, "firewall-no-forwarding-pkts": { "type": "number", "example": 0 }, "firewall-no-new-sessions-octets": { "type": "number", "example": 0 }, "firewall-no-new-sessions-pkts": { "type": "number", "example": 0 }, "firewall-nonsession-octets": { "type": "number", "example": 0 }, "firewall-nonsession-pkts": { "type": "number", "example": 0 }, "firewall-not-from-init-octets": { "type": "number", "example": 0 }, "firewall-not-from-init-pkts": { "type": "number", "example": 0 }, "firewall-not-initiator-octets": { "type": "number", "example": 0 }, "firewall-not-initiator-pkts": { "type": "number", "example": 0 }, "firewall-policy-octets": { "type": "number", "example": 0 }, "firewall-policy-pkts": { "type": "number", "example": 0 }, "firewall-syncookie-max-dst-octets": { "type": "number", "example": 0 }, "firewall-syncookie-max-dst-pkts": { "type": "number", "example": 0 }, "firewall-syncookie-octets": { "type": "number", "example": 0 }, "firewall-syncookie-pkts": { "type": "number", "example": 0 }, "flow-queue-failure-id-octets": { "type": "number", "example": 0 }, "flow-queue-failure-id-pkts": { "type": "number", "example": 0 }, "flowspec-octets": { "type": "number", "example": 0 }, "flowspec-pkts": { "type": "number", "example": 0 }, "for-us-octets": { "type": "number", "example": 0 }, "for-us-pkts": { "type": "number", "example": 0 }, "frag-inv-ipv6-octets": { "type": "number", "example": 0 }, "frag-inv-ipv6-pkts": { "type": "number", "example": 0 }, "frag-inv-octets": { "type": "number", "example": 0 }, "frag-inv-pkts": { "type": "number", "example": 0 }, "frag-tail-drop-octets": { "type": "number", "example": 0 }, "frag-tail-drop-pkts": { "type": "number", "example": 0 }, "frfab-wred-drop-octets": { "type": "number", "example": 0 }, "frfab-wred-drop-pkts": { "type": "number", "example": 0 }, "frr-oce-invalid-state-octets": { "type": "number", "example": 0 }, "frr-oce-invalid-state-pkts": { "type": "number", "example": 0 }, "frr-oce-no-backup-octets": { "type": "number", "example": 0 }, "frr-oce-no-backup-pkts": { "type": "number", "example": 0 }, "gen-pkt-replication-octets": { "type": "number", "example": 0 }, "gen-pkt-replication-pkts": { "type": "number", "example": 0 }, "glean-adj-unsupport-linktype-octets": { "type": "number", "example": 0 }, "glean-adj-unsupport-linktype-pkts": { "type": "number", "example": 0 }, "gpm-tx-len-exceed-octets": { "type": "number", "example": 0 }, "gpm-tx-len-exceed-pkts": { "type": "number", "example": 0 }, "gre-bad-options-octets": { "type": "number", "example": 0 }, "gre-bad-options-pkts": { "type": "number", "example": 0 }, "host-name": { "type": "string", "example": "vm5" }, "hqf-tx-error-octets": { "type": "number", "example": 0 }, "hqf-tx-error-pkts": { "type": "number", "example": 0 }, "icmp-octets": { "type": "number", "example": 0 }, "icmp-pkts": { "type": "number", "example": 0 }, "identity-cft-error-octets": { "type": "number", "example": 0 }, "identity-cft-error-pkts": { "type": "number", "example": 0 }, "idle-packet-octets": { "type": "number", "example": 0 }, "idle-packet-pkts": { "type": "number", "example": 0 }, "illegal-obj-octets": { "type": "number", "example": 0 }, "illegal-obj-pkts": { "type": "number", "example": 0 }, "inject-err-octets": { "type": "number", "example": 0 }, "inject-err-pkts": { "type": "number", "example": 0 }, "internal-ctl-octets": { "type": "number", "example": 0 }, "internal-ctl-pkts": { "type": "number", "example": 0 }, "internal-intf-err-octets": { "type": "number", "example": 0 }, "internal-intf-err-pkts": { "type": "number", "example": 0 }, "internal-no-channel-mem-octets": { "type": "number", "example": 0 }, "internal-no-channel-mem-pkts": { "type": "number", "example": 0 }, "internal-no-gpm-octets": { "type": "number", "example": 0 }, "internal-no-gpm-pkts": { "type": "number", "example": 0 }, "internal-octets": { "type": "number", "example": 0 }, "internal-pkts": { "type": "number", "example": 0 }, "internal-recycle-tail-octets": { "type": "number", "example": 0 }, "internal-recycle-tail-pkts": { "type": "number", "example": 0 }, "internal-replication-octets": { "type": "number", "example": 0 }, "internal-replication-pkts": { "type": "number", "example": 0 }, "inv-common-preamble-octets": { "type": "number", "example": 0 }, "inv-common-preamble-pkts": { "type": "number", "example": 0 }, "inv-hdr-err-octets": { "type": "number", "example": 0 }, "inv-hdr-err-pkts": { "type": "number", "example": 0 }, "inv-l2-hdr-octets": { "type": "number", "example": 0 }, "inv-l2-hdr-pkts": { "type": "number", "example": 0 }, "inv-ppp-cp-pkt-octets": { "type": "number", "example": 0 }, "inv-ppp-cp-pkt-pkts": { "type": "number", "example": 0 }, "inv-spa-hdr-octets": { "type": "number", "example": 0 }, "inv-spa-hdr-pkts": { "type": "number", "example": 0 }, "invalid-encap-octets": { "type": "number", "example": 0 }, "invalid-encap-pkts": { "type": "number", "example": 0 }, "invalid-queue-octets": { "type": "number", "example": 0 }, "invalid-queue-pkts": { "type": "number", "example": 0 }, "invalid-virtual-id-octets": { "type": "number", "example": 0 }, "invalid-virtual-id-pkts": { "type": "number", "example": 0 }, "invalid-wred-octets": { "type": "number", "example": 0 }, "invalid-wred-pkts": { "type": "number", "example": 0 }, "ip-acl-err-octets": { "type": "number", "example": 0 }, "ip-acl-err-pkts": { "type": "number", "example": 0 }, "ip-bad-options-octets": { "type": "number", "example": 0 }, "ip-bad-options-pkts": { "type": "number", "example": 0 }, "ip-format-err-octets": { "type": "number", "example": 0 }, "ip-format-err-pkts": { "type": "number", "example": 0 }, "ip-frag-err-octets": { "type": "number", "example": 0 }, "ip-frag-err-pkts": { "type": "number", "example": 0 }, "ip-sia-hdr-err-octets": { "type": "number", "example": 0 }, "ip-sia-hdr-err-pkts": { "type": "number", "example": 0 }, "ip-sia-hop-limit-exceeded-octets": { "type": "number", "example": 0 }, "ip-sia-hop-limit-exceeded-pkts": { "type": "number", "example": 0 }, "ip-sia-processing-err-octets": { "type": "number", "example": 0 }, "ip-sia-processing-err-pkts": { "type": "number", "example": 0 }, "ip-ttl-exceeded-octets": { "type": "number", "example": 0 }, "ip-ttl-exceeded-pkts": { "type": "number", "example": 0 }, "iphc-octets": { "type": "number", "example": 0 }, "iphc-pkts": { "type": "number", "example": 0 }, "ipsec-deny-drop-octets": { "type": "number", "example": 0 }, "ipsec-deny-drop-pkts": { "type": "number", "example": 0 }, "ipsec-ike-indicate-octets": { "type": "number", "example": 0 }, "ipsec-ike-indicate-pkts": { "type": "number", "example": 0 }, "ipsec-input-octets": { "type": "number", "example": 0 }, "ipsec-input-pkts": { "type": "number", "example": 0 }, "ipsec-invalid-sa-octets": { "type": "number", "example": 0 }, "ipsec-invalid-sa-pkts": { "type": "number", "example": 0 }, "ipsec-output-octets": { "type": "number", "example": 0 }, "ipsec-output-pkts": { "type": "number", "example": 0 }, "ipsec-tail-drop-octets": { "type": "number", "example": 0 }, "ipsec-tail-drop-pkts": { "type": "number", "example": 0 }, "ipsec-ted-indicate-octets": { "type": "number", "example": 0 }, "ipsec-ted-indicate-pkts": { "type": "number", "example": 0 }, "ipv4-acl-lookup-miss-octets": { "type": "number", "example": 0 }, "ipv4-acl-lookup-miss-pkts": { "type": "number", "example": 0 }, "ipv4-acl-octets": { "type": "number", "example": 0 }, "ipv4-acl-pkts": { "type": "number", "example": 0 }, "ipv4-adj-drop-octets": { "type": "number", "example": 0 }, "ipv4-adj-drop-pkts": { "type": "number", "example": 0 }, "ipv4-egr-intf-enf-octets": { "type": "number", "example": 0 }, "ipv4-egr-intf-enf-pkts": { "type": "number", "example": 0 }, "ipv4-fpm-octets": { "type": "number", "example": 0 }, "ipv4-fpm-pkts": { "type": "number", "example": 0 }, "ipv4-martian-octets": { "type": "number", "example": 0 }, "ipv4-martian-pkts": { "type": "number", "example": 0 }, "ipv4-mcast-acl-octets": { "type": "number", "example": 0 }, "ipv4-mcast-acl-pkts": { "type": "number", "example": 0 }, "ipv4-mtr-octets": { "type": "number", "example": 0 }, "ipv4-mtr-pkts": { "type": "number", "example": 0 }, "ipv4-no-adj-octets": { "type": "number", "example": 0 }, "ipv4-no-adj-pkts": { "type": "number", "example": 0 }, "ipv4-no-route-octets": { "type": "number", "example": 0 }, "ipv4-no-route-pkts": { "type": "number", "example": 0 }, "ipv4-null0-octets": { "type": "number", "example": 0 }, "ipv4-null0-pkts": { "type": "number", "example": 0 }, "ipv4-pbr-octets": { "type": "number", "example": 0 }, "ipv4-pbr-pkts": { "type": "number", "example": 0 }, "ipv4-pop-pipe-php-ttl-expire-octets": { "type": "number", "example": 0 }, "ipv4-pop-pipe-php-ttl-expire-pkts": { "type": "number", "example": 0 }, "ipv4-pop-unf-php-ttl-expire-octets": { "type": "number", "example": 0 }, "ipv4-pop-unf-php-ttl-expire-pkts": { "type": "number", "example": 0 }, "ipv4-pop-unf-uhp-ttl-expire-octets": { "type": "number", "example": 0 }, "ipv4-pop-unf-uhp-ttl-expire-pkts": { "type": "number", "example": 0 }, "ipv4-reass-tail-drop-octets": { "type": "number", "example": 0 }, "ipv4-reass-tail-drop-pkts": { "type": "number", "example": 0 }, "ipv4-routing-err-octets": { "type": "number", "example": 0 }, "ipv4-routing-err-pkts": { "type": "number", "example": 0 }, "ipv4-unclassified-octets": { "type": "number", "example": 0 }, "ipv4-unclassified-pkts": { "type": "number", "example": 0 }, "ipv4-urpf-loose-failed-octets": { "type": "number", "example": 0 }, "ipv4-urpf-loose-failed-pkts": { "type": "number", "example": 0 }, "ipv4-urpf-null-path-list-octets": { "type": "number", "example": 0 }, "ipv4-urpf-null-path-list-pkts": { "type": "number", "example": 0 }, "ipv4-urpf-strict-failed-octets": { "type": "number", "example": 0 }, "ipv4-urpf-strict-failed-pkts": { "type": "number", "example": 0 }, "ipv4mc-extra-replicae-octets": { "type": "number", "example": 0 }, "ipv4mc-extra-replicae-pkts": { "type": "number", "example": 0 }, "ipv4mc-invalid-replica-record-octets": { "type": "number", "example": 0 }, "ipv4mc-invalid-replica-record-pkts": { "type": "number", "example": 0 }, "ipv4mc-nat-in2out-octets": { "type": "number", "example": 0 }, "ipv4mc-nat-in2out-pkts": { "type": "number", "example": 0 }, "ipv4mc-nat-out2in-octets": { "type": "number", "example": 0 }, "ipv4mc-nat-out2in-pkts": { "type": "number", "example": 0 }, "ipv4mc-no-route-octets": { "type": "number", "example": 0 }, "ipv4mc-no-route-pkts": { "type": "number", "example": 0 }, "ipv4mc-oif-rpf-failed-octets": { "type": "number", "example": 0 }, "ipv4mc-oif-rpf-failed-pkts": { "type": "number", "example": 0 }, "ipv4mc-rpf-failed-octets": { "type": "number", "example": 0 }, "ipv4mc-rpf-failed-pkts": { "type": "number", "example": 0 }, "ipv4mc-ttl-threshold-chk-failed-octets": { "type": "number", "example": 0 }, "ipv4mc-ttl-threshold-chk-failed-pkts": { "type": "number", "example": 0 }, "ipv6-acl-lookup-miss-octets": { "type": "number", "example": 0 }, "ipv6-acl-lookup-miss-pkts": { "type": "number", "example": 0 }, "ipv6-acl-octets": { "type": "number", "example": 0 }, "ipv6-acl-pkts": { "type": "number", "example": 0 }, "ipv6-adj-drop-octets": { "type": "number", "example": 0 }, "ipv6-adj-drop-pkts": { "type": "number", "example": 0 }, "ipv6-badhop-octets": { "type": "number", "example": 0 }, "ipv6-badhop-pkts": { "type": "number", "example": 0 }, "ipv6-badsource-octets": { "type": "number", "example": 0 }, "ipv6-badsource-pkts": { "type": "number", "example": 0 }, "ipv6-egr-intf-enf-octets": { "type": "number", "example": 0 }, "ipv6-egr-intf-enf-pkts": { "type": "number", "example": 0 }, "ipv6-formaterr-octets": { "type": "number", "example": 0 }, "ipv6-formaterr-pkts": { "type": "number", "example": 0 }, "ipv6-mcast-acl-octets": { "type": "number", "example": 0 }, "ipv6-mcast-acl-pkts": { "type": "number", "example": 0 }, "ipv6-no-adj-octets": { "type": "number", "example": 0 }, "ipv6-no-adj-pkts": { "type": "number", "example": 0 }, "ipv6-no-route-octets": { "type": "number", "example": 0 }, "ipv6-no-route-pkts": { "type": "number", "example": 0 }, "ipv6-null0-octets": { "type": "number", "example": 0 }, "ipv6-null0-pkts": { "type": "number", "example": 0 }, "ipv6-pbr-octets": { "type": "number", "example": 0 }, "ipv6-pbr-pkts": { "type": "number", "example": 0 }, "ipv6-reass-tail-drop-octets": { "type": "number", "example": 0 }, "ipv6-reass-tail-drop-pkts": { "type": "number", "example": 0 }, "ipv6-routing-err-octets": { "type": "number", "example": 0 }, "ipv6-routing-err-pkts": { "type": "number", "example": 0 }, "ipv6-toobigpacket-octets": { "type": "number", "example": 0 }, "ipv6-toobigpacket-pkts": { "type": "number", "example": 0 }, "ipv6-truncatedpkts-octets": { "type": "number", "example": 0 }, "ipv6-truncatedpkts-pkts": { "type": "number", "example": 0 }, "ipv6-unclassified-octets": { "type": "number", "example": 0 }, "ipv6-unclassified-pkts": { "type": "number", "example": 0 }, "ipv6-urpf-loose-failed-octets": { "type": "number", "example": 0 }, "ipv6-urpf-loose-failed-pkts": { "type": "number", "example": 0 }, "ipv6-urpf-no-fib-octets": { "type": "number", "example": 0 }, "ipv6-urpf-no-fib-pkts": { "type": "number", "example": 0 }, "ipv6-urpf-null-path-list-octets": { "type": "number", "example": 0 }, "ipv6-urpf-null-path-list-pkts": { "type": "number", "example": 0 }, "ipv6-urpf-strict-failed-octets": { "type": "number", "example": 0 }, "ipv6-urpf-strict-failed-pkts": { "type": "number", "example": 0 }, "ipv6mc-extra-replica-octets": { "type": "number", "example": 0 }, "ipv6mc-extra-replica-pkts": { "type": "number", "example": 0 }, "ipv6mc-invalid-replica-record-octets": { "type": "number", "example": 0 }, "ipv6mc-invalid-replica-record-pkts": { "type": "number", "example": 0 }, "ipv6mc-no-route-octets": { "type": "number", "example": 0 }, "ipv6mc-no-route-pkts": { "type": "number", "example": 0 }, "ipv6mc-oif-rpf-failed-octets": { "type": "number", "example": 0 }, "ipv6mc-oif-rpf-failed-pkts": { "type": "number", "example": 0 }, "ipv6mc-rpf-failed-octets": { "type": "number", "example": 0 }, "ipv6mc-rpf-failed-pkts": { "type": "number", "example": 0 }, "ipv6mc-ttl-threshold-chk-failed-octets": { "type": "number", "example": 0 }, "ipv6mc-ttl-threshold-chk-failed-pkts": { "type": "number", "example": 0 }, "l2bd-bd-disabled-octets": { "type": "number", "example": 0 }, "l2bd-bd-disabled-pkts": { "type": "number", "example": 0 }, "l2bd-inject-invalid-octets": { "type": "number", "example": 0 }, "l2bd-inject-invalid-pkts": { "type": "number", "example": 0 }, "l2bd-inject-no-sb-octets": { "type": "number", "example": 0 }, "l2bd-inject-no-sb-pkts": { "type": "number", "example": 0 }, "l2bd-mac-security-move-octets": { "type": "number", "example": 0 }, "l2bd-mac-security-move-pkts": { "type": "number", "example": 0 }, "l2bd-mac-security-unknown-octets": { "type": "number", "example": 0 }, "l2bd-mac-security-unknown-pkts": { "type": "number", "example": 0 }, "l2bd-mac-security-violation-octets": { "type": "number", "example": 0 }, "l2bd-mac-security-violation-pkts": { "type": "number", "example": 0 }, "l2bd-octets": { "type": "number", "example": 0 }, "l2bd-pkts": { "type": "number", "example": 0 }, "l2bd-policy-octets": { "type": "number", "example": 0 }, "l2bd-policy-pkts": { "type": "number", "example": 0 }, "l2bd-recycle-tail-octets": { "type": "number", "example": 0 }, "l2bd-recycle-tail-pkts": { "type": "number", "example": 0 }, "l2bd-repl-end-octets": { "type": "number", "example": 0 }, "l2bd-repl-end-pkts": { "type": "number", "example": 0 }, "l2bd-repl-start-octets": { "type": "number", "example": 0 }, "l2bd-repl-start-pkts": { "type": "number", "example": 0 }, "l2bd-sisf-ctrl-octets": { "type": "number", "example": 0 }, "l2bd-sisf-ctrl-pkts": { "type": "number", "example": 0 }, "l2bd-src-filter-octets": { "type": "number", "example": 0 }, "l2bd-src-filter-pkts": { "type": "number", "example": 0 }, "l2bd-static-mac-move-octets": { "type": "number", "example": 0 }, "l2bd-static-mac-move-pkts": { "type": "number", "example": 0 }, "l2bd-storm-ctrl-octets": { "type": "number", "example": 0 }, "l2bd-storm-ctrl-pkts": { "type": "number", "example": 0 }, "l2bd-stp-state-octets": { "type": "number", "example": 0 }, "l2bd-stp-state-pkts": { "type": "number", "example": 0 }, "l2bd-uuf-suppr-octets": { "type": "number", "example": 0 }, "l2bd-uuf-suppr-pkts": { "type": "number", "example": 0 }, "l2cp-cfg-action-octets": { "type": "number", "example": 0 }, "l2cp-cfg-action-pkts": { "type": "number", "example": 0 }, "l2es-input-invalid-svi-octets": { "type": "number", "example": 0 }, "l2es-input-invalid-svi-pkts": { "type": "number", "example": 0 }, "l2es-input-invalid-tag-octets": { "type": "number", "example": 0 }, "l2es-input-invalid-tag-pkts": { "type": "number", "example": 0 }, "l2mc-invalid-replica-record-octets": { "type": "number", "example": 0 }, "l2mc-invalid-replica-record-pkts": { "type": "number", "example": 0 }, "l2tp-bad-udp-chksum-octets": { "type": "number", "example": 0 }, "l2tp-bad-udp-chksum-pkts": { "type": "number", "example": 0 }, "l2tp-cxt-missed-octets": { "type": "number", "example": 0 }, "l2tp-cxt-missed-pkts": { "type": "number", "example": 0 }, "l2tp-exceed-tx-mtu-octets": { "type": "number", "example": 0 }, "l2tp-exceed-tx-mtu-pkts": { "type": "number", "example": 0 }, "l2tp-no-session-octets": { "type": "number", "example": 0 }, "l2tp-no-session-pkts": { "type": "number", "example": 0 }, "l2tp-ooo-rx-pkt-octets": { "type": "number", "example": 0 }, "l2tp-ooo-rx-pkt-pkts": { "type": "number", "example": 0 }, "l2tp-pkt-bad-len-octets": { "type": "number", "example": 0 }, "l2tp-pkt-bad-len-pkts": { "type": "number", "example": 0 }, "l2tp-pkt-inv-hdr-octets": { "type": "number", "example": 0 }, "l2tp-pkt-inv-hdr-pkts": { "type": "number", "example": 0 }, "l2tp-pktsb-missed-octets": { "type": "number", "example": 0 }, "l2tp-pktsb-missed-pkts": { "type": "number", "example": 0 }, "l2tp-security-check-octets": { "type": "number", "example": 0 }, "l2tp-security-check-pkts": { "type": "number", "example": 0 }, "l2tp-tx-seq-missed-octets": { "type": "number", "example": 0 }, "l2tp-tx-seq-missed-pkts": { "type": "number", "example": 0 }, "l2tp-unconfigured-octets": { "type": "number", "example": 0 }, "l2tp-unconfigured-pkts": { "type": "number", "example": 0 }, "l2v4mc-invalid-replica-record-octets": { "type": "number", "example": 0 }, "l2v4mc-invalid-replica-record-pkts": { "type": "number", "example": 0 }, "l2v6mc-invalid-replica-record-octets": { "type": "number", "example": 0 }, "l2v6mc-invalid-replica-record-pkts": { "type": "number", "example": 0 }, "label-pop-unsupport-linktype-octets": { "type": "number", "example": 0 }, "label-pop-unsupport-linktype-pkts": { "type": "number", "example": 0 }, "layer2-no-route-octets": { "type": "number", "example": 0 }, "layer2-no-route-pkts": { "type": "number", "example": 0 }, "layer2-switching-octets": { "type": "number", "example": 0 }, "layer2-switching-pkts": { "type": "number", "example": 0 }, "lisp-decap-failed-octets": { "type": "number", "example": 0 }, "lisp-decap-failed-pkts": { "type": "number", "example": 0 }, "lisp-disabled-octets": { "type": "number", "example": 0 }, "lisp-disabled-pkts": { "type": "number", "example": 0 }, "lisp-elig-oce-octets": { "type": "number", "example": 0 }, "lisp-elig-oce-pkts": { "type": "number", "example": 0 }, "lisp-failed-to-punt-dynmaic-eid-config-octets": { "type": "number", "example": 0 }, "lisp-failed-to-punt-dynmaic-eid-config-pkts": { "type": "number", "example": 0 }, "lisp-failed-to-punt-gsmr-enabled-octets": { "type": "number", "example": 0 }, "lisp-failed-to-punt-gsmr-enabled-pkts": { "type": "number", "example": 0 }, "lisp-failed-to-punt-lsb-mismatch-octets": { "type": "number", "example": 0 }, "lisp-failed-to-punt-lsb-mismatch-pkts": { "type": "number", "example": 0 }, "lisp-hash-lkup-failed-octets": { "type": "number", "example": 0 }, "lisp-hash-lkup-failed-pkts": { "type": "number", "example": 0 }, "lisp-misconfiguration-octets": { "type": "number", "example": 0 }, "lisp-misconfiguration-pkts": { "type": "number", "example": 0 }, "lisp-sfltr-octets": { "type": "number", "example": 0 }, "lisp-sfltr-pkts": { "type": "number", "example": 0 }, "loadbalance-null0-octets": { "type": "number", "example": 0 }, "loadbalance-null0-pkts": { "type": "number", "example": 0 }, "lookup-oce-should-drop-octets": { "type": "number", "example": 0 }, "lookup-oce-should-drop-pkts": { "type": "number", "example": 0 }, "lookup-oce-unsupport-linktype-octets": { "type": "number", "example": 0 }, "lookup-oce-unsupport-linktype-pkts": { "type": "number", "example": 0 }, "lsm-invalid-replica-record-octets": { "type": "number", "example": 0 }, "lsm-invalid-replica-record-pkts": { "type": "number", "example": 0 }, "mac-acl-lookup-miss-octets": { "type": "number", "example": 0 }, "mac-acl-lookup-miss-pkts": { "type": "number", "example": 0 }, "mac-acl-octets": { "type": "number", "example": 0 }, "mac-acl-pkts": { "type": "number", "example": 0 }, "mac-mcast-ip-nonmcast-octets": { "type": "number", "example": 0 }, "mac-mcast-ip-nonmcast-pkts": { "type": "number", "example": 0 }, "max-indirect-exceeded-octets": { "type": "number", "example": 0 }, "max-indirect-exceeded-pkts": { "type": "number", "example": 0 }, "max-tu-octets": { "type": "number", "example": 0 }, "max-tu-pkts": { "type": "number", "example": 0 }, "memory-intf-octets": { "type": "number", "example": 0 }, "memory-intf-pkts": { "type": "number", "example": 0 }, "mfr-octets": { "type": "number", "example": 0 }, "mfr-pkts": { "type": "number", "example": 0 }, "min-tu-octets": { "type": "number", "example": 0 }, "min-tu-pkts": { "type": "number", "example": 0 }, "mlp-octets": { "type": "number", "example": 0 }, "mlp-pkts": { "type": "number", "example": 0 }, "mpass-err-octets": { "type": "number", "example": 0 }, "mpass-err-pkts": { "type": "number", "example": 0 }, "mpass-invalid-fs-vector-octets": { "type": "number", "example": 0 }, "mpass-invalid-fs-vector-pkts": { "type": "number", "example": 0 }, "mpls-adj-drop-octets": { "type": "number", "example": 0 }, "mpls-adj-drop-pkts": { "type": "number", "example": 0 }, "mpls-csc-drop-octets": { "type": "number", "example": 0 }, "mpls-csc-drop-pkts": { "type": "number", "example": 0 }, "mpls-el-invalid-tag-octets": { "type": "number", "example": 0 }, "mpls-el-invalid-tag-pkts": { "type": "number", "example": 0 }, "mpls-eos-invalid-octets": { "type": "number", "example": 0 }, "mpls-eos-invalid-pkts": { "type": "number", "example": 0 }, "mpls-frag-req-octets": { "type": "number", "example": 0 }, "mpls-frag-req-pkts": { "type": "number", "example": 0 }, "mpls-gal-check-invalid-octets": { "type": "number", "example": 0 }, "mpls-gal-check-invalid-pkts": { "type": "number", "example": 0 }, "mpls-gal-check-non-eos-dropped-octets": { "type": "number", "example": 0 }, "mpls-gal-check-non-eos-dropped-pkts": { "type": "number", "example": 0 }, "mpls-gal-check-non-gal-dropped-octets": { "type": "number", "example": 0 }, "mpls-gal-check-non-gal-dropped-pkts": { "type": "number", "example": 0 }, "mpls-gal-exception-non-eos-dropped-octets": { "type": "number", "example": 0 }, "mpls-gal-exception-non-eos-dropped-pkts": { "type": "number", "example": 0 }, "mpls-gal-exception-non-gach-dropped-octets": { "type": "number", "example": 0 }, "mpls-gal-exception-non-gach-dropped-pkts": { "type": "number", "example": 0 }, "mpls-icmp-invalid-hdr-octets": { "type": "number", "example": 0 }, "mpls-icmp-invalid-hdr-pkts": { "type": "number", "example": 0 }, "mpls-ipv6-frag-req-octets": { "type": "number", "example": 0 }, "mpls-ipv6-frag-req-pkts": { "type": "number", "example": 0 }, "mpls-label-oce-invalid-label-octets": { "type": "number", "example": 0 }, "mpls-label-oce-invalid-label-pkts": { "type": "number", "example": 0 }, "mpls-label-oce-ptr-null-octets": { "type": "number", "example": 0 }, "mpls-label-oce-ptr-null-pkts": { "type": "number", "example": 0 }, "mpls-label-oce-unsupport-linktype-octets": { "type": "number", "example": 0 }, "mpls-label-oce-unsupport-linktype-pkts": { "type": "number", "example": 0 }, "mpls-mismatch-linktype-octets": { "type": "number", "example": 0 }, "mpls-mismatch-linktype-pkts": { "type": "number", "example": 0 }, "mpls-no-adj-octets": { "type": "number", "example": 0 }, "mpls-no-adj-pkts": { "type": "number", "example": 0 }, "mpls-no-route-octets": { "type": "number", "example": 0 }, "mpls-no-route-pkts": { "type": "number", "example": 0 }, "mpls-octets": { "type": "number", "example": 0 }, "mpls-pkts": { "type": "number", "example": 0 }, "mpls-pop-pipe-ttl-expire-octets": { "type": "number", "example": 0 }, "mpls-pop-pipe-ttl-expire-pkts": { "type": "number", "example": 0 }, "mpls-pop-unf-php-ttl-expire-octets": { "type": "number", "example": 0 }, "mpls-pop-unf-php-ttl-expire-pkts": { "type": "number", "example": 0 }, "mpls-pop-unf-uhp-ttl-expire-octets": { "type": "number", "example": 0 }, "mpls-pop-unf-uhp-ttl-expire-pkts": { "type": "number", "example": 0 }, "mpls-sanity-drop-octets": { "type": "number", "example": 0 }, "mpls-sanity-drop-pkts": { "type": "number", "example": 0 }, "mpls-sanity-echo-req-octets": { "type": "number", "example": 0 }, "mpls-sanity-echo-req-pkts": { "type": "number", "example": 0 }, "mpls-unclassified-octets": { "type": "number", "example": 0 }, "mpls-unclassified-pkts": { "type": "number", "example": 0 }, "multilink-cfg-octets": { "type": "number", "example": 0 }, "multilink-cfg-pkts": { "type": "number", "example": 0 }, "nat-in2out-octets": { "type": "number", "example": 0 }, "nat-in2out-pkts": { "type": "number", "example": 0 }, "nat-out2in-octets": { "type": "number", "example": 0 }, "nat-out2in-pkts": { "type": "number", "example": 0 }, "nat64-v4tov6-octets": { "type": "number", "example": 0 }, "nat64-v4tov6-pkts": { "type": "number", "example": 0 }, "nat64-v6tov4-octets": { "type": "number", "example": 0 }, "nat64-v6tov4-pkts": { "type": "number", "example": 0 }, "nat66-in2out-octets": { "type": "number", "example": 0 }, "nat66-in2out-pkts": { "type": "number", "example": 0 }, "nat66-out2in-octets": { "type": "number", "example": 0 }, "nat66-out2in-pkts": { "type": "number", "example": 0 }, "ngfw-divert-octets": { "type": "number", "example": 0 }, "ngfw-divert-pkts": { "type": "number", "example": 0 }, "ngfw-policy-octets": { "type": "number", "example": 0 }, "ngfw-policy-pkts": { "type": "number", "example": 0 }, "nid-vlan-mismatch-octets": { "type": "number", "example": 0 }, "nid-vlan-mismatch-pkts": { "type": "number", "example": 0 }, "no-def-jib-octets": { "type": "number", "example": 0 }, "no-def-jib-pkts": { "type": "number", "example": 0 }, "no-gpm-memory-err-octets": { "type": "number", "example": 0 }, "no-gpm-memory-err-pkts": { "type": "number", "example": 0 }, "no-inj-jib-octets": { "type": "number", "example": 0 }, "no-inj-jib-pkts": { "type": "number", "example": 0 }, "no-intf-res-octets": { "type": "number", "example": 0 }, "no-intf-res-pkts": { "type": "number", "example": 0 }, "no-mem-octets": { "type": "number", "example": 0 }, "no-mem-pkts": { "type": "number", "example": 0 }, "not-enabled-octets": { "type": "number", "example": 0 }, "not-enabled-pkts": { "type": "number", "example": 0 }, "null-jib-hdr-tbl-octets": { "type": "number", "example": 0 }, "null-jib-hdr-tbl-pkts": { "type": "number", "example": 0 }, "oam-loopback-octets": { "type": "number", "example": 0 }, "oam-loopback-pkts": { "type": "number", "example": 0 }, "oce-drop-adj-octets": { "type": "number", "example": 0 }, "oce-drop-adj-pkts": { "type": "number", "example": 0 }, "onefw-octets": { "type": "number", "example": 0 }, "onefw-pkts": { "type": "number", "example": 0 }, "opendns-octets": { "type": "number", "example": 0 }, "opendns-pkts": { "type": "number", "example": 0 }, "ovl-bad-pkt-octets": { "type": "number", "example": 0 }, "ovl-bad-pkt-pkts": { "type": "number", "example": 0 }, "ovl-l2-filter-octets": { "type": "number", "example": 0 }, "ovl-l2-filter-pkts": { "type": "number", "example": 0 }, "pa-pkt-not-suppt-octets": { "type": "number", "example": 0 }, "pa-pkt-not-suppt-pkts": { "type": "number", "example": 0 }, "pa-walk-err-octets": { "type": "number", "example": 0 }, "pa-walk-err-pkts": { "type": "number", "example": 0 }, "pathmgr-measurement-err-octets": { "type": "number", "example": 0 }, "pathmgr-measurement-err-pkts": { "type": "number", "example": 0 }, "pathmgr-select-err-octets": { "type": "number", "example": 0 }, "pathmgr-select-err-pkts": { "type": "number", "example": 0 }, "pcacl-octets": { "type": "number", "example": 0 }, "pcacl-pkts": { "type": "number", "example": 0 }, "pcgw-gtpu-err-octets": { "type": "number", "example": 0 }, "pcgw-gtpu-err-pkts": { "type": "number", "example": 0 }, "pcgw-pdu-sess-err-octets": { "type": "number", "example": 0 }, "pcgw-pdu-sess-err-pkts": { "type": "number", "example": 0 }, "pcgw-punt-inj-err-octets": { "type": "number", "example": 0 }, "pcgw-punt-inj-err-pkts": { "type": "number", "example": 0 }, "perf-lic-policer-hi-octets": { "type": "number", "example": 0 }, "perf-lic-policer-hi-pkts": { "type": "number", "example": 0 }, "perf-lic-policer-lo-octets": { "type": "number", "example": 0 }, "perf-lic-policer-lo-pkts": { "type": "number", "example": 0 }, "pfrv3-at-failure-octets": { "type": "number", "example": 0 }, "pfrv3-at-failure-pkts": { "type": "number", "example": 0 }, "pfrv3-blackhole-octets": { "type": "number", "example": 0 }, "pfrv3-blackhole-pkts": { "type": "number", "example": 0 }, "pfrv3-loop-octets": { "type": "number", "example": 0 }, "pfrv3-loop-pkts": { "type": "number", "example": 0 }, "pfrv3-probe-err-octets": { "type": "number", "example": 0 }, "pfrv3-probe-err-pkts": { "type": "number", "example": 0 }, "pfrv3-stickiness-octets": { "type": "number", "example": 0 }, "pfrv3-stickiness-pkts": { "type": "number", "example": 0 }, "ppe-exception-octets": { "type": "number", "example": 0 }, "ppe-exception-pkts": { "type": "number", "example": 0 }, "ppp-cxt-missed-octets": { "type": "number", "example": 0 }, "ppp-cxt-missed-pkts": { "type": "number", "example": 0 }, "pppoe-fctl-octets": { "type": "number", "example": 0 }, "pppoe-fctl-pkts": { "type": "number", "example": 0 }, "pppoe-inv-encap-info-octets": { "type": "number", "example": 0 }, "pppoe-inv-encap-info-pkts": { "type": "number", "example": 0 }, "pppoe-no-session-octets": { "type": "number", "example": 0 }, "pppoe-no-session-pkts": { "type": "number", "example": 0 }, "pppoe-pkt-bad-len-octets": { "type": "number", "example": 0 }, "pppoe-pkt-bad-len-pkts": { "type": "number", "example": 0 }, "pppoe-pkt-inv-hdr-octets": { "type": "number", "example": 0 }, "pppoe-pkt-inv-hdr-pkts": { "type": "number", "example": 0 }, "pppox-unconfigured-octets": { "type": "number", "example": 0 }, "pppox-unconfigured-pkts": { "type": "number", "example": 0 }, "pprl-sbrl-drop-octets": { "type": "number", "example": 0 }, "pprl-sbrl-drop-pkts": { "type": "number", "example": 0 }, "punt-err-octets": { "type": "number", "example": 0 }, "punt-err-pkts": { "type": "number", "example": 0 }, "punt-global-policer-drop-octets": { "type": "number", "example": 0 }, "punt-global-policer-drop-pkts": { "type": "number", "example": 0 }, "punt-intf-drop-octets": { "type": "number", "example": 0 }, "punt-intf-drop-pkts": { "type": "number", "example": 0 }, "punt-policer-drop-octets": { "type": "number", "example": 0 }, "punt-policer-drop-pkts": { "type": "number", "example": 0 }, "qos-actions-octets": { "type": "number", "example": 0 }, "qos-actions-pkts": { "type": "number", "example": 0 }, "qos-policing-octets": { "type": "number", "example": 0 }, "qos-policing-pkts": { "type": "number", "example": 0 }, "reass-bad-len-octets": { "type": "number", "example": 0 }, "reass-bad-len-pkts": { "type": "number", "example": 0 }, "reass-drop-octets": { "type": "number", "example": 0 }, "reass-drop-pkts": { "type": "number", "example": 0 }, "reass-frag-too-big-octets": { "type": "number", "example": 0 }, "reass-frag-too-big-pkts": { "type": "number", "example": 0 }, "reass-no-frag-info-low-octets": { "type": "number", "example": 0 }, "reass-no-frag-info-low-pkts": { "type": "number", "example": 0 }, "reass-no-frag-info-octets": { "type": "number", "example": 0 }, "reass-no-frag-info-pkts": { "type": "number", "example": 0 }, "reass-no-frags-left-octets": { "type": "number", "example": 0 }, "reass-no-frags-left-pkts": { "type": "number", "example": 0 }, "reass-overlap-octets": { "type": "number", "example": 0 }, "reass-overlap-pkts": { "type": "number", "example": 0 }, "reass-timeout-octets": { "type": "number", "example": 0 }, "reass-timeout-pkts": { "type": "number", "example": 0 }, "reass-too-many-frags-octets": { "type": "number", "example": 0 }, "reass-too-many-frags-pkts": { "type": "number", "example": 0 }, "redistrib-err-bad-dst-octets": { "type": "number", "example": 0 }, "redistrib-err-bad-dst-pkts": { "type": "number", "example": 0 }, "redistrib-err-not-sup-octets": { "type": "number", "example": 0 }, "redistrib-err-not-sup-pkts": { "type": "number", "example": 0 }, "redistrib-err-ph-alc-fail-octets": { "type": "number", "example": 0 }, "redistrib-err-ph-alc-fail-pkts": { "type": "number", "example": 0 }, "redistrib-err-sb-trans-fail-octets": { "type": "number", "example": 0 }, "redistrib-err-sb-trans-fail-pkts": { "type": "number", "example": 0 }, "redistrib-fifo-tail-drop-octets": { "type": "number", "example": 0 }, "redistrib-fifo-tail-drop-pkts": { "type": "number", "example": 0 }, "redistrib-no-credits-octets": { "type": "number", "example": 0 }, "redistrib-no-credits-pkts": { "type": "number", "example": 0 }, "rl2gp-non-tcb-octets": { "type": "number", "example": 0 }, "rl2gp-non-tcb-pkts": { "type": "number", "example": 0 }, "sbc-mmoh-invalid-replica-record-octets": { "type": "number", "example": 0 }, "sbc-mmoh-invalid-replica-record-pkts": { "type": "number", "example": 0 }, "sbc-police-punt-octets": { "type": "number", "example": 0 }, "sbc-police-punt-pkts": { "type": "number", "example": 0 }, "sbc-sess-octets": { "type": "number", "example": 0 }, "sbc-sess-pkts": { "type": "number", "example": 0 }, "sbc-uidb-octets": { "type": "number", "example": 0 }, "sbc-uidb-pkts": { "type": "number", "example": 0 }, "schain-flow-action-octets": { "type": "number", "example": 0 }, "schain-flow-action-pkts": { "type": "number", "example": 0 }, "sdvt-octets": { "type": "number", "example": 0 }, "sdvt-pkts": { "type": "number", "example": 0 }, "sdvt-sn-octets": { "type": "number", "example": 0 }, "sdvt-sn-pkts": { "type": "number", "example": 0 }, "sdwan-acl-octets": { "type": "number", "example": 0 }, "sdwan-acl-pkts": { "type": "number", "example": 0 }, "sdwan-app-route-policy-octets": { "type": "number", "example": 0 }, "sdwan-app-route-policy-pkts": { "type": "number", "example": 0 }, "sdwan-bfd-octets": { "type": "number", "example": 0 }, "sdwan-bfd-pkts": { "type": "number", "example": 0 }, "sdwan-data-policy-octets": { "type": "number", "example": 0 }, "sdwan-data-policy-pkts": { "type": "number", "example": 0 }, "sdwan-generic-octets": { "type": "number", "example": 0 }, "sdwan-generic-pkts": { "type": "number", "example": 0 }, "sdwan-implicit-acl-octets": { "type": "number", "example": 0 }, "sdwan-implicit-acl-pkts": { "type": "number", "example": 0 }, "sdwan-interface-policy-octets": { "type": "number", "example": 0 }, "sdwan-interface-policy-pkts": { "type": "number", "example": 0 }, "sdwan-octets": { "type": "number", "example": 0 }, "sdwan-pkts": { "type": "number", "example": 0 }, "sdwan-tloc-ext-octets": { "type": "number", "example": 0 }, "sdwan-tloc-ext-pkts": { "type": "number", "example": 0 }, "sdwan-tunnel-lkup-octets": { "type": "number", "example": 0 }, "sdwan-tunnel-lkup-pkts": { "type": "number", "example": 0 }, "servicewire-hdr-err-octets": { "type": "number", "example": 0 }, "servicewire-hdr-err-pkts": { "type": "number", "example": 0 }, "servicewire-hop-limit-exceeded-octets": { "type": "number", "example": 0 }, "servicewire-hop-limit-exceeded-pkts": { "type": "number", "example": 0 }, "servicewire-processing-err-octets": { "type": "number", "example": 0 }, "servicewire-processing-err-pkts": { "type": "number", "example": 0 }, "smi-disabled-octets": { "type": "number", "example": 0 }, "smi-disabled-pkts": { "type": "number", "example": 0 }, "special-multicast-obj-octets": { "type": "number", "example": 0 }, "special-multicast-obj-pkts": { "type": "number", "example": 0 }, "sr-te-remote-error-octets": { "type": "number", "example": 0 }, "sr-te-remote-error-pkts": { "type": "number", "example": 0 }, "srh-invalid-extension-octets": { "type": "number", "example": 0 }, "srh-invalid-extension-pkts": { "type": "number", "example": 0 }, "srh-pkt-truncated-in-gpm-octets": { "type": "number", "example": 0 }, "srh-pkt-truncated-in-gpm-pkts": { "type": "number", "example": 0 }, "sslvpn-add-ssl-rec-hdr-err-octets": { "type": "number", "example": 0 }, "sslvpn-add-ssl-rec-hdr-err-pkts": { "type": "number", "example": 0 }, "sslvpn-coprocessor-err-octets": { "type": "number", "example": 0 }, "sslvpn-coprocessor-err-pkts": { "type": "number", "example": 0 }, "sslvpn-coprocessor-state-not-set-octets": { "type": "number", "example": 0 }, "sslvpn-coprocessor-state-not-set-pkts": { "type": "number", "example": 0 }, "sslvpn-coprocessor-state-reply-not-set-octets": { "type": "number", "example": 0 }, "sslvpn-coprocessor-state-reply-not-set-pkts": { "type": "number", "example": 0 }, "sslvpn-ctx-not-alive-octets": { "type": "number", "example": 0 }, "sslvpn-ctx-not-alive-pkts": { "type": "number", "example": 0 }, "sslvpn-ctx-null-octets": { "type": "number", "example": 0 }, "sslvpn-ctx-null-pkts": { "type": "number", "example": 0 }, "sslvpn-empty-pkt-octets": { "type": "number", "example": 0 }, "sslvpn-empty-pkt-pkts": { "type": "number", "example": 0 }, "sslvpn-inv-ssl-rec-octets": { "type": "number", "example": 0 }, "sslvpn-inv-ssl-rec-pkts": { "type": "number", "example": 0 }, "sslvpn-invalid-pkt-octets": { "type": "number", "example": 0 }, "sslvpn-invalid-pkt-pkts": { "type": "number", "example": 0 }, "sslvpn-invalid-session-octets": { "type": "number", "example": 0 }, "sslvpn-invalid-session-pkts": { "type": "number", "example": 0 }, "sslvpn-neg-ssl-rec-pad-len-octets": { "type": "number", "example": 0 }, "sslvpn-neg-ssl-rec-pad-len-pkts": { "type": "number", "example": 0 }, "sslvpn-not-ssl-rec-rc-octets": { "type": "number", "example": 0 }, "sslvpn-not-ssl-rec-rc-pkts": { "type": "number", "example": 0 }, "sslvpn-not-ssl-record-octets": { "type": "number", "example": 0 }, "sslvpn-not-ssl-record-pkts": { "type": "number", "example": 0 }, "sslvpn-null-rc-octets": { "type": "number", "example": 0 }, "sslvpn-null-rc-pkts": { "type": "number", "example": 0 }, "sslvpn-null-session-octets": { "type": "number", "example": 0 }, "sslvpn-null-session-pkts": { "type": "number", "example": 0 }, "sslvpn-pkt-rc-err-octets": { "type": "number", "example": 0 }, "sslvpn-pkt-rc-err-pkts": { "type": "number", "example": 0 }, "sslvpn-socket-wr-err-octets": { "type": "number", "example": 0 }, "sslvpn-socket-wr-err-pkts": { "type": "number", "example": 0 }, "sslvpn-ssl-rec-not-pkt-octets": { "type": "number", "example": 0 }, "sslvpn-ssl-rec-not-pkt-pkts": { "type": "number", "example": 0 }, "sslvpn-svi-if-err-octets": { "type": "number", "example": 0 }, "sslvpn-svi-if-err-pkts": { "type": "number", "example": 0 }, "sslvpn-svi-invalid-h-octets": { "type": "number", "example": 0 }, "sslvpn-svi-invalid-h-pkts": { "type": "number", "example": 0 }, "sslvpn-tail-drop-octets": { "type": "number", "example": 0 }, "sslvpn-tail-drop-pkts": { "type": "number", "example": 0 }, "sslvpn-wrong-pkt-type-octets": { "type": "number", "example": 0 }, "sslvpn-wrong-pkt-type-pkts": { "type": "number", "example": 0 }, "sv-match-fail-octets": { "type": "number", "example": 0 }, "sv-match-fail-pkts": { "type": "number", "example": 0 }, "svi-input-invalid-mac-octets": { "type": "number", "example": 0 }, "svi-input-invalid-mac-pkts": { "type": "number", "example": 0 }, "svi-output-invalid-l2sb-octets": { "type": "number", "example": 0 }, "svi-output-invalid-l2sb-pkts": { "type": "number", "example": 0 }, "svi-output-recycle-tail-octets": { "type": "number", "example": 0 }, "svi-output-recycle-tail-pkts": { "type": "number", "example": 0 }, "svi-output-repl-octets": { "type": "number", "example": 0 }, "svi-output-repl-pkts": { "type": "number", "example": 0 }, "svi-repl-end-octets": { "type": "number", "example": 0 }, "svi-repl-end-pkts": { "type": "number", "example": 0 }, "sw-mac-filter-octets": { "type": "number", "example": 0 }, "sw-mac-filter-pkts": { "type": "number", "example": 0 }, "switch-l2m-igmp-octets": { "type": "number", "example": 0 }, "switch-l2m-igmp-pkts": { "type": "number", "example": 0 }, "switch-l2m-lookup-miss-octets": { "type": "number", "example": 0 }, "switch-l2m-lookup-miss-pkts": { "type": "number", "example": 0 }, "switch-l2m-mld-octets": { "type": "number", "example": 0 }, "switch-l2m-mld-pkts": { "type": "number", "example": 0 }, "switch-l2m-octets": { "type": "number", "example": 0 }, "switch-l2m-pkts": { "type": "number", "example": 0 }, "switch-l2m-sanity-check-octets": { "type": "number", "example": 0 }, "switch-l2m-sanity-check-pkts": { "type": "number", "example": 0 }, "swport-disabled-octets": { "type": "number", "example": 0 }, "swport-disabled-pkts": { "type": "number", "example": 0 }, "swport-mac-conflict-octets": { "type": "number", "example": 0 }, "swport-mac-conflict-pkts": { "type": "number", "example": 0 }, "swport-octets": { "type": "number", "example": 0 }, "swport-pkts": { "type": "number", "example": 0 }, "swport-sanity-check-octets": { "type": "number", "example": 0 }, "swport-sanity-check-pkts": { "type": "number", "example": 0 }, "swport-stby-octets": { "type": "number", "example": 0 }, "swport-stby-pkts": { "type": "number", "example": 0 }, "swport-tx-stby-octets": { "type": "number", "example": 0 }, "swport-tx-stby-pkts": { "type": "number", "example": 0 }, "swport-vp-state-octets": { "type": "number", "example": 0 }, "swport-vp-state-pkts": { "type": "number", "example": 0 }, "tail-drop-octets": { "type": "number", "example": 0 }, "tail-drop-pkts": { "type": "number", "example": 0 }, "tcp-badfrag-octets": { "type": "number", "example": 0 }, "tcp-badfrag-pkts": { "type": "number", "example": 0 }, "tcp-bp-sslvpn-octets": { "type": "number", "example": 0 }, "tcp-bp-sslvpn-pkts": { "type": "number", "example": 0 }, "tcp-octets": { "type": "number", "example": 0 }, "tcp-pkts": { "type": "number", "example": 0 }, "too-many-mpls-lookup-oce-octets": { "type": "number", "example": 0 }, "too-many-mpls-lookup-oce-pkts": { "type": "number", "example": 0 }, "tunnel-bad-gre-checksum-octets": { "type": "number", "example": 0 }, "tunnel-bad-gre-checksum-pkts": { "type": "number", "example": 0 }, "tunnel-bad-pim-checksum-octets": { "type": "number", "example": 0 }, "tunnel-bad-pim-checksum-pkts": { "type": "number", "example": 0 }, "tunnel-decap-too-many-times-octets": { "type": "number", "example": 0 }, "tunnel-decap-too-many-times-pkts": { "type": "number", "example": 0 }, "tunnel-invalid-protocol-octets": { "type": "number", "example": 0 }, "tunnel-invalid-protocol-pkts": { "type": "number", "example": 0 }, "tunnel-l2tpv3oipv6-cookie-mismatch-octets": { "type": "number", "example": 0 }, "tunnel-l2tpv3oipv6-cookie-mismatch-pkts": { "type": "number", "example": 0 }, "tunnel-l2tpv3oipv6-cookieflag-error-octets": { "type": "number", "example": 0 }, "tunnel-l2tpv3oipv6-cookieflag-error-pkts": { "type": "number", "example": 0 }, "tunnel-l2tpv3oipv6-mac-mismatch-octets": { "type": "number", "example": 0 }, "tunnel-l2tpv3oipv6-mac-mismatch-pkts": { "type": "number", "example": 0 }, "tunnel-l2tpv3oipv6-minmtu-error-octets": { "type": "number", "example": 0 }, "tunnel-l2tpv3oipv6-minmtu-error-pkts": { "type": "number", "example": 0 }, "tunnel-l2tpv3oipv6-unsupported-proto-octets": { "type": "number", "example": 0 }, "tunnel-l2tpv3oipv6-unsupported-proto-pkts": { "type": "number", "example": 0 }, "tunnel-l2tpv3oipv6-vlanid-mismatch-octets": { "type": "number", "example": 0 }, "tunnel-l2tpv3oipv6-vlanid-mismatch-pkts": { "type": "number", "example": 0 }, "tunnel-misconfiguration-octets": { "type": "number", "example": 0 }, "tunnel-misconfiguration-pkts": { "type": "number", "example": 0 }, "tunnel-pkt-sb-missed-octets": { "type": "number", "example": 0 }, "tunnel-pkt-sb-missed-pkts": { "type": "number", "example": 0 }, "tunnel-sec-chk-fail-octets": { "type": "number", "example": 0 }, "tunnel-sec-chk-fail-pkts": { "type": "number", "example": 0 }, "tunnel-sgre-unsupported-proto-octets": { "type": "number", "example": 0 }, "tunnel-sgre-unsupported-proto-pkts": { "type": "number", "example": 0 }, "tunnel-sgre-virtual-mac-mismatch-octets": { "type": "number", "example": 0 }, "tunnel-sgre-virtual-mac-mismatch-pkts": { "type": "number", "example": 0 }, "tunnel-unsupported-config-octets": { "type": "number", "example": 0 }, "tunnel-unsupported-config-pkts": { "type": "number", "example": 0 }, "tunnel-vrf-demux-octets": { "type": "number", "example": 0 }, "tunnel-vrf-demux-pkts": { "type": "number", "example": 0 }, "tunnel-vrf-mux-octets": { "type": "number", "example": 0 }, "tunnel-vrf-mux-pkts": { "type": "number", "example": 0 }, "tunnel-vxlan-mismatch-octets": { "type": "number", "example": 0 }, "tunnel-vxlan-mismatch-pkts": { "type": "number", "example": 0 }, "tunnel-vxlan-policer-octets": { "type": "number", "example": 0 }, "tunnel-vxlan-policer-pkts": { "type": "number", "example": 0 }, "udp-octets": { "type": "number", "example": 0 }, "udp-pkts": { "type": "number", "example": 0 }, "uidb-not-cfgd-octets": { "type": "number", "example": 0 }, "uidb-not-cfgd-pkts": { "type": "number", "example": 0 }, "unconfigured-fia-octets": { "type": "number", "example": 0 }, "unconfigured-fia-pkts": { "type": "number", "example": 0 }, "unconfigured-ipv4-fia-octets": { "type": "number", "example": 0 }, "unconfigured-ipv4-fia-pkts": { "type": "number", "example": 0 }, "unconfigured-ipv6-fia-octets": { "type": "number", "example": 0 }, "unconfigured-ipv6-fia-pkts": { "type": "number", "example": 0 }, "unconfigured-mpls-fia-octets": { "type": "number", "example": 0 }, "unconfigured-mpls-fia-pkts": { "type": "number", "example": 0 }, "unisr-no-match-octets": { "type": "number", "example": 0 }, "unisr-no-match-pkts": { "type": "number", "example": 0 }, "unisr-src-fltrd-octets": { "type": "number", "example": 0 }, "unisr-src-fltrd-pkts": { "type": "number", "example": 0 }, "unknown-encap-octets": { "type": "number", "example": 0 }, "unknown-encap-pkts": { "type": "number", "example": 0 }, "unknown-ext-header-octets": { "type": "number", "example": 0 }, "unknown-ext-header-pkts": { "type": "number", "example": 0 }, "unknown-mcast-pkt-type-octets": { "type": "number", "example": 0 }, "unknown-mcast-pkt-type-pkts": { "type": "number", "example": 0 }, "unresolved-octets": { "type": "number", "example": 0 }, "unresolved-pkts": { "type": "number", "example": 0 }, "unsupport-linktype-no-route-octets": { "type": "number", "example": 0 }, "unsupport-linktype-no-route-pkts": { "type": "number", "example": 0 }, "unsupport-linktype-null0-octets": { "type": "number", "example": 0 }, "unsupport-linktype-null0-pkts": { "type": "number", "example": 0 }, "unsupported-oce-octets": { "type": "number", "example": 0 }, "unsupported-oce-pkts": { "type": "number", "example": 0 }, "utd-octets": { "type": "number", "example": 0 }, "utd-pkts": { "type": "number", "example": 0 }, "utd-sn-octets": { "type": "number", "example": 0 }, "utd-sn-pkts": { "type": "number", "example": 0 }, "vdevice-name": { "type": "string", "example": "172.16.255.15" }, "vfr-err-octets": { "type": "number", "example": 0 }, "vfr-err-pkts": { "type": "number", "example": 0 }, "vfr-tail-drop-octets": { "type": "number", "example": 0 }, "vfr-tail-drop-pkts": { "type": "number", "example": 0 }, "vtcp-err-octets": { "type": "number", "example": 0 }, "vtcp-err-pkts": { "type": "number", "example": 0 }, "vtcp-inv-tx-octets": { "type": "number", "example": 0 }, "vtcp-inv-tx-pkts": { "type": "number", "example": 0 }, "vtcp-mem-err-octets": { "type": "number", "example": 0 }, "vtcp-mem-err-pkts": { "type": "number", "example": 0 }, "vtcp-pa-err-octets": { "type": "number", "example": 0 }, "vtcp-pa-err-pkts": { "type": "number", "example": 0 }, "vtcp-punt-err-octets": { "type": "number", "example": 0 }, "vtcp-punt-err-pkts": { "type": "number", "example": 0 }, "wlclnt-err-octets": { "type": "number", "example": 0 }, "wlclnt-err-pkts": { "type": "number", "example": 0 }, "wlclnt-fnf-v9-err-octets": { "type": "number", "example": 0 }, "wlclnt-fnf-v9-err-pkts": { "type": "number", "example": 0 }, "wlclnt-fnf-v9-report-octets": { "type": "number", "example": 0 }, "wlclnt-fnf-v9-report-pkts": { "type": "number", "example": 0 }, "wpan-octets": { "type": "number", "example": 0 }, "wpan-pkts": { "type": "number", "example": 0 }, "wred-octets": { "type": "number", "example": 0 }, "wred-pkts": { "type": "number", "example": 0 } }, "$$ref": "#/components/schemas/QfpDropResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/qos/session/details": { "get": { "tags": [ "Real-Time Monitoring - QoS" ], "description": "Get per-tunnel QoS session detailed info", "operationId": "getPerTunnelQosDetailedInfo", "parameters": [ { "name": "deviceId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "local-system-ip", "in": "query", "schema": { "type": "string" } }, { "name": "local-color", "in": "query", "schema": { "type": "string" } }, { "name": "remote-system-ip", "in": "query", "schema": { "type": "string" } }, { "name": "remote-color", "in": "query", "schema": { "type": "string" } }, { "name": "proto", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "classifier-entry-name": { "type": "string", "example": "Queue1" }, "drop-bytes": { "type": "number", "example": 0 }, "drop-pkts": { "type": "number", "example": 0 }, "lastupdated": { "type": "number", "example": 1728710934571 }, "local-color": { "type": "string", "example": "lte" }, "local-system-ip": { "type": "string", "example": "172.16.255.15" }, "post-policy-bytes": { "type": "number", "example": 0 }, "post-policy-pkts": { "type": "number", "example": 0 }, "pre-policy-bytes": { "type": "number", "example": 0 }, "pre-policy-pkts": { "type": "number", "example": 0 }, "proto": { "type": "string", "example": "ipsec" }, "remote-color": { "type": "string", "example": "lte" }, "remote-system-ip": { "type": "string", "example": "172.16.255.16" }, "tunnel-endpoint": { "type": "string", "example": "172.16.255.15_lte_172.16.255.16_lte_ipsec" }, "vdevice-dataKey": { "type": "string", "example": "172.16.255.15-172.16.255.15_lte_172.16.255.16_lte_ipsec-Queue1" }, "vdevice-host-name": { "type": "string", "example": "vm5" }, "vdevice-name": { "type": "string", "example": "172.16.255.15" } }, "$$ref": "#/components/schemas/QosDetailedObject" } } }, "$$ref": "#/components/schemas/QosDetailedResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/qos/session/summary": { "get": { "tags": [ "Real-Time Monitoring - QoS" ], "description": "Get per-tunnel QoS sessions summary info", "operationId": "getPerTunnelQosSummary", "parameters": [ { "name": "deviceId", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "drop-bytes": { "type": "number", "example": 0 }, "drop-pkts": { "type": "number", "example": 0 }, "lastupdated": { "type": "number", "example": 1728710934571 }, "post-policy-bytes": { "type": "number", "example": 1133915 }, "post-policy-pkts": { "type": "number", "example": 3159 }, "pre-policy-bytes": { "type": "number", "example": 1133915 }, "pre-policy-pkts": { "type": "number", "example": 3159 }, "tunnel-endpoint": { "type": "string", "example": "172.16.255.15_lte_172.16.255.16_lte_ipsec" }, "vdevice-dataKey": { "type": "string", "example": "172.16.255.15-172.16.255.15_lte_172.16.255.16_lte_ipsec" }, "vdevice-host-name": { "type": "string", "example": "vm5" }, "vdevice-name": { "type": "string", "example": "172.16.255.15" } }, "$$ref": "#/components/schemas/QosSummaryObject" } } }, "$$ref": "#/components/schemas/QosSummaryResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" }, "post": { "tags": [ "Real-Time Monitoring - QoS" ], "description": "Get per-tunnel QoS filtered sessions summary info", "operationId": "getPerTunnelQosSummaryPost", "parameters": [ { "name": "deviceId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Required sessions", "content": { "application/json": { "schema": { "type": "array" }, "examples": { "Sessions": { "description": "Sessions", "value": [ { "local-system-ip": "172.16.255.15", "local-color": "lte", "remote-system-ip": "10.2.1.83", "remote-color": "gold", "proto": "ipsec" } ] } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "drop-bytes": { "type": "number", "example": 0 }, "drop-pkts": { "type": "number", "example": 0 }, "lastupdated": { "type": "number", "example": 1728710934571 }, "post-policy-bytes": { "type": "number", "example": 1133915 }, "post-policy-pkts": { "type": "number", "example": 3159 }, "pre-policy-bytes": { "type": "number", "example": 1133915 }, "pre-policy-pkts": { "type": "number", "example": 3159 }, "tunnel-endpoint": { "type": "string", "example": "172.16.255.15_lte_172.16.255.16_lte_ipsec" }, "vdevice-dataKey": { "type": "string", "example": "172.16.255.15-172.16.255.15_lte_172.16.255.16_lte_ipsec" }, "vdevice-host-name": { "type": "string", "example": "vm5" }, "vdevice-name": { "type": "string", "example": "172.16.255.15" } }, "$$ref": "#/components/schemas/QosSummaryObject" } } }, "$$ref": "#/components/schemas/QosSummaryResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,RBAC VPN-read,RBAC VPN-write" } }, "/device/queues": { "get": { "tags": [ "Monitoring - Device Details" ], "description": "Get synchronized queue information, returns information about syncing, queued and stuck devices", "operationId": "getSyncQueues", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Queue status": { "description": "Queue status", "value": { "syncing": [], "queued": [], "Stuck": {} } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/reachable": { "get": { "tags": [ "Monitoring - Device Details" ], "description": "Get list of reachable devices", "operationId": "listReachableDevices", "parameters": [ { "name": "personality", "in": "query", "description": "personality", "schema": { "type": "string" }, "examples": { "vedge personality": { "description": "vedge personality", "value": "vedge" }, "vsmart personality": { "description": "vsmart personality", "value": "vsmart" }, "vbond personality": { "description": "vbond personality", "value": "vbond" } } }, { "name": "vpnId", "in": "query", "description": "vpnId", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "availableVersions": { "type": "array", "items": { "type": "string" } }, "board-serial": { "type": "integer", "format": "int64" }, "board_type": { "type": "string" }, "bootloader_version": { "type": "string" }, "build_number": { "type": "integer", "format": "int64" }, "certificate-not-valid-after": { "type": "string" }, "certificate-not-valid-before": { "type": "string" }, "certificate-status": { "type": "string" }, "certificate-validity": { "type": "string" }, "chassis-number": { "type": "string" }, "chassis-serial-number": { "type": "number", "format": "float" }, "connectedVManages": { "type": "array", "items": { "type": "string" } }, "controlConnections": { "type": "integer", "format": "int64" }, "controlConnectionsDown": { "type": "integer", "format": "int32" }, "controlConnectionsUp": { "type": "integer", "format": "int64" }, "cpuLoadDisplay": { "type": "number", "format": "float" }, "cpuState": { "type": "string" }, "defaultVersion": { "type": "string" }, "device-category": { "type": "string" }, "device-groups": { "type": "array", "items": { "type": "string" } }, "device-model": { "type": "string" }, "device-os": { "type": "string" }, "device-type": { "type": "string", "example": "9" }, "deviceId": { "type": "string" }, "domain-id": { "type": "integer", "format": "int32" }, "expectedControlConnections": { "type": "integer", "format": "int64" }, "fips_mode": { "type": "string" }, "firmwareAvailablePackages": { "type": "array", "items": { "type": "string" } }, "firmwareAvailableVersions": { "type": "array", "items": { "type": "string" } }, "firmwareVersion": { "type": "string" }, "grid": { "type": "integer", "format": "int32" }, "groupId": { "type": "array", "items": { "type": "string" } }, "hardwareState": { "type": "string" }, "hasGeoData": { "type": "boolean" }, "host-name": { "type": "string" }, "isDeviceGeoData": { "type": "boolean" }, "lastDataSyncTime": { "type": "integer", "format": "int64" }, "lastupdated": { "type": "integer", "format": "int64" }, "latitude": { "type": "string" }, "layoutLevel": { "type": "integer", "format": "int32" }, "local-system-ip": { "type": "string" }, "longitude": { "type": "string" }, "memStatenormal": { "type": "string" }, "memUsage": { "type": "integer", "format": "int32" }, "memUsageDisplay": { "type": "integer", "format": "int32" }, "model_sku": { "type": "string" }, "mpPeers": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "number-vbond-peers": { "type": "integer", "format": "int32" }, "number-vsmart-control-connections": { "type": "integer", "format": "int64" }, "number-vsmart-peers": { "type": "integer", "format": "int64" }, "ompPeersDown": { "type": "integer", "format": "int64" }, "ompPeersUp": { "type": "integer", "format": "int32" }, "organization-name": { "type": "string" }, "personality": { "type": "string" }, "platform": { "type": "string" }, "policy-template-nam": { "type": "string" }, "policy-template-name": { "type": "string" }, "policy-template-version": { "type": "string" }, "reachability": { "type": "string" }, "site-id": { "type": "integer", "format": "int32" }, "sp-organization-name": { "type": "string" }, "state": { "type": "string" }, "state_description": { "type": "string" }, "status": { "type": "string" }, "statusOrder": { "type": "integer", "format": "int32" }, "syncCompleted": { "type": "integer", "format": "int64" }, "syncQueued": { "type": "integer", "format": "int64" }, "syncScheduled": { "type": "integer", "format": "int64" }, "syncState": { "type": "string" }, "system-ip": { "type": "string" }, "testbed_mode": { "type": "boolean" }, "timezone": { "type": "string" }, "token": { "type": "string" }, "total_cpu_count": { "type": "integer", "format": "int64" }, "uptime": { "type": "string" }, "uptime-date": { "type": "integer", "format": "int64" }, "uuid": { "type": "string" }, "vbond": { "type": "string" }, "vedge-list-version": { "type": "integer", "format": "int32" }, "version": { "type": "string" }, "vmanage-system-ip": { "type": "string" }, "vmanageConnectionState": { "type": "string" }, "vsmart-list-version": { "type": "integer", "format": "int32", "example": 0 } }, "$$ref": "#/components/schemas/DeviceReachableData" }, "examples": { "List of reachable devices": { "description": "List of reachable devices", "value": "[\n {\n \"device-model\":\"vsmart\",\n \"statusOrder\":4,\n \"total_cpu_count\":\"2\",\n \"groupId\":[\n \"none\"\n ],\n \"certificate-not-valid-before\":\"Feb 23 02:32:17 2021 GMT\",\n \"uuid\":\"bd7440de-aff6-4f9f-a99a-48d5f08b9fa5\",\n \"deviceId\":\"172.16.255.19\",\n \"syncScheduled\":1616436317638,\n \"chassis-serial-number\":\"None\",\n \"cpuLoad\":0.22,\n \"state_description\":\"All daemons up\",\n \"vsmart-list-version\":\"0\",\n \"vbond\":\"10.0.12.26\",\n \"ompPeersUp\":3,\n \"syncQueued\":1616436317586,\n \"isDeviceGeoData\":true,\n \"device-type\":\"vsmart\",\n \"state\":\"green\",\n \"firmwareVersion\":\"---\",\n \"organization-name\":\"vIPtela Inc Regression\",\n \"longitude\":\"-122.0\",\n \"syncCompleted\":1616436319560,\n \"domain-id\":\"1\",\n \"policy-template-name\":\"\",\n \"expectedControlConnections\":1,\n \"memUsageDisplay\":\"39.0\",\n \"model_sku\":\"None\",\n \"sp-organization-name\":\"vIPtela Inc Regression\",\n \"version\":\"20.6.999-756\",\n \"firmwareAvailablePackages\":\"[]\",\n \"layoutLevel\":2,\n \"bootloader_version\":\"Not applicable\",\n \"fips_mode\":\"enabled\",\n \"name\":\"172.16.255.19\",\n \"controlConnectionsUp\":5,\n \"controlConnectionsToVsmarts\":\"1\",\n \"number-vbond-peers\":\"1\",\n \"defaultVersion\":\"20.6.999-756\",\n \"status\":\"normal\",\n \"ompPeers\":\"3\",\n \"memState\":\"normal\",\n \"chassis-number\":\"bd7440de-aff6-4f9f-a99a-48d5f08b9fa5\",\n \"board_type\":\"None\",\n \"device-os\":\"next\",\n \"local-system-ip\":\"172.16.255.19\",\n \"timezone\":\"UTC\",\n \"latitude\":\"45.0\",\n \"system-ip\":\"172.16.255.19\",\n \"site-id\":\"100\",\n \"certificate-not-valid-after\":\"Feb 23 02:32:17 2022 GMT\",\n \"platform\":\"x86_64\",\n \"hardwareState\":\"--\",\n \"board-serial\":\"12345981\",\n \"@rid\":377,\n \"vedge-list-version\":\"0\",\n \"personality\":\"vsmart\",\n \"memUsage\":39.0,\n \"lastDataSyncTime\":1616436319524,\n \"certificate-status\":\"Installed\",\n \"reachability\":\"reachable\",\n \"controlConnections\":\"5\",\n \"controlConnectionsDown\":0,\n \"availableVersions\":[\n \n ],\n \"policy-template-version\":\"\",\n \"number-vsmart-peers\":1,\n \"connectedVManages\":[\n \"172.16.255.22\"\n ],\n \"testbed_mode\":true,\n \"syncState\":\"Completed\",\n \"firmwareAvailableVersions\":[\n \n ],\n \"host-name\":\"vm9\",\n \"uptime\":\"27 days 15 hrs 59 min 37 sec\",\n \"token\":\"-NA-\",\n \"cpuLoadDisplay\":\"0.22\",\n \"cpuState\":\"normal\",\n \"certificate-validity\":\"Valid\",\n \"number-vsmart-control-connections\":1,\n \"vmanage-system-ip\":\"172.16.255.19\",\n \"ompPeersDown\":0,\n \"vmanageConnectionState\":\"connected\",\n \"build_number\":\"756\\n\",\n \"lastupdated\":1616436319460,\n \"device-category\":\"controller\",\n \"device-groups\":[\n \"No groups\"\n ],\n \"hasGeoData\":true,\n \"uptime-date\":1614045900000\n },\n {\n \"device-model\":\"vsmart\",\n \"statusOrder\":4,\n \"total_cpu_count\":\"2\",\n \"groupId\":[\n \"none\"\n ],\n \"certificate-not-valid-before\":\"Feb 23 02:32:18 2021 GMT\",\n \"uuid\":\"0faa6449-8ab8-4e53-a580-893f16f80738\",\n \"deviceId\":\"172.16.255.20\",\n \"syncScheduled\":0,\n \"chassis-serial-number\":\"None\",\n \"cpuLoad\":0.18,\n \"state_description\":\"All daemons up\",\n \"vsmart-list-version\":\"0\",\n \"vbond\":\"10.0.12.26\",\n \"ompPeersUp\":3,\n \"syncQueued\":1616395493285,\n \"isDeviceGeoData\":true,\n \"device-type\":\"vsmart\",\n \"state\":\"green\",\n \"firmwareVersion\":\"---\",\n \"organization-name\":\"vIPtela Inc Regression\",\n \"longitude\":\"-90.0\",\n \"syncCompleted\":1616395494540,\n \"domain-id\":\"1\",\n \"policy-template-name\":\"\",\n \"expectedControlConnections\":1,\n \"memUsageDisplay\":\"39.0\",\n \"model_sku\":\"None\",\n \"sp-organization-name\":\"vIPtela Inc Regression\",\n \"version\":\"20.6.999-756\",\n \"firmwareAvailablePackages\":\"[]\",\n \"layoutLevel\":2,\n \"bootloader_version\":\"Not applicable\",\n \"fips_mode\":\"enabled\",\n \"name\":\"172.16.255.20\",\n \"controlConnectionsUp\":5,\n \"controlConnectionsToVsmarts\":\"1\",\n \"number-vbond-peers\":\"1\",\n \"defaultVersion\":\"20.6.999-756\",\n \"status\":\"normal\",\n \"ompPeers\":\"3\",\n \"memState\":\"normal\",\n \"chassis-number\":\"0faa6449-8ab8-4e53-a580-893f16f80738\",\n \"board_type\":\"None\",\n \"device-os\":\"next\",\n \"local-system-ip\":\"172.16.255.20\",\n \"timezone\":\"UTC\",\n \"latitude\":\"45.0\",\n \"system-ip\":\"172.16.255.20\",\n \"site-id\":\"200\",\n \"certificate-not-valid-after\":\"Feb 23 02:32:18 2022 GMT\",\n \"platform\":\"x86_64\",\n \"hardwareState\":\"--\",\n \"board-serial\":\"12345975\",\n \"@rid\":393,\n \"vedge-list-version\":\"0\",\n \"personality\":\"vsmart\",\n \"memUsage\":39.0,\n \"lastDataSyncTime\":1616395494518,\n \"certificate-status\":\"Installed\",\n \"reachability\":\"reachable\",\n \"controlConnections\":\"5\",\n \"controlConnectionsDown\":0,\n \"availableVersions\":[\n \n ],\n \"policy-template-version\":\"\",\n \"number-vsmart-peers\":1,\n \"connectedVManages\":[\n \"172.16.255.22\"\n ],\n \"testbed_mode\":true,\n \"syncState\":\"Completed\",\n \"firmwareAvailableVersions\":[\n \n ],\n \"host-name\":\"vm10\",\n \"uptime\":\"27 days 04 hrs 39 min 57 sec\",\n \"token\":\"-NA-\",\n \"cpuLoadDisplay\":\"0.18\",\n \"cpuState\":\"normal\",\n \"certificate-validity\":\"Valid\",\n \"number-vsmart-control-connections\":1,\n \"vmanage-system-ip\":\"172.16.255.20\",\n \"ompPeersDown\":0,\n \"vmanageConnectionState\":\"connected\",\n \"build_number\":\"756\\n\",\n \"lastupdated\":1616395494468,\n \"device-category\":\"controller\",\n \"device-groups\":[\n \"No groups\"\n ],\n \"hasGeoData\":true,\n \"uptime-date\":1614045840000\n }\n{\n \"device-model\":\"vedge-cloud\",\n \"statusOrder\":4,\n \"total_cpu_count\":\"2\",\n \"groupId\":[\n \"none\"\n ],\n \"certificate-not-valid-before\":\"Feb 23 02:32:40 2021 GMT\",\n \"fp_cpu_count\":\"1\",\n \"uuid\":\"fd31a48b-2908-4315-a911-a3f2f0a8da24\",\n \"deviceId\":\"172.16.255.26\",\n \"syncScheduled\":1616411710011,\n \"chassis-serial-number\":\"None\",\n \"cpuLoad\":1.04,\n \"state_description\":\"All daemons up\",\n \"vsmart-list-version\":\"0\",\n \"vbond\":\"10.0.12.26\",\n \"syncQueued\":1616411703542,\n \"isDeviceGeoData\":false,\n \"device-type\":\"vbond\",\n \"state\":\"green\",\n \"firmwareVersion\":\"---\",\n \"organization-name\":\"vIPtela Inc Regression\",\n \"longitude\":\"-122.777023\",\n \"syncCompleted\":1616411711225,\n \"memUsageDisplay\":\"63.7\",\n \"model_sku\":\"None\",\n \"sp-organization-name\":\"vIPtela Inc Regression\",\n \"version\":\"20.6.999-756\",\n \"firmwareAvailablePackages\":\"[]\",\n \"layoutLevel\":3,\n \"bootloader_version\":\"Not applicable\",\n \"fips_mode\":\"enabled\",\n \"name\":\"172.16.255.26\",\n \"defaultVersion\":\"20.6.999-756\",\n \"status\":\"normal\",\n \"memState\":\"normal\",\n \"chassis-number\":\"fd31a48b-2908-4315-a911-a3f2f0a8da24\",\n \"board_type\":\"Sim\",\n \"device-os\":\"next\",\n \"local-system-ip\":\"172.16.255.26\",\n \"timezone\":\"UTC\",\n \"latitude\":\"37.666684\",\n \"system-ip\":\"172.16.255.26\",\n \"certificate-not-valid-after\":\"Feb 23 02:32:40 2022 GMT\",\n \"platform\":\"x86_64\",\n \"hardwareState\":\"--\",\n \"board-serial\":\"12345979\",\n \"@rid\":369,\n \"vedge-list-version\":\"0\",\n \"personality\":\"vbond\",\n \"memUsage\":63.7,\n \"lastDataSyncTime\":1616411711185,\n \"certificate-status\":\"Installed\",\n \"reachability\":\"reachable\",\n \"linux_cpu_count\":\"1\",\n \"availableVersions\":[\n \n ],\n \"vbond-standalone\":\"false\",\n \"connectedVManages\":[\n \"172.16.255.22\"\n ],\n \"testbed_mode\":true,\n \"syncState\":\"Completed\",\n \"firmwareAvailableVersions\":[\n \n ],\n \"host-name\":\"vm16\",\n \"tcpd_cpu_count\":\"0\",\n \"uptime\":\"27 days 09 hrs 09 min 40 sec\",\n \"cpuLoadDisplay\":\"1.04\",\n \"cpuState\":\"normal\",\n \"certificate-validity\":\"Valid\",\n \"vmanage-system-ip\":\"172.16.255.26\",\n \"vmanageConnectionState\":\"connected\",\n \"build_number\":\"756\\n\",\n \"lastupdated\":1616411711138,\n \"device-category\":\"controller\",\n \"device-groups\":[\n \"No groups\"\n ],\n \"hasGeoData\":true,\n \"uptime-date\":1614045900000\n} ]" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/reboothistory": { "get": { "tags": [ "Real-Time Monitoring - Reboot History" ], "description": "Get device reboot history", "operationId": "createRebootHistoryList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device reboot history": { "description": "Device reboot history", "value": { "data": [ { "reboot_date_time-date": 1642651714000, "lastupdated": 1642656685355, "vdevice-dataKey": "172.16.255.11-2022-01-20T04:08:34+00:00", "reboot_date_time": "2022-01-20T04:08:34+00:00", "reboot_reason": "Initiated by user - Reboot issued via NETCONF", "vdevice-host-name": "vm1", "vdevice-name": "172.16.255.11" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Device Monitoring-read,Device Monitoring-write,Software Upgrade-read,Software Upgrade-write,Device Reboot-read,Device Reboot-write,dca,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read" } }, "/device/reboothistory/details": { "get": { "tags": [ "Real-Time Monitoring - Reboot History" ], "description": "Get detailed reboot history list", "operationId": "getRebootHistoryDetails", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Detailed device reboot history": { "description": "Detailed device reboot history", "value": { "data": [ { "reboot_date_time-date": 1642651714000, "lastupdated": 1642652319187, "reboot_date_time": "2022-01-20T04:08:34+00:00", "reboot_reason": "Initiated by user - Reboot issued via NETCONF", "vdevice-host-name": "vm1", "vdevice-name": "172.16.255.11" }, { "reboot_date_time-date": 1642656388000, "lastupdated": 1642656695661, "reboot_date_time": "2022-01-20T05:26:28+00:00", "reboot_reason": "Initiated by user - Reboot issued via NETCONF", "vdevice-host-name": "vm1", "vdevice-name": "172.16.255.11" }, { "reboot_date_time-date": 1642657398000, "lastupdated": 1642657658587, "reboot_date_time": "2022-01-20T05:43:18+00:00", "reboot_reason": "reload", "vdevice-host-name": "vm5", "vdevice-name": "172.16.255.15" }, { "reboot_date_time-date": 1642658548000, "lastupdated": 1642659153477, "reboot_date_time": "2022-01-20T06:02:28+00:00", "reboot_reason": "Initiated by user - Reboot issued via NETCONF", "vdevice-host-name": "vm1", "vdevice-name": "172.16.255.11" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Device Monitoring-read,Device Monitoring-write,Software Upgrade-read,Software Upgrade-write,Device Reboot-read,Device Reboot-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read" } }, "/device/reboothistory/synced": { "get": { "tags": [ "Real-Time Monitoring - Reboot History" ], "description": "Get device reboot history synchronously", "operationId": "createSyncedRebootHistoryList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device reboot history": { "description": "Device reboot history", "value": { "data": [ { "reboot_date_time-date": 1642658548000, "vmanage-system-ip": "172.16.255.11", "reboot_date_time": "2022-01-20T06:02:28+00:00", "vdevice-dataKey": "172.16.255.11-2022-01-20T06:02:28+00:00", "createTimeStamp": 1642659153490, "lastupdated": 1642659153477, "reboot_reason": "Initiated by user - Reboot issued via NETCONF", "vdevice-host-name": "vm1", "vdevice-name": "172.16.255.11", "@rid": 1078 }, { "reboot_date_time-date": 1642651714000, "vmanage-system-ip": "172.16.255.11", "reboot_date_time": "2022-01-20T04:08:34+00:00", "vdevice-dataKey": "172.16.255.11-2022-01-20T04:08:34+00:00", "createTimeStamp": 1642652319194, "lastupdated": 1642652319187, "reboot_reason": "Initiated by user - Reboot issued via NETCONF", "vdevice-host-name": "vm1", "vdevice-name": "172.16.255.11", "@rid": 1086 }, { "reboot_date_time-date": 1642656388000, "vmanage-system-ip": "172.16.255.11", "reboot_date_time": "2022-01-20T05:26:28+00:00", "vdevice-dataKey": "172.16.255.11-2022-01-20T05:26:28+00:00", "createTimeStamp": 1642656696210, "lastupdated": 1642656695661, "reboot_reason": "Initiated by user - Reboot issued via NETCONF", "vdevice-host-name": "vm1", "vdevice-name": "172.16.255.11", "@rid": 1095 }, { "reboot_date_time-date": 1642659874000, "vmanage-system-ip": "172.16.255.11", "reboot_date_time": "2022-01-20T06:24:34+00:00", "vdevice-dataKey": "172.16.255.11-2022-01-20T06:24:34+00:00", "createTimeStamp": 1642660158532, "lastupdated": 1642660158402, "reboot_reason": "Initiated by user - Reboot issued via NETCONF", "vdevice-host-name": "vm1", "vdevice-name": "172.16.255.11", "@rid": 1103 }, { "reboot_date_time-date": 1642659181000, "vmanage-system-ip": "172.16.255.11", "reboot_date_time": "2022-01-20T06:13:01+00:00", "vdevice-dataKey": "172.16.255.11-2022-01-20T06:13:01+00:00", "createTimeStamp": 1642659460686, "lastupdated": 1642659460446, "reboot_reason": "Initiated by user - Reboot issued via NETCONF", "vdevice-host-name": "vm1", "vdevice-name": "172.16.255.11", "@rid": 1104 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Device Monitoring-read,Device Monitoring-write,Software Upgrade-read,Software Upgrade-write,Device Reboot-read,Device Reboot-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read" } }, "/device/redundancy-group/app-group": { "get": { "tags": [ "Monitoring - Cedge Cflowd" ], "description": "Get Redundancy Group Information", "operationId": "getRedundancyGroupAppGroup", "parameters": [ { "name": "deviceId", "in": "query", "required": true, "schema": { "type": "object", "properties": { "deviceIp": { "type": "string" } }, "description": "This is the valid DeviceIP", "$$ref": "#/components/schemas/DeviceIP" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Redundancy group info": { "description": "Redundancy group info", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/roleBasedCounters": { "get": { "tags": [ "Real-Time Monitoring - Trustsec" ], "description": "get Cisco TrustSec Role Based Counters information from device", "operationId": "getRoleBasedCounters", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "TrustSec role based counters information": { "description": "TrustSec role based counters information", "value": { "data": [ { "software-permit-count": "0", "software-monitor-count": "0", "software-deny-count": "0", "vdevice-name": "172.16.255.15", "total-permit-count": "0", "src-sgt": 55, "total-deny-count": "0", "vdevice-host-name": "vm5", "hardware-deny-count": "0", "vdevice-dataKey": "172.16.255.15-vm5-55-66", "hardware-permit-count": "0", "lastupdated": 1654768097970, "dst-sgt": 66, "hardware-monitor-count": "0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write" } }, "/device/roleBasedIpv6Counters": { "get": { "tags": [ "Real-Time Monitoring - Trustsec" ], "description": "get Cisco TrustSec Role Based Ipv6 Counters information from device", "operationId": "getRoleBasedIpv6Counters", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "TrustSec role based counters information": { "description": "TrustSec role based counters information", "value": { "data": [ { "software-permit-count": "0", "software-monitor-count": "0", "software-deny-count": "0", "vdevice-name": "172.16.255.16", "total-permit-count": "0", "src-sgt": 3, "total-deny-count": "0", "vdevice-host-name": "vm6", "hardware-deny-count": "0", "vdevice-dataKey": "172.16.255.16-vm6-3-5", "hardware-permit-count": "0", "lastupdated": 1654823680867, "dst-sgt": 5, "hardware-monitor-count": "0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/roleBasedIpv6Permissions": { "get": { "tags": [ "Real-Time Monitoring - Trustsec" ], "description": "get Cisco TrustSec Role Based ipv6 Permissions information from device", "operationId": "getRoleBasedIpv6Permissions", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "TrustSec role based permissions information": { "description": "TrustSec role based permissions information", "value": { "data": [ { "last-updated-time": "2036-02-07T06:28:16+00:00", "num-of-sgacl": 1, "vdevice-dataKey": "172.16.255.16-vm6-3-5", "vdevice-name": "172.16.255.16", "policy-life-time": "0", "sgacl-name": "zhanglist2", "monitor-mode": "false", "src-sgt": 3, "lastupdated": 1654823603240, "dst-sgt": 5, "vdevice-host-name": "vm6" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/roleBasedPermissions": { "get": { "tags": [ "Real-Time Monitoring - Trustsec" ], "description": "get Cisco TrustSec Role Based Permissions information from device", "operationId": "getRoleBasedPermissions", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "TrustSec role based permissions information": { "description": "TrustSec role based permissions information", "value": { "data": [ { "last-updated-time": "2036-02-07T06:28:16+00:00", "num-of-sgacl": 1, "vdevice-dataKey": "172.16.255.15-vm5-55-66", "vdevice-name": "172.16.255.15", "policy-life-time": "0", "sgacl-name": "acl1", "monitor-mode": "false", "src-sgt": 55, "lastupdated": 1654767424577, "dst-sgt": 66, "vdevice-host-name": "vm5" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write" } }, "/device/roleBasedSgtMap": { "get": { "tags": [ "Real-Time Monitoring - Trustsec" ], "description": "get Cisco TrustSec Role Based SGT Map information from device", "operationId": "getRoleBasedSgtMap", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "TrustSec role based SGT map information": { "description": "TrustSec role based SGT map information", "value": { "data": [ { "vdevice-dataKey": "172.16.255.15-vm5-10.0.1.15/32-Default", "ip": "10.0.1.15/32", "sgt": 10, "lastupdated": 1652322326243, "source": "from-cli-hi", "vrf-name": "Default", "vdevice-host-name": "vm5", "vdevice-name": "172.16.255.15" }, { "vdevice-dataKey": "172.16.255.15-vm5-10.0.20.15/32-Default", "ip": "10.0.20.15/32", "sgt": 10, "lastupdated": 1652322326243, "source": "from-cli-hi", "vrf-name": "Default", "vdevice-host-name": "vm5", "vdevice-name": "172.16.255.15" }, { "vdevice-dataKey": "172.16.255.15-vm5-10.0.100.15/32-Default", "ip": "10.0.100.15/32", "sgt": 10, "lastupdated": 1652322326243, "source": "from-cli-hi", "vrf-name": "Default", "vdevice-host-name": "vm5", "vdevice-name": "172.16.255.15" }, { "vdevice-dataKey": "172.16.255.15-vm5-10.1.15.15/32-Default", "ip": "10.1.15.15/32", "sgt": 10, "lastupdated": 1652322326243, "source": "from-cli-hi", "vrf-name": "Default", "vdevice-host-name": "vm5", "vdevice-name": "172.16.255.15" }, { "vdevice-dataKey": "172.16.255.15-vm5-10.1.17.15/32-Default", "ip": "10.1.17.15/32", "sgt": 10, "lastupdated": 1652322326243, "source": "from-cli-hi", "vrf-name": "Default", "vdevice-host-name": "vm5", "vdevice-name": "172.16.255.15" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write" } }, "/device/sdwan-global-drop-statistics": { "get": { "tags": [ "Real-Time Monitoring - SDWAN Statistics" ], "description": "Get SD-WAN global drop statistics detail from device (Real Time)", "operationId": "getSDWanGlobalDropStatistics", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "SD-WAN global drop statistics": { "description": "SD-WAN global drop statistics", "value": { "data": [ { "ipv4-acl-lookup-miss-octets": "0", "ip-ttl-exceeded-pkts": "0", "unconfigured-mpls-fia-pkts": "0", "tunnel-pkt-sb-missed-octets": "0", "lisp-decap-failed-octets": "0", "sdwan-bfd-octets": "0", "gre-bad-options-pkts": "0", "sdwan-data-policy-octets": "0", "inv-common-preamble-pkts": "0", "firewall-nonsession-octets": "0", "bqs-oor-pkts": "0", "unconfigured-ipv4-fia-pkts": "0", "perf-lic-policer-lo-octets": "0", "reass-frag-too-big-octets": "0", "unsupport-linktype-no-route-pkts": "0", "lisp-failed-to-punt-dynmaic-eid-config-pkts": "0", "ipv4-no-adj-pkts": "323", "sdwan-octets": "0", "ipv6-acl-octets": "0", "ipv4-acl-pkts": "0", "firewall-backpressure-octets": "0", "ipsec-input-octets": "6185", "ipv6-adj-drop-pkts": "0", "lookup-oce-unsupport-linktype-octets": "0", "ipv6-no-adj-pkts": "6", "reass-bad-len-octets": "0", "ipv4-null0-pkts": "0", "tcp-badfrag-pkts": "0", "ip-bad-options-pkts": "0", "reass-bad-len-pkts": "0", "reass-no-frags-left-pkts": "0", "reass-timeout-pkts": "0", "ipv4-no-route-octets": "63122", "oce-drop-adj-octets": "0", "sdwan-generic-pkts": "0", "no-gpm-memory-err-octets": "0", "lisp-decap-failed-pkts": "0", "frfab-wred-drop-octets": "0", "ipsec-ted-indicate-octets": "0", "lisp-sfltr-pkts": "0", "tunnel-sec-chk-fail-octets": "0", "pa-walk-err-pkts": "0", "loadbalance-null0-pkts": "0", "hqf-tx-error-octets": "0", "ipv4mc-extra-replicae-octets": "0", "ipv4-martian-pkts": "0", "tcp-octets": "0", "ipv4-pbr-pkts": "0", "ipsec-invalid-sa-octets": "0", "no-mem-octets": "0", "ipv4-adj-drop-octets": "0", "glean-adj-unsupport-linktype-octets": "0", "vdevice-name": "169.254.10.12", "ipv4-martian-octets": "0", "identity-cft-error-pkts": "0", "reass-frag-too-big-pkts": "0", "lisp-disabled-octets": "0", "udp-octets": "0", "multilink-cfg-pkts": "0", "pa-walk-err-octets": "0", "bad-adj-octets": "0", "unconfigured-ipv6-fia-pkts": "51334", "flow-queue-failure-id-octets": "0", "multilink-cfg-octets": "0", "gpm-tx-len-exceed-pkts": "0", "tunnel-decap-too-many-times-pkts": "0", "inv-hdr-err-pkts": "0", "attn-invalid-spid-octets": "0", "tail-drop-octets": "0", "tunnel-bad-gre-checksum-octets": "0", "ipv4mc-ttl-threshold-chk-failed-pkts": "0", "mpass-err-octets": "0", "nat-out2in-octets": "0", "ip-format-err-octets": "0", "firewall-backpressure-pkts": "0", "illegal-obj-pkts": "0", "reass-overlap-octets": "0", "bad-len-octets": "0", "tunnel-misconfiguration-pkts": "0", "reass-too-many-frags-octets": "0", "punt-global-policer-drop-octets": "0", "reass-too-many-frags-pkts": "0", "frr-oce-invalid-state-octets": "0", "invalid-queue-pkts": "0", "ipv4mc-extra-replicae-pkts": "0", "mpls-adj-drop-octets": "0", "bad-uidb-idx-octets": "0", "mpass-err-pkts": "0", "ipv6-truncatedpkts-octets": "0", "lastupdated": 1645693979596, "ip-format-err-pkts": "0", "ipsec-deny-drop-pkts": "0", "invalid-encap-octets": "0", "lookup-oce-should-drop-octets": "0", "lisp-hash-lkup-failed-octets": "0", "unresolved-octets": "0", "ipv4-no-route-pkts": "398", "lisp-failed-to-punt-gsmr-enabled-pkts": "0", "ipv6-null0-pkts": "0", "sdwan-bfd-pkts": "0", "ipv4mc-invalid-replica-record-pkts": "0", "unconfigured-fia-octets": "0", "ext-drop-path-octets": "0", "qos-actions-pkts": "0", "mpass-invalid-fs-vector-pkts": "0", "oce-drop-adj-pkts": "0", "max-tu-octets": "0", "invalid-encap-pkts": "0", "mpls-pkts": "0", "punt-err-pkts": "0", "hqf-tx-error-pkts": "0", "reass-drop-octets": "0", "tail-drop-pkts": "0", "ip-frag-err-octets": "0", "punt-policer-drop-pkts": "0", "mlp-pkts": "0", "max-tu-pkts": "0", "lisp-hash-lkup-failed-pkts": "0", "inv-l2-hdr-pkts": "0", "ipv4-unclassified-octets": "0", "lisp-failed-to-punt-lsb-mismatch-pkts": "0", "nat64-v6tov4-octets": "480", "lisp-failed-to-punt-gsmr-enabled-octets": "0", "sdwan-data-policy-pkts": "0", "bqs-oor-octets": "0", "ipv4-routing-err-pkts": "0", "disabled-pkts": "2590", "cts-format-octets": "0", "bad-len-pkts": "0", "ipv6-routing-err-octets": "0", "illegal-obj-octets": "0", "ipv6-unclassified-octets": "0", "bad-uidb-idx-pkts": 0, "bad-uidb-sub-idx-pkts": "0", "for-us-pkts": "0", "icmp-pkts": "0", "invalid-wred-pkts": "0", "lisp-elig-oce-octets": "0", "bfd-octets": "0", "sdwan-tloc-ext-pkts": "0", "ipv4-acl-lookup-miss-pkts": "0", "reass-no-frag-info-octets": "0", "mpls-adj-drop-pkts": "0", "sdwan-generic-octets": "0", "reass-drop-pkts": "0", "inv-common-preamble-octets": "0", "bad-ip-checksum-octets": "0", "ipv6-acl-lookup-miss-pkts": "0", "reass-no-frag-info-low-pkts": "0", "frr-oce-no-backup-pkts": "0", "ipv6-unclassified-pkts": "0", "mpls-mismatch-linktype-pkts": "0", "wred-pkts": "0", "ipv6-badsource-pkts": "0", "lisp-disabled-pkts": "0", "choice-oce-octets": "0", "ipv6-acl-lookup-miss-octets": "0", "bad-adj-pkts": "0", "min-tu-octets": "0", "nat-out2in-pkts": "0", "unsupport-linktype-null0-octets": "0", "firewall-invalid-zone-pkts": "0", "lisp-failed-to-punt-dynmaic-eid-config-octets": "0", "attn-invalid-spid-pkts": "0", "not-enabled-octets": "0", "fia-error-pkts": "0", "bad-ip-checksum-pkts": "0", "ipsec-ike-indicate-octets": "0", "sdwan-app-route-policy-pkts": "0", "ipv6-toobigpacket-octets": "0", "ipv6-formaterr-octets": "0", "ipv4mc-no-route-pkts": "0", "mpls-frag-req-octets": "0", "vdevice-dataKey": "169.254.10.12-", "lookup-oce-should-drop-pkts": "0", "cts-not-enable-octets": "0", "loadbalance-null0-octets": "0", "frr-oce-invalid-state-pkts": "0", "tcp-pkts": "0", "ipv6-acl-pkts": "0", "nat-in2out-pkts": "0", "ipv6-badhop-pkts": "0", "ipv6-badsource-octets": "0", "inv-hdr-err-octets": "0", "tcp-badfrag-octets": "0", "ipv4-mtr-octets": "0", "ipsec-ted-indicate-pkts": "0", "ipsec-output-octets": "0", "nat66-out2in-octets": "0", "lisp-misconfiguration-octets": "0", "ipsec-output-pkts": "0", "cts-not-enable-pkts": "0", "mlp-octets": "0", "qos-actions-octets": "0", "iphc-octets": "0", "disabled-octets": "403111", "unknown-ext-header-pkts": "0", "mpls-mismatch-linktype-octets": "0", "ipv6-no-adj-octets": "456", "fia-error-octets": "0", "gre-bad-options-octets": "0", "reass-overlap-pkts": "0", "vfr-tail-drop-octets": "0", "sdwan-acl-octets": "0", "ipv4-null0-octets": "0", "unresolved-pkts": "0", "invalid-queue-octets": "0", "sdwan-implicit-acl-octets": "55011", "ipv4-routing-err-octets": "0", "inject-err-pkts": "0", "punt-policer-drop-octets": "0", "reass-no-frag-info-low-octets": "0", "min-tu-pkts": "0", "ipsec-input-pkts": "17", "perf-lic-policer-hi-octets": "0", "mac-acl-lookup-miss-octets": "0", "ipv6-no-route-pkts": "3", "cts-format-pkts": "0", "ipsec-deny-drop-octets": "0", "ip-bad-options-octets": "0", "frag-tail-drop-octets": "0", "frr-oce-no-backup-octets": "0", "internal-ctl-pkts": "0", "flow-queue-failure-id-pkts": "0", "unconfigured-mpls-fia-octets": "0", "ip-ttl-exceeded-octets": "0", "unsupported-oce-pkts": "0", "sdwan-acl-pkts": "0", "no-gpm-memory-err-pkts": "0", "perf-lic-policer-hi-pkts": "0", "nat64-v6tov4-pkts": "6", "unsupport-linktype-null0-pkts": "0", "ipv4mc-ttl-threshold-chk-failed-octets": "0", "glean-adj-unsupport-linktype-pkts": "0", "firewall-l4-insp-pkts": "0", "mpass-invalid-fs-vector-octets": "0", "inv-l2-hdr-octets": "0", "mpls-frag-req-pkts": "0", "internal-ctl-octets": "0", "identity-cft-error-octets": "0", "sdwan-pkts": "0", "reass-no-frag-info-pkts": "0", "mpls-octets": "0", "sdwan-interface-policy-octets": "0", "frag-tail-drop-pkts": "0", "ip-acl-err-octets": "0", "discard-pkts": "0", "sdwan-tunnel-lkup-pkts": "0", "not-enabled-pkts": "0", "choice-oce-pkts": "0", "lookup-oce-unsupport-linktype-pkts": "0", "sdwan-app-route-policy-octets": "0", "lisp-misconfiguration-pkts": "0", "bad-uidb-sub-idx-octets": "0", "reass-timeout-octets": "0", "tunnel-decap-too-many-times-octets": "0", "vdevice-host-name": "vm5", "icmp-octets": "0", "ipv4-adj-drop-pkts": "0", "tunnel-invalid-protocol-pkts": "0", "wred-octets": "0", "lisp-sfltr-octets": "0", "ipv6-no-route-octets": "168", "unconfigured-ipv6-fia-octets": "5564369", "for-us-octets": "0", "vfr-tail-drop-pkts": "0", "frfab-wred-drop-pkts": "0", "ipsec-invalid-sa-pkts": "0", "ipv6-null0-octets": "0", "ipv4-acl-octets": "0", "firewall-nonsession-pkts": "0", "ipsec-tail-drop-pkts": "0", "tunnel-misconfiguration-octets": "0", "bfd-pkts": "0", "ipv4mc-invalid-replica-record-octets": "0", "ip-acl-err-pkts": "0", "ipsec-ike-indicate-pkts": "0", "idle-packet-octets": "0", "unconfigured-ipv4-fia-octets": "0", "ipv6-toobigpacket-pkts": "0", "idle-packet-pkts": "0", "ipv4mc-rpf-failed-pkts": "0", "ip-frag-err-pkts": "0", "sdwan-interface-policy-pkts": "0", "vfr-err-pkts": "0", "unknown-encap-octets": "0", "ipv4mc-no-route-octets": "0", "unsupported-oce-octets": "0", "unconfigured-fia-pkts": "0", "sdwan-tloc-ext-octets": "0", "qos-policing-octets": "0", "sdwan-implicit-acl-pkts": "607", "internal-intf-err-pkts": "0", "firewall-l4-insp-octets": "0", "mac-acl-octets": "0", "no-mem-pkts": "0", "ipv4-mtr-pkts": "0", "internal-intf-err-octets": "0", "invalid-wred-octets": "0", "ipsec-tail-drop-octets": "0", "lisp-elig-oce-pkts": "0", "layer2-no-route-pkts": "0", "ipv6-routing-err-pkts": "0", "ext-drop-path-pkts": "0", "unsupport-linktype-no-route-octets": "0", "mac-acl-lookup-miss-pkts": "0", "ipv4-fpm-pkts": "0", "nat-in2out-octets": "0", "ipv6-adj-drop-octets": "0", "ipv4-no-adj-octets": "20728", "ipv4-fpm-octets": "0", "punt-global-policer-drop-pkts": "0", "ipv4-pbr-octets": "0", "nat66-in2out-octets": "0", "nat66-out2in-pkts": "0", "nat66-in2out-pkts": "0", "ipv6-formaterr-pkts": "0", "vfr-err-octets": "0", "mac-acl-pkts": "0", "ipv6-truncatedpkts-pkts": "0", "tunnel-pkt-sb-missed-pkts": "0", "qos-policing-pkts": "0", "gpm-tx-len-exceed-octets": "0", "layer2-no-route-octets": "0", "perf-lic-policer-lo-pkts": "0", "null-jib-hdr-tbl-pkts": "0", "ipv6-badhop-octets": "0", "udp-pkts": "0", "unknown-encap-pkts": "0", "ipv4-unclassified-pkts": "0", "tunnel-bad-gre-checksum-pkts": "0", "tunnel-invalid-protocol-octets": "0", "reass-no-frags-left-octets": "0", "tunnel-sec-chk-fail-pkts": "0", "ipv4mc-rpf-failed-octets": "0", "lisp-failed-to-punt-lsb-mismatch-octets": "0", "inject-err-octets": "0", "iphc-pkts": "0", "discard-octets": "0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write,System-read,System-write" } }, "/device/sdwan-stats": { "get": { "tags": [ "Real-Time Monitoring - SDWAN Statistics" ], "description": "Get SD-WAN statistics detail from device (Real Time)", "operationId": "getSDWanStats", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "SD-WAN statistics": { "description": "SD-WAN statistics", "value": { "data": [ { "ipv4-acl-out-drop-action-drop": "0", "ipv4-acl-in-drop-action-drop": "0", "ipv6-acl-in-drop-action-drop": "0", "ipv4-acl-in-prior-implicit-acl-disallow-drop": "607", "vdevice-name": "169.254.10.12", "app-route-sla-strict-drop": "0", "data-policy-in-drop-action-drop": "0", "ipv6-acl-in-prior-implicit-acl-disallow-drop": "0", "data-policy-out-drop-action-drop": "0", "vdevice-host-name": "vm5", "ipv4-acl-in-implicit-acl-allow-service-accept": "9484", "ipv4-acl-out-police-exceed-drop": "0", "ipv6-acl-out-police-exceed-drop": "0", "ipv4-acl-in-police-exceed-drop": "0", "ipv6-acl-in-police-exceed-drop": "0", "vdevice-dataKey": "169.254.10.12-", "ipv6-acl-out-drop-action-drop": "0", "ipv6-acl-in-implicit-acl-allow-service-accept": "0", "lastupdated": 1645691843259, "data-policy-in-set-remote-tloc-fail-drop": "0", "app-route-matched-none-drop": "0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write,System-read,System-write" } }, "/device/security/information": { "get": { "tags": [ "Real-Time Monitoring - Security" ], "description": "Get security information from devices", "operationId": "createSessionList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Security information": { "description": "Security information", "value": { "data": [ { "authentication-type": "deprecated", "replay-window": "512", "rekey": "86400", "lastupdated": 1642754840126, "vdevice-dataKey": "169.254.10.12", "vdevice-host-name": "vm5", "fips-mode": "Disabled", "vdevice-name": "169.254.10.12" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/sfp/detail": { "get": { "tags": [ "Real-Time Monitoring - SFP" ], "description": "Get SFP detail", "operationId": "getDetail", "parameters": [ { "name": "ifname", "in": "query", "description": "IF Name", "schema": { "type": "string", "enum": [ "ge0/0", "ge0/1", "ge0/2", "ge0/3", "ge0/4", "ge0/5", "ge0/6", "ge0/7", "system", "eth0" ] } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Serial interface": { "description": "Serial interface", "value": { "data": [ { "vdevice-dataKey": "169.254.10.10-ge0/0", "vdevice-name": "169.254.10.10", "ifname": "ge0/0", "lastupdated": 1643091761770, "present": "No", "vdevice-host-name": "vm3" }, { "vdevice-dataKey": "169.254.10.10-ge0/1", "vdevice-name": "169.254.10.10", "ifname": "ge0/1", "lastupdated": 1643091761770, "present": "No", "vdevice-host-name": "vm3" }, { "vdevice-dataKey": "169.254.10.10-ge0/2", "vdevice-name": "169.254.10.10", "ifname": "ge0/2", "lastupdated": 1643091761770, "present": "No", "vdevice-host-name": "vm3" }, { "vdevice-dataKey": "169.254.10.10-ge0/3", "vdevice-name": "169.254.10.10", "ifname": "ge0/3", "lastupdated": 1643091761770, "present": "No", "vdevice-host-name": "vm3" }, { "vdevice-dataKey": "169.254.10.10-ge0/4", "vdevice-name": "169.254.10.10", "ifname": "ge0/4", "lastupdated": 1643091761770, "present": "No", "vdevice-host-name": "vm3" }, { "vdevice-dataKey": "169.254.10.10-ge0/5", "vdevice-name": "169.254.10.10", "ifname": "ge0/5", "lastupdated": 1643091761770, "present": "No", "vdevice-host-name": "vm3" }, { "vdevice-dataKey": "169.254.10.10-ge0/6", "vdevice-name": "169.254.10.10", "ifname": "ge0/6", "lastupdated": 1643091761770, "present": "No", "vdevice-host-name": "vm3" }, { "vdevice-dataKey": "169.254.10.10-ge0/7", "vdevice-name": "169.254.10.10", "ifname": "ge0/7", "lastupdated": 1643091761770, "present": "No", "vdevice-host-name": "vm3" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/sfp/diagnostic": { "get": { "tags": [ "Real-Time Monitoring - SFP" ], "description": "Get SFP diagnostic", "operationId": "getDiagnostic", "parameters": [ { "name": "ifname", "in": "query", "description": "IF Name", "schema": { "type": "string", "enum": [ "ge0/0", "ge0/1", "ge0/2", "ge0/3", "ge0/4", "ge0/5", "ge0/6", "ge0/7", "system", "eth0" ] } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Serial interface": { "description": "Serial interface", "value": { "data": [ { "vdevice-dataKey": "169.254.10.10-ge0/0", "vdevice-name": "169.254.10.10", "ifname": "ge0/0", "lastupdated": 1643093876343, "present": "No", "vdevice-host-name": "vm3" }, { "vdevice-dataKey": "169.254.10.10-ge0/1", "vdevice-name": "169.254.10.10", "ifname": "ge0/1", "lastupdated": 1643093876343, "present": "No", "vdevice-host-name": "vm3" }, { "vdevice-dataKey": "169.254.10.10-ge0/2", "vdevice-name": "169.254.10.10", "ifname": "ge0/2", "lastupdated": 1643093876343, "present": "No", "vdevice-host-name": "vm3" }, { "vdevice-dataKey": "169.254.10.10-ge0/3", "vdevice-name": "169.254.10.10", "ifname": "ge0/3", "lastupdated": 1643093876343, "present": "No", "vdevice-host-name": "vm3" }, { "vdevice-dataKey": "169.254.10.10-ge0/4", "vdevice-name": "169.254.10.10", "ifname": "ge0/4", "lastupdated": 1643093876343, "present": "No", "vdevice-host-name": "vm3" }, { "vdevice-dataKey": "169.254.10.10-ge0/5", "vdevice-name": "169.254.10.10", "ifname": "ge0/5", "lastupdated": 1643093876343, "present": "No", "vdevice-host-name": "vm3" }, { "vdevice-dataKey": "169.254.10.10-ge0/6", "vdevice-name": "169.254.10.10", "ifname": "ge0/6", "lastupdated": 1643093876343, "present": "No", "vdevice-host-name": "vm3" }, { "vdevice-dataKey": "169.254.10.10-ge0/7", "vdevice-name": "169.254.10.10", "ifname": "ge0/7", "lastupdated": 1643093876343, "present": "No", "vdevice-host-name": "vm3" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/sfp/diagnosticMeasurementAlarm": { "get": { "tags": [ "Real-Time Monitoring - SFP" ], "description": "Get SFP diagnostic measurement alarm", "operationId": "getDiagnosticMeasurementAlarm", "parameters": [ { "name": "ifname", "in": "query", "description": "IF Name", "schema": { "type": "string", "enum": [ "ge0/0", "ge0/1", "ge0/2", "ge0/3", "ge0/4", "ge0/5", "ge0/6", "ge0/7", "system", "eth0" ] } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Serial interface": { "description": "Serial interface", "value": { "data": [ { "vdevice-name": "169.254.10.10", "vdevice-host-name": "vm1", "ifname": "ge0/3", "measurement": "Rx power", "low-alarm-alarm": "Y", "low-warning-alarm": "Y", "high-warning-alarm": "N", "high-alarm-alarm": "N", "lastupdated": 1661322671947, "vdevice-dataKey": "169.254.10.10-ge0/3" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/sfp/diagnosticMeasurementValue": { "get": { "tags": [ "Real-Time Monitoring - SFP" ], "description": "Get SFP diagnostic measurement value", "operationId": "getDiagnosticMeasurementValue", "parameters": [ { "name": "ifname", "in": "query", "description": "IF Name", "schema": { "type": "string", "enum": [ "ge0/0", "ge0/1", "ge0/2", "ge0/3", "ge0/4", "ge0/5", "ge0/6", "ge0/7", "system", "eth0" ] } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Serial interface": { "description": "Serial interface", "value": { "data": [ { "vdevice-name": "169.254.10.10", "vdevice-host-name": "vm1", "ifname": "ge0/3", "measurement": "Rx power", "unit-value": "mW", "low-alarm-value": "0.010", "low-warning-value": "0.016", "high-warning-value": "1.585", "high-alarm-value": "1.778", "current-value": "0.000", "lastupdated": 1661324101365, "vdevice-dataKey": "169.254.10.10-ge0/3" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/sig/getSigTunnelList": { "get": { "tags": [ "Real-Time Monitoring - SIG" ], "description": "get Sig TunnelList", "operationId": "getSigTunnelList_RealTimeMonitoringSig_2803", "parameters": [ { "name": "pageSize", "in": "query", "description": "Page Size", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Page offset", "schema": { "type": "string" } }, { "name": "lastNHours", "in": "query", "description": "last n hours", "schema": { "type": "string" } }, { "name": "site-id", "in": "query", "description": "Optional site ID to filter devices", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Sig Zscaler tunnels": { "description": "Sig Zscaler tunnels", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write,Security-read,Security-write" } }, "/device/sig/getSigTunnelTotal": { "get": { "tags": [ "Real-Time Monitoring - SIG" ], "description": "get Sig Tunnel Total coount", "operationId": "getSigTunnelTotal", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Sig Zscaler tunnels": { "description": "Sig Zscaler tunnels", "value": { "count": "0" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write,Security-read,Security-write" } }, "/device/sig/tunnelDashboard": { "get": { "tags": [ "Real-Time Monitoring - SIG" ], "description": "Get SIG Zscaler tunnels from device", "operationId": "tunnelDashboard", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Sig Zscaler tunnels": { "description": "Sig Zscaler tunnels", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write,Security-read,Security-write" } }, "/device/sig/umbrella/tunnels": { "get": { "tags": [ "Real-Time Monitoring - SIG" ], "description": "Get SIG Umbrella tunnels from device", "operationId": "getSigUmbrellaTunnels", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Sig Umbrella tunnels": { "description": "Sig Umbrella tunnels", "value": [ { "lastupdated": 1649242617635, "tunnel-if-name": "Tunnel100512", "tunnel-id": "94075", "tunnel-name": "128.107.85.118", "tunnel-state": "active", "fsm-state": "fsm-state", "http-resp-code": "200", "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "last-http-req": "activate-req", "vdevice-dataKey": "172.16.255.15" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write,Security-read,Security-write" } }, "/device/sig/zscaler/tunnels": { "get": { "tags": [ "Real-Time Monitoring - SIG" ], "description": "Get SIG Zscaler tunnels from device", "operationId": "getSigZscalerTunnels", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Sig Zscaler tunnels": { "description": "Sig Zscaler tunnels", "value": [ { "tunnel-if-name": "Tunnel100512", "tunnel-fsm-state": "gre-add-tunnel", "vdevice-name": "172.16.255.15", "fqdn": "n/a", "vdevice-host-name": "vm5", "tunnel-id": "94075", "last-http-req": "activate-req", "vdevice-dataKey": "172.16.255.15", "http-resp-code": "200", "tunnel-name": "128.107.85.118", "location-id": "43551040", "lastupdated": 1649242617635, "location-fsm-state": "location-init-state" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write,Security-read,Security-write" } }, "/device/smu": { "get": { "tags": [ "Real-Time Monitoring - Software" ], "description": "Get software list from device", "operationId": "createSmuList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Software list": { "description": "Software list", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "smu-compatible-with": "16.6.1.0", "package-state": "Not Installed", "defect": "CSCxxXXXXX", "smu-type": "reload", "lastupdated": 1661330128299, "vdevice-dataKey": "172.16.254.15" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/smu/synced": { "get": { "tags": [ "Real-Time Monitoring - Software" ], "description": "Get software list from device synchronously", "operationId": "createSyncedSmuList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Software list": { "description": "Software list", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "smu-compatible-with": "16.6.1.0", "package-state": "Not Installed", "defect": "CSCxxXXXXX", "smu-type": "reload", "lastupdated": 1661330128299, "vdevice-dataKey": "172.16.254.15" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/software": { "get": { "tags": [ "Real-Time Monitoring - Software" ], "description": "Get software list from device", "operationId": "getAAAUcreateSoftwareListsers", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Software list": { "description": "Software list", "value": { "data": [ { "default": "true", "vdevice-dataKey": "169.254.10.10-20.6.2-432", "software": true, "vdevice-name": "169.254.10.10", "active": "true", "lastupdated": 1643356263821, "version": "20.6.2-432", "vdevice-host-name": "vm3" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/software/synced": { "get": { "tags": [ "Real-Time Monitoring - Software" ], "description": "Get software list from device synchronously", "operationId": "createSyncedSoftwareList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Software list": { "description": "Software list", "value": { "data": [ { "vdevice-name": "172.16.255.11", "software": true, "createTimeStamp": 1647315989838, "active": "true", "version": "20.9.999-1787", "vdevice-host-name": "vm1", "default": "true", "vdevice-dataKey": "172.16.255.11-20.9.999-1787", "@rid": 1084, "vmanage-system-ip": "172.16.255.11", "lastupdated": 1647315989833 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/sse/tunnels": { "get": { "tags": [ "Real-Time Monitoring - SSE" ], "description": "Get SSE tunnels from device", "operationId": "getSSETunnel", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Sig SSE tunnels": { "description": "Sig SSE tunnels", "value": [ { "lastupdated": 1649242617635, "tunnel-if-name": "Tunnel100512", "tunnel-id": "94075", "tunnel-name": "128.107.85.118", "tunnel-state": "active", "fsm-state": "fsm-state", "http-resp-code": "200", "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "last-http-req": "activate-req", "vdevice-dataKey": "172.16.255.15" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write,Security-read,Security-write" } }, "/device/sslproxy/statistics": { "get": { "tags": [ "Real-Time Monitoring - Sslproxy" ], "description": "Get ssl proxy statistics from device", "operationId": "getSslProxyStatistics", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Ssl proxy statistics": { "description": "Ssl proxy statistics", "value": { "data": [ { "exception": "0", "app-ocsp-req-int-error": "0", "decrypt-fail-mode": "0", "ps-pkt-rec-from-client": "0", "tot-client-cert-val-req": "0", "c2s-fin-rec-from-sc": "0", "tot-req-tls1-1-flows": "0", "ocsp-stap-unknown-resp": "0", "tot-failed-renego": "0", "s2c-fin-rec": "0", "pc-pkt-rec-from-server": "0", "s2c-cn-rec": "0", "c2s-fin-rec": "0", "tot-client-cert-untrusted": "0", "c2s-cn-rec-from-sc": "0", "s2c-cn-rec-from-sc": "0", "tot-ssl-renego": "0", "s2c-fin-rec-from-sc": "0", "drop-mempool-get-fail": "0", "drop-load-key-packet-fail": "0", "nodecrypt-unsup-cipher": "0", "max-conc-non-proxied-conn": "0", "pc-clr-pkt-rec-from-sc": "0", "c2s-rst-generated": "0", "pc-pkt-sent-to-server": "0", "che-bypass": "0", "s2c-rst-rec": "0", "c2s-rst-rec": "0", "che-pushdown": "0", "client-ocsp-res": "0", "ocsp-stap-reqs": "0", "tot-server-cert-untrusted": "0", "alert-genrtd-c2s": "0", "vdevice-name": "169.254.10.12", "alert-genrtd-s2c": "0", "pc-rst-rec-from-sc": "0", "c2s-cn-sent-to-sc": "0", "lwssl-send-msg-toism-fail": "0", "c2s-rst-rec-from-sc": "0", "c2s-fin-sent": "0", "ps-clr-pkt-to-client": "0", "s2c-rst-rec-from-sc": "0", "client-ocsp-reqs": "0", "tot-ssl-resump-ses-tkt": "0", "s2c-rst-sent": "0", "drop-null-ch-buf": "0", "non-proxied-conn": "0", "hs-unsupported": "0", "app-ocsp-good": "0", "s2c-fin-rec-during-hs": "0", "drop-inv-evt-in-fsm-state": "0", "drop-unable-to-get-pr-cert": "0", "lastupdated": 1645776582193, "ism-sem-post-failed": "0", "s2c-fin-rec-after-hs": "0", "app-ocsp-res": "0", "c2s-rst-sent-to-sc": "0", "s2c-rst-sent-to-sc": "0", "app-ocsp-unknown": "0", "c2s-cn-rec": "0", "ism-flow-create-fail": "0", "c2s-cn-sent": "0", "s2c-cn-sent": "0", "ps-clr-pkt-rec-from-sc": "0", "tot-client-cert-val-succes": "0", "pc-pkt-rec-from-sc": "0", "rm-session-alloc-success": "0", "unsup-ssl-version": "0", "ps-pkt-sent-to-sc": "0", "alert-recvd-c2s": "0", "alert-recvd-s2c": "0", "endpoint-alert": "0", "mem-alloc-fail": "0", "ocsp-stap-valid-resp": "0", "client-ocsp-revoked": "0", "min-tls-version": "0", "ssl-parse-failure": "0", "s2c-fin-rec-non-ssl": "0", "ism-flow-create": "0", "rm-session-alloc-failures": "0", "ps-lwssl-flow-delete": "0", "drop-ssl-parse-abort": "0", "drop-unsup-prot-vers": "0", "tot-select-tls1-1-flows": "0", "client-ocsp-failures": "0", "pc-clr-pkt-rec-from-server": "0", "pc-clr-pkt-sent-to-sc": "0", "c2s-pkt-drop-deny-verdict": "0", "decrypt-untrusted-cert": "0", "peer-pd": "0", "tot-server-cert-expired": "0", "vdevice-dataKey": "169.254.10.12", "pc-fin-rec-from-sc": "0", "drop-untrusted-cert": "0", "ocsp-stap-resp": "0", "tcp-close-before-hs": "0", "nodecrypt-unsup-prot-vers": "0", "c2s-fin-rec-non-ssl": "0", "tot-select-tls1-0-flows": "0", "s2c-pkt-drop-deny-verdict": "0", "c2s-fin-sent-to-sc": "0", "s2c-fin-sent-to-sc": "0", "client-ocsp-req-int-error": "0", "client-ocsp-unknown": "0", "app-ocsp-timeout": "0", "tot-full-ssl-hs": "0", "rm-session-free-success": "0", "tot-req-sslv2-flows": "0", "ps-cn-sent": "0", "tot-ssl-hs-completed": "0", "ps-clr-pkt-sent-to-sc": "0", "ism-flow-delete": "0", "tot-client-cert-expired": "0", "drop-unknown-status": "0", "clear-conn": "0", "active-non-proxied-conn": "0", "pc-lwssl-flow-create": "0", "che-process": "0", "client-ocsp-good": "0", "tot-select-tls1-2-flows": "0", "tot-ssl-hs-started": "0", "drop-mem-access-issue": "0", "app-ocsp-failures": "0", "unknown-reasons": "0", "tot-ssl-resump-ses-id": "0", "app-ocsp-reqs": "0", "tot-conn": "0", "drop-null-ssl-rec": "0", "drop-ocsp-cert-verify-fail": "0", "drop-de-handle-data-fail": "0", "ism-fifo-enqueue-failed": "0", "unsup-cipher": "0", "drop-fail-mode": "0", "drop-invalid-fsm-evt": "0", "drop-invalid-fs-type": "0", "pc-fs-mem-alloc-fail": "0", "error-state": "0", "tot-server-cert-val-req": "0", "vdevice-host-name": "vm5", "s2c-cn-sent-to-sc": "0", "drop-invalid-ssl-rec": "0", "ps-clr-pkt-rec-from-client": "0", "pc-lwssl-flow-delete": "0", "tot-server-cert-val-succes": "0", "c2s-fin-rec-during-hs": "0", "drop-ism-flow-create-fail": "0", "pc-cn-sent": "0", "ps-lwssl-flow-create": "0", "c2s-fin-rec-after-hs": "0", "drop-expired-cert": "0", "drop-key-pkt-snd-fail": "0", "proxied-conn": "0", "drop-other-side-key-pend": "0", "active-proxied-conn": "0", "max-conc-proxied-conn": "0", "mem-access-issue": "0", "unexpected-packet": "0", "tot-ssl-resump": "0", "ssl-error": "0", "decrypt-exp-cert": "0", "ps-pkt-sent-to-client": "0", "rm-session-free-failures": "0", "pc-clr-pkt-to-server": "0", "drop-send-ism-hs-msg-fail": "0", "ocsp-stap-revoked-resp": "0", "client-ocsp-timeout": "0", "ps-fin-rec-from-sc": "0", "tot-req-sslv3-flows": "0", "drop-invalid-msg-type": "0", "che-strip": "0", "active-clear-conn": "0", "non-ssl-traffic": "0", "drop-hs-unsupported": "0", "max-conc-clear-conn": "0", "ps-fs-mem-alloc-fail": "0", "tot-req-tls1-0-flows": "0", "pc-pkt-sent-to-sc": "0", "s2c-rst-generated": "0", "drop-unsup-cipher": "0", "ocsp-stap-resp-val-fail": "0", "tot-req-tls1-3-flows": "0", "decrypt-unknown-status": "0", "app-ocsp-revoked": "0", "s2c-fin-sent": "0", "tot-ssl-fb-full-hs": "0", "drop-exp-cert": "0", "drop-tcp-close-before-hs": "0", "ps-pkt-rec-from-sc": "0", "ism-msg-mem-alloc-failed": "0", "tot-req-tls1-2-flows": "0", "drop-endpoint-alert": "0", "drop-mem-alloc-fail": "0", "tot-closed-conn": "0", "c2s-rst-sent": "0", "drop-nop-read-fn": "0", "ps-rst-rec-from-sc": "0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/sslproxy/status": { "get": { "tags": [ "Real-Time Monitoring - Sslproxy" ], "description": "Get ssl proxy status from device", "operationId": "getSslProxyStatus", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Ssl proxy status": { "description": "Ssl proxy status", "value": { "data": [ { "failure-mode": "failure-mode-action-close", "minimum-tls-version": "tls-ver-1", "vdevice-name": "169.254.10.12", "cert-lifetime-in-days": "730", "unsup-cipher-suite": "unsup-mode-action-drop", "expired-cert": "cert-valid-action-decrypt", "untrusted-cert": "cert-valid-action-decrypt", "ca-tp-label": "PROXY-SIGNING-CA", "unknown-status": "cert-valid-action-drop", "rsa-key-mod": "2048", "clear-mode": "false", "vdevice-host-name": "vm5", "ec-key-type": "ec-key-p256", "cert-revocation": "cert-rev-none", "vdevice-dataKey": "169.254.10.12", "ca-cert-bundle": "/bootflash/vmanage-admin/sslProxyDefaultCAbundle.pem", "lastupdated": 1645776060286, "unsup-protocol-version": "unsup-mode-action-drop" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/staticRouteTracker": { "get": { "tags": [ "Real-Time Monitoring - Static Route Tracker Service" ], "description": "Get single static route tracker info from device", "operationId": "getStaticRouteTrackerInfo", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Static route tracker info": { "description": "Static route tracker info", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/stats": { "get": { "tags": [ "Monitoring - Device Details" ], "description": "Get stats queue information", "operationId": "getStatsQueues", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Queue status": { "description": "Queue status", "value": { "ProcessQueue-0": { "syncing": [], "queued": [], "stuck": {} } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/status": { "get": { "tags": [ "Monitoring - Device Details" ], "description": "Get devices status for vSmart,vBond,vEdge, and cEdge", "operationId": "getAllDeviceStatus", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Device status list": { "description": "Device status list", "value": { "header": { "generatedOn": 1635236849570 }, "data": [ { "type": "vSmart", "name": "vSmart", "image": "images/vsmart.png", "count": 3, "detailView": "dialog", "detailsURL": "/dataservice/device?personality=vsmart", "statusList": [ { "status": "error", "name": "Error", "detailView": "dialog", "detailsURL": "/dataservice/device?personality=vsmart&status=error", "color": "fa7c7d", "icon": "images/device/device-error.png", "count": 0 }, { "status": "warning", "name": "Warning", "detailView": "dialog", "detailsURL": "/dataservice/device?personality=vsmart&status=warning", "color": "f2ce60", "icon": "images/device/device-warning.png", "count": 0 }, { "status": "normal", "name": "Normal", "detailView": "dialog", "detailsURL": "/dataservice/device?personality=vsmart&status=normal", "color": "b0e276", "icon": "images/device/device-normal.png", "count": 3 }, { "status": "new", "name": "Discovered device", "detailView": "dialog", "detailsURL": "/dataservice/device?personality=vsmart&status=new", "color": "7c8afa", "icon": "images/device/device-new.png", "count": 0 } ] } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/sxpConnections": { "get": { "tags": [ "Real-Time Monitoring - Trustsec" ], "description": "get Cisco TrustSec SXP Connections information from device", "operationId": "getSxpConnections", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "TrustSec SXP Connections information": { "description": "TrustSec SXP Connections information", "value": { "data": [ { "listener-duration": "23", "vdevice-dataKey": "172.16.255.15-vm5-10.1.16.116-Default", "vdevice-name": "172.16.255.15", "source-ip": "10.1.15.15", "listener-state": "state-off", "peer-ip": "10.1.16.116", "vrf-name": "Default", "lastupdated": 1652319406421, "speaker-state": "state-off", "vdevice-host-name": "vm5", "local-mode": "con-mode-both", "speaker-duration": "35008" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write" } }, "/device/sync_status": { "get": { "tags": [ "Monitoring - Device Details" ], "description": "Get list of currently syncing devices", "operationId": "listCurrentlySyncingDevices", "parameters": [ { "name": "groupId", "in": "query", "description": "Group Id", "required": true, "schema": { "type": "string", "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "List of currently syncing devices": { "description": "List of currently syncing devices", "value": { "header": { "generatedOn": 1635237704919 }, "data": [ { "name": "vedge-C8500-12X4QC", "templateClass": "cedge", "displayName": "C8500-12X4QC", "deviceType": "vedge", "isCliSupported": true, "templateSupported": true, "deviceClass": "cisco-router", "cpuCountAttribute": { "enable": true, "attributeField": "total_cpu_count" }, "interfaces": { "wan": [ "GigabitEthernet", "TenGigabitEthernet", "Loopback" ], "lan": [ "GigabitEthernet", "TenGigabitEthernet", "Loopback" ], "mgmt": [ "GigabitEthernet", "TenGigabitEthernet", "Loopback" ], "day0": [ "GigabitEthernet0/0/0" ] }, "onboardCert": true } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/syncall/memorydb": { "post": { "tags": [ "Monitoring - Device Details" ], "description": "Synchronize memory database for all devices", "operationId": "syncAllDevicesMemDB", "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/system/clock": { "get": { "tags": [ "Real-Time Monitoring - System" ], "description": "Get device system clock", "operationId": "getDeviceSystemClock", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device system clock": { "description": "Device system clock", "value": { "data": [ { "current_date/date-time-string": "Tue Mar 15 16:46:40 UTC 2022" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/system/info": { "get": { "tags": [ "Real-Time Monitoring - System" ], "description": "Get device information list", "operationId": "createDeviceInfoList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "array", "description": "List of device IPs", "example": [ "169.254.10.10", "169.254.10.11" ], "items": { "type": "string", "description": "Device IP", "example": "169.254.10.10" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device info": { "description": "Device info", "value": { "data": [ { "device-model": "vedge-cloud", "statusOrder": 4, "total_cpu_count": "2", "max-controllers": "0", "groupId": [ "none" ], "certificate-not-valid-before": "Jan 29 00:19:35 2022 GMT", "fp_cpu_count": "1", "deviceId": "169.254.10.10", "uuid": "bc2a78ac-a06e-40fd-b2b7-1b1e062f3f9e", "syncScheduled": 1644759037120, "chassis-serial-number": "None", "cpuLoad": 1.46, "state_description": "All daemons up", "vsmart-list-version": "9223372036854775807", "vbond": "10.103.135.135", "ompPeersUp": 2, "syncQueued": 1644759037119, "isDeviceGeoData": false, "device-type": "vedge", "state": "green", "firmwareVersion": "---", "organization-name": "vIPtela Inc Regression-Apple Inc", "longitude": "-122.777023", "syncCompleted": 1644759039647, "domain-id": "1", "downloadedServices": [], "availableServices": [], "expectedControlConnections": 2, "memUsageDisplay": "24.1", "model_sku": "None", "sp-organization-name": "vIPtela Inc Regression", "version": "20.6.2-440", "firmwareAvailablePackages": [], "layoutLevel": 4, "bootloader_version": "Not applicable", "fips_mode": "enabled", "name": "169.254.10.10", "controlConnectionsUp": 3, "controlConnectionsToVsmarts": "2", "number-vbond-peers": "1", "defaultVersion": "20.6.2-440", "status": "normal", "ompPeers": "2", "memState": "normal", "chassis-number": "bc2a78ac-a06e-40fd-b2b7-1b1e062f3f9e", "board_type": "Sim", "device-os": "next", "local-system-ip": "172.16.254.2", "timezone": "UTC", "latitude": "37.666684", "system-ip": "169.254.10.10", "site-id": "3", "certificate-not-valid-after": "Jan 29 00:19:35 2023 GMT", "downloadedImages": [], "platform": "x86_64", "hardwareState": "normal", "board-serial": "12345708", "@rid": 2493, "personality": "vedge", "memUsage": 24.1, "lastDataSyncTime": 1644801887955, "certificate-status": "Installed", "reachability": "reachable", "controlConnections": "3", "linux_cpu_count": "1", "controlConnectionsDown": 0, "availableVersions": [], "number-vsmart-peers": 2, "connectedVManages": [ "169.254.10.3" ], "testbed_mode": true, "syncState": "Completed", "firmwareAvailableVersions": [], "host-name": "vm3", "bfdSessionsDown": 0, "tcpd_cpu_count": "0", "uptime": "15 days 13 hrs 52 min 15 sec", "token": "Invalid", "cpuLoadDisplay": "1.46", "certificate-validity": "Valid", "cpuState": "normal", "number-vsmart-control-connections": 2, "vmanage-system-ip": "169.254.10.10", "ompPeersDown": 0, "bfdSessions": "5", "tenantId": "c2c6093d-a33c-400a-90e8-1f549fe7a12c", "vmanageConnectionState": "connected", "build_number": "440", "lastupdated": 1644759039485, "device-category": "vedge", "device-groups": [ "No groups" ], "hasGeoData": true, "uptime-date": 1643413080000, "isMultiStepUpgradeSupported": false, "bfdSessionsUp": 5 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/system/statistics": { "get": { "tags": [ "Real-Time Monitoring - System" ], "description": "Get device system stats list (Real Time)", "operationId": "createDeviceSystemStatsList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device system stats": { "description": "Device system stats", "value": { "data": [ { "tx_gre_pkts": 132344, "tx_arp_replies": 1700, "rx_icmp_port_unreach": 303, "rx_window_drops_tc6": 0, "rx_window_drops_tc7": 0, "tx_arp_reqs": 43535, "rx_window_drops_tc4": 0, "rx_window_drops_tc5": 0, "pko_wred_drops": 0, "rx_window_drops_tc2": 0, "rx_window_drops_tc3": 0, "rx_window_drops_tc0": 0, "rx_window_drops_tc1": 0, "bfd_rx_non_ip": 0, "ip_fwd_mcast_invalid_iif": 0, "route_to_host": 0, "tx_pkts": 55508251, "arp_add_fail": 51, "tx_ipsec_policer_drops": 0, "tx_fragment_drops": 0, "ip_fwd_from_cpu_non_local": 0, "ip_fwd_null_mcast_group": 0, "buf_alloc_fails": 0, "fragment_df_drops": 0, "rx_drops": 0, "tx_fragment_fail": 0, "bfd_lkup_fail": 0, "rx_icmp_network_unreach": 9, "vdevice-name": "169.254.10.10", "tx_icmp_fragment_required": 0, "cflowd_pkts": 0, "tx_fragment_alloc_fail": 0, "rx_replay_integrity_drops_tc3": 0, "rx_replay_integrity_drops_tc4": 0, "rx_replay_integrity_drops_tc5": 0, "rx_sa_ipsec_drops": 0, "rx_replay_integrity_drops_tc6": 0, "openssl_aes_encrypt": 0, "rx_replay_integrity_drops_tc7": 0, "to_cpu_policer_drops": 3173, "rx_icmp_redirect": 0, "tx_no_tunn_pre_ipsec_drops": 0, "tx_icmp_src_quench": 0, "rx_icmp_ttl_expired": 0, "rx_replay_integrity_drops_tc0": 1, "rx_replay_integrity_drops_tc1": 0, "rx_arp_reqs": 1333, "rx_replay_integrity_drops_tc2": 0, "tx_icmp_ttl_expired": 0, "ip_fwd_mirror_pkts": 0, "rx_non_ip_drops": 1469202, "rx_icmp_bad_ip_hdr": 0, "tx_ip6_ipsec_drops": 0, "nat_xlate_outbound_drops": 0, "rx_err_pad_ipsec_drops": 0, "rx_pre_ipsec_pkts": 0, "lastupdated": 1644814365917, "tx_icmp_policer_drops": 0, "mirror_drops": 0, "rx_ipsec_bad_inner": 0, "rx_ip_errs": 0, "ip_fwd_null_nhop": 132344, "tx_bcast": 2353, "bfd_rx_parse_err": 0, "rx_bcast": 185, "rx_icmp_echo_requests": 0, "tx_if_not_preferred": 1197705, "tx_icmp_dst_unreach_other": 0, "rx_invalid_port": 0, "split_horizon_drops": 0, "rx_icmp_other_types": 5458, "rx_arp_replies": 43098, "tx_no_out_sa_pre_ipsec_drops": 0, "invalid_back_ptr": 0, "rx_pkts": 31444972, "rx_invalid_qtags": 244, "ip_fwd_to_cpu_nat_drops": 0, "tx_gre_drops": 0, "rx_icmp_src_quench": 0, "rx_gre_policer_drops": 0, "cbf_discards": 0, "tx_gre_policer_drops": 0, "rx_arp_non_local_drops": 161199, "ip_fwd_unknown_nh_type": 0, "tx_arp_req_fail": 0, "tx_icmp_echo_requests": 486552, "ip_fwd_to_egress": 22866794, "tx_ipsec_encap": 16205725, "rx_tunneled_pkts": 0, "bfd_tx_record_changed": 374, "rx_mcast_mirror_fwd_drops": 0, "rx_unexpected_replay_drops_tc1": 0, "rx_unexpected_replay_drops_tc2": 0, "rx_unexpected_replay_drops_tc3": 0, "rx_invalid_ipsec_pkt_size": 0, "rx_unexpected_replay_drops_tc4": 0, "ip_disabled_tx": 0, "rx_unexpected_replay_drops_tc0": 0, "rx_ipsec_policer_drops": 0, "rx_unexpected_replay_drops_tc5": 0, "rx_unexpected_replay_drops_tc6": 0, "rx_unexpected_replay_drops_tc7": 0, "rx_replay_drops_tc7": 0, "rx_replay_drops_tc5": 0, "ip_fwd_to_cpu_nat_xlates": 0, "rx_replay_drops_tc6": 0, "vdevice-dataKey": "169.254.10.10", "rx_replay_drops_tc3": 0, "rx_replay_drops_tc4": 0, "rx_replay_drops_tc1": 0, "rx_ipsec_decap": 16201636, "rx_replay_drops_tc2": 0, "rx_spi_ipsec_drops": 0, "rx_replay_drops_tc0": 0, "rx_host_mirror_drops": 0, "rx_gre_drops": 0, "ip_fwd_nat_on_tunnel": 0, "rx_cp_non_local": 0, "ip_fwd_to_cpu": 6893414, "bfd_rx_record_invalid": 0, "no_nat_nexthop": 0, "tx_fragment_needed": 0, "ip_fwd_mcast_life_exceeded_drops": 0, "rx_pre_ipsec_decap": 0, "ip_fwd": 46077192, "rx_unexpected_replay_drops": 0, "bfd_rec_down": 0, "tunnel_pmtu_lowered": 0, "filter_drops": 0, "rx_icmp_protocol_unreach": 0, "tx_queue_exceeded": 0, "nat_xlate_inbound_fail": 0, "tx_icmp_bad_ip_hdr": 0, "nat_xlate_inbound": 0, "rx_arp_rate_limit_drops": 0, "bfd_rec_invalid": 1, "rx_implicit_acl_drops": 869, "ip_disabled_rx": 0, "rx_mac_compare_ipsec_drops": 0, "tx_ipsec_pkts": 16205725, "rx_mcast_threshold_exceeded": 0, "bfd_timer_add_fail": 0, "openssl_aes_decrypt": 0, "nat_xlate_outbound": 0, "tx_ipsec_mcast_encap": 0, "rx_gre_decap": 0, "tx_errors": 0, "bfd_tx_pkts": 16142569, "service_label_fwd": 0, "unknown_nh_type": 0, "rx_mcast_policy_fwd_drops": 0, "rx_pre_ipsec_drops": 0, "tx_icmp_host_unreach": 0, "vdevice-host-name": "vm3", "rx_icmp_host_unreach": 0, "rx_icmp_dst_unreach_other": 0, "tx_icmp_redirect": 0, "rx_mcast_link_local": 17935, "rx_host_local_pkt": 0, "tx_fragments": 0, "tx_icmp_port_unreach": 50, "icmp_redirect": 0, "rx_mcast": 18682, "tx_mcast": 55760, "tx_mcast_fragment_needed": 0, "rx_replay_integrity_drops": 1, "rx_mcast_filter_to_cpu": 0, "ip_fwd_rx_gre": 0, "tx_icmp_protocol_unreach": 0, "port_disabled_rx": 9018, "ttl_expired": 0, "tx_gre_encap": 132344, "bfd_rx_pkts": 16138479, "ip_fwd_arp": 1187, "tx_icmp_network_unreach": 0, "ip_fwd_invalid_tun_oil": 0, "ip_fwd_rx_ipsec": 16202760, "tx_icmp_other_types": 654, "rx_no_tun_if": 0, "app_route_policy_discards": 0, "tx_no_out_sa_ipsec_drops": 0, "rx_bad_label": 0, "tx_pre_ipsec_pkts": 16205725, "rx_mcast_filter_to_cpu_and_fwd": 0, "tx_pre_ipsec_policer_drops": 0, "rx_next_hdr_ipsec_drops": 0, "bfd_tx_fail": 0, "rx_ip6_ipsec_drops": 0, "tunnel_loop_drops": 0, "tx_arp_rate_limit_drops": 0, "bfd_alloc_fail": 0, "tx_pre_ipsec_encap": 16205725, "ip_v6_mcast_drops": 0, "port_disabled_tx": 193, "ecmp_discards": 0, "tx_icmp_echo_replies": 0, "rx_icmp_fragment_required": 0, "ip_fwd_from_cpu_nat_xlates": 0, "rx_icmp_echo_replies": 486048, "tx_no_tunn_ipsec_drops": 0, "tx_no_arp_drop": 0, "tx_vsmart_drop": 0, "rx_policer_drops": 0, "ip_fwd_invalid_oil": 0, "rx_replay_drops": 0 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/system/status": { "get": { "tags": [ "Real-Time Monitoring - System" ], "description": "Get device system status list (Real Time)", "operationId": "createDeviceSystemStatusList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device system status": { "description": "Device system status", "value": { "data": [ { "mem_used": "954024", "procs": "244", "disk_avail": "7015M", "disk_mount": "/", "board_type": "Sim", "vdevice-name": "169.254.10.10", "total_cpu_count": "2", "mem_cached": "740972", "reboot_type": "Not Applicable", "disk_fs": "/dev/root", "fp_cpu_count": "1", "chassis-serial-number": "None", "min1_avg": "1.06", "state_description": "All daemons up", "personality": "vedge", "disk_used": "174M", "disk_use": "2", "disk_status": "enabled", "state": "green", "config_date/date-time-string": "Mon Feb 14 04:47:05 UTC 2022", "linux_cpu_count": "1", "cpu_user": "5.53", "testbed_mode": "1", "min15_avg": "1.08", "disk_size": "7615M", "cpu_idle": "91.96", "mem_buffers": "82140", "model_sku": "None", "cpu_system": "2.51", "version": "20.6.2-440", "min5_avg": "1.10", "tcpd_cpu_count": "0", "vdevice-host-name": "vm3", "mem_total": "3906816", "uptime": "16 days 05 hrs 08 min 45 sec", "vdevice-dataKey": "169.254.10.10", "mem_free": "2129680", "bootloader_version": "Not applicable", "fips_mode": "enabled", "build_number": "440", "lastupdated": 1644814027189, "loghost_status": "disabled", "uptime-date": 1643413080000 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,dca" } }, "/device/system/synced/status": { "get": { "tags": [ "Real-Time Monitoring - System" ], "description": "Get device system stats list synchronously", "operationId": "createSyncedDeviceSystemStatusList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device system stats": { "description": "Device system stats", "value": { "data": [ { "vdevice-name": "172.16.255.11", "board_type": "Sim", "total_cpu_count": "2", "reboot_type": "NotApplicable", "fp_cpu_count": "1", "chassis-serial-number": "None", "state_description": "Alldaemonsup", "@rid": 1175, "personality": "vedge", "disk_status": "enabled", "state": "green", "linux_cpu_count": "1", "testbed_mode": "1", "createTimeStamp": 1647316043522, "model_sku": "None", "version": "20.9.999-1787", "tcpd_cpu_count": "0", "vdevice-host-name": "vm1", "vdevice-dataKey": "172.16.255.11", "vmanage-system-ip": "172.16.255.11", "bootloader_version": "Notapplicable", "fips_mode": "enabled", "lastupdated": 1647316042867, "build_number": "1787", "loghost_status": "disabled", "uptime-date": 1647312840000 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/device/tcpopt/activeflows": { "get": { "tags": [ "Real-Time Monitoring - TCP Optimization" ], "description": "Get TCP optimized active flows from device (Real Time)", "operationId": "getActiveTCPFlows", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "TCP optimized active flow": { "description": "TCP optimized active flow", "value": { "data": [ { "vdevice-name": "172.16.254.1", "vdevice-host-name": "vm2", "vpn-id": "1", "src-ip": "10.20.24.17", "dest-ip": "10.20.25.18", "src-port": 53723, "dest-port": 22, "start-time": "Fri Mar 17 13:21:02 2022", "egress-intf-name": "loop0.3", "ingress-intf-name": "ge0_4", "tx-bytes": "153", "rx-bytes": "64", "tcp-state": "In progress", "unopt-reason": "-", "delete-reason": "-", "proxy-identity": "Client-Proxy", "lastupdated": 0, "vdevice-dataKey": "172.16.254.1" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write" } }, "/device/tcpopt/expiredflows": { "get": { "tags": [ "Real-Time Monitoring - TCP Optimization" ], "description": "Get TCP optimized expired flows from device (Real Time)", "operationId": "getExpiredTCPFlows", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "TCP optimized expired flow": { "description": "TCP optimized expired flow", "value": { "data": [ { "vdevice-name": "169.254.10.9", "vdevice-host-name": "vm2", "vpn-id": "1", "src-ip": "10.20.24.17", "dest-ip": "10.20.25.18", "src-port": 53722, "dest-port": 22, "start-time": "Fri Mar 17 13:16:26 2022", "end-time": "Fri Mar 17 13:17:51 2022", "tx-bytes": "4113", "rx-bytes": "4333", "tcp-state": "Optimized", "unopt-reason": "-", "proxy-identity": "Client-Proxy", "delete-reason": "Closed", "vdevice-dataKey": "169.254.10.9", "lastupdated": 1659327030348 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write" } }, "/device/tcpopt/summary": { "get": { "tags": [ "Real-Time Monitoring - TCP Optimization" ], "description": "Get TCP optimization summary from device (Real Time)", "operationId": "getTCPSummary", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "TCP optimization summary": { "description": "TCP optimization summary", "value": { "data": [ { "flows-expired": "0", "vdevice-dataKey": "169.254.10.10", "vdevice-name": "169.254.10.10", "flows-optimized": "0", "lastupdated": 1644816147644, "flows-passthrough": "0", "vdevice-host-name": "vm3", "flows-in-progress": "0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write" } }, "/device/tcpproxy/statistics": { "get": { "tags": [ "Real-Time Monitoring - Tcpproxy" ], "description": "Get tcp proxy statistics from device", "operationId": "getTcpProxyStatistics", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Tcp proxy statistics": { "description": "Tcp proxy statistics", "value": { "data": [ { "syn-purged-enq": "0", "tot-fin-processed": "0", "enable-rx-called": "0", "tot-ev-tx-enable-process": "0", "tot-send-fail": "0", "tot-ssl-trig-rst-wkq-fail": "0", "tcpp-aoim-sync-done": "0", "tot-tcp-buf-sent": "0", "tot-ssl-pause-called": "0", "tot-ssl2svc-buf-enq": "0", "tcp-flow-stats-del-fail": "0", "enable-rx-queued": "0", "tot-tcp-buf-rcvd": "0", "tot-bytes-read-less-512": "0", "tot-dre-resume-to-be-sent": "0", "sync-fail-marked-cleanup": "0", "sync-fail-entry-invalid": "0", "tot-clean-server-data-q": "0", "tot-ssl-resume-done": "0", "ssl-init-failure": "0", "tot-bytes-read-less-1024": "0", "tot-tcp-buf-alloc": "0", "pre-list-enq-failed": "0", "tot-actual-pause-done": "0", "tot-tcp-flow-clean-done": "0", "tot-sc-reset-rcvd": "0", "tot-rx-ssl-pause-process": "0", "tot-async-event-send": "0", "tot-bytes-read-less-4096": "0", "vpath-cleanup-from-nmrx": "0", "tcp-flow-entries-created": "0", "tot-ssl-pause-done": "0", "tot-tx-async-event-proc": "0", "tcp-flow-stats-add-fail": "0", "unif-logg-deq-no-space": "0", "vdevice-name": "169.254.10.12", "tot-snort-resume-done": "0", "tot-pause-count-buf": "0", "tot-snort-reset-init": "0", "tot-buf-128k-alloc-failed": "0", "unified-logging-msg-recvd": "0", "tot-bytes-read-less-2048": "0", "wcapi-svc-flow-delete-f": "0", "sync-flow-mismatch": "0", "num-stack-cb-null-ctx": "0", "tot-tcp-buf-128k-alloc": "0", "tot-clean-flow-ign": "0", "cur-rx-epoll-count": "0", "cur-tx-epoll-count": "0", "curr-val-tcp-flow-entries": "0", "unified-logg-deq-succ": "0", "tx-enq-failure-count": "0", "tot-reset-processed": "0", "vpath-cleanup-from-evlib": "0", "tot-en-rx-sock-stk-cl-svr": "0", "tot-rx-dre-pause-process": "0", "unified-logg-data-too-long": "0", "sync-fail-nat-entry-null": "0", "tot-tcp-reset-rcvd": "0", "current-conn-count": "0", "tot-ssl-fin-rcvd": "0", "tot-tcp-buf-16k-alloc": "0", "tot-buf-16k-alloc-failed": "0", "tot-ssl-server-init": "0", "vdevice-host-name": "vm5", "tot-sc-fin-rcvd": "0", "sync-fail-entry-null": "0", "tot-ssl-buf-free": "0", "tot-buff-drop-sock-closed": "0", "enable-rx-done": "0", "tot-page-alloc-retry": "0", "tot-resume-count-buf": "0", "lastupdated": 1646012087379, "tx-enqueue-drops-close": "0", "unified-logg-enq-succ": "0", "proxy-cleanup-enq": "0", "tot-ssl-reset-init": "0", "tot-buff-drop-sock-not-av": "0", "conn-failed": "0", "tot-dre-resume-done": "0", "tcpp-aoim-sync-error": "0", "timer-expire-cleanup-enq": "0", "tcp-flow-inv-entries": "0", "other-cleanup-enq": "0", "tot-page-alloc-failed": "0", "tot-ssl2tcp-buf-enq": "0", "tot-clean-add-wk-q-fail": "0", "tot-dre-resume-msg-sent": "0", "tot-uhi-munmap": "2768", "pre-list-enq": "0", "tot-fin-ign-fd-close": "0", "tot-buf-32k-alloc-failed": "0", "flow-drop-sn-gbl-health-y": "0", "stack-cleanup-enq": "0", "pre-remove-cleanup": "0", "tot-en-rx-sock-stk-cl-clnt": "0", "total-conns": "0", "tot-ev-resume-process": "0", "tot-svc2ssl-buf-enq": "0", "tot-page-free": "0", "conn-in-progress": "0", "tot-dre-close-init": "0", "clean-req-watcher-called": "1104871", "tot-async-event-process": "0", "tot-svc-reset-processed": "0", "tot-page-alloc-fail-size": "0", "flows-drop-wcapi-health-y": "0", "tot-rx-snort-pause-proc": "0", "pre-remove-err-timer": "0", "tot-uhi-mmap": "88936", "tot-page-alloc": "0", "tot-cleanup-add-to-wk-q": "0", "stack-cleanup-enq-failed": "0", "pre-remove-accept": "0", "tot-tcp2ssl-buf-enq": "0", "tot-ssl-clean-addwkq-fail": "0", "tot-ssl-buf-alloc": "0", "tot-actual-resume-done": "0", "tot-pause-count": "0", "wcapi-svc-flow-create-f": "0", "enable-rx-enq-failed": "0", "flow-drop-sn-inst-health-y": "0", "max-conns": "0", "proxy-cleanup-enq-failed": "0", "tot-ssl-reset-rcvd": "0", "pre-rem-err-accept": "0", "tot-ssl-reset-rcvd-sc": "0", "wcapi-svc-flow-close-f": "0", "other-cleanup-enq-failed": "0", "tot-ssl-fin-rcvd-sc": "0", "tot-tcp-buf-free": "0", "tot-resume-count": "0", "tot-tcp-fin-rcvd": "0", "tot-tcp-buf-32k-alloc": "0", "tot-clean-msg-rcvd": "0", "tot-clean-client-data-q": "0", "enable-rx-failed": "0", "curr-tcp-flow-entries": "0", "syn-purge-enq-failed": "0", "tot-tx-async-event-send": "0", "wcapi-svc-data-send-f": "0", "tcp-flow-entries-deleted": "0", "timer-ex-clean-enq-failed": "0", "pre-clean-time-update": "0", "vdevice-dataKey": "169.254.10.12", "tot-ssl-buf-alloc-failed": "0", "tot-ssl-resume-called": "0", "tcpp-aoim-sync-started": "0", "tot-dre-pause-done": "0", "tot-tcp-buf-alloc-failed": "0", "tot-snort-pause-done": "0", "sync-fail-entry-inuse": "0", "syncache-add-done": "0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/tcpproxy/status": { "get": { "tags": [ "Real-Time Monitoring - Tcpproxy" ], "description": "Get tcp proxy status from device", "operationId": "getTcpProxyStatus", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Tcp proxy status": { "description": "Tcp proxy status", "value": { "data": [ { "vdevice-dataKey": "169.254.10.12", "vdevice-name": "169.254.10.12", "oper-state": "running", "sng-name": "SNG-APPQOE", "lastupdated": 1646011762240, "sng-addr": "192.168.2.2", "vdevice-host-name": "vm5", "vpg-name": "VirtualPortGroup2", "vpg-addr": "192.168.2.1", "vpg-netmask": "255.255.255.0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/tier": { "post": { "tags": [ "Monitoring - Device Details" ], "description": "add tier", "operationId": "addTier", "requestBody": { "description": "Tier configuration", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "tier": { "description": "tier", "value": { "tierName": "bronze_tenant1", "vpn": 1 } } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Inventory-write" }, "get": { "tags": [ "Monitoring - Device Details" ], "description": "getTiers", "operationId": "getTiers", "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/tier/{tierName}": { "delete": { "tags": [ "Monitoring - Device Details" ], "description": "deleteTier", "operationId": "deleteTier", "parameters": [ { "name": "tierName", "in": "path", "description": "deletetier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/tloc": { "get": { "tags": [ "Monitoring - Device Details" ], "description": "Get TLOC status list", "operationId": "getDeviceTlocStatus", "parameters": [ { "name": "deviceId", "in": "query", "schema": { "type": "string" } }, { "name": "color", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "bfdSessionsDown": { "type": "integer", "format": "int32", "example": 0 }, "bfdSessionsUp": { "type": "integer", "format": "int32", "example": 5 }, "color": { "type": "string", "example": "red" }, "controlConnectionsDown": { "type": "string", "example": "vmanage" }, "controlConnectionsUp": { "type": "integer", "format": "int32", "example": 2 }, "system-ip": { "type": "string", "example": "169.254.10.1" } }, "$$ref": "#/components/schemas/DeviceTlocDataWithBFD" }, "examples": { "Tloc Status": { "description": "Tloc Status", "value": [ { "color": "default", "system-ip": "172.16.255.22", "expectedControlConnections": 2, "controlConnectionsUp": 8, "controlConnectionsToVsmarts": 2, "controlConnectionsDown": 0 }, { "color": "default", "system-ip": "172.16.255.20", "expectedControlConnections": 1, "controlConnectionsUp": 15, "controlConnectionsToVsmarts": 1, "controlConnectionsDown": 0 }, { "color": "lte", "system-ip": "172.16.255.21", "bfdSessionsDown": 0, "controlConnectionsUp": 2, "controlConnectionsToVsmarts": "--", "bfdSessionsUp": 5, "controlConnectionsDown": 0 }, { "color": "3g", "system-ip": "172.16.255.21", "bfdSessionsDown": 0, "controlConnectionsUp": 3, "controlConnectionsToVsmarts": "--", "bfdSessionsUp": 5, "controlConnectionsDown": 0 }, { "color": "3g", "system-ip": "172.16.255.11", "bfdSessionsDown": 0, "controlConnectionsUp": 3, "controlConnectionsToVsmarts": "--", "bfdSessionsUp": 5, "controlConnectionsDown": 0 }, { "color": "lte", "system-ip": "172.16.255.11", "bfdSessionsDown": 0, "controlConnectionsUp": 2, "controlConnectionsToVsmarts": "--", "bfdSessionsUp": 5, "controlConnectionsDown": 0 }, { "color": "red", "system-ip": "172.16.255.11", "bfdSessionsDown": 0, "controlConnectionsUp": 2, "controlConnectionsToVsmarts": "--", "bfdSessionsUp": 5, "controlConnectionsDown": 0 }, { "color": "gold", "system-ip": "172.16.255.11", "bfdSessionsDown": 0, "controlConnectionsUp": 2, "controlConnectionsToVsmarts": "--", "bfdSessionsUp": 5, "controlConnectionsDown": 0 }, { "color": "lte", "system-ip": "172.16.255.14", "bfdSessionsDown": 0, "controlConnectionsUp": 3, "controlConnectionsToVsmarts": "--", "bfdSessionsUp": 10, "controlConnectionsDown": 0 }, { "color": "3g", "system-ip": "172.16.255.16", "bfdSessionsDown": 0, "controlConnectionsUp": 3, "controlConnectionsToVsmarts": "--", "bfdSessionsUp": 10, "controlConnectionsDown": 0 }, { "color": "lte", "system-ip": "172.16.255.16", "bfdSessionsDown": 0, "controlConnectionsUp": 2, "controlConnectionsToVsmarts": "--", "bfdSessionsUp": 9, "controlConnectionsDown": 0 }, { "color": "default", "system-ip": "172.16.255.19", "expectedControlConnections": 1, "controlConnectionsUp": 15, "controlConnectionsToVsmarts": 1, "controlConnectionsDown": 0 }, { "color": "lte", "system-ip": "172.16.255.15", "bfdSessionsDown": 0, "controlConnectionsUp": 3, "bfdSessionsUp": 9, "controlConnectionsDown": 0 }, { "color": "3g", "system-ip": "172.16.255.15", "bfdSessionsDown": 0, "controlConnectionsUp": 2, "bfdSessionsUp": 10, "controlConnectionsDown": 0 } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/tlocutil": { "get": { "tags": [ "Monitoring - Device Details" ], "description": "Get TLOC list", "operationId": "getDeviceTlocUtil", "parameters": [ { "name": "site-id", "in": "query", "description": "Optional site ID to filter devices", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "TLOC list": { "description": "TLOC list", "value": { "header": { "generatedOn": 1635311915500, "title": "Transport Interface Distribution", "viewKeys": { "uniqueKey": [], "preferenceKey": "grid-TlocUtilization" }, "columns": [ { "title": "Percentage Distribution", "property": "percentageDistribution", "dataType": "string" }, { "title": "Value", "property": "value", "dataType": "number" } ], "fields": [ { "property": "percentageDistribution", "dataType": "string" }, { "property": "value", "dataType": "number" } ] }, "data": [ { "name": "less_than_10_mbps", "percentageDistribution": "< 10 Mbps", "detailsURL": "/dataservice/device/tlocutil/detail?util=lessthan10mbps", "value": 0 }, { "name": "10_mbps_100_mbps", "percentageDistribution": "10 Mbps - 100 Mbps", "detailsURL": "/dataservice/device/tlocutil/detail?util=10mbps100mbps", "value": 0 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/tlocutil/detail": { "get": { "tags": [ "Monitoring - Device Details" ], "description": "Get detailed TLOC list", "operationId": "getDeviceTlocUtilDetails", "parameters": [ { "name": "site-id", "in": "query", "description": "Optional site ID to filter devices", "schema": { "type": "string" } }, { "name": "util", "in": "query", "description": "Tloc util", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Detailed TLOC list": { "description": "Detailed TLOC list", "value": { "header": { "generatedOn": 1635314596057, "viewKeys": { "uniqueKey": [], "preferenceKey": "grid-TlocUtilizationDetails" }, "columns": [ { "title": "Average", "property": "average", "hideable": false, "dataType": "number" } ], "fields": [ { "property": "system-ip", "dataType": "string" }, { "property": "average", "dataType": "number" } ] }, "data": [] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/tools/admintech": { "post": { "tags": [ "Troubleshooting Tools - Device Connectivity" ], "description": "Generate admin tech logs", "operationId": "createAdminTech", "requestBody": { "description": "Admin tech generation request", "content": { "application/json": { "schema": { "type": "object", "properties": { "custom-commands": { "type": "array", "description": "custom commands", "example": [ "show version", "show platform" ], "items": { "type": "string", "description": "command", "example": "show versio" } }, "device-type": { "type": "string", "example": "vmanage" }, "deviceIP": { "type": "string", "example": "10.3.0.1" }, "exclude-cores": { "type": "boolean", "example": true }, "exclude-logs": { "type": "boolean", "example": true }, "exclude-tech": { "type": "boolean", "example": false }, "tech-filter": { "type": "array", "items": { "type": "string" } } }, "$$ref": "#/components/schemas/AdminTechCreateReq" }, "examples": { "Generate Admin tech log": { "description": "Generate Admin tech log", "value": { "deviceIP": "10.3.0.1", "device-type": "vmanage", "exclude-cores": true, "exclude-tech": false, "exclude-logs": false } } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tools-write,dca" } }, "/device/tools/admintech/copy": { "post": { "tags": [ "Troubleshooting Tools - Device Connectivity" ], "description": "copy admin tech logs", "operationId": "copyAdminTechOnDevice", "requestBody": { "description": "Admin tech copy request", "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceIP": { "type": "string", "example": "10.3.0.1" }, "fileName": { "type": "string", "example": "10.3.0.1-20200522-102611-admin-tech.tar.gz" } }, "$$ref": "#/components/schemas/AdminTechReq" }, "examples": { "Copy Admin tech log": { "description": "Copy Admin tech log", "value": { "deviceIP": "10.3.0.1", "fileName": "10.3.0.1-20200522-102611-admin-tech.tar.gz" } } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tools-write,dca" } }, "/device/tools/admintech/delete": { "delete": { "tags": [ "Troubleshooting Tools - Device Connectivity" ], "description": "delete admin tech logs", "operationId": "deleteAdminTechOnDevice", "requestBody": { "description": "Admin tech delete request", "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceIP": { "type": "string", "example": "10.3.0.1" }, "fileName": { "type": "string", "example": "10.3.0.1-20200522-102611-admin-tech.tar.gz" } }, "$$ref": "#/components/schemas/AdminTechReq" }, "examples": { "Delete Admin tech log": { "description": "Delete Admin tech log", "value": { "deviceIP": "10.3.0.1", "fileName": "10.3.0.1-20200522-102611-admin-tech.tar.gz" } } } } } }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tools-write,dca" } }, "/device/tools/admintech/download/{filename}": { "get": { "tags": [ "Troubleshooting Tools - Device Connectivity" ], "description": "Download admin tech logs", "operationId": "downloadAdminTechFile", "parameters": [ { "name": "filename", "in": "path", "description": "Admin tech file", "required": true, "schema": { "type": "string" }, "example": "172.16.255.14-vm4-20240605-175206-admin-tech.tar.gz" } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tools-write,dca" } }, "/device/tools/admintech/supportedfeatures/{deviceModel}/{deviceIP}/{personality}": { "get": { "tags": [ "Troubleshooting Tools - Device Connectivity" ], "summary": "Get supported admin tech features", "description": "Get supported admin tech features", "operationId": "getSupportedAdminTechFeatures", "parameters": [ { "name": "deviceModel", "in": "path", "description": "device Model", "required": true, "schema": { "type": "object", "properties": { "deviceModel": { "type": "string" } }, "description": "This is the valid DeviceModel ", "$$ref": "#/components/schemas/DeviceModel" } }, { "name": "deviceIP", "in": "path", "description": "Device IP", "required": true, "schema": { "type": "object", "properties": { "deviceIp": { "type": "string" } }, "description": "This is the valid DeviceIP", "$$ref": "#/components/schemas/DeviceIP" } }, { "name": "personality", "in": "path", "description": "personality", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/tools/admintech/{requestID}": { "delete": { "tags": [ "Troubleshooting Tools - Device Connectivity" ], "description": "Delete admin tech logs", "operationId": "deleteAdminTechFile", "parameters": [ { "name": "requestID", "in": "path", "description": "Request Id of admin tech generation request", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tools-write" } }, "/device/tools/admintechlist": { "post": { "tags": [ "Troubleshooting Tools - Device Connectivity" ], "description": "List admin tech logs", "operationId": "listAdminTechsOnDevice", "requestBody": { "description": "Admin tech listing request", "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceIP": { "type": "string", "example": "10.3.0.1" } }, "$$ref": "#/components/schemas/AdminTechListReq" }, "examples": { "List Admin tech log": { "description": "List Admin tech log", "value": { "deviceIP": "10.3.0.1" } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "creationTime": { "type": "integer", "format": "int64", "example": 1590186370340 }, "fileName": { "type": "string", "example": "10.3.0.1-20200522-102611-admin-tech.tar.gz" }, "requestTokenId": { "type": "string", "example": "10540562-6759-40ad-917f-71d4b81ff37d" }, "size": { "type": "integer", "format": "int32", "example": 1081406 }, "state": { "type": "string", "example": "done" } }, "$$ref": "#/components/schemas/AdminTechListRes" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tools-write,dca" } }, "/device/tools/admintechs": { "get": { "tags": [ "Troubleshooting Tools - Device Connectivity" ], "description": "Get device admin-tech information", "operationId": "listAdminTechs", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "creationTime": { "type": "integer", "format": "int64", "example": 1590186370340 }, "deviceIP": { "type": "string", "example": "10.3.0.1" }, "fileName": { "type": "string", "example": "10.3.0.1-20200522-102611-admin-tech.tar.gz" }, "local-system-ip": { "type": "string", "example": "10.3.0.1" }, "requestTokenId": { "type": "string", "example": "10540562-6759-40ad-917f-71d4b81ff37d" }, "size": { "type": "integer", "format": "int32", "example": 1081406 }, "state": { "type": "string", "example": "done" }, "tac_state": { "type": "string", "example": "notStarted" } }, "$$ref": "#/components/schemas/AdminTechsRes" }, "examples": { "Example": { "description": "Example", "value": { "data": [ { "creationTime": 1590186370340, "size": 1081406, "fileName": "10.3.0.1-20200522-102611-admin-tech.tar.gz", "state": "done", "deviceIP": "10.3.0.1", "local-system-ip": "10.3.0.1", "requestTokenId": "10540562-6759-40ad-917f-71d4b81ff37d", "tac_state": "notStarted" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceCommonDevicetoolsapiResponseExampleAdmintechs" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tools-write,dca" } }, "/device/tools/admintechs/inprogress": { "get": { "tags": [ "Troubleshooting Tools - Device Connectivity" ], "description": "Get device admin-tech InProgressCount", "operationId": "getInProgressCount", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "inProgressCount": { "type": "integer", "format": "int32", "example": 5 } }, "$$ref": "#/components/schemas/InProgressCount" }, "examples": { "Example": { "description": "Example", "value": { "data": [ { "inProgressCount": "5" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceCommonDevicetoolsapiResponseExampleAdmintechsinprogress" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tools-write,dca" } }, "/device/tools/admintechs/upload": { "post": { "tags": [ "Troubleshooting Tools - Device Connectivity" ], "description": "upload admin tech to SR", "operationId": "uploadAdminTech", "requestBody": { "description": "Admin tech upload request", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestTokenId": { "type": "string", "example": "ea8cb172-61c4-47e0-8957-ac83b384f53e" }, "sr_number": { "type": "string", "example": "69131837254" }, "token": { "type": "string", "example": "9b42986QTUc" }, "vpn": { "type": "string", "example": "VPN 0" } }, "$$ref": "#/components/schemas/AdminTechsUploadReq" }, "examples": { "upload Admin tech log": { "description": "upload Admin tech log", "value": { "sr_number": "69131837254", "token": "9b42986QTUc", "vpn": "VPN 0", "requestTokenId": "ea8cb172-61c4-47e0-8957-ac83b384f53e" } } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tools-write,dca" } }, "/device/tools/factoryreset": { "post": { "tags": [ "Troubleshooting Tools - Device Connectivity" ], "description": "Device factory reset", "operationId": "factoryReset", "requestBody": { "description": "Device factory reset", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device factory reset": { "description": "Device factory reset", "value": { "deviceIP": "172.16.255.16", "resetOption": "full-wipe/retain-license" } } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/tools/netstat": { "get": { "tags": [ "Real-Time Monitoring - Tools" ], "description": "Get device tool net stat", "operationId": "getDeviceToolsNetstat", "parameters": [ { "name": "vpn", "in": "query", "description": "VPN", "schema": { "type": "string", "enum": [ "0", "512" ] } }, { "name": "options", "in": "query", "description": "Options", "schema": { "type": "string" } }, { "name": "deviceId", "in": "query", "description": "Device Id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Tools netstat Data Example": { "description": "Tools netstat Data Example", "value": "{{\n \"rawOutput\": [\n \"Active Internet connections (w/o servers)\",\n \"Proto Recv-Q Send-Q Local Address Foreign Address State PID/Program name\",\n \"tcp 0 0 vm1:ssh 10.0.1.1:54932 ESTABLISHED 8964/sshd: admin [p\",\n \"Active UNIX domain sockets (w/o servers)\",\n \"Proto RefCnt Flags Type State I-Node PID/Program name Path\",\n \"unix 3 [ ] STREAM CONNECTED 1154465 3283/ftmd /var/run/.ftmd.512\",\n \"unix 3 [ ] STREAM CONNECTED 767015 2519/zebra \",\n \"unix 3 [ ] STREAM CONNECTED 1154461 2519/zebra \",\n \"unix 3 [ ] STREAM CONNECTED 767017 2181/cfgmgr /var/run/quagga/zebra_protobuf_notify.api.512\",\n \"unix 3 [ ] STREAM CONNECTED 1177839 8966/0 \",\n \"unix 2 [ ] STREAM CONNECTED 1177830 8964/sshd: admin [p \",\n \"unix 3 [ ] STREAM CONNECTED 1177840 8964/sshd: admin [p \",\n \"unix 2 [ ] DGRAM 1177838 8964/sshd: admin [p \",\n \"unix 2 [ ] DGRAM 766216 2519/zebra \"\n ]\n}" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/tools/nping/{deviceIP}": { "post": { "tags": [ "Troubleshooting Tools - Device Connectivity" ], "description": "NPing device", "operationId": "npingDevice", "parameters": [ { "name": "deviceIP", "in": "path", "description": "Device IP", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Ping parameter", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "string", "example": "5" }, "destPort": { "type": "string", "example": "22" }, "df": { "type": "string", "example": "true" }, "host": { "type": "string", "example": "3::2" }, "interfaceIP": { "type": "string", "example": "3::1" }, "mtu": { "type": "string", "example": "128" }, "probeType": { "type": "string", "example": "tcp" }, "rapid": { "type": "string", "example": "true" }, "size": { "type": "string", "example": "128" }, "source": { "type": "string", "example": "3::1" }, "sourcePort": { "type": "string", "example": "22" }, "tos": { "type": "string", "example": "1" }, "ttl": { "type": "string", "example": "1" }, "vpn": { "type": "string", "example": "0" } }, "$$ref": "#/components/schemas/NPingRequest" }, "examples": { "Ping parameter": { "description": "Ping parameter", "value": { "host": "10.1.12.16", "probeType": "icmp", "source": "10.1.12.15", "interfaceIP": "10.1.12.15", "vpn": "0" } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "avgRoundTrip": { "type": "number", "example": 3.964 }, "lossPercentage": { "type": "number", "example": 0 }, "maxRoundTrip": { "type": "number", "example": 14.43 }, "minRoundTrip": { "type": "number", "example": 1.221 }, "packetsReceived": { "type": "number", "example": 5 }, "packetsTransmitted": { "type": "number", "example": 5 }, "rawOutput": { "type": "array", "items": { "type": "string" } } }, "$$ref": "#/components/schemas/NPingResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tools-read" } }, "/device/tools/nslookup": { "get": { "tags": [ "Real-Time Monitoring - Tools" ], "description": "Get device tool nslookup", "operationId": "getDeviceToolsNSlookup", "parameters": [ { "name": "vpn", "in": "query", "description": "VPN", "required": true, "schema": { "type": "string", "enum": [ "0", "512" ] } }, { "name": "dns", "in": "query", "description": "DNS", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "8.8.8.8" } }, { "name": "deviceId", "in": "query", "description": "Device Id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device tool nslookup data": { "description": "Device tool nslookup data", "value": { "rawOutput": [ "Server: 10.0.1.1", "Address 1: 10.0.1.1", "", "Name: 8.8.8.8", "Address 1: 8.8.8.8" ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/tools/ping/{deviceIP}": { "post": { "tags": [ "Troubleshooting Tools - Device Connectivity" ], "description": "Ping device", "operationId": "pingDevice", "parameters": [ { "name": "deviceIP", "in": "path", "description": "Device IP", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Ping parameter", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "string", "example": "5" }, "host": { "type": "string", "example": "10.1.12.16" }, "rapid": { "type": "string", "example": "true" }, "size": { "type": "string", "example": "128" }, "source": { "type": "string", "example": "10.1.12.15" }, "vpn": { "type": "string", "example": "0" } }, "$$ref": "#/components/schemas/PingRequest" }, "examples": { "Ping parameter": { "description": "Ping parameter", "value": { "host": "10.1.12.16", "source": "10.1.12.15", "vpn": "0" } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "avgRoundTrip": { "type": "number", "example": 0.389 }, "lossPercentage": { "type": "number", "example": 0 }, "maxRoundTrip": { "type": "number", "example": 0.534 }, "minRoundTrip": { "type": "number", "example": 0.226 }, "packetsReceived": { "type": "number", "example": 5 }, "packetsTransmitted": { "type": "number", "example": 5 }, "rawOutput": { "type": "array", "items": { "type": "string" } } }, "$$ref": "#/components/schemas/PingResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tools-read" } }, "/device/tools/porthopcolor/{deviceIP}": { "post": { "tags": [ "Troubleshooting Tools - Device Connectivity" ], "description": "Request port hop color", "operationId": "processPortHopColor", "parameters": [ { "name": "deviceIP", "in": "path", "description": "Device IP", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Device port hop color", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device port hop color": { "description": "Device port hop color", "value": { "color": "mpls" } } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/tools/realtimeinfo": { "get": { "tags": [ "Real-Time Monitoring - Tools" ], "description": "Get hardware real time info from device", "operationId": "getRealTimeinfo", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device Id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "hardware real time info data": { "description": "hardware real time info data", "value": "{ \"hardware-info\" : \"Hardware Information\\n---------------------------------\\n\nBaseboard Details:\\nboard type : ISR1100-4G\\nboard serial number:\nISR1100-4G-FCH2414L04T\\n-------------------------------\\nTPM Details:\\nAikido FPGA : 07250006\\n---------------------------------------------------------\\nBootloader version:\\nBIOS Version:17.7(1r)\\nBootloader Source: Upgrade\nBIOS\\n----------------------------------------------------------------\\nTemperature threshold history:\\n\",\n\"Kernel-log\" : \"Critical Kernel Logs:\"\n}" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/tools/reset/interface/{deviceIP}": { "post": { "tags": [ "Troubleshooting Tools - Device Connectivity" ], "description": "Reset device interface", "operationId": "processInterfaceReset", "parameters": [ { "name": "deviceIP", "in": "path", "description": "Device IP", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Device interface", "content": { "application/json": { "schema": { "type": "object", "properties": { "ifname": { "type": "string", "example": "GigabitEthernet1" }, "vpnId": { "type": "string", "example": "512" } }, "$$ref": "#/components/schemas/ResetInterfaceReq" }, "examples": { "Device interface": { "description": "Device interface", "value": { "vpnId": "512", "ifname": "GigabitEthernet1" } } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tools-write" } }, "/device/tools/reset/profile": { "post": { "tags": [ "Troubleshooting Tools - Device Connectivity" ], "summary": "Reset Cellular Profile", "description": "Reset Cellular Profile", "operationId": "processCellularProfileReset", "requestBody": { "description": "Reset Cellular Profile", "content": { "application/json": { "schema": { "type": "object", "properties": { "localSystemIp": { "type": "string", "description": "local system ip", "example": "172.16.255.15" } }, "$$ref": "#/components/schemas/ResetProfileReq" }, "examples": { "Reset Cellular Profile": { "description": "Reset Cellular Profile", "value": { "localSystemIp": "172.16.255.15" } } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Cellular Profile Reset-write" } }, "/device/tools/resetuser/{deviceIP}": { "post": { "tags": [ "Troubleshooting Tools - Device Connectivity" ], "description": "Request reset user", "operationId": "processResetUser", "parameters": [ { "name": "deviceIP", "in": "path", "description": "Device IP", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Device user reset", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device user reset": { "description": "Device user reset", "value": { "user": "admin" } } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/tools/servicepath/{deviceIP}": { "post": { "tags": [ "Troubleshooting Tools - Device Connectivity" ], "description": "Service path", "operationId": "servicePath", "parameters": [ { "name": "deviceIP", "in": "path", "description": "Device IP", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Service path parameter", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Service path parameter": { "description": "Service path parameter", "value": {} } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/tools/ss": { "get": { "tags": [ "Real-Time Monitoring - Tools" ], "description": "Get device tool ss", "operationId": "getDeviceToolsSS", "parameters": [ { "name": "vpn", "in": "query", "description": "VPN", "schema": { "type": "string", "enum": [ "0", "512" ] } }, { "name": "options", "in": "query", "description": "Options", "schema": { "type": "string" } }, { "name": "deviceId", "in": "query", "description": "Device Id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device tool SS data ": { "description": "Device tool SS data ", "value": { "rawOutput": [ "Netid State Recv-Q Send-Q Local Address:Port Peer Address:Port Process ", "u_str ESTAB 0 0 * 767015 * 0 users:((\"zebra\",pid=2519,fd=13)) ", "u_str ESTAB 0 0 /var/run/quagga/zebra_protobuf_notify.api.512 767017 * 0 users:((\"cfgmgr\",pid=2181,fd=30)) ", "u_str ESTAB 0 0 * 1154461 * 0 users:((\"zebra\",pid=2519,fd=16)) ", "u_str ESTAB 0 0 /var/run/.ftmd.512 1154465 * 0 users:((\"ftmd\",pid=3283,fd=58)) ", "u_str ESTAB 0 0 * 1177830 * 0 users:((\"sshd\",pid=8966,fd=6),(\"sshd\",pid=8964,fd=6)) ", "u_str ESTAB 0 0 * 1177839 * 0 users:((\"sshd\",pid=8966,fd=5)) ", "u_str ESTAB 0 0 * 1177840 * 0 users:((\"sshd\",pid=8964,fd=7)) ", "u_dgr ESTAB 0 0 * 766216 * 0 users:((\"zebra\",pid=2519,fd=3)) ", "u_dgr ESTAB 0 0 * 1177838 * 0 users:((\"sshd\",pid=8966,fd=3),(\"sshd\",pid=8964,fd=3)) ", "tcp ESTAB 0 0 10.0.1.11:ssh 10.0.1.1:54932 users:((\"sshd\",pid=8966,fd=4),(\"sshd\",pid=8964,fd=4)) " ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/tools/system-netfilter": { "get": { "tags": [ "Real-Time Monitoring - Tools" ], "description": "Get system netfilter info from device", "operationId": "getSystemNetfilter", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device Id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "System Netfilter info": { "description": "System Netfilter info", "value": { "ipv4": "Chain POLICE_PROT (2 references)\n pkts bytes target prot opt in out source destination \n 113K 16M ACCEPT tcp -- * * 0.0.0.0/0 0.0.0.0/0 tcp dpt:830\n 0 0 ACCEPT tcp -- * * 0.0.0.0/0 172.16.255.11 tcp dpt:830\n 0 0 ACCEPT icmp -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 \n 0 0 ACCEPT 89 -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 \n 0 0 ACCEPT tcp -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 tcp dpt:22\n 0 0 ACCEPT tcp -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 tcp dpt:179\n 0 0 ACCEPT tcp -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 tcp dpt:830\n 0 0 ACCEPT udp -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 udp spt:67 dpt:68\nChain INPUT (policy ACCEPT 760K packets, 433M bytes)\n pkts bytes target prot opt in out source destination \n 113K 16M POLICE_PROT tcp -- * * 0.0.0.0/0 0.0.0.0/0 tcp dpt:830\n 0 0 LOGGING tcp -- * * 0.0.0.0/0 0.0.0.0/0 tcp dpt:830\n 921K 494M ACCEPT all -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 ctstate ESTABLISHED\n 0 0 POLICE_PROT all -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 \n 0 0 LOGGING all -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 \nChain LOGGING (2 references)\n pkts bytes target prot opt in out source destination \n 0 0 DROP all -- * * 0.0.0.0/0 0.0.0.0/0 ", "ipv6": "Chain INPUT (policy ACCEPT 90 packets, 5040 bytes)\n pkts bytes target prot opt in out source destination \n 0 0 ACCEPT all ge0_2 * ::/0 ::/0 ctstate ESTABLISHED\n 30 1680 POLICE_PROT all ge0_2 * ::/0 ::/0 \n 0 0 LOGGING all ge0_2 * ::/0 ::/0 \nChain POLICE_PROT (1 references)\n pkts bytes target prot opt in out source destination \n 0 0 ACCEPT tcp * * ::/0 ::/0 tcp dpt:830\n 30 1680 ACCEPT icmpv6 ge0_2 * ::/0 ::/0 \n 0 0 ACCEPT 89 ge0_2 * ::/0 ::/0 \n 0 0 ACCEPT tcp ge0_2 * ::/0 ::/0 tcp dpt:22\n 0 0 ACCEPT tcp ge0_2 * ::/0 ::/0 tcp dpt:179\n 0 0 ACCEPT tcp ge0_2 * ::/0 ::/0 tcp dpt:830\n 0 0 ACCEPT udp ge0_2 * ::/0 ::/0 udp spt:547 dpt:546\nChain LOGGING (1 references)\n pkts bytes target prot opt in out source destination \n 0 0 DROP all * * ::/0 ::/0 " } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/tools/traceroute/{deviceIP}": { "post": { "tags": [ "Troubleshooting Tools - Device Connectivity" ], "description": "Traceroute", "operationId": "tracerouteDevice", "parameters": [ { "name": "deviceIP", "in": "path", "description": "Device IP", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Traceroute parameter", "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceIp": { "type": "string", "example": "172.16.255.15" }, "host": { "type": "string", "example": "3::2" }, "interface": { "type": "string", "example": "3::1" }, "interfaceIP": { "type": "string", "example": "3::1" }, "size": { "type": "string", "example": "128" }, "vpn": { "type": "string", "example": "0" } }, "$$ref": "#/components/schemas/TracerouteRequest" }, "examples": { "Traceroute parameter": { "description": "Traceroute parameter", "value": { "deviceIp": "172.16.255.15", "host": "10.1.12.16", "interface": "10.1.12.15", "interfaceIP": "10.1.12.15", "vpn": "0" } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "nexthops": { "type": "array", "items": { "type": "object", "properties": { "errorInfo": { "type": "string", "example": "Host unreachable" }, "hopName": { "type": "string" }, "hopNumber": { "type": "string", "example": "1" }, "ipAddress": { "type": "string", "example": "3::2" }, "meanLatency": { "type": "string", "example": "1.269" } }, "$$ref": "#/components/schemas/Hops" } }, "rawOutput": { "type": "array", "items": { "type": "string" } } }, "$$ref": "#/components/schemas/TracerouteResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tools-read" } }, "/device/tools/tunnelpath/{deviceIP}": { "post": { "tags": [ "Troubleshooting Tools - Device Connectivity" ], "description": "TunnelPath", "operationId": "tunnelPath", "parameters": [ { "name": "deviceIP", "in": "path", "description": "Device IP", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "TunnelPath parameter", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "TunnelPath parameter": { "description": "TunnelPath parameter", "value": {} } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/transport/connection": { "get": { "tags": [ "Real-Time Monitoring - Transport" ], "description": "Get transport connection list from device", "operationId": "createTransportConnectionList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Transport connection list": { "description": "Transport connection list", "value": { "data": [ { "vdevice-dataKey": "169.254.10.10--", "vdevice-name": "169.254.10.10", "destination": "10.103.135.135", "index": "0", "lastupdated": 1644816647932, "source": "0.0.0.0", "time": "Fri Feb 11 18:19:43 2022", "state": "up", "vdevice-host-name": "vm3", "track-type": "tloc" }, { "vdevice-dataKey": "169.254.10.10--", "vdevice-name": "169.254.10.10", "destination": "10.103.135.135", "index": "1", "lastupdated": 1644816647933, "source": "0.0.0.0", "time": "Fri Feb 11 18:16:58 2022", "state": "down", "vdevice-host-name": "vm3", "track-type": "tloc" }, { "vdevice-dataKey": "169.254.10.10--", "vdevice-name": "169.254.10.10", "destination": "10.103.135.135", "index": "2", "lastupdated": 1644816647933, "source": "0.0.0.0", "time": "Fri Feb 4 18:19:51 2022", "state": "up", "vdevice-host-name": "vm3", "track-type": "tloc" }, { "vdevice-dataKey": "169.254.10.10--", "vdevice-name": "169.254.10.10", "destination": "10.103.135.135", "index": "3", "lastupdated": 1644816647933, "source": "0.0.0.0", "time": "Fri Feb 4 18:17:06 2022", "state": "down", "vdevice-host-name": "vm3", "track-type": "tloc" }, { "vdevice-dataKey": "169.254.10.10--", "vdevice-name": "169.254.10.10", "destination": "10.103.135.135", "index": "4", "lastupdated": 1644816647934, "source": "0.0.0.0", "time": "Thu Feb 3 18:23:58 2022", "state": "up", "vdevice-host-name": "vm3", "track-type": "tloc" }, { "vdevice-dataKey": "169.254.10.10--", "vdevice-name": "169.254.10.10", "destination": "10.103.135.135", "index": "5", "lastupdated": 1644816647934, "source": "0.0.0.0", "time": "Thu Feb 3 18:21:13 2022", "state": "down", "vdevice-host-name": "vm3", "track-type": "tloc" }, { "vdevice-dataKey": "169.254.10.10--", "vdevice-name": "169.254.10.10", "destination": "10.103.135.135", "index": "6", "lastupdated": 1644816647935, "source": "0.0.0.0", "time": "Wed Feb 2 18:19:38 2022", "state": "up", "vdevice-host-name": "vm3", "track-type": "tloc" }, { "vdevice-dataKey": "169.254.10.10--", "vdevice-name": "169.254.10.10", "destination": "10.103.135.135", "index": "7", "lastupdated": 1644816647935, "source": "0.0.0.0", "time": "Wed Feb 2 18:16:47 2022", "state": "down", "vdevice-host-name": "vm3", "track-type": "tloc" }, { "vdevice-dataKey": "169.254.10.10--", "vdevice-name": "169.254.10.10", "destination": "10.103.135.135", "index": "8", "lastupdated": 1644816647935, "source": "0.0.0.0", "time": "Tue Feb 1 18:19:56 2022", "state": "up", "vdevice-host-name": "vm3", "track-type": "tloc" }, { "vdevice-dataKey": "169.254.10.10--", "vdevice-name": "169.254.10.10", "destination": "10.103.135.135", "index": "9", "lastupdated": 1644816647936, "source": "0.0.0.0", "time": "Tue Feb 1 18:17:11 2022", "state": "down", "vdevice-host-name": "vm3", "track-type": "tloc" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/tunnel/bfd_statistics": { "get": { "tags": [ "Real-Time Monitoring - Tunnel" ], "description": "Get tunnel BFD statistics all devices", "operationId": "createBfdStatisticsList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Tunnel BFD statistics": { "description": "Tunnel BFD statistics", "value": { "data": [ { "dest-ip": "30.30.30.30", "source-port": 0, "bfd-echo-rx-pkts": 0, "vdevice-name": "169.254.10.10", "bfd-pmtu-tx-octets": 0, "bfd-echo-tx-octets": 0, "bfd-pmtu-rx-octets": 0, "vdevice-host-name": "vm3", "tunnel-protocol": "gre", "bfd-pmtu-tx-pkts": 0, "dest-port": 0, "vdevice-dataKey": "169.254.10.10-gre-10.0.3.3-30.30.30.30-0-0", "lastupdated": 1644817628460, "source-ip": "10.0.3.3", "bfd-echo-tx-pkts": 0, "bfd-pmtu-rx-pkts": 0, "bfd-echo-rx-octets": 0 }, { "dest-ip": "10.101.2.2", "source-port": 12366, "bfd-echo-rx-pkts": 427365, "vdevice-name": "169.254.10.10", "bfd-pmtu-tx-octets": 307216, "bfd-echo-tx-octets": 71583641, "bfd-pmtu-rx-octets": 307216, "vdevice-host-name": "vm3", "tunnel-protocol": "ipsec", "bfd-pmtu-tx-pkts": 376, "dest-port": 12346, "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.101.2.2-12366-12346", "lastupdated": 1644817628460, "source-ip": "10.101.3.3", "bfd-echo-tx-pkts": 427365, "bfd-pmtu-rx-pkts": 376, "bfd-echo-rx-octets": 71583634 }, { "dest-ip": "10.101.4.4", "source-port": 12366, "bfd-echo-rx-pkts": 427523, "vdevice-name": "169.254.10.10", "bfd-pmtu-tx-octets": 307090, "bfd-echo-tx-octets": 71610106, "bfd-pmtu-rx-octets": 305818, "vdevice-host-name": "vm3", "tunnel-protocol": "ipsec", "bfd-pmtu-tx-pkts": 375, "dest-port": 12366, "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.101.4.4-12366-12366", "lastupdated": 1644817628460, "source-ip": "10.101.3.3", "bfd-echo-tx-pkts": 427523, "bfd-pmtu-rx-pkts": 375, "bfd-echo-rx-octets": 71610099 }, { "dest-ip": "10.102.5.5", "source-port": 12366, "bfd-echo-rx-pkts": 449468, "vdevice-name": "169.254.10.10", "bfd-pmtu-tx-octets": 531622, "bfd-echo-tx-octets": 75208785, "bfd-pmtu-rx-octets": 2835599, "vdevice-host-name": "vm3", "tunnel-protocol": "ipsec", "bfd-pmtu-tx-pkts": 2157, "dest-port": 12366, "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.5.5-12366-12366", "lastupdated": 1644817628460, "source-ip": "10.101.3.3", "bfd-echo-tx-pkts": 449468, "bfd-pmtu-rx-pkts": 2157, "bfd-echo-rx-octets": 75362995 }, { "dest-ip": "10.102.6.6", "source-port": 12366, "bfd-echo-rx-pkts": 449575, "vdevice-name": "169.254.10.10", "bfd-pmtu-tx-octets": 531622, "bfd-echo-tx-octets": 75226641, "bfd-pmtu-rx-octets": 2835599, "vdevice-host-name": "vm3", "tunnel-protocol": "ipsec", "bfd-pmtu-tx-pkts": 2157, "dest-port": 12366, "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.6.6-12366-12366", "lastupdated": 1644817628460, "source-ip": "10.101.3.3", "bfd-echo-tx-pkts": 449575, "bfd-pmtu-rx-pkts": 2157, "bfd-echo-rx-octets": 75380984 }, { "dest-ip": "10.102.16.16", "source-port": 12366, "bfd-echo-rx-pkts": 449641, "vdevice-name": "169.254.10.10", "bfd-pmtu-tx-octets": 531622, "bfd-echo-tx-octets": 75237437, "bfd-pmtu-rx-octets": 2835599, "vdevice-host-name": "vm3", "tunnel-protocol": "ipsec", "bfd-pmtu-tx-pkts": 2157, "dest-port": 12366, "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.16.16-12366-12366", "lastupdated": 1644817628460, "source-ip": "10.101.3.3", "bfd-echo-tx-pkts": 449641, "bfd-pmtu-rx-pkts": 2157, "bfd-echo-rx-octets": 75392298 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Security-read,Security-write,System-read,System-write" } }, "/device/tunnel/fec_statistics": { "get": { "tags": [ "Real-Time Monitoring - Tunnel" ], "description": "Get tunnel fec statistics", "operationId": "createFecStatistics", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "tunnel fec statistics": { "description": "tunnel fec statistics", "value": { "data": [ { "dest-ip": "30.30.30.30", "source-port": 0, "vdevice-name": "169.254.10.10", "fec-rx-parity-pkts": 0, "fec-capable": "false", "fec-tx-parity-pkts": 0, "vdevice-host-name": "vm3", "tunnel-protocol": "gre", "fec-tx-data-pkts": 0, "dest-port": 0, "vdevice-dataKey": "169.254.10.10-gre-10.0.3.3-30.30.30.30-0-0", "fec-rx-data-pkts": 0, "fec-reconstruct-pkts": 0, "lastupdated": 1644821014912, "source-ip": "10.0.3.3", "fec-dynamic": "false" }, { "dest-ip": "10.101.2.2", "source-port": 12366, "vdevice-name": "169.254.10.10", "fec-rx-parity-pkts": 0, "fec-capable": "false", "fec-tx-parity-pkts": 0, "vdevice-host-name": "vm3", "tunnel-protocol": "ipsec", "fec-tx-data-pkts": 0, "dest-port": 12346, "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.101.2.2-12366-12346", "fec-rx-data-pkts": 0, "fec-reconstruct-pkts": 0, "lastupdated": 1644821014912, "source-ip": "10.101.3.3", "fec-dynamic": "false" }, { "dest-ip": "10.101.4.4", "source-port": 12366, "vdevice-name": "169.254.10.10", "fec-rx-parity-pkts": 0, "fec-capable": "false", "fec-tx-parity-pkts": 0, "vdevice-host-name": "vm3", "tunnel-protocol": "ipsec", "fec-tx-data-pkts": 0, "dest-port": 12366, "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.101.4.4-12366-12366", "fec-rx-data-pkts": 0, "fec-reconstruct-pkts": 0, "lastupdated": 1644821014912, "source-ip": "10.101.3.3", "fec-dynamic": "false" }, { "dest-ip": "10.102.5.5", "source-port": 12366, "vdevice-name": "169.254.10.10", "fec-rx-parity-pkts": 0, "fec-capable": "false", "fec-tx-parity-pkts": 0, "vdevice-host-name": "vm3", "tunnel-protocol": "ipsec", "fec-tx-data-pkts": 0, "dest-port": 12366, "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.5.5-12366-12366", "fec-rx-data-pkts": 0, "fec-reconstruct-pkts": 0, "lastupdated": 1644821014912, "source-ip": "10.101.3.3", "fec-dynamic": "false" }, { "dest-ip": "10.102.6.6", "source-port": 12366, "vdevice-name": "169.254.10.10", "fec-rx-parity-pkts": 0, "fec-capable": "false", "fec-tx-parity-pkts": 0, "vdevice-host-name": "vm3", "tunnel-protocol": "ipsec", "fec-tx-data-pkts": 0, "dest-port": 12366, "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.6.6-12366-12366", "fec-rx-data-pkts": 0, "fec-reconstruct-pkts": 0, "lastupdated": 1644821014912, "source-ip": "10.101.3.3", "fec-dynamic": "false" }, { "dest-ip": "10.102.16.16", "source-port": 12366, "vdevice-name": "169.254.10.10", "fec-rx-parity-pkts": 0, "fec-capable": "false", "fec-tx-parity-pkts": 0, "vdevice-host-name": "vm3", "tunnel-protocol": "ipsec", "fec-tx-data-pkts": 0, "dest-port": 12366, "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.16.16-12366-12366", "fec-rx-data-pkts": 0, "fec-reconstruct-pkts": 0, "lastupdated": 1644821014912, "source-ip": "10.101.3.3", "fec-dynamic": "false" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Security-read,Security-write,System-read,System-write" } }, "/device/tunnel/gre-keepalives": { "get": { "tags": [ "Real-Time Monitoring - Tunnel" ], "description": "Get GRE keep alive information", "operationId": "createGreKeepalivesList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "GRE keep alive": { "description": "GRE keep alive", "value": { "data": [ { "dest-ip": "30.30.30.30", "vdevice-name": "169.254.10.10", "rx-packets": 0, "rx-errors": 0, "oper-state": "down", "tx-errors": 0, "admin-state": "up", "vpn-id": "10", "vdevice-host-name": "vm3", "ka-enabled": "true", "remote-tx-packets": 0, "if-name": "gre1", "vdevice-dataKey": "169.254.10.10-10-gre1", "tx-packets": 81366, "remote-rx-packets": 0, "lastupdated": 1644817234436, "source-ip": "10.0.3.3" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Security-read,Security-write,System-read,System-write" } }, "/device/tunnel/ipsec_statistics": { "get": { "tags": [ "Real-Time Monitoring - Tunnel" ], "description": "Get tunnel IPSec statistics all devices", "operationId": "createIpsecStatisticsList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Tunnel IPSec statistics": { "description": "Tunnel IPSec statistics", "value": { "data": [ { "dest-ip": "30.30.30.30", "source-port": 0, "dest-port": 0, "vdevice-dataKey": "169.254.10.10-gre-10.0.3.3-30.30.30.30-0-0", "vdevice-name": "169.254.10.10", "lastupdated": 1644818093996, "source-ip": "10.0.3.3", "vdevice-host-name": "vm3", "tunnel-protocol": "gre" }, { "dest-ip": "10.101.2.2", "source-port": 12366, "vdevice-name": "169.254.10.10", "ipsec-rx-failures": 0, "ipsec-rx-auth-failures": 0, "ipsec-tx-auth-failures": 0, "vdevice-host-name": "vm3", "tunnel-protocol": "ipsec", "dest-port": 12346, "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.101.2.2-12366-12346", "ipsec-decrypt-inbound": 428675, "lastupdated": 1644818093996, "source-ip": "10.101.3.3", "ipsec-tx-failures": 0, "ipsec-encrypt-outbound": 428675 }, { "dest-ip": "10.101.4.4", "source-port": 12366, "vdevice-name": "169.254.10.10", "ipsec-rx-failures": 0, "ipsec-rx-auth-failures": 0, "ipsec-tx-auth-failures": 0, "vdevice-host-name": "vm3", "tunnel-protocol": "ipsec", "dest-port": 12366, "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.101.4.4-12366-12366", "ipsec-decrypt-inbound": 428832, "lastupdated": 1644818093996, "source-ip": "10.101.3.3", "ipsec-tx-failures": 0, "ipsec-encrypt-outbound": 428832 }, { "dest-ip": "10.102.5.5", "source-port": 12366, "vdevice-name": "169.254.10.10", "ipsec-rx-failures": 0, "ipsec-rx-auth-failures": 0, "ipsec-tx-auth-failures": 0, "vdevice-host-name": "vm3", "tunnel-protocol": "ipsec", "dest-port": 12366, "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.5.5-12366-12366", "ipsec-decrypt-inbound": 452605, "lastupdated": 1644818093996, "source-ip": "10.101.3.3", "ipsec-tx-failures": 0, "ipsec-encrypt-outbound": 452605 }, { "dest-ip": "10.102.6.6", "source-port": 12366, "vdevice-name": "169.254.10.10", "ipsec-rx-failures": 0, "ipsec-rx-auth-failures": 0, "ipsec-tx-auth-failures": 0, "vdevice-host-name": "vm3", "tunnel-protocol": "ipsec", "dest-port": 12366, "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.6.6-12366-12366", "ipsec-decrypt-inbound": 452712, "lastupdated": 1644818093996, "source-ip": "10.101.3.3", "ipsec-tx-failures": 0, "ipsec-encrypt-outbound": 452712 }, { "dest-ip": "10.102.16.16", "source-port": 12366, "vdevice-name": "169.254.10.10", "ipsec-rx-failures": 0, "ipsec-rx-auth-failures": 0, "ipsec-tx-auth-failures": 0, "vdevice-host-name": "vm3", "tunnel-protocol": "ipsec", "dest-port": 12366, "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.16.16-12366-12366", "ipsec-decrypt-inbound": 452777, "lastupdated": 1644818093996, "source-ip": "10.101.3.3", "ipsec-tx-failures": 0, "ipsec-encrypt-outbound": 452777 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Security-read,Security-write,System-read,System-write" } }, "/device/tunnel/packet-duplicate": { "get": { "tags": [ "Real-Time Monitoring - Tunnel" ], "description": "Get tunnel statistics packet duplication statistics", "operationId": "createPacketDuplicateStatistics", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "tunnel statistics packet duplication stats": { "description": "tunnel statistics packet duplication stats", "value": { "data": [ { "dest-ip": "30.30.30.30", "source-port": 0, "pktdup-tx": 0, "pktdup-rx-other": 0, "vdevice-name": "169.254.10.10", "pktdup-rx": 0, "pktdup-rx-this": 0, "vdevice-host-name": "vm3", "tunnel-protocol": "gre", "dest-port": 0, "vdevice-dataKey": "169.254.10.10-gre-10.0.3.3-30.30.30.30-0-0", "pktdup-capable": "false", "lastupdated": 1644820446648, "source-ip": "10.0.3.3", "pktdup-tx-other": 0 }, { "dest-ip": "10.101.2.2", "source-port": 12366, "pktdup-tx": 0, "pktdup-rx-other": 0, "vdevice-name": "169.254.10.10", "pktdup-rx": 0, "pktdup-rx-this": 0, "vdevice-host-name": "vm3", "tunnel-protocol": "ipsec", "dest-port": 12346, "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.101.2.2-12366-12346", "pktdup-capable": "false", "lastupdated": 1644820446648, "source-ip": "10.101.3.3", "pktdup-tx-other": 0 }, { "dest-ip": "10.101.4.4", "source-port": 12366, "pktdup-tx": 0, "pktdup-rx-other": 0, "vdevice-name": "169.254.10.10", "pktdup-rx": 0, "pktdup-rx-this": 0, "vdevice-host-name": "vm3", "tunnel-protocol": "ipsec", "dest-port": 12366, "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.101.4.4-12366-12366", "pktdup-capable": "false", "lastupdated": 1644820446648, "source-ip": "10.101.3.3", "pktdup-tx-other": 0 }, { "dest-ip": "10.102.5.5", "source-port": 12366, "pktdup-tx": 0, "pktdup-rx-other": 0, "vdevice-name": "169.254.10.10", "pktdup-rx": 0, "pktdup-rx-this": 0, "vdevice-host-name": "vm3", "tunnel-protocol": "ipsec", "dest-port": 12366, "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.5.5-12366-12366", "pktdup-capable": "false", "lastupdated": 1644820446648, "source-ip": "10.101.3.3", "pktdup-tx-other": 0 }, { "dest-ip": "10.102.6.6", "source-port": 12366, "pktdup-tx": 0, "pktdup-rx-other": 0, "vdevice-name": "169.254.10.10", "pktdup-rx": 0, "pktdup-rx-this": 0, "vdevice-host-name": "vm3", "tunnel-protocol": "ipsec", "dest-port": 12366, "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.6.6-12366-12366", "pktdup-capable": "false", "lastupdated": 1644820446648, "source-ip": "10.101.3.3", "pktdup-tx-other": 0 }, { "dest-ip": "10.102.16.16", "source-port": 12366, "pktdup-tx": 0, "pktdup-rx-other": 0, "vdevice-name": "169.254.10.10", "pktdup-rx": 0, "pktdup-rx-this": 0, "vdevice-host-name": "vm3", "tunnel-protocol": "ipsec", "dest-port": 12366, "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.16.16-12366-12366", "pktdup-capable": "false", "lastupdated": 1644820446648, "source-ip": "10.101.3.3", "pktdup-tx-other": 0 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Security-read,Security-write,System-read,System-write" } }, "/device/tunnel/statistics": { "get": { "tags": [ "Real-Time Monitoring - Tunnel" ], "description": "Get tunnel statistics all devices", "operationId": "createStatisticsList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Tunnel statistics": { "description": "Tunnel statistics", "value": { "data": [ { "dest-ip": "30.30.30.30", "source-port": 0, "vdevice-name": "169.254.10.10", "rx_pkts": 0, "tcp-mss-adjust": 1392, "tx_octets": 0, "vdevice-host-name": "vm3", "tunnel-protocol": "gre", "tx_pkts": 0, "dest-port": 0, "vdevice-dataKey": "169.254.10.10-gre-10.0.3.3-30.30.30.30-0-0", "rx_octets": 0, "tunnel-mtu": 1476, "lastupdated": 1644819414066, "source-ip": "10.0.3.3" }, { "dest-ip": "10.101.2.2", "source-port": 12366, "vdevice-name": "169.254.10.10", "rx_pkts": 431317, "system-ip": "172.16.254.1", "tcp-mss-adjust": 1361, "remote-color": "default", "tx_octets": 72492445, "vdevice-host-name": "vm3", "tunnel-protocol": "ipsec", "local-color": "default", "tx_pkts": 431317, "dest-port": 12346, "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.101.2.2-12366-12346", "rx_octets": 72492438, "tunnel-mtu": 1441, "lastupdated": 1644819414066, "source-ip": "10.101.3.3" }, { "dest-ip": "10.101.4.4", "source-port": 12366, "vdevice-name": "169.254.10.10", "rx_pkts": 431474, "system-ip": "172.16.254.3", "tcp-mss-adjust": 1361, "remote-color": "default", "tx_octets": 72518784, "vdevice-host-name": "vm3", "tunnel-protocol": "ipsec", "local-color": "default", "tx_pkts": 431474, "dest-port": 12366, "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.101.4.4-12366-12366", "rx_octets": 72517505, "tunnel-mtu": 1441, "lastupdated": 1644819414066, "source-ip": "10.101.3.3" }, { "dest-ip": "10.102.5.5", "source-port": 12366, "vdevice-name": "169.254.10.10", "rx_pkts": 455393, "system-ip": "172.16.254.4", "tcp-mss-adjust": 1361, "remote-color": "default", "tx_octets": 76373141, "vdevice-host-name": "vm3", "tunnel-protocol": "ipsec", "local-color": "default", "tx_pkts": 455393, "dest-port": 12366, "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.5.5-12366-12366", "rx_octets": 78844158, "tunnel-mtu": 1441, "lastupdated": 1644819414066, "source-ip": "10.101.3.3" }, { "dest-ip": "10.102.6.6", "source-port": 12366, "vdevice-name": "169.254.10.10", "rx_pkts": 455504, "system-ip": "172.16.254.5", "tcp-mss-adjust": 1361, "remote-color": "default", "tx_octets": 76391653, "vdevice-host-name": "vm3", "tunnel-protocol": "ipsec", "local-color": "default", "tx_pkts": 455504, "dest-port": 12366, "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.6.6-12366-12366", "rx_octets": 78862831, "tunnel-mtu": 1441, "lastupdated": 1644819414066, "source-ip": "10.101.3.3" }, { "dest-ip": "10.102.16.16", "source-port": 12366, "vdevice-name": "169.254.10.10", "rx_pkts": 455567, "system-ip": "172.16.254.16", "tcp-mss-adjust": 1361, "remote-color": "default", "tx_octets": 76401957, "vdevice-host-name": "vm3", "tunnel-protocol": "ipsec", "local-color": "default", "tx_pkts": 455567, "dest-port": 12366, "vdevice-dataKey": "169.254.10.10-ipsec-10.101.3.3-10.102.16.16-12366-12366", "rx_octets": 78873632, "tunnel-mtu": 1441, "lastupdated": 1644819414066, "source-ip": "10.101.3.3" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Security-read,Security-write,System-read,System-write" } }, "/device/ucse/stats": { "get": { "tags": [ "Real-Time Monitoring - Ucse" ], "description": "Get UCSE stats entry from device", "operationId": "createUcseStats", "parameters": [ { "name": "remote-tloc-address", "in": "query", "description": "Remote TLOC address", "schema": { "type": "string" } }, { "name": "remote-tloc-color", "in": "query", "description": "Remote tloc color", "schema": { "type": "string", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] } }, { "name": "local-tloc-color", "in": "query", "description": "Local tloc color", "schema": { "type": "string", "enum": [ "default", "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { " UCSE stats entry": { "description": " UCSE stats entry", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "vdevice-dataKey": "172.16.254.15", "lastupdated": 1646031617468, "slot-num": "0", "subslot-num": "1", "shutdown-count": "1", "status-count": "0", "server-raid-password-reset-count": "1", "server-bios-password-reset-count": "2", "server-reload-count": "1", "server-reset-count": "1", "server-start-count": "1", "server-stop-count": "1", "imc-password-reset-count": "1", "imc-vlan-count": "1", "imc-access-port-count": "1", "imc-ip-count": "1", "stats-start-time": "13:59:27 PDT Jun 5 2022" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Security-read,Security-write" } }, "/device/umbrella/device-registration": { "get": { "tags": [ "Real-Time Monitoring - Umbrella" ], "description": "Get Umbrella device registration from device", "operationId": "getUmbrellaDevReg", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Umbrella device registration": { "description": "Umbrella device registration", "value": { "data": [ { "vdevice-name": "169.254.10.9", "vdevice-host-name": "vm2", "vdevice-dataKey": "169.254.10.9", "vpn-id": "1", "intf-name": "GigabitEthernet1/0/1", "state": "SUCCESS", "deviceID": "010a9b2b0d5cb21f", "org-id": 1892929, "retry-count": 10, "tag": "vpn29", "label": "-", "http-response-code": 200, "http-response-text": "SUCCESS", "last-error": "-", "last-code": "-", "last-code-text": "-", "lastupdated": 1659327030348 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/umbrella/dnscrypt": { "get": { "tags": [ "Real-Time Monitoring - Umbrella" ], "description": "Get Umbrella DNScrypt information from device", "operationId": "getUmbrellaDNSCrypt", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Umbrella DNScrypt information": { "description": "Umbrella DNScrypt information", "value": { "data": [ { "vdevice-name": "169.254.10.10", "index": 0, "serial-num": 0, "vdevice-host-name": "vm3", "certificate-valid-from": "Jan 01 00:00:00 1970 GMT", "client-magic": "0:0:0:0", "vdevice-dataKey": "169.254.10.10-0", "certificate-validity": "Invalid", "client-public-key": "B40F:FA9A:31BB:690:C9F:7FEF:60A6:7FF5:286A:F519:64B2:586B:E35E:E4F0:E496:7FEE", "certificate-state": "Init", "resolver-public-key": "0:0:0:0:0:0:0:0:0:0:0:0:0:0:0:0", "certificate-valid-till": "Jan 01 00:00:00 1970 GMT", "lastupdated": 1644823735329, "certificate-last-refresh-time": "Jan 01 00:00:00 1970 GMT", "resolver-address": "208.67.222.222" }, { "vdevice-name": "169.254.10.10", "index": 1, "serial-num": 0, "vdevice-host-name": "vm3", "certificate-valid-from": "Jan 01 00:00:00 1970 GMT", "client-magic": "0:0:0:0", "vdevice-dataKey": "169.254.10.10-1", "certificate-validity": "Invalid", "client-public-key": "97A1:BCCD:92FE:7FCE:2EC7:CEBC:B6CB:7589:9E63:D830:5D56:FEFD:301E:56C3:D9EF:1851", "certificate-state": "Init", "resolver-public-key": "0:0:0:0:0:0:0:0:0:0:0:0:0:0:0:0", "certificate-valid-till": "Jan 01 00:00:00 1970 GMT", "lastupdated": 1644823735329, "certificate-last-refresh-time": "Jan 01 00:00:00 1970 GMT", "resolver-address": "208.67.220.220" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/umbrella/dp-stats": { "get": { "tags": [ "Real-Time Monitoring - Umbrella" ], "description": "Get Umbrella dp-stats from device", "operationId": "getUmbrellaDpStats", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Umbrella dp-stats": { "description": "Umbrella dp-stats", "value": { "data": [ { "vdevice-name": "169.254.10.9", "vdevice-host-name": "vm2", "vpn-id": "1", "local-domain-bypass-pkts": "0", "dnscrypt-dec-rcvd": "0", "redirect-pkts": "0", "dnscrypt-enc-sent": "0", "dnscrypt-errors": "0", "parser-errors": "0", "lastupdated": 1659327030348, "vdevice-dataKey": "169.254.10.9" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/umbrella/overview": { "get": { "tags": [ "Real-Time Monitoring - Umbrella" ], "description": "Get Umbrella overview from device", "operationId": "getUmbrellaOverview", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Umbrella overview": { "description": "Umbrella overview", "value": { "data": [ { "vdevice-dataKey": "169.254.10.10", "vdevice-name": "169.254.10.10", "registrations-requested": "0", "registrations-completed": "0", "lastupdated": 1644823908956, "dnscrypt": "true", "vdevice-host-name": "vm3", "last-success-attempt": "0000-00-00T00:00:00+00:00" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/umbrella/umbrella-config": { "get": { "tags": [ "Real-Time Monitoring - Umbrella" ], "description": "Get Umbrella configuration from device", "operationId": "getUmbrellaConfig", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Umbrella configuration": { "description": "Umbrella configuration", "value": { "data": [ { "vdevice-dataKey": "169.254.10.10", "vdevice-name": "169.254.10.10", "ldb-status": "-N/A-", "public-key": "B0E1:6D15:C32D:4E8C:996B:635A:FA90:05B9", "lastupdated": 1644823464208, "DNSCrypt": "Enabled", "vdevice-host-name": "vm3", "resolver-address": "208.67.222.222, 208.67.220.220" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/unclaimed/vedges": { "get": { "tags": [ "Real-Time Monitoring - AAA" ], "description": "Get unclaimed vEdges from vbond", "operationId": "getUnclaimedVedges", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Unclaimed vEdges": { "description": "Unclaimed vEdges", "value": { "data": [ { "vdevice-name": "172.16.255.15", "chassis-number": "07a08f05-ad1d-4ccc-b383-dc608f4eb2a3", "serial-number": "E66DC14C154D4861", "subject-serial-number": "E66DC14C154D4861", "org": "viptela.local" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Routing-read,Routing-write,System-read,System-write" } }, "/device/unconfigured": { "get": { "tags": [ "Monitoring - Device Details" ], "description": "Get wan edge devices not configured by vManage (that is, those in CLI mode)", "operationId": "getUnconfigured", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "chassis-serial-number": { "type": "string", "example": "SSI130300YK" }, "configuredAaaUser": { "type": "array", "items": { "type": "string" } }, "device-model": { "type": "string", "example": "C8000v" }, "device-os": { "type": "string", "example": "next" }, "device-type": { "type": "string", "example": "vedge" }, "deviceId": { "type": "string", "example": "C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f" }, "devicesAttached": { "type": "integer", "format": "int32", "example": 0 }, "discoveredDeviceInterfaces": { "type": "array", "items": { "type": "string" } }, "host-name": { "type": "string", "example": "vm5" }, "loopback": { "type": "array", "items": { "type": "object", "properties": { "interfaceIP": { "type": "string", "example": "127.0.0.1" }, "interfaceName": { "type": "string", "example": "Loopback0" } }, "$$ref": "#/components/schemas/Loopback" } }, "personality": { "type": "string", "example": "vedge" }, "platform": { "type": "string", "example": "x86_64" }, "reachability": { "type": "string", "example": "reachable", "enum": [ "reachable", "unreachable" ] }, "registrationDate": { "type": "integer", "format": "int64", "example": 1590186370340 }, "serialNumber": { "type": "string", "example": "12345712" }, "site-id": { "type": "string", "example": "500" }, "state": { "type": "string", "example": "green" }, "status": { "type": "string", "example": "normal", "enum": [ "error", "warning", "normal", "new" ] }, "system-ip": { "type": "string", "example": "172.16.255.15" }, "templateStatus": { "type": "string", "example": "Success" }, "uuid": { "type": "string", "example": "C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f" }, "validity": { "type": "string", "example": "valid", "enum": [ "invalid", "staging", "valid", "prestaging" ] }, "version": { "type": "string", "example": "17.06.01.0.1422" }, "wanInterfaces": { "type": "array", "items": { "type": "string" } } }, "$$ref": "#/components/schemas/Device" } }, "examples": { "Unconfigured devices": { "description": "Unconfigured devices", "value": [ { "uuid": "3e314ce8-cbaf-4fc7-882b-bacd16bd9a33", "systemIp": "172.16.255.11", "deviceType": "vedge" }, { "uuid": "a9d47933-ee30-4e9f-bee6-a2ac81a0b284", "systemIp": "172.16.255.21", "deviceType": "vedge" }, { "uuid": "e417ea1d-43dd-4285-8077-f7e20975568a", "systemIp": "172.16.255.14", "deviceType": "vedge" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/underlay/alarms/{type}": { "get": { "tags": [ "Monitoring - Underlay Alarms" ], "description": "Get Underlay Alarms Overview", "operationId": "getUnderlayAlarmsOverview", "parameters": [ { "name": "type", "in": "path", "description": "Underlay Alarms filter", "required": true, "schema": { "pattern": "alarm|device", "type": "string", "enum": [ "alarm", "device" ] } }, { "name": "last_n_hours", "in": "query", "schema": { "maximum": 24, "minimum": 1, "type": "integer", "format": "int32", "default": 12 } }, { "name": "limit", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32", "default": 30 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "alarms": { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "integer", "format": "int64", "example": 10 }, "ruleName": { "type": "string", "example": "interface-state-change" }, "ruleNameDisplay": { "type": "string", "example": "Interface_State_Change" }, "severity": { "type": "string", "example": "Critical" } }, "$$ref": "#/components/schemas/DeviceAlarmData" } }, "count": { "type": "integer", "format": "int64", "example": 50 }, "hostName": { "type": "string", "example": "vm4" }, "siteId": { "type": "string", "example": "400" }, "siteName": { "type": "string", "example": "SITE_400" }, "systemIp": { "type": "string", "example": "172.16.255.14" } }, "$$ref": "#/components/schemas/FilterByDeviceData" } } }, "$$ref": "#/components/schemas/UnderlayAlarmFilterByDevice" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "integer", "format": "int64", "example": 20 }, "devices": { "type": "array", "description": "devices values", "example": [ "172.16.255.15", "172.16.255.16" ], "items": { "type": "string", "description": "device", "example": "172.16.255.15" } }, "prevDevices": { "type": "array", "description": "previce devices values", "example": [ "172.16.255.15", "172.16.255.16" ], "items": { "type": "string", "description": "prev device", "example": "172.16.255.15" } }, "ruleName": { "type": "string", "example": "interface-state-change" }, "ruleNameDisplay": { "type": "string", "example": "Interface_State_Change" }, "severity": { "type": "string", "example": "Critical" } }, "$$ref": "#/components/schemas/FilterByAlarmTypeData" } } }, "$$ref": "#/components/schemas/UnderlayAlarmFilterByAlarmType" } ] }, "examples": { "UnderlayAlarmFilterByDevice": { "description": "UnderlayAlarmFilterByDevice", "value": { "data": [ { "system_ip": "172.16.255.16", "count": 2, "site_id": "600", "site_name": "SITE_600", "host_name": "vm6", "alarms": [ { "count": 1, "rule_name_display": "BFD_Node_Down", "severity": "Critical", "rulename": "node_down" }, { "count": 1, "rule_name_display": "Interface_State_Change", "severity": "Critical", "rulename": "interface-state-change" } ] }, { "system_ip": "172.16.255.15", "count": 2, "site_id": "500", "site_name": "SITE_500", "host_name": "vm5", "alarms": [ { "count": 1, "rule_name_display": "BFD_Node_Down", "severity": "Critical", "rulename": "node_down" }, { "count": 1, "rule_name_display": "Interface_State_Change", "severity": "Critical", "rulename": "interface-state-change" } ] }, { "system_ip": "172.16.255.11", "count": 1, "site_id": "100", "site_name": "SITE_100", "host_name": "vm1", "alarms": [ { "count": 1, "rule_name_display": "BFD_Node_Down", "severity": "Critical", "rulename": "node_down" } ] }, { "system_ip": "172.16.255.21", "count": 1, "site_id": "100", "site_name": "SITE_100", "host_name": "vm11", "alarms": [ { "count": 1, "rule_name_display": "BFD_Node_Down", "severity": "Critical", "rulename": "node_down" } ] }, { "system_ip": "172.16.255.14", "count": 1, "site_id": "400", "site_name": "SITE_400", "host_name": "vm4", "alarms": [ { "count": 1, "rule_name_display": "BFD_Node_Down", "severity": "Critical", "rulename": "node_down" } ] } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceUnderlayUnderlayalarmsapiResponseExampleUnderlayalarmfilterbydevice" }, "UnderlayAlarmFilterByAlarmType": { "description": "UnderlayAlarmFilterByAlarmType", "value": { "data": [ { "rule_name_display": "Interface_State_Change", "severity": "Critical", "rulename": "interface-state-change", "devices": [ "172.16.255.15", "172.16.255.14" ], "prev_devices": [] }, { "rule_name_display": "BFD_Site_Down", "severity": "Critical", "rulename": "site_down", "devices": [ "172.16.255.15", "172.16.255.14" ], "prev_devices": [ "172.16.255.15", "172.16.255.14" ] }, { "rule_name_display": "BFD_Node_Down", "severity": "Critical", "rulename": "node_down", "devices": [ "172.16.255.15", "172.16.255.14" ], "prev_devices": [] } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceUnderlayUnderlayalarmsapiResponseExampleUnderlayalarmfilterbyalarmtype" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/unreachable": { "get": { "tags": [ "Monitoring - Device Details" ], "description": "Get list of unreachable devices", "operationId": "listUnreachableDevices", "parameters": [ { "name": "personality", "in": "query", "description": "Device personality (vedge OR vsmart OR vbond... )", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "List of unreachable devices": { "description": "List of unreachable devices", "value": { "header": { "generatedOn": 1635316653935, "viewKeys": { "uniqueKey": [ "system-ip" ], "preferenceKey": "grid-vManage Control Connections" }, "columns": [ { "title": "Reachability", "property": "reachability", "colorProperty": "reachability", "color": [ { "key": "reachable", "value": "616161" }, { "key": "unreachable", "value": "ef5350" }, { "key": "auth-failed", "value": "ffb300" } ], "width": 100, "minWidth": 90, "dataType": "string" }, { "title": "Hostname", "property": "host-name", "display": "iconAndText", "iconProperty": "device-type", "hideable": false, "icon": [ { "key": "vmanage", "value": "images/vmanage_table.png" }, { "key": "vedge", "value": "images/vedge_table.png" }, { "key": "vedge-vbond", "value": "images/vedge-vbond_table.png" }, { "key": "vsmart", "value": "images/vsmart_table.png" }, { "key": "vbond", "value": "images/vbond_table.png" } ], "width": 150, "dataType": "string" } ], "fields": [ { "property": "board-serial", "dataType": "string" }, { "property": "lastupdated", "dataType": "date" } ] }, "data": [] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/unreachable/{deviceIP}": { "delete": { "tags": [ "Monitoring - Device Details" ], "description": "Delete unreachable device", "operationId": "removeUnreachableDevice", "parameters": [ { "name": "deviceIP", "in": "path", "description": "Device IP", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/users": { "get": { "tags": [ "Real-Time Monitoring - AAA" ], "description": "Get users from device (Real Time)", "operationId": "getUsersFromDevice", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Users": { "description": "Users", "value": [ { "from": "10.0.1.1", "proto": "ssh", "login-time": "2022-01-26T07:36:15+00:00", "auth-group": "netadmin log ", "lastupdated": 1644914131016, "vdevice-dataKey": "172.16.255.11-28", "session": "28", "user": "admin", "context": "cli", "vdevice-host-name": "vm1", "vdevice-name": "172.16.255.11" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/users/list": { "get": { "tags": [ "Real-Time Monitoring - AAA" ], "description": "Get all users from device", "operationId": "getAllDeviceUsers", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Users": { "description": "Users", "value": { "data": [ { "user": "admin" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Tools-read,Tools-write" } }, "/device/utd/dataplane-config": { "get": { "tags": [ "Real-Time Monitoring - UTD" ], "description": "Get data plane config from Device", "operationId": "getUTDDataplaneConfig", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "UTD data plane config": { "description": "UTD data plane config", "value": { "data": [ { "sn-redirect": "fail-open", "vdevice-name": "172.16.255.15", "context-flag": "8847361", "defense-mode": "IPS", "context-id": "0", "redirect-type": "divert", "vdevice-host-name": "vm5", "vdevice-dataKey": "172.16.255.15-0", "threat-inspection": "enabled", "engine": "Standard", "domain-filtering": "not-enabled", "url-filtering": "not-enabled", "lastupdated": 1659514008513, "state": "enabled", "all-interface": "enabled" }, { "sn-redirect": "fail-open", "vdevice-name": "172.16.255.15", "context-flag": "13041665", "defense-mode": "IPS", "context-id": "3", "redirect-type": "divert", "vdevice-host-name": "vm5", "vdevice-dataKey": "172.16.255.15-3", "threat-inspection": "enabled", "engine": "Standard", "domain-filtering": "not-enabled", "url-filtering": "enabled", "lastupdated": 1659514008513, "state": "enabled", "all-interface": "enabled" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/utd/dataplane-global": { "get": { "tags": [ "Real-Time Monitoring - UTD" ], "description": "Get data plane global from Device", "operationId": "getUTDDataplaneGlobal", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "UTD data plane global": { "description": "UTD data plane global", "value": { "data": [ { "utd-appnav-dereg-failed": "0", "utd-appnav-health-down": "0", "vdevice-name": "172.16.255.15", "utd-appnav-health-yellow": "0", "init-service-plane-failed": "0", "sn-threads": "12", "cft-utd-fo-id": "4", "cft-feat-id": "4", "sn-health": "green", "nat64": "disabled", "utd-appnav-health-green": "1", "multi-tenancy": "enabled", "max-flows": "165000", "cft-utd-fo-chunk-id": "12", "utd-appnav-health-unknown": "0", "utd-appnav-health-red": "1", "vdevice-host-name": "vm5", "dp-initialized": "yes", "vdevice-dataKey": "172.16.255.15", "cft-id": "0", "utd-appnav-register": "0", "utd-appnav-deregister": "0", "utd-appnav-reg-failed": "0", "lastupdated": 1659514090144, "drop-pkts": "disabled" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/utd/dataplane-stats": { "get": { "tags": [ "Real-Time Monitoring - UTD" ], "description": "Get data plane stats from Device", "operationId": "getUTDDataplaneStats", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "UTD data plane stats": { "description": "UTD data plane stats", "value": { "data": [ { "cft-ager-del-fo": "0", "utd-appnav-decaps-icmp-no-payload-err": "0", "utd-drop-cft-lookup-flow": "0", "utd-pkts-enter-divert": "0", "utd-appnav-encaps-debug-err": "0", "utd-appnav-decaps-ip-unsup-ver": "0", "cft-ager-del-fo-failed": "0", "utd-flow-bypass": "0", "utd-packets-reinjected": "0", "utd-sn-drop": "0", "utd-drop-cft-get-fo": "0", "utd-appnav-decaps-icmp-v6-tcp-err": "0", "utd-df-blacklist-match": "0", "utd-drop-appnav-decaps-class-event-err": "0", "pkt-skip-invalid-iuidb": "0", "pkt-skip-for-us": "0", "utd-appnav-decaps-icmp-no-inner-flow": "0", "utd-appnav-encap-fail": "0", "utd-appnav-encaps-fail": "0", "pkt-skip-unsupport-prot": "0", "utd-appnav-decaps-icmp-udp-err": "0", "utd-drop-msg-logged": "0", "utd-appnav-decaps-no-fo": "0", "utd-drop-bad-ip-ver": "0", "utd-drop-cft-alloc-fo": "0", "utd-drop-nat64-int-lookup-fail": "0", "utd-drop-appnav-encaps-debug": "0", "pkt-no-inspect-divert-intf": "4516", "utd-drop-divert-down": "0", "pkt-policy-inspected": "87657", "min-utd-drop-cause": "0", "pkt-nat-dropped-pkt": "0", "utd-appnav-decaps-icmp-tcp-err": "0", "utd-df-gray-flows": "0", "vdevice-name": "172.16.255.15", "utd-drop-ipv6-frag": "0", "init-cft-inst-get-failed": "0", "utd-pm-tcpconns": "0", "utd-pkts-enter-policy": "0", "utd-appnav-decaps-del-term": "0", "pkt-skip-new-pkt": "0", "init-vfr-unreg-failed": "0", "utd-drop-appnav-encaps-vrf": "0", "utd-appnav-decaps-tlv-len-err": "0", "utd-appnav-decaps-icmp-no-inner-fo": "0", "utd-appnav-decaps-icmp-v6-udp-err": "0", "utd-appnav-redirect-fail": "0", "utd-drop-cft-attach-fo": "0", "utd-appnav-decaps-not-icmp-v6": "0", "utd-appnav-decaps-icmp-v6-no-payload-err": "0", "utd-pm-udpconns": "0", "flow-setup-failed": "0", "utd-df-whitelist-match": "0", "utd-drop-appnav-encaps-service-add": "0", "vdevice-host-name": "vm5", "utd-drop-appnav-encaps-not-enuf": "0", "utd-appnav-decaps-del-unknown": "0", "utd-drop-cft-no-fo": "0", "utd-drop-appnav-encaps-conn-handle-err": "0", "skp-no-divert-needed": "0", "utd-drop-was-vfr": "0", "lastupdated": 1659514165829, "utd-df-blacklisted-flows": "0", "utd-appnav-decaps": "0", "utd-appnav-decaps-icmp-unsup-proto": "0", "utd-drop-appnav-encaps-no-fo": "0", "utd-appnav-encaps": "0", "utd-active-conns": "0", "utd-appnav-decaps-no-flow": "0", "utd-bypass-drop": "0", "utd-appnav-decaps-ipv6-parse-err": "0", "init-cft-del-cb-reg-failed": "0", "utd-appnav-encaps-conn-est-err": "0", "utd-drop-appnav-divert": "0", "utd-drop-no-uidb": "0", "pkt-skip-inspected": "4516", "utd-appnav-decaps-unsupported-tlv": "0", "utd-drop-appnav-encaps-no-classified": "0", "pkt-fo-free-err": "0", "utd-drop-appnav-unhealthy": "0", "utd-drop-appnav-encaps-first-pkt-fail": "0", "utd-reinject-no-ctx": "0", "pkt-skip-no-ctx": "0", "pkt-skip-inspected-no-divert": "0", "utd-flow-notify-offload": "0", "utd-appnav-decaps-not-icmp-err": "0", "utd-drop-no-fib": "0", "utd-pkts-dropped": "0", "utd-pkt-entry-sp": "0", "utd-drop-appnav-decaps-no-flow-tuple": "0", "context-id": "0", "utd-df-whitelisted-flows": "0", "utd-drop-no-divert-intf": "0", "utd-appnav-redirect": "0", "pkt-skip-mpls-non-ip": "0", "utd-appnav-decaps-not-icmp-v6-err": "0", "utd-drop-no-oce-chain": "0", "pkt-skip-l2-glean-adj": "0", "utd-appnav-decaps-icmp-v6-unsup-proto": "0", "utd-pm-icmpconns": "0", "utd-appnav-reinject": "0", "cft-flow-responder-seen": "0", "utd-drop-appnav-decaps-conn-est": "0", "utd-drop-no-egress-intf": "0", "utd-appnav-decaps-del-req": "0", "utd-appnav-unhealthy": "0", "utd-drop-appnav-encaps-no-mem": "0", "pkt-fo-alloc": "0", "utd-drop-ips": "0", "pkt-fo-free": "0", "init-vfr-reg-failed": "0", "utd-packets-diverted": "0", "utd-drop-appnav-decaps-delete": "0", "utd-drop-ipv4-frag": "0", "utd-drop-appnav-decaps-pass-err": "0", "utd-drop-sn-request": "0", "utd-appnav-encaps-vrf-err": "0", "utd-drop-reinject": "0", "utd-pkts-skipped": "0", "utd-packets-failed-divert": "0", "utd-appnav-decaps-no-conn-tlv-flow": "0", "vdevice-dataKey": "172.16.255.15-0", "pkt-skip-invalid-ouidb": "0", "utd-appnav-decaps-del-resource": "0", "utd-appnav-decaps-del-idle": "0" }, { "cft-ager-del-fo": "0", "utd-appnav-decaps-icmp-no-payload-err": "0", "utd-drop-cft-lookup-flow": "0", "utd-pkts-enter-divert": "0", "utd-appnav-encaps-debug-err": "0", "utd-appnav-decaps-ip-unsup-ver": "0", "cft-ager-del-fo-failed": "0", "utd-flow-bypass": "0", "utd-packets-reinjected": "0", "utd-sn-drop": "0", "utd-drop-cft-get-fo": "0", "utd-appnav-decaps-icmp-v6-tcp-err": "0", "utd-df-blacklist-match": "0", "utd-drop-appnav-decaps-class-event-err": "0", "pkt-skip-invalid-iuidb": "0", "pkt-skip-for-us": "0", "utd-appnav-decaps-icmp-no-inner-flow": "0", "utd-appnav-encap-fail": "0", "utd-appnav-encaps-fail": "0", "pkt-skip-unsupport-prot": "0", "utd-appnav-decaps-icmp-udp-err": "0", "utd-drop-msg-logged": "0", "utd-appnav-decaps-no-fo": "0", "utd-drop-bad-ip-ver": "0", "utd-drop-cft-alloc-fo": "0", "utd-drop-nat64-int-lookup-fail": "0", "utd-drop-appnav-encaps-debug": "0", "pkt-no-inspect-divert-intf": "0", "utd-drop-divert-down": "0", "pkt-policy-inspected": "0", "min-utd-drop-cause": "0", "pkt-nat-dropped-pkt": "0", "utd-appnav-decaps-icmp-tcp-err": "0", "utd-df-gray-flows": "0", "vdevice-name": "172.16.255.15", "utd-drop-ipv6-frag": "0", "init-cft-inst-get-failed": "0", "utd-pm-tcpconns": "0", "utd-pkts-enter-policy": "0", "utd-appnav-decaps-del-term": "0", "pkt-skip-new-pkt": "0", "init-vfr-unreg-failed": "0", "utd-drop-appnav-encaps-vrf": "0", "utd-appnav-decaps-tlv-len-err": "0", "utd-appnav-decaps-icmp-no-inner-fo": "0", "utd-appnav-decaps-icmp-v6-udp-err": "0", "utd-appnav-redirect-fail": "0", "utd-drop-cft-attach-fo": "0", "utd-appnav-decaps-not-icmp-v6": "0", "utd-appnav-decaps-icmp-v6-no-payload-err": "0", "utd-pm-udpconns": "0", "flow-setup-failed": "0", "utd-df-whitelist-match": "0", "utd-drop-appnav-encaps-service-add": "0", "vdevice-host-name": "vm5", "utd-drop-appnav-encaps-not-enuf": "0", "utd-appnav-decaps-del-unknown": "0", "utd-drop-cft-no-fo": "0", "utd-drop-appnav-encaps-conn-handle-err": "0", "skp-no-divert-needed": "0", "utd-drop-was-vfr": "0", "lastupdated": 1659514165829, "utd-df-blacklisted-flows": "0", "utd-appnav-decaps": "0", "utd-appnav-decaps-icmp-unsup-proto": "0", "utd-drop-appnav-encaps-no-fo": "0", "utd-appnav-encaps": "0", "utd-active-conns": "0", "utd-appnav-decaps-no-flow": "0", "utd-bypass-drop": "0", "utd-appnav-decaps-ipv6-parse-err": "0", "init-cft-del-cb-reg-failed": "0", "utd-appnav-encaps-conn-est-err": "0", "utd-drop-appnav-divert": "0", "utd-drop-no-uidb": "0", "pkt-skip-inspected": "0", "utd-appnav-decaps-unsupported-tlv": "0", "utd-drop-appnav-encaps-no-classified": "0", "pkt-fo-free-err": "0", "utd-drop-appnav-unhealthy": "0", "utd-drop-appnav-encaps-first-pkt-fail": "0", "utd-reinject-no-ctx": "0", "pkt-skip-no-ctx": "0", "pkt-skip-inspected-no-divert": "0", "utd-flow-notify-offload": "0", "utd-appnav-decaps-not-icmp-err": "0", "utd-drop-no-fib": "0", "utd-pkts-dropped": "0", "utd-pkt-entry-sp": "0", "utd-drop-appnav-decaps-no-flow-tuple": "0", "context-id": "3", "utd-df-whitelisted-flows": "0", "utd-drop-no-divert-intf": "0", "utd-appnav-redirect": "0", "pkt-skip-mpls-non-ip": "0", "utd-appnav-decaps-not-icmp-v6-err": "0", "utd-drop-no-oce-chain": "0", "pkt-skip-l2-glean-adj": "0", "utd-appnav-decaps-icmp-v6-unsup-proto": "0", "utd-pm-icmpconns": "0", "utd-appnav-reinject": "0", "cft-flow-responder-seen": "0", "utd-drop-appnav-decaps-conn-est": "0", "utd-drop-no-egress-intf": "0", "utd-appnav-decaps-del-req": "0", "utd-appnav-unhealthy": "0", "utd-drop-appnav-encaps-no-mem": "0", "pkt-fo-alloc": "0", "utd-drop-ips": "0", "pkt-fo-free": "0", "init-vfr-reg-failed": "0", "utd-packets-diverted": "0", "utd-drop-appnav-decaps-delete": "0", "utd-drop-ipv4-frag": "0", "utd-drop-appnav-decaps-pass-err": "0", "utd-drop-sn-request": "0", "utd-appnav-encaps-vrf-err": "0", "utd-drop-reinject": "0", "utd-pkts-skipped": "0", "utd-packets-failed-divert": "0", "utd-appnav-decaps-no-conn-tlv-flow": "0", "vdevice-dataKey": "172.16.255.15-3", "pkt-skip-invalid-ouidb": "0", "utd-appnav-decaps-del-resource": "0", "utd-appnav-decaps-del-idle": "0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/utd/dataplane-stats-summary": { "get": { "tags": [ "Real-Time Monitoring - UTD" ], "description": "Get data plane stats summary", "operationId": "getUTDDataplaneStatsSummary", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "UTD data plane stats summary": { "description": "UTD data plane stats summary", "value": { "data": [ { "utd-active-conns": "0", "vdevice-name": "172.16.255.15", "utd-drop-sn-request": "0", "utd-pm-udpconns": "0", "utd-pkts-dropped": "0", "context-id": "0", "utd-pkts-skipped": "0", "vdevice-host-name": "vm5", "utd-packets-reinjected": "0", "utd-pm-tcpconns": "0", "utd-pkts-enter-policy": "0", "utd-appnav-unhealthy": "0", "vdevice-dataKey": "172.16.255.15-0", "utd-pm-icmpconns": "0", "lastupdated": 1659514169760, "utd-packets-diverted": "0", "utd-flow-notify-offload": "0" }, { "utd-active-conns": "0", "vdevice-name": "172.16.255.15", "utd-drop-sn-request": "0", "utd-pm-udpconns": "0", "utd-pkts-dropped": "0", "context-id": "3", "utd-pkts-skipped": "0", "vdevice-host-name": "vm5", "utd-packets-reinjected": "0", "utd-pm-tcpconns": "0", "utd-pkts-enter-policy": "0", "utd-appnav-unhealthy": "0", "vdevice-dataKey": "172.16.255.15-3", "utd-pm-icmpconns": "0", "lastupdated": 1659514169760, "utd-packets-diverted": "0", "utd-flow-notify-offload": "0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/utd/engine-instance-status": { "get": { "tags": [ "Real-Time Monitoring - UTD" ], "description": "Get UTD engine instance status from device (Real Time)", "operationId": "getUTDEngineInstanceStatus", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "UTD engine instance status": { "description": "UTD engine instance status", "value": { "data": [ { "utd-engine-instance-status-running": "true", "vdevice-dataKey": "172.16.255.15-1", "vdevice-name": "172.16.255.15", "utd-engine-instance-status-id": "1", "utd-engine-instance-status-status": "utd-oper-status-green", "lastupdated": 1659499440216, "vdevice-host-name": "vm5" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/utd/engine-status": { "get": { "tags": [ "Real-Time Monitoring - UTD" ], "description": "Get UTD engine status from device (Real Time)", "operationId": "getUTDEngineStatus", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "UTD engine status": { "description": "UTD engine status", "value": { "data": [ { "vdevice-dataKey": "172.16.255.15", "utd-engine-status-version": "1.0.6_SV2.9.18.1_XE17.9", "vdevice-name": "172.16.255.15", "utd-engine-status-memory-status": "utd-oper-status-green", "lastupdated": 1659514314427, "utd-engine-status-status": "utd-oper-status-green", "utd-engine-status-memory-usage": "8.9", "vdevice-host-name": "vm5", "utd-engine-status-profile": "Cloud-Low" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/utd/file-analysis-status": { "get": { "tags": [ "Real-Time Monitoring - UTD" ], "description": "Get UTD file analysis status from device (Real Time)", "operationId": "getUTDFileAnalysisStatus", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "UTD file analysis status": { "description": "UTD file analysis status", "value": { "data": [ { "utd-file-analysis-status-status": "tg-client-stat-unknown", "vdevice-dataKey": "169.254.10.12", "vdevice-name": "169.254.10.12", "lastupdated": 1645768248935, "utd-file-analysis-status-backoff-interval": "0", "vdevice-host-name": "vm5" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/utd/file-reputation-status": { "get": { "tags": [ "Real-Time Monitoring - UTD" ], "description": "Get UTD file reputation status from device (Real Time)", "operationId": "getUTDFileReputationStatus", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "UTD file reputation status": { "description": "UTD file reputation status", "value": { "data": [ { "vdevice-dataKey": "169.254.10.12", "utd-file-reputation-status-status": "utd-file-repu-stat-process-unknown", "vdevice-name": "169.254.10.12", "lastupdated": 1645773049060, "vdevice-host-name": "vm5" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/utd/ips-update-status": { "get": { "tags": [ "Real-Time Monitoring - UTD" ], "description": "Get UTD IPS update status from device (Real Time)", "operationId": "getUTDIpsUpdateStatus", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "UTD IPS update status": { "description": "UTD IPS update status", "value": { "data": [ { "ips-update-status-last-update-time": "1970-01-01T00:00:00+00:00", "vdevice-dataKey": "172.16.255.15", "vdevice-name": "172.16.255.15", "lastupdated": 1659499361542, "ips-update-status-last-update-status": "utd-update-status-unknown", "vdevice-host-name": "vm5", "ips-update-status-last-successful-update-time": "1970-01-01T00:00:00+00:00" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/utd/signature/version/details": { "get": { "tags": [ "Real-Time Monitoring - UTD" ], "description": "Get UTD Signature version information from Device", "operationId": "getSignatureVersionInfo", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "UTD Signature version": { "description": "UTD Signature version", "value": { "data": [ { "last-updated": "-", "ips-version": "29.0.c" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/utd/urlf-con-status": { "get": { "tags": [ "Real-Time Monitoring - UTD" ], "description": "Get UTD URLF Connection status from device (Real Time)", "operationId": "getUTDUrlfConnectionStatus", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "UTD URLF connection status": { "description": "UTD URLF connection status", "value": { "data": [ { "vdevice-dataKey": "172.16.255.15", "vdevice-name": "172.16.255.15", "lastupdated": 1659499167268, "vdevice-host-name": "vm5", "last-attempt-time": "1970-01-01T00:00:00+00:00", "status": "utd-con-unknown" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/utd/urlf-update-status": { "get": { "tags": [ "Real-Time Monitoring - UTD" ], "description": "Get UTD URLF update status from device (Real Time)", "operationId": "getUTDUrlfUpdateStatus", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "UTD URLF update status": { "description": "UTD URLF update status", "value": { "data": [ { "urlf-update-status-last-successful-update-time": "1970-01-01T00:00:00+00:00", "vdevice-dataKey": "null", "urlf-update-status-last-update-status": "utd-update-status-unknown", "vdevice-name": "172.16.255.15", "urlf-update-status-last-update-time": "1970-01-01T00:00:00+00:00", "lastupdated": 1659499288353, "vdevice-host-name": "vm5" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/utd/version-status": { "get": { "tags": [ "Real-Time Monitoring - UTD" ], "description": "Get UTD version status from device (Real Time)", "operationId": "getUTDVersionStatus", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "UTD version status": { "description": "UTD version status", "value": { "data": [ { "utd-version-status-supported": "false", "vdevice-dataKey": "169.254.10.12", "vdevice-name": "169.254.10.12", "utd-version-status-recommended-version": "1.11.1_SV2.9.18.1_XEmain", "lastupdated": 1645756283937, "vdevice-host-name": "vm5", "utd-version-status-supported-regex": "^1\\.11\\.([0-9]+)_SV(.*)_XEmain$" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/vdslService/coLineSpecificStats": { "get": { "tags": [ "Real-Time Monitoring - VDSL Service" ], "description": "Get VDSL service line bonding stats from device", "operationId": "getCoLineSpecificStats", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "VDSL service line bonding stats": { "description": "VDSL service line bonding stats", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "slot-num": "0", "line-num": "4", "trellis-state": "ON", "sra-enabled": "disabled", "sra-count": "0", "bit-swap-enabled": "enabled", "bit-swap-count": "0", "line-attenuation": "0.9dB", "signal-attenuation": "1.8dB", "noise-margin": "18.6dB", "attainable-rate": "138139 kbits/s", "actual-power": "14.1dBm", "total-fecc": "302690", "total-es": "295", "total-ses": "161", "total-loss": "14", "total-uas": "87189", "total-lprs": "0", "total-lofs": "80", "total-lols": "0", "speed": "27547", "sra-previous-speed": "0", "previous-speed": "128857", "reed-solomon-ec": "0", "crc-errors": "24722", "header-errors": "8", "interleave": "7.00", "actual-inp": "1.00", "gfast-fra-count": "57", "gfast-rpa-count": "45", "gfast-tiga-count": "76", "gfast-rtx-uc": "0", "gfast-rtx-tx": "0", "gfast-attainable-exp-thru": "0", "gfast-error-free-thru": "0", "atm-total-cells": "11338923", "atm-user-cells": "0", "vdsl2-la-band-d1": "0.2", "vdsl2-la-band-d2": "0.9", "vdsl2-la-band-d3": "1.7", "vdsl2-sa-band-d1": "0.2", "vdsl2-sa-band-d2": "0.9", "vdsl2-sa-band-d3": "1.7", "vdsl2-snr-band-d1": "27.7", "vdsl2-snr-band-d2": "16.9", "vdsl2-snr-band-d3": "10.9", "vdevice-dataKey": "172.16.255.15", "lastupdated": 1642581869106 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/vdslService/coStats": { "get": { "tags": [ "Real-Time Monitoring - VDSL Service" ], "description": "Get CO stats from device", "operationId": "getCoStats", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "CO stats": { "description": "CO stats", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "chip-vendor": "BDCM", "line-attenuation": "0.9dB", "noise-margin": "18.6dB", "attainable-rate": "138139kbits/s", "actual-power": "14.1dBm", "speed": "128857", "slot-num": "0", "subslot-num": "0", "modem-serial": "FCH2234TH6R C927-4P 15.8(3)M1", "chip-vendor-specific": "0xB11F", "chip-vendor-country": "0xB500", "modem-vendor-id": "CSCO", "modem-vendor-specific": "0x4602", "modem-vendor-country": "0xB500", "modem-version": "15.8(3)M1", "lastupdated": 1642581869106, "vdevice-dataKey": "172.16.255.15" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/vdslService/cpeLineSpecificStats": { "get": { "tags": [ "Real-Time Monitoring - VDSL Service" ], "description": "Get VDSL service CPE line specific stats from device", "operationId": "getCpeLineSpecificStats", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "VDSL service CPE line specific stats": { "description": "VDSL service CPE line specific stats", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "slot-num": "0", "line-num": "4", "trellis-state": "ON", "sra-enabled": "disabled", "sra-count": "0", "bit-swap-enabled": "enabled", "bit-swap-count": "0", "line-attenuation": "0.9dB", "signal-attenuation": "1.8dB", "noise-margin": "18.6dB", "attainable-rate": "138139 kbits/s", "actual-power": "14.1dBm", "total-fecc": "302690", "total-es": "295", "total-ses": "161", "total-loss": "14", "total-uas": "87189", "total-lprs": "0", "total-lofs": "80", "total-lols": "0", "speed": "27547", "sra-previous-speed": "0", "previous-speed": "128857", "reed-solomon-ec": "0", "crc-errors": "24722", "header-errors": "8", "interleave": "7.00", "actual-inp": "1.00", "gfast-fra-count": "57", "gfast-rpa-count": "45", "gfast-tiga-count": "76", "gfast-rtx-uc": "0", "gfast-rtx-tx": "0", "gfast-attainable-exp-thru": "0", "gfast-error-free-thru": "0", "atm-total-cells": "11338923", "atm-user-cells": "0", "vdsl2-la-band-d1": "0.2", "vdsl2-la-band-d2": "0.9", "vdsl2-la-band-d3": "1.7", "vdsl2-sa-band-d1": "0.2", "vdsl2-sa-band-d2": "0.9", "vdsl2-sa-band-d3": "1.7", "vdsl2-snr-band-d1": "27.7", "vdsl2-snr-band-d2": "16.9", "vdsl2-snr-band-d3": "10.9", "vdevice-dataKey": "172.16.255.15", "lastupdated": 1642581869106 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/vdslService/cpeStats": { "get": { "tags": [ "Real-Time Monitoring - VDSL Service" ], "description": "Get CPE stats from device", "operationId": "getCpeStats", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "CPE stats": { "description": "CPE stats", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "chip-vendor": "BDCM", "line-attenuation": "0.9dB", "noise-margin": "18.6dB", "attainable-rate": "138139kbits/s", "actual-power": "14.1dBm", "speed": "128857", "slot-num": "0", "subslot-num": "0", "modem-serial": "", "chip-vendor-specific": "FCH2234TH6R C927-4P 15.8(3)M1", "chip-vendor-country": "0xB500", "modem-vendor-id": "CSCO", "modem-vendor-specific": "0x4602", "modem-vendor-country": "0xB500", "modem-version": "15.8(3)M1", "lastupdated": 1642581869106, "vdevice-dataKey": "172.16.255.15" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/vdslService/lineBondingStats": { "get": { "tags": [ "Real-Time Monitoring - VDSL Service" ], "description": "Get VDSL service line bonding stats from device", "operationId": "getLineBondingStats", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "VDSL service line bonding stats": { "description": "VDSL service line bonding stats", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "slot-num": "0", "ports-supported": "0", "port-0-link-status": "up", "port-1-link-status": "down", "aggregate-us-rate": "87957 kbits/s", "aggregate-ds-rate": "138139 kbits/s", "lastupdated": 0, "vdevice-dataKey": "172.16.255.15" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/vdslService/lineSpecificStats": { "get": { "tags": [ "Real-Time Monitoring - VDSL Service" ], "description": "Get VDSL service line specific stats from device", "operationId": "getLineSpecificStats", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "VDSL service line specific stats": { "description": "VDSL service line specific stats", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "vdevice-dataKey": "172.16.255.15", "slot-num": "0", "line-number": "4", "modem-status": "TC Sync (Showtime!)", "trained-mode": "G.992.5 (ADSL2+) Annex A", "profile-30a-enabled": "enabled", "lastupdated": 1642581869106 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/vdslService/vdslInfo": { "get": { "tags": [ "Real-Time Monitoring - VDSL Service" ], "description": "Get VDSL info from device", "operationId": "getVdslInfo", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "VDSL info": { "description": "VDSL info", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "state": "UP", "mode": "AUTO", "modem-status": "TC Sync (Showtime!)", "trained-mode": "G.993.2 (VDSL2) Profile 17a", "firmware-version": "4.14L.04", "phy-version": "A2pv6F039x8.d26d", "slot-num": "0", "subslot-num": "0", "dsl-config-mode": "AUTO", "delt-configuration-enabled": "disabled", "delt-state": "not running", "failed-full-inits": "15", "short-inits": "8", "failed-short-inits": "7", "modem-phy-source": "embedded", "training-log-state": "Stopped", "training-log-filename": "flash:vdsllog.bin", "lastupdated": 1642581869106, "vdevice-dataKey": "172.16.255.15" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/vedgeinventory/detail": { "get": { "tags": [ "Monitoring - Device Details" ], "description": "Get detailed vEdge inventory", "operationId": "getVedgeInventory", "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "chasisNumber": { "type": "string", "example": "0a452cf0-5db7-47c2-80bf-7e619e294a6b" }, "deviceType": { "type": "string", "example": "vedge" }, "local-system-ip": { "type": "string", "example": "172.16.255.14" }, "serialNumber": { "type": "string", "example": "12345707" }, "site-id": { "type": "string", "example": "400" }, "system-ip": { "type": "string", "example": "0.0.0.0" }, "validity": { "type": "string", "example": "valid" } }, "$$ref": "#/components/schemas/VedgeInventoryData" }, "examples": { "vEdge Inventory": { "description": "vEdge Inventory", "value": [ { "site-id": "400", "serialNumber": "12346576", "validity": "valid", "host-name": "vm4", "deviceType": "vedge", "local-system-ip": "172.16.255.14", "chasisNumber": "59414e3c-24cd-44de-8072-261224224c25", "system-ip": "172.16.255.14" }, { "site-id": "100", "serialNumber": "12346568", "validity": "valid", "host-name": "vm11", "deviceType": "vedge", "local-system-ip": "172.16.255.21", "chasisNumber": "63e8518c-e76f-4d5f-a4c7-28ffb669526b", "system-ip": "172.16.255.21" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/vedgeinventory/summary": { "get": { "tags": [ "Monitoring - Device Details" ], "description": "Get vEdge inventory", "operationId": "getVedgeInventorySummary", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "vEdge inventory": { "description": "vEdge inventory", "value": { "header": { "generatedOn": 1635390164998, "title": "WAN Edge Inventory", "viewKeys": { "uniqueKey": [], "preferenceKey": "grid-vedgeInventory" }, "columns": [ { "title": "Inventory List", "property": "list", "dataType": "string" } ], "fields": [ { "property": "list", "dataType": "string" } ] }, "data": [ { "name": "Total", "list": "Total", "value": 0, "detailsURL": "/dataservice/device/vedgeinventory/detail" }, { "name": "Authorized", "list": "Authorized", "detailsURL": "/dataservice/device/vedgeinventory/detail?status=authorized", "value": 0 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/virtualApplication/te": { "get": { "tags": [ "Real-Time Monitoring - NTP" ], "description": "Get ThousandEyes app list from device", "operationId": "createTeList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Te apps list": { "description": "Te apps list", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "version": "1.0.16_SV2.9.16.1_XE17.3", "active": "true", "previous": "true", "timestamp": "2022-09-01T13:29:43-00:00", "lastupdated": 1660244459596 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/virtualApplication/utd": { "get": { "tags": [ "Real-Time Monitoring - NTP" ], "description": "Get Utd apps list from device", "operationId": "createUtdList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Utd apps list": { "description": "Utd apps list", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "version": "1.0.16_SV2.9.16.1_XE17.3", "active": "true", "previous": "true", "timestamp": "2022-09-01T13:29:43-00:00", "lastupdated": 1660244459596 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/virtualApplication/waas": { "get": { "tags": [ "Real-Time Monitoring - NTP" ], "description": "Get Waas apps list from device", "operationId": "createWaasList", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Waas apps list": { "description": "Waas apps list", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "version": "1.0.16_SV2.9.16.1_XE17.3", "active": "true", "previous": "true", "timestamp": "2022-09-01T13:29:43-00:00", "lastupdated": 1660244459596 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/vm/nics": { "get": { "tags": [ "Real-Time Monitoring - VM" ], "description": "Get vbranch vm lifecycle state (NIC)", "operationId": "getVbranchVMLifecycleNics", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "vBranch VM lifecycle state (NIC)": { "description": "vBranch VM lifecycle state (NIC)", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "name": "int-mgmt-net-subnet", "vnic-id": "1", "network": "int-mgmt-net", "vdevice-dataKey": "172.16.255.15", "lastupdated": 1642581869106 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Routing-read,Routing-write" } }, "/device/vm/notifications": { "get": { "tags": [ "Real-Time Monitoring - VM" ], "description": "Get CloudDock vm lifecycle state", "operationId": "getCloudDockVMLifecycleNics", "parameters": [ { "name": "userGroup", "in": "query", "description": "userGroup Name", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "CloudDock VM lifecycle state ": { "description": "CloudDock VM lifecycle state ", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "depname": "SystemAdminTena_isrv1_0_72619ffd-df8e-4c32-b24a-3d7b03a31303", "eventTime": "600", "hostname": "nfvis", "type": "local", "vmid": "1", "vmName": "ISR", "status_message": "active", "status_code": "200", "user-group": "router1", "category": "Sample_Category_0001", "vdevice-dataKey": "172.16.255.15", "lastupdated": 1642581869106 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Routing-read,Routing-write" } }, "/device/vm/oper/state": { "get": { "tags": [ "Real-Time Monitoring - VM" ], "description": "Get vbranch vm lifecycle state", "operationId": "getVbranchVMLifecycle", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "vBranch VM lifecycle state": { "description": "vBranch VM lifecycle state", "value": { "data": [ { "vdevice-dataKey": "172.16.255.15", "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "name": "int-mgmt-net-subnet", "state": "Active", "lastupdated": 1642581869106, "vcpus": "2", "memory-mb": "4096", "color": "default", "root-disk-mb": "8192" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Routing-read,Routing-write" } }, "/device/vm/state": { "get": { "tags": [ "Real-Time Monitoring - VM" ], "description": "Get vm lifecycle state", "operationId": "getVMLifeCycleState", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "VM lifecycle state": { "description": "VM lifecycle state", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "deployment_name": "dep1", "deployment_id": "SystemAdminTenantIdisrv1", "name": "router1", "state": "Active" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write,Routing-read,Routing-write" } }, "/device/vmanage": { "get": { "tags": [ "Monitoring - Device Details" ], "description": "Get vManage system IP", "operationId": "getVManageSystemIP", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "ipAddress": { "type": "string" } }, "$$ref": "#/components/schemas/DeviceVmanageResponseData" }, "header": { "type": "object", "properties": { "generatedOn": { "type": "integer", "format": "int64", "example": 1635224742597 } }, "$$ref": "#/components/schemas/DeviceResponseHeader" } }, "$$ref": "#/components/schemas/DeviceVmanageResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/device/voice/dspActive": { "get": { "tags": [ "Real-Time Monitoring - Voice" ], "description": "Get DSPFarm Active DSP info from device", "operationId": "getDspActive", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DSPFarm Active DSP info": { "description": "DSPFarm Active DSP info", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "dsp-num": 2, "dsp-status": "up", "rsc-id": 1, "bridge-id": 9, "pkts-txed": 228, "pkts-rxed": 119, "lastupdated": 1660244459596 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write" } }, "/device/voice/phoneInfo": { "get": { "tags": [ "Real-Time Monitoring - Voice" ], "description": "Get phone registration info from device", "operationId": "getPhoneInfo", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "VOIP call info": { "description": "VOIP call info", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "pool-tag": "1", "id-network": "10.1.10.217", "reg-state": "yes", "dialpeer-tag": "100", "address": "10.64.86.70", "dir-number": "5550111", "lastupdated": 1660244459596 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write" } }, "/device/voice/profiles": { "get": { "tags": [ "Real-Time Monitoring - Voice" ], "description": "Get DSPFarm Profiles info from device", "operationId": "getDSPFarmProfiles", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DSPFarm Profiles info": { "description": "DSPFarm Profiles info", "value": { "data": [ { "prof-oper-state": "prof-oper-state-active-in-prog", "service-id": "profile-mtp", "app-id": "app-id-sccp", "vdevice-name": "32.32.32.17", "prof-admin-state": "prof-admin-state-up", "vdevice-host-name": "isr4331-prakuma3-2", "resource-id": "1", "rsc-status": "rsc-group-state-none", "app-assoc-status": "app-assoc-active-in-prog", "vdevice-dataKey": "32.32.32.17-9", "rsc-provider": "rsc-prov-none", "profile-id": "9", "lastupdated": 1660244459596, "secure-mode": "srvc-mode-non-secure" }, { "prof-oper-state": "prof-oper-state-active-in-prog", "service-id": "profile-mtp", "app-id": "app-id-sccp", "vdevice-name": "32.32.32.17", "prof-admin-state": "prof-admin-state-up", "vdevice-host-name": "isr4331-prakuma3-2", "resource-id": "2", "rsc-status": "rsc-group-state-none", "app-assoc-status": "app-assoc-active-in-prog", "vdevice-dataKey": "32.32.32.17-52", "rsc-provider": "rsc-prov-none", "profile-id": "52", "lastupdated": 1660244459596, "secure-mode": "srvc-mode-non-secure" }, { "prof-oper-state": "prof-oper-state-active-in-prog", "service-id": "profile-mtp", "app-id": "app-id-sccp", "vdevice-name": "32.32.32.17", "prof-admin-state": "prof-admin-state-up", "vdevice-host-name": "isr4331-prakuma3-2", "resource-id": "3", "rsc-status": "rsc-group-state-none", "app-assoc-status": "app-assoc-active-in-prog", "vdevice-dataKey": "32.32.32.17-183", "rsc-provider": "rsc-prov-none", "profile-id": "183", "lastupdated": 1660244459596, "secure-mode": "srvc-mode-non-secure" }, { "prof-oper-state": "prof-oper-state-active-in-prog", "service-id": "profile-transcode", "app-id": "app-id-sccp", "vdevice-name": "32.32.32.17", "prof-admin-state": "prof-admin-state-up", "vdevice-host-name": "isr4331-prakuma3-2", "resource-id": "4", "rsc-status": "rsc-group-state-up", "app-assoc-status": "app-assoc-active-in-prog", "vdevice-dataKey": "32.32.32.17-711", "rsc-provider": "rsc-prov-flex-dsprm", "profile-id": "711", "lastupdated": 1660244459596, "secure-mode": "srvc-mode-non-secure" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write" } }, "/device/voice/sccpCcmGroups": { "get": { "tags": [ "Real-Time Monitoring - Voice" ], "description": "Get DSPFarm SCCP CCM Groups info from device", "operationId": "getSccpCcmGroups", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DSPFarm SCCP CCM Groups info": { "description": "DSPFarm SCCP CCM Groups info", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "ccm-group-id": 5, "description": "boston office", "switchover-method": "GRACEFUL", "switchback-method": "GRACEFUL_GUARD", "ccm-id": 1, "ccm-priority": 1, "profile-id": 6, "reg-name": "MTP123456789988", "lastupdated": 1642581869106 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write" } }, "/device/voice/sccpConnections": { "get": { "tags": [ "Real-Time Monitoring - Voice" ], "description": "Get DSPFarm SCCP Connections info from device", "operationId": "getSccpConnections", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DSPFarm SCCP Connections info": { "description": "DSPFarm SCCP Connections info", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "conn-id": 16777409, "sess-id": 16777222, "stype": "secure-xcode", "mode": "sendrecv", "codec": "g729b", "rmt-ipaddr": "10.3.56.120", "rmt-port": "16772", "src-port": "19354", "dtmf-method": "enabled", "lastupdated": 1642581869106 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write" } }, "/device/voice/voiceCalls": { "get": { "tags": [ "Real-Time Monitoring - Voice" ], "description": "Get voice call info from device", "operationId": "getVoiceCalls", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Voice call info": { "description": "Voice call info", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "key-id": "0312341111", "call-id": "24", "voice-port-id": "1/015", "codec-type": "g729r8", "vad": "disabled", "dsp-id": "010", "dsp-type": "C549", "dsp-abort-packet-cnt": 0, "dsp-tx-packet-cnt": 67400, "dsp-rx-packet-cnt": 67400, "lastupdated": 1660244459596 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write" } }, "/device/voice/voipCalls": { "get": { "tags": [ "Real-Time Monitoring - Voice" ], "description": "Get VOIP call info from device", "operationId": "getVoipCalls", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "VOIP call info": { "description": "VOIP call info", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "call-index": 3917844, "call-setuptime": 126640, "call-id": 5554071, "codec": "g711ulaw", "remote-ip-address": "10.128.136.58", "remote-media-port": 17602, "transmit-packets": 2246, "receive-packets": 2246, "call-duration": "00:00:50", "lastupdated": 1660727547133 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write" } }, "/device/voiceisdninfo/isdnstatus": { "get": { "tags": [ "Real-Time Monitoring - Voice" ], "description": "Retrieve Voice ISDN Status from device", "operationId": "getT1e1IsdnStatus", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device voice ISDN status": { "description": "Device voice ISDN status", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "key-id": 0, "intf-name": "Serial0:23", "switch-type": "primary-5ess", "l1-status": "ACTIVE", "l2-status": "MULTIPLE_FRAME_ESTABLISHED", "num-active-calls": 1, "lastupdated": 1660727547133 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write" } }, "/device/voicet1e1controllerinfo/current15minstats": { "get": { "tags": [ "Real-Time Monitoring - Voice" ], "description": "Retrieve T1E1 controller last 15 min stats from device (Real Time)", "operationId": "getControllerT1e1InfoCurrent15MinStats", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "T1E1 controller status": { "description": "T1E1 controller status", "value": { "data": [ { "vdevice-name": "32.32.32.17", "vdevice-host-name": "vm5", "slot-num": "6", "subslot-num": "3", "port-num": "0", "state": "up", "type": "t1", "clocking": "internal", "vdevice-dataKey": "32.32.32.17-711", "lcvs": 136, "pcvs": 63, "csss": 0, "sefss": 6, "less": 4, "dms": 0, "ess": 7, "bess": 1, "sess": 6, "uass": 458, "lastupdated": 1660727547133 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write" } }, "/device/voicet1e1controllerinfo/totalstats": { "get": { "tags": [ "Real-Time Monitoring - Voice" ], "description": "Retrieve T1E1 controller total stats from device (Real Time)", "operationId": "getControllerT1e1InfoTotalStats", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "T1E1 controller status": { "description": "T1E1 controller status", "value": { "data": [ { "vdevice-name": "32.32.32.17", "vdevice-host-name": "vm5", "slot-num": "6", "subslot-num": "3", "port-num": "0", "state": "up", "type": "t1", "clocking": "internal", "vdevice-dataKey": "32.32.32.17-711", "lcvs": 136, "pcvs": 63, "csss": 0, "sefss": 6, "less": 4, "dms": 0, "ess": 7, "bess": 1, "sess": 6, "uass": 458, "lastupdated": 1660727547133 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write" } }, "/device/vpn": { "get": { "tags": [ "Real-Time Monitoring - VPN" ], "description": "Get VPN instance list from device (Real Time)", "operationId": "getVPNInstances", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "VPN instance list ": { "description": "VPN instance list ", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "vpn-id": "10", "if-name": "ge0/1", "ip-address": "10.0.0.2 255.255.255.0", "color": "mpls", "shutdown": "no shutdown", "lastupdated": 1660890739250, "vdevice-dataKey": "172.16.255.15" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/vrrp": { "get": { "tags": [ "Real-Time Monitoring - VRRP" ], "description": "Get VRRP interface list from device", "operationId": "getVRRPInterface", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "VRRP interface": { "description": "VRRP interface", "value": { "data": [ { "omp-state": "up", "group-id": "123", "if-name": "ge0/0", "virtual-mac": "00:00:5e:00:01:7b", "lastupdated": 1650878690993, "vpn-id": "10", "vdevice-dataKey": "169.254.10.9-10-ge0/0-123", "advertisement-timer": "1", "last-state-change-time": "0000-00-00T00:00:00+00:00", "vdevice-host-name": "vm2", "vrrp-state": "init", "vdevice-name": "169.254.10.9", "priority": "101" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Interface-read,Interface-write" } }, "/device/wireless/client": { "get": { "tags": [ "Real-Time Monitoring - Wireless" ], "description": "Get wireless clients from device", "operationId": "getWirelessClients", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Wireless client": { "description": "Wireless client", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "wlan-id": "1", "mac-address": "24:77:03:89:9b:f8", "ssid": "rf4k3ap", "band": "band-24ghz", "status": "0", "ip-address": "192.168.1.1", "device-type": "Android", "vdevice-dataKey": "172.16.255.15", "rssi": -51, "lastupdated": 1660894960587 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/wireless/radio": { "get": { "tags": [ "Real-Time Monitoring - Wireless" ], "description": "Get wireless Radios from device", "operationId": "getWirelessRadios", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Wireless Radio": { "description": "Wireless Radio", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "band": "band-24ghz", "channel": 11, "channel-bandwidth": "chan-bw-160mhz", "client-count": 110, "lastupdated": 1660898493410, "vdevice-dataKey": "172.16.255.15" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/wireless/ssid": { "get": { "tags": [ "Real-Time Monitoring - Wireless" ], "description": "Get wireless SSID from device", "operationId": "getWirelessSsid", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Wireless SSID": { "description": "Wireless SSID", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "wlan-id": "1", "ssid": "rf4k3ap", "vlan-id": 1, "band": "band-24ghz", "admin-up": "true", "oper-up": "true", "client-count": 110, "max-client-count": 200, "lastupdated": 1660910032581, "vdevice-dataKey": "172.16.255.15" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Policy-read,Policy-write,System-read,System-write" } }, "/device/wireless/status": { "get": { "tags": [ "Real-Time Monitoring - Wireless" ], "description": "Get wireless status from device", "operationId": "getWirelessStatus", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Wireless status": { "description": "Wireless status", "value": { "data": [ { "vdevice-name": "172.16.255.15", "vdevice-host-name": "vm5", "wlan-id": "1", "mac-address": "24:77:03:89:9b:f8", "ssid": "rf4k3ap", "band": "band-24ghz", "status": "0", "ip-address": "192.168.1.1", "device-type": "Android", "vdevice-dataKey": "172.16.255.15", "rssi": -51, "lastupdated": 1660894960587 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/wlan/clients": { "get": { "tags": [ "Real-Time Monitoring - WLAN" ], "description": "Get WLAN client from device", "operationId": "getWLANClients", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "WLAN client": { "description": "WLAN client", "value": { "data": [ { "vdevice-name": "vm2", "vdevice-host-name": "169.254.10.9", "vap": "vap0", "client-id": "0", "mac": "50:50:50:50:50:50", "mode": "802.11ac", "band": "5 GHz", "channel": "36", "channel-bandwidth": "80", "data-security": "none", "rx-rate": "175", "rssi": "11", "assoc-time": "00:11:43", "lastupdated": 1658194642863, "vdevice-dataKey": "169.254.10.9" }, { "vdevice-name": "vm2", "vdevice-host-name": "169.254.10.9", "vap": "vap0", "client-id": "1", "mac": "50:50:50:50:50:53", "mode": "802.11ac", "band": "5 GHz", "channel": "36", "channel-bandwidth": "80", "data-security": "none", "rx-rate": "175", "rssi": "11", "assoc-time": "00:11:43", "lastupdated": 1658194642863, "vdevice-dataKey": "169.254.10.9" }, { "vdevice-name": "vm2", "vdevice-host-name": "169.254.10.9", "vap": "vap0", "client-id": "2", "mac": "50:50:50:50:50:56", "mode": "802.11ac", "band": "5 GHz", "channel": "36", "channel-bandwidth": "80", "data-security": "none", "rx-rate": "175", "rssi": "11", "assoc-time": "00:11:43", "lastupdated": 1658194642863, "vdevice-dataKey": "169.254.10.9" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/wlan/interfaces": { "get": { "tags": [ "Real-Time Monitoring - WLAN" ], "description": "Get WLAN interface from device", "operationId": "getWLANInterfaces", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "WLAN interface": { "description": "WLAN interface", "value": { "data": [ { "vdevice-name": "vm2", "vdevice-host-name": "169.254.10.9", "vap": "vap0", "ssid": "tb31_pm6_5ghz_vap0", "bssid": "80:b7:09:08:b7:6a", "data-security": "wpa/wpa2-enterprise", "mgmt-security": "optional", "band": "5 GHz", "mode": "802.11ac", "description": "-", "bit-rate": "1300", "tx-power": "25", "admin-status": "Up", "oper-status": "Up", "max-clients": "50", "num-clients": "8", "lastupdated": 0, "vdevice-dataKey": "169.254.10.9" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/wlan/radios": { "get": { "tags": [ "Real-Time Monitoring - WLAN" ], "description": "Get WLAN Radios from device", "operationId": "getWLANRadios", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "WLAN Radios": { "description": "WLAN Radios", "value": { "data": [ { "vdevice-name": "169.254.10.9", "vdevice-host-name": "vm2", "vdevice-dataKey": "169.254.10.9", "radio-name": "wifi0", "mode": "802.11ac", "band": "5 GHz", "mac": "80:b7:09:08:b7:6a", "country": "United States", "channel": "36", "channel-bandwidth": "80", "frequency": "5180", "guard-interval": "400", "vaps": "4", "lastupdated": 1658194642863 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device/wlan/radius": { "get": { "tags": [ "Real-Time Monitoring - WLAN" ], "description": "Get WLAN RADIUS authentication from device", "operationId": "getWLANRadius", "parameters": [ { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "WLAN RADIUS authentication": { "description": "WLAN RADIUS authentication", "value": { "data": [ { "vdevice-name": "169.254.10.9", "vdevice-host-name": "vm2", "vap-ifname": "vap1", "preference": "-", "ip-address": "10.20.24.15", "vpn-id": "1", "priority": "0", "source-interface": "-", "source-address": "-", "tag": "tag_dummy1", "vdevice-dataKey": "169.254.10.9", "auth-port": "1812", "auth-active": "true", "auth-rtt": "0", "auth-requests": "0", "auth-retrans": "0", "auth-accepts": "0", "auth-rejects": "0", "auth-challenges": "0", "auth-mal-resp": "0", "auth-bad-auth": "0", "auth-pend-reqs": "0", "auth-timeouts": "0", "auth-unk-types": "0", "auth-pkts-drop": "0", "acct-port": "0", "acct-active": "false", "acct-rtt": "0", "acct-requests": "0", "acct-retrans": "0", "acct-responses": "0", "acct-mal-resp": "0", "acct-bad-auth": "0", "acct-pend-reqs": "0", "acct-timeouts": "0", "acct-unk-types": "0", "acct-pkts-drop": "0", "lastupdated": 1658194642863 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "System-read,System-write" } }, "/device_authorization/{regionBaseUri}/{clientId}": { "post": { "tags": [ "Monitoring - SecureX Integration" ], "description": "User authorization for Cisco vManage SecureX integration", "operationId": "deviceAuthorization", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "regionBaseUri", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "device_code": { "type": "string" }, "expires_in": { "type": "integer", "format": "int32" }, "interval": { "type": "integer", "format": "int32" }, "user_code": { "type": "string" }, "verification_uri": { "type": "string" }, "verification_uri_complete": { "type": "string" } }, "description": "Response from Cisco SecureX device_authorization API", "$$ref": "#/components/schemas/Codes" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/event": { "post": { "tags": [ "Monitoring - Events" ], "description": "Get events for given query.", "operationId": "postEvents", "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 events", "schema": { "pattern": "^[0-9]+$", "type": "string" } }, { "name": "includeTenants", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "description": "Event query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Get events filter by hours": { "description": "Get events filter by hours", "value": { "query": { "condition": "AND", "rules": [ { "field": "entry_time", "operator": "last_n_hours", "type": "date", "value": [ "10" ] } ] }, "size": 100 }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventRequestFilterByHours" }, "Get events filter between dates": { "description": "Get events 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": 100 }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventRequestFilterBetweenDates" }, "Get events filter by type": { "description": "Get events filter by type", "value": { "query": { "condition": "AND", "rules": [ { "field": "entry_time", "operator": "last_n_hours", "type": "date", "value": [ "10" ] }, { "field": "eventname", "operator": "in", "type": "string", "value": [ "memory-usage" ] } ] }, "size": 100 }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventRequestFilterByType" }, "Get events filter by system ip": { "description": "Get events 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/ComViptelaVmanageServerEventRequestFilterBySystemIp" }, "Get events filter by severity": { "description": "Get events filter by severity", "value": { "query": { "condition": "AND", "rules": [ { "field": "entry_time", "operator": "last_n_hours", "type": "date", "value": [ "10" ] }, { "field": "severity_level", "operator": "in", "type": "string", "value": [ "critical" ] } ] }, "size": 100 }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventRequestFilterBySeverity" }, "Get events filter by site-id": { "description": "Get events 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/ComViptelaVmanageServerEventRequestFilterBySites" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Events": { "description": "Events", "value": { "data": [ { "system_ip": "172.16.255.11", "vmanage_system_ip": "172.16.255.11", "tenant": "default", "device_type": "vedge", "entry_time": 1666259117528, "statcycletime": 1666259117528, "eventname": "bfd-state-change", "component": "BFD", "severity_level": "major", "host_name": "vm1", "event": { "bfd-state-change": { "src-ip": "10.0.5.11", "dst-ip": "10.1.16.16", "local-system-ip": "172.16.255.11", "src-port": 12347, "system-ip": "172.16.255.11", "dst-port": 12346, "remote-color": "lte", "host-name": "vm1", "remote-system-ip": "172.16.255.16", "severity-level": "major", "local-color": "lte", "xmlns": "http://viptela.com/bfd", "deleted": false, "flap-reason": "na", "proto": "ipsec", "new-state": "down" } }, "details": "host-name=vm1; src-ip=10.0.5.11; dst-ip=10.1.16.16; proto=ipsec; src-port=12347; dst-port=12346; local-system-ip=172.16.255.11; local-color=lte; remote-system-ip=172.16.255.16; remote-color=lte; new-state=down; deleted=false; flap-reason=na", "id": "xh_I9IMBLPMz2to0aA3r" } ], "pageInfo": { "startTime": "1589073783045", "endTime": "1589072535795", "count": 15 } }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventResponseEvent" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "get": { "tags": [ "Monitoring - Events" ], "description": "Get events for given query. If query is empty then last 30 mins data will be returned.", "operationId": "getEvents_MonitoringEvents_603", "parameters": [ { "name": "query", "in": "query", "description": "Query", "allowEmptyValue": true, "schema": { "type": "string" }, "examples": { "Empty": { "description": "Empty" }, "Get events filter by hours": { "description": "Get events filter by hours", "value": { "query": { "condition": "AND", "rules": [ { "field": "entry_time", "operator": "last_n_hours", "type": "date", "value": [ "10" ] } ] }, "size": 100 }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventRequestFilterByHours" }, "Get events filter between dates": { "description": "Get events 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": 100 }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventRequestFilterBetweenDates" }, "Get events filter by type": { "description": "Get events filter by type", "value": { "query": { "condition": "AND", "rules": [ { "field": "entry_time", "operator": "last_n_hours", "type": "date", "value": [ "10" ] }, { "field": "eventname", "operator": "in", "type": "string", "value": [ "memory-usage" ] } ] }, "size": 100 }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventRequestFilterByType" }, "Get events filter by system ip": { "description": "Get events 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/ComViptelaVmanageServerEventRequestFilterBySystemIp" }, "Get events filter by severity": { "description": "Get events filter by severity", "value": { "query": { "condition": "AND", "rules": [ { "field": "entry_time", "operator": "last_n_hours", "type": "date", "value": [ "10" ] }, { "field": "severity_level", "operator": "in", "type": "string", "value": [ "critical" ] } ] }, "size": 100 }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventRequestFilterBySeverity" }, "Get events filter by site-id": { "description": "Get events 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/ComViptelaVmanageServerEventRequestFilterBySites" } } }, { "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 events", "schema": { "pattern": "^[0-9]+$", "type": "string" } }, { "name": "includeTenants", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Events": { "description": "Events", "value": { "data": [ { "system_ip": "172.16.255.11", "vmanage_system_ip": "172.16.255.11", "tenant": "default", "device_type": "vedge", "entry_time": 1666259117528, "statcycletime": 1666259117528, "eventname": "bfd-state-change", "component": "BFD", "severity_level": "major", "host_name": "vm1", "event": { "bfd-state-change": { "src-ip": "10.0.5.11", "dst-ip": "10.1.16.16", "local-system-ip": "172.16.255.11", "src-port": 12347, "system-ip": "172.16.255.11", "dst-port": 12346, "remote-color": "lte", "host-name": "vm1", "remote-system-ip": "172.16.255.16", "severity-level": "major", "local-color": "lte", "xmlns": "http://viptela.com/bfd", "deleted": false, "flap-reason": "na", "proto": "ipsec", "new-state": "down" } }, "details": "host-name=vm1; src-ip=10.0.5.11; dst-ip=10.1.16.16; proto=ipsec; src-port=12347; dst-port=12346; local-system-ip=172.16.255.11; local-color=lte; remote-system-ip=172.16.255.16; remote-color=lte; new-state=down; deleted=false; flap-reason=na", "id": "xh_I9IMBLPMz2to0aA3r" } ], "pageInfo": { "startTime": "1589073783045", "endTime": "1589072535795", "count": 15 } }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventResponseEvent" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Events-read" } }, "/event/aggregation": { "get": { "tags": [ "Monitoring - Events" ], "description": "Get aggregated count of events based on given query.", "operationId": "getAggregationData_MonitoringEvents_1803", "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_level", "order": "asc", "sequence": 1 } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 60, "order": "asc" } } }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventRequestAggregationBySeverity" } } }, { "name": "site-id", "in": "query", "description": "Specify the site-id to filter the events", "schema": { "pattern": "^[0-9]+$", "type": "string" } }, { "name": "includeTenants", "in": "query", "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": 1718014129437, "columns": [ { "property": "entry_time", "title": "Entry_time", "dataType": "date", "isDisplay": true }, { "property": "severity_level", "title": "Severity_level", "dataType": "string", "isDisplay": true } ], "fields": [ { "property": "entry_time", "dataType": "date" }, { "property": "severity_level", "dataType": "string" } ] }, "entryTimeList": [ 1717927200000, 1717930800000, 1717934400000, 1717938000000, 1717941600000 ], "data": [ { "entry_time": 1717988400000, "severity_level": "major", "count": 878 }, { "entry_time": 1717988400000, "severity_level": "minor", "count": 1104 }, { "entry_time": 1717988400000, "severity_level": "critical", "count": 7 }, { "entry_time": 1717992000000, "severity_level": "minor", "count": 385 }, { "entry_time": 1717992000000, "severity_level": "major", "count": 548 } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventResponseAggregationBySeverity" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Events-read" }, "post": { "tags": [ "Monitoring - Events" ], "description": "Get aggregated count of events based on given query.", "operationId": "postAggregationData_MonitoringEvents_1804", "parameters": [ { "name": "site-id", "in": "query", "description": "Specify the site-id to filter the events", "schema": { "pattern": "^[0-9]+$", "type": "string" } }, { "name": "includeTenants", "in": "query", "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_level", "order": "asc", "sequence": 1 } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 60, "order": "asc" } } }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventRequestAggregationBySeverity" } } } }, "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": 1718014129437, "columns": [ { "property": "entry_time", "title": "Entry_time", "dataType": "date", "isDisplay": true }, { "property": "severity_level", "title": "Severity_level", "dataType": "string", "isDisplay": true } ], "fields": [ { "property": "entry_time", "dataType": "date" }, { "property": "severity_level", "dataType": "string" } ] }, "entryTimeList": [ 1717927200000, 1717930800000, 1717934400000, 1717938000000, 1717941600000 ], "data": [ { "entry_time": 1717988400000, "severity_level": "major", "count": 878 }, { "entry_time": 1717988400000, "severity_level": "minor", "count": 1104 }, { "entry_time": 1717988400000, "severity_level": "critical", "count": 7 }, { "entry_time": 1717992000000, "severity_level": "minor", "count": 385 }, { "entry_time": 1717992000000, "severity_level": "major", "count": 548 } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventResponseAggregationBySeverity" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Events-read" } }, "/event/byuuids": { "post": { "tags": [ "Monitoring - Events" ], "description": "Get Events for given uuids", "operationId": "getByUuids", "parameters": [ { "name": "timeFilter", "in": "query", "description": "Query", "allowEmptyValue": true, "schema": { "type": "string" }, "examples": { "Empty": { "description": "Empty" }, "Get events filter by hours": { "description": "Get events filter by hours", "value": { "field": "entry_time", "operator": "last_n_hours", "type": "date", "value": [ "10" ] } }, "Get events filter between dates": { "description": "Get events filter between dates", "value": { "field": "entry_time", "type": "date", "value": [ "2024-04-30T19:30:00 UTC", "2024-05-30T17:30:00 UTC" ], "operator": "between" } } } } ], "requestBody": { "description": "List of event uuids", "content": { "application/json": { "schema": { "type": "array" }, "examples": { "List of event uuids": { "description": "List of event uuids", "value": [ "8ee4a76c-3e45-4e99-b789-dae0fdcdb015", "5f22b598-10cd-4162-9c73-6b37540521e5" ] } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Response": { "description": "Response", "value": "TODO" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Alarms-read" } }, "/event/component/keyvalue": { "get": { "tags": [ "Monitoring - Events" ], "description": "Get event component types.", "operationId": "getComponentsAsKeyValue", "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": { "data": [ { "key": "Policy", "value": "Policy" }, { "key": "Nat", "value": "Nat" }, { "key": "BFD", "value": "BFD" }, { "key": "App-Route", "value": "App-Route" }, { "key": "Nwpi", "value": "Nwpi" }, { "key": "Security", "value": "Security" }, { "key": "Statistics", "value": "Statistics" }, { "key": "System", "value": "System" }, { "key": "Control", "value": "Control" }, { "key": "security", "value": "security" }, { "key": "OMP", "value": "OMP" }, { "key": "VPN", "value": "VPN" }, { "key": "PIM", "value": "PIM" }, { "key": "Software", "value": "Software" }, { "key": "Hardware", "value": "Hardware" }, { "key": "CloudExpress", "value": "CloudExpress" }, { "key": "cloudDock", "value": "cloudDock" }, { "key": "Firmware", "value": "Firmware" }, { "key": "Bridge", "value": "Bridge" }, { "key": "OSPF", "value": "OSPF" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventResponseComponentKeyvalue" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/event/doccount": { "get": { "tags": [ "Monitoring - Events" ], "description": "Get the count of events as per the query passed.", "operationId": "getDocCount_MonitoringEvents_1503", "parameters": [ { "name": "query", "in": "query", "description": "Query", "required": true, "schema": { "type": "string" }, "examples": { "Get events filter by hours": { "description": "Get events filter by hours", "value": { "query": { "condition": "AND", "rules": [ { "field": "entry_time", "operator": "last_n_hours", "type": "date", "value": [ "10" ] } ] }, "size": 100 }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventRequestFilterByHours" }, "Get events filter between dates": { "description": "Get events 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": 100 }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventRequestFilterBetweenDates" }, "Get events filter by type": { "description": "Get events filter by type", "value": { "query": { "condition": "AND", "rules": [ { "field": "entry_time", "operator": "last_n_hours", "type": "date", "value": [ "10" ] }, { "field": "eventname", "operator": "in", "type": "string", "value": [ "memory-usage" ] } ] }, "size": 100 }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventRequestFilterByType" }, "Get events filter by system ip": { "description": "Get events 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/ComViptelaVmanageServerEventRequestFilterBySystemIp" }, "Get events filter by severity": { "description": "Get events filter by severity", "value": { "query": { "condition": "AND", "rules": [ { "field": "entry_time", "operator": "last_n_hours", "type": "date", "value": [ "10" ] }, { "field": "severity_level", "operator": "in", "type": "string", "value": [ "critical" ] } ] }, "size": 100 }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventRequestFilterBySeverity" }, "Get events filter by site-id": { "description": "Get events 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/ComViptelaVmanageServerEventRequestFilterBySites" } } }, { "name": "site-id", "in": "query", "description": "Specify the site-id to filter the events", "schema": { "pattern": "^[0-9]+$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Count": { "description": "Count", "value": { "count": 964 }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventResponseDoccount" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Monitoring - Events" ], "description": "Get the count of events as per the query passed.", "operationId": "postDocCount_MonitoringEvents_1504", "parameters": [ { "name": "site-id", "in": "query", "description": "Specify the site-id to filter the events", "schema": { "pattern": "^[0-9]+$", "type": "string" } } ], "requestBody": { "description": "Query", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Get events filter by hours": { "description": "Get events filter by hours", "value": { "query": { "condition": "AND", "rules": [ { "field": "entry_time", "operator": "last_n_hours", "type": "date", "value": [ "10" ] } ] }, "size": 100 }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventRequestFilterByHours" }, "Get events filter between dates": { "description": "Get events 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": 100 }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventRequestFilterBetweenDates" }, "Get events filter by type": { "description": "Get events filter by type", "value": { "query": { "condition": "AND", "rules": [ { "field": "entry_time", "operator": "last_n_hours", "type": "date", "value": [ "10" ] }, { "field": "eventname", "operator": "in", "type": "string", "value": [ "memory-usage" ] } ] }, "size": 100 }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventRequestFilterByType" }, "Get events filter by system ip": { "description": "Get events 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/ComViptelaVmanageServerEventRequestFilterBySystemIp" }, "Get events filter by severity": { "description": "Get events filter by severity", "value": { "query": { "condition": "AND", "rules": [ { "field": "entry_time", "operator": "last_n_hours", "type": "date", "value": [ "10" ] }, { "field": "severity_level", "operator": "in", "type": "string", "value": [ "critical" ] } ] }, "size": 100 }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventRequestFilterBySeverity" }, "Get events filter by site-id": { "description": "Get events 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/ComViptelaVmanageServerEventRequestFilterBySites" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Count": { "description": "Count", "value": { "count": 964 }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventResponseDoccount" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/event/enable/fileprocess": { "get": { "tags": [ "Monitoring - Events" ], "description": "Enable events from file.", "operationId": "enableEventsFromFile", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "empty": { "type": "boolean" } }, "additionalProperties": { "type": "string" }, "$$ref": "#/components/schemas/GeneralSchema" }, "examples": { "Enabled status": { "description": "Enabled status", "value": { "enable.events.from.files": true }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventResponseEnableFileprocess" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Events-read" } }, "/event/getEventsByComponent": { "get": { "tags": [ "Monitoring - Events" ], "description": "Get event names by component.", "operationId": "getEventNamesByComponent", "parameters": [ { "name": "query", "in": "query", "description": "Event component name", "required": true, "schema": { "type": "string" }, "examples": { "Policy": { "description": "Policy", "value": "Policy" }, "Nat": { "description": "Nat", "value": "Nat" }, "BFD": { "description": "BFD", "value": "BFD" }, "App Route": { "description": "App Route", "value": "App-Route" }, "Nwpi": { "description": "Nwpi", "value": "Nwpi" }, "Security": { "description": "Security", "value": "Security" }, "Statistics": { "description": "Statistics", "value": "Statistics" }, "System": { "description": "System", "value": "System" }, "Control": { "description": "Control", "value": "Control" }, "OMP": { "description": "OMP", "value": "OMP" }, "VPN": { "description": "VPN", "value": "VPN" }, "PIM": { "description": "PIM", "value": "PIM" }, "Software": { "description": "Software", "value": "Software" }, "Hardware": { "description": "Hardware", "value": "Hardware" }, "CloudExpress": { "description": "CloudExpress", "value": "CloudExpress" }, "cloudDock": { "description": "cloudDock", "value": "cloudDock" }, "Firmware": { "description": "Firmware", "value": "Firmware" }, "Bridge": { "description": "Bridge", "value": "Bridge" }, "OSPF": { "description": "OSPF", "value": "OSPF" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "component": { "type": "string", "example": "Software" }, "event": { "type": "string", "example": "system-software-install-change" } }, "$$ref": "#/components/schemas/ComponentEventMapping" }, "examples": { "Events": { "description": "Events", "value": { "data": [ { "component": "Software", "event": "system-software-install-change" }, { "component": "Software", "event": "system-software-install-status" }, { "component": "Firmware", "event": "system-firmware-install-status" }, { "component": "Software", "event": "im-event" }, { "component": "Software", "event": "utd-notification" }, { "component": "Software", "event": "utd-update" }, { "component": "Software", "event": "utd-ips-alert" }, { "component": "Software", "event": "utd-engine-status" }, { "component": "Software", "event": "utd-sessions-max" }, { "component": "Software", "event": "utd-version-mismatch" }, { "component": "Software", "event": "utd-file-reputation-retrospective-alert" }, { "component": "Software", "event": "utd-file-analysis-upload-state" }, { "component": "Software", "event": "utd-file-reputation-alert" }, { "component": "Software", "event": "utd-file-analysis-status-event" }, { "component": "Software", "event": "utd-file-reputation-status-event" }, { "component": "Software", "event": "utd-con" }, { "component": "Software", "event": "appqoe-event" }, { "component": "Software", "event": "data-policy-association-status" }, { "component": "Software", "event": "access-list-association-status" }, { "component": "Software", "event": "device-policy-association-status" }, { "component": "Software", "event": "umbrella-anycast-server-switch" }, { "component": "Software", "event": "system-software-patch-change" }, { "component": "Software", "event": "system-software-install-complete-change" }, { "component": "BFD", "event": "bfd-state-change" }, { "component": "Hardware", "event": "flash-fault" }, { "component": "Hardware", "event": "emmc-fault" }, { "component": "Hardware", "event": "sdcard-fault" }, { "component": "Hardware", "event": "tempsensor-fault" }, { "component": "Hardware", "event": "tempsensor-state" }, { "component": "Hardware", "event": "fan-fault" }, { "component": "Hardware", "event": "fantray-fault" }, { "component": "Hardware", "event": "pem-fault" }, { "component": "Hardware", "event": "pem-state-change" }, { "component": "Hardware", "event": "pim-fault" }, { "component": "Hardware", "event": "pim-state-change" }, { "component": "Hardware", "event": "sfp-state-change" }, { "component": "Hardware", "event": "usb-state-change" }, { "component": "Hardware", "event": "sfp-support-state" }, { "component": "OMP", "event": "omp-number-of-vsmarts-change" }, { "component": "OMP", "event": "omp-ro-gen-failure" }, { "component": "OMP", "event": "omp-state-change" }, { "component": "OMP", "event": "omp-peer-state-change" }, { "component": "OMP", "event": "omp-tloc-state-change" }, { "component": "OMP", "event": "omp-data-policy" }, { "component": "OMP", "event": "omp-policy" }, { "component": "Control", "event": "control-connection-state-change" }, { "component": "Control", "event": "control-connection-auth-fail" }, { "component": "Control", "event": "control-vbond-state-change" }, { "component": "Control", "event": "control-connection-tloc-ip-change" }, { "component": "Control", "event": "control-no-active-vsmart" }, { "component": "Control", "event": "control-no-active-vbond" }, { "component": "Control", "event": "control-vedge-list-request" }, { "component": "Control", "event": "tunnel-ipsec-rekey" }, { "component": "Control", "event": "tunnel-ipsec-manual-rekey" }, { "component": "Security", "event": "security-root-cert-chain-installed" }, { "component": "Security", "event": "pki-certificate-event" }, { "component": "Security", "event": "pki-certificate-expiry" }, { "component": "Security", "event": "security-certificate-installed" }, { "component": "Security", "event": "service-gre-state-update" }, { "component": "Security", "event": "security-new-csr-generated" }, { "component": "Security", "event": "security-root-cert-chain-uninstalled" }, { "component": "Security", "event": "security-clear-installed-certificate" }, { "component": "Security", "event": "security-vedge-serial-file-uploaded" }, { "component": "Security", "event": "security-vsmart-serial-file-uploaded" }, { "component": "Security", "event": "security-vedge-entry-added" }, { "component": "Security", "event": "security-vedge-entry-removed" }, { "component": "Security", "event": "security-unclaimed-vedge-entry-added" }, { "component": "Security", "event": "security-vsmart-entry-added" }, { "component": "Security", "event": "security-vsmart-entry-removed" }, { "component": "Security", "event": "ssl-certificate-warning" }, { "component": "Security", "event": "security-certificate-expired" }, { "component": "Security", "event": "vbond-reject-vedge-connection" }, { "component": "Security", "event": "device-template-missing" }, { "component": "Security", "event": "device-template-attached-during-ztp" }, { "component": "System", "event": "process-restart" }, { "component": "System", "event": "process-down" }, { "component": "System", "event": "reboot-aborted" }, { "component": "System", "event": "disk-usage" }, { "component": "System", "event": "memory-usage" }, { "component": "System", "event": "aaa-admin-pwd-change" }, { "component": "System", "event": "site-id-change" }, { "component": "System", "event": "domain-id-change" }, { "component": "System", "event": "system-ip-change" }, { "component": "System", "event": "org-name-change" }, { "component": "System", "event": "system-login-change" }, { "component": "System", "event": "system-logout-change" }, { "component": "System", "event": "system-aaa-login-fail" }, { "component": "System", "event": "cpu-usage" }, { "component": "System", "event": "system-commit" }, { "component": "System", "event": "pseudo-commit-status" }, { "component": "VPN", "event": "bgp-peer-state-change" }, { "component": "VPN", "event": "interface-state-change" }, { "component": "VPN", "event": "interface-bw" }, { "component": "VPN", "event": "interface-auto-bw" }, { "component": "VPN", "event": "route-install-fail" }, { "component": "VPN", "event": "tunnel-install-fail" }, { "component": "VPN", "event": "vrrp-group-state-change" }, { "component": "OSPF", "event": "ospf-neighbor-state-change" }, { "component": "OSPF", "event": "ospf-interface-state-change" }, { "component": "PIM", "event": "pim-neighbor-state-change" }, { "component": "PIM", "event": "pim-interface-state-change" }, { "component": "PIM", "event": "pim-tunnel-state-change" }, { "component": "PIM", "event": "pim-tunnel-change" }, { "component": "System", "event": "system-reboot-issued" }, { "component": "System", "event": "system-reboot-complete" }, { "component": "VPN", "event": "dhcp-address-assigned" }, { "component": "VPN", "event": "dhcp-address-renewed" }, { "component": "VPN", "event": "dhcp-address-released" }, { "component": "VPN", "event": "dhcp-request-rejected" }, { "component": "VPN", "event": "dhcp-address-rejected" }, { "component": "VPN", "event": "dhcp-server-state-change" }, { "component": "App-Route", "event": "sla-change" }, { "component": "App-Route", "event": "sla-violation" }, { "component": "App-Route", "event": "sla-violation-pkt-drop" }, { "component": "VPN", "event": "fib-update" }, { "component": "VPN", "event": "fib-updates" }, { "component": "Bridge", "event": "bridge-creation" }, { "component": "Bridge", "event": "bridge-deletion" }, { "component": "Bridge", "event": "bridge-interface-state-change" }, { "component": "Bridge", "event": "bridge-max-mac-reached" }, { "component": "System", "event": "app-dpi-flows-out-of-memory" }, { "component": "System", "event": "app-dpi-flows-write-failed-vedge" }, { "component": "Statistics", "event": "data-block-create" }, { "component": "Statistics", "event": "data-block-delete" }, { "component": "security", "event": "vmanage-connection-preference-changed" }, { "component": "CloudExpress", "event": "cloudexpress-application-change" }, { "component": "CloudExpress", "event": "cloudexpress-score-change" }, { "component": "CloudExpress", "event": "cloudexpress-max-local-exit-exceeded" }, { "component": "Hardware", "event": "sim-state-change" }, { "component": "VPN", "event": "interface-admin-state-change" }, { "component": "VPN", "event": "endpoint_tracker_state_change" }, { "component": "Hardware", "event": "domain-state-change" }, { "component": "Hardware", "event": "reg-state-change" }, { "component": "Hardware", "event": "bearer-change" }, { "component": "Policy", "event": "zbfw-flow-creation" }, { "component": "Policy", "event": "zbfw-flow-deletion" }, { "component": "Policy", "event": "zbfw-clear-flow-table-full" }, { "component": "Policy", "event": "zbfw-pkt-log" }, { "component": "Policy", "event": "zbfw-sessions-maximum" }, { "component": "Policy", "event": "zbfw-sess-rate-alert-on" }, { "component": "Policy", "event": "zbfw-sess-rate-alert-off" }, { "component": "Policy", "event": "data-policy-association-status" }, { "component": "Policy", "event": "access-list-association-status" }, { "component": "Policy", "event": "zbfw-flow-table-full" }, { "component": "Policy", "event": "zbfw-half-open-limit-hit" }, { "component": "App-Route", "event": "sla-config" }, { "component": "cloudDock", "event": "NETWORK_CREATE" }, { "component": "cloudDock", "event": "NETWORK_DELETE" }, { "component": "cloudDock", "event": "BRIDGE_CREATE" }, { "component": "cloudDock", "event": "BRIDGE_UPDATE" }, { "component": "cloudDock", "event": "BRIDGE_DELETE" }, { "component": "cloudDock", "event": "WAN_DHCP_RENEW" }, { "component": "cloudDock", "event": "MGMT_DHCP_RENEW" }, { "component": "cloudDock", "event": "INTF_STATUS_CHANGE" }, { "component": "cloudDock", "event": "UPGRADE_REGISTER" }, { "component": "cloudDock", "event": "UPGRADE_APPLY" }, { "component": "cloudDock", "event": "RBAC_USER_CREATE" }, { "component": "cloudDock", "event": "RBAC_USER_PASSWORD_UPDATE" }, { "component": "cloudDock", "event": "RBAC_USER_ROLE_UPDATE" }, { "component": "cloudDock", "event": "RBAC_USER_DELETE" }, { "component": "cloudDock", "event": "RBAC_USERS_INACTIVATED" }, { "component": "cloudDock", "event": "RBAC_USER_ACTIVATED" }, { "component": "cloudDock", "event": "RBAC_PWD_EXPIRED" }, { "component": "cloudDock", "event": "SECURITY_SERVER_CREATE" }, { "component": "cloudDock", "event": "SECURITY_SERVER_UPDATE" }, { "component": "cloudDock", "event": "SECURITY_SERVER_DELETE" }, { "component": "cloudDock", "event": "AAA_TYPE_CREATE" }, { "component": "cloudDock", "event": "AAA_TYPE_UPDATE" }, { "component": "cloudDock", "event": "CERT_SWITCH_CERT" }, { "component": "cloudDock", "event": "CERT_CSR_CREATE" }, { "component": "cloudDock", "event": "CERT_CA_CERT_INSTALL" }, { "component": "cloudDock", "event": "REBOOT" }, { "component": "cloudDock", "event": "SHUTDOWN" }, { "component": "cloudDock", "event": "LOGGING_FAILURE" }, { "component": "cloudDock", "event": "DISK_SPACE_ALMOST_FULL" }, { "component": "cloudDock", "event": "ROTATED_LOGS_DELETE" }, { "component": "cloudDock", "event": "TIME_UPDATE" }, { "component": "cloudDock", "event": "TIMEZONE_UPDATE" }, { "component": "cloudDock", "event": "FILE_COPY_STATUS" }, { "component": "cloudDock", "event": "FILE_DOWNLOAD_STATUS" }, { "component": "cloudDock", "event": "FILE_DOWNLOAD_START" }, { "component": "cloudDock", "event": "FILE_DOWNLOAD_VERIFIED" }, { "component": "cloudDock", "event": "FILE_DOWNLOAD_DONE" }, { "component": "cloudDock", "event": "FILE_DOWNLOAD_FAILED" }, { "component": "cloudDock", "event": "CREATE_IMAGE" }, { "component": "cloudDock", "event": "DELETE_IMAGE" }, { "component": "cloudDock", "event": "CREATE_FLAVOR" }, { "component": "cloudDock", "event": "VM_DEPLOYED" }, { "component": "cloudDock", "event": "VM_ALIVE" }, { "component": "cloudDock", "event": "SERVICE_ALIVE" }, { "component": "cloudDock", "event": "VM_UNDEPLOYED" }, { "component": "cloudDock", "event": "SERVICE_UNDEPLOYED" }, { "component": "cloudDock", "event": "SERVICE_UPDATED" }, { "component": "cloudDock", "event": "VM_STOPPED" }, { "component": "cloudDock", "event": "VM_STARTED" }, { "component": "cloudDock", "event": "VM_UPDATED" }, { "component": "cloudDock", "event": "VM_REBOOTED" }, { "component": "cloudDock", "event": "VM_RECOVERY_INIT" }, { "component": "cloudDock", "event": "VM_RECOVERY_REBOOT" }, { "component": "cloudDock", "event": "VM_RECOVERY_COMPLETE" }, { "component": "cloudDock", "event": "VM_MONITOR_UNSET" }, { "component": "cloudDock", "event": "VM_MONITOR_SET" }, { "component": "cloudDock", "event": "CIMC_PASSWORD_UPDATE" }, { "component": "cloudDock", "event": "FACTORY_RESET" }, { "component": "cloudDock", "event": "CPU_USAGE_HIGH" }, { "component": "cloudDock", "event": "viptela" }, { "component": "cloudDock", "event": "ccmEvent" }, { "component": "Software", "event": "umbrella-registration-success" }, { "component": "Software", "event": "umbrella-registration-failure" }, { "component": "Software", "event": "site-id-mismatch" }, { "component": "Software", "event": "service-node-state" }, { "component": "Software", "event": "appqoe-alarm" }, { "component": "Security", "event": "fw-alert" }, { "component": "Security", "event": "ftm-zia-tunnel-setup" }, { "component": "Security", "event": "ftm-tunnel-setup" }, { "component": "Security", "event": "ftm-zia-location-setup" }, { "component": "Security", "event": "ftm-tunnel-tracker" }, { "component": "System", "event": "dca-change-event" }, { "component": "System", "event": "geo-fence-alert-status" }, { "component": "Software", "event": "app-list-app-aliases-notify" }, { "component": "Software", "event": "app-list-unsupported-app-notify" }, { "component": "VPN", "event": "tracker-state-change" }, { "component": "System", "event": "disk-read-speed" }, { "component": "System", "event": "disk-write-speed" }, { "component": "Software", "event": "idmgr-pxgrid-connection" }, { "component": "Nwpi", "event": "qos-congestion" }, { "component": "Nat", "event": "nat-update" }, { "component": "System", "event": "aaa-password-expiry-warning" }, { "component": "System", "event": "aaa-password-expired" }, { "component": "Policy", "event": "data-policy-commit-failure" }, { "component": "System", "event": "non-yang-cli-file-generated" }, { "component": "Hardware", "event": "cellular-network-status-change" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventResponseGeteventsbycomponent" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/event/listeners": { "get": { "tags": [ "Monitoring - Events" ], "description": "Retrieve listener information", "operationId": "getListenersInfo", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Listeners": { "description": "Listeners", "value": { "data": [ [ "172.16.255.14", "b6f96d9d-c7f4-42cf-a0c3-229987ebfadd", 1717499753110, 1418525 ], [ "172.16.255.19", "7ed6a5b0-ddcb-4024-88ae-73e723476202", 1717499754183, 1405384 ], [ "172.16.255.21", "5cd0fe57-30ee-4e9b-bf9a-028141a02f1e", 1717499751671, 1362486 ], [ "172.16.255.16", "21a8ce32-0400-4c1b-8860-07af4180addb", 1717499751021, 1398150 ], [ "172.16.255.20", "a12fecf8-7c83-470b-8d4b-238f5197fcef", 1717499753787, 1399405 ], [ "172.16.255.26", "a52dcb70-bd3b-4d9e-baf0-6616ab20538c", 1717499754401, 462213 ], [ "172.16.255.11", "91e86df6-8cd1-4a5d-99a9-0104b2960114", 1717499752137, 1450422 ], [ "172.16.255.15", "0f2d7ac4-72cb-47ad-b02f-ed35c0517b79", 1717499751235, 1408530 ], [ "172.16.255.22", "c2c0d332-91d6-4159-b0a5-2dc0f4861f5e", 1717499783893, 485555 ] ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventResponseListeners" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/event/page": { "get": { "tags": [ "Monitoring - Events" ], "description": "Get paginated events", "operationId": "getPage_MonitoringEvents_1103", "parameters": [ { "name": "query", "in": "query", "description": "Query", "schema": { "type": "string" }, "examples": { "Get events filter by hours": { "description": "Get events filter by hours", "value": { "query": { "condition": "AND", "rules": [ { "field": "entry_time", "operator": "last_n_hours", "type": "date", "value": [ "10" ] } ] }, "size": 100 }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventRequestFilterByHours" }, "Get events filter between dates": { "description": "Get events 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": 100 }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventRequestFilterBetweenDates" }, "Get events filter by type": { "description": "Get events filter by type", "value": { "query": { "condition": "AND", "rules": [ { "field": "entry_time", "operator": "last_n_hours", "type": "date", "value": [ "10" ] }, { "field": "eventname", "operator": "in", "type": "string", "value": [ "memory-usage" ] } ] }, "size": 100 }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventRequestFilterByType" }, "Get events filter by system ip": { "description": "Get events 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/ComViptelaVmanageServerEventRequestFilterBySystemIp" }, "Get events filter by severity": { "description": "Get events filter by severity", "value": { "query": { "condition": "AND", "rules": [ { "field": "entry_time", "operator": "last_n_hours", "type": "date", "value": [ "10" ] }, { "field": "severity_level", "operator": "in", "type": "string", "value": [ "critical" ] } ] }, "size": 100 }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventRequestFilterBySeverity" }, "Get events filter by site-id": { "description": "Get events 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/ComViptelaVmanageServerEventRequestFilterBySites" } } }, { "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 events", "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": { "data": [ { "entry_time": 1717405624895, "statcycletime": 1717405624895, "tenant": "default", "deviceuuid": "91e86df6-8cd1-4a5d-99a9-0104b2960114", "host_name": "vedge", "system_ip": "172.16.255.11", "vmanage_system_ip": "172.16.255.11", "device_type": "vedge", "eventname": "interface-state-change", "component": "VPN", "severity_level": "major", "event": "{\"interface-state-change\":{\"if-name\":\"eth0\",\"xmlns\":\"http://viptela.com/vpn\",\"system-ip\":\"::\",\"host-name\":\"vedge\",\"vpn-id\":512,\"new-state\":\"up\",\"severity-level\":\"major\"}}", "details": "host-name=vedge; vpn-id=512; if-name=eth0; new-state=up", "tunnelname": "eth0", "process_id": "", "event_type": "", "event_description": "", "cor_region": "", "cloud_type": "", "transit_vpc_account_id": "", "transit_vpc_account_name": "", "transit_vpc_id": "", "transit_vpc_name": "", "host_vpc_id": "", "host_vpc_account_id": "", "host_vpc_account_name": "", "instance_id": "", "device_pair_id": "", "device_uuid_list": "", "device_instance_id_list": "", "old_device_pair_id": "", "target_device_ip": "", "target_device_uuid": "", "date_string": "", "alert_timestamp": 0, "filename": "", "dst_port": 0, "dst_ip": "" } ], "pageInfo": { "startTime": "1717405606203", "endTime": "1717405624910", "scrollId": "NQYkPL3cg2Y8fSMTClSW7MJ5e8A4ilV1vb7o0YhfJzHKS3hdaq6uOgIX2tUev4MV865y1txxwN6GU6XXg3hNX5dYrvKRfb4MeEUnc4pmkrgVwRUQnhUkZils", "hasMoreData": true, "count": 4, "totalCount": 2728 } }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventResponsePage" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Events-read" }, "post": { "tags": [ "Monitoring - Events" ], "description": "Get paginated events", "operationId": "postPage_MonitoringEvents_1104", "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 events", "schema": { "pattern": "^[0-9]+$", "type": "string" } } ], "requestBody": { "description": "Event query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Get events filter by hours": { "description": "Get events filter by hours", "value": { "query": { "condition": "AND", "rules": [ { "field": "entry_time", "operator": "last_n_hours", "type": "date", "value": [ "10" ] } ] }, "size": 100 }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventRequestFilterByHours" }, "Get events filter between dates": { "description": "Get events 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": 100 }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventRequestFilterBetweenDates" }, "Get events filter by type": { "description": "Get events filter by type", "value": { "query": { "condition": "AND", "rules": [ { "field": "entry_time", "operator": "last_n_hours", "type": "date", "value": [ "10" ] }, { "field": "eventname", "operator": "in", "type": "string", "value": [ "memory-usage" ] } ] }, "size": 100 }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventRequestFilterByType" }, "Get events filter by system ip": { "description": "Get events 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/ComViptelaVmanageServerEventRequestFilterBySystemIp" }, "Get events filter by severity": { "description": "Get events filter by severity", "value": { "query": { "condition": "AND", "rules": [ { "field": "entry_time", "operator": "last_n_hours", "type": "date", "value": [ "10" ] }, { "field": "severity_level", "operator": "in", "type": "string", "value": [ "critical" ] } ] }, "size": 100 }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventRequestFilterBySeverity" }, "Get events filter by site-id": { "description": "Get events 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/ComViptelaVmanageServerEventRequestFilterBySites" } } } }, "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": { "data": [ { "entry_time": 1717405624895, "statcycletime": 1717405624895, "tenant": "default", "deviceuuid": "91e86df6-8cd1-4a5d-99a9-0104b2960114", "host_name": "vedge", "system_ip": "172.16.255.11", "vmanage_system_ip": "172.16.255.11", "device_type": "vedge", "eventname": "interface-state-change", "component": "VPN", "severity_level": "major", "event": "{\"interface-state-change\":{\"if-name\":\"eth0\",\"xmlns\":\"http://viptela.com/vpn\",\"system-ip\":\"::\",\"host-name\":\"vedge\",\"vpn-id\":512,\"new-state\":\"up\",\"severity-level\":\"major\"}}", "details": "host-name=vedge; vpn-id=512; if-name=eth0; new-state=up", "tunnelname": "eth0", "process_id": "", "event_type": "", "event_description": "", "cor_region": "", "cloud_type": "", "transit_vpc_account_id": "", "transit_vpc_account_name": "", "transit_vpc_id": "", "transit_vpc_name": "", "host_vpc_id": "", "host_vpc_account_id": "", "host_vpc_account_name": "", "instance_id": "", "device_pair_id": "", "device_uuid_list": "", "device_instance_id_list": "", "old_device_pair_id": "", "target_device_ip": "", "target_device_uuid": "", "date_string": "", "alert_timestamp": 0, "filename": "", "dst_port": 0, "dst_ip": "" } ], "pageInfo": { "startTime": "1717405606203", "endTime": "1717405624910", "scrollId": "NQYkPL3cg2Y8fSMTClSW7MJ5e8A4ilV1vb7o0YhfJzHKS3hdaq6uOgIX2tUev4MV865y1txxwN6GU6XXg3hNX5dYrvKRfb4MeEUnc4pmkrgVwRUQnhUkZils", "hasMoreData": true, "count": 4, "totalCount": 2728 } }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventResponsePage" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Alarms-read" } }, "/event/query/fields": { "get": { "tags": [ "Monitoring - Events" ], "description": "Get query fields", "operationId": "getQueryFields", "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/EventQueryInputResponse" }, "examples": { "Query fields": { "description": "Query fields", "value": { "data": [ { "isRequired": true, "fieldData": { "type": "dateList" }, "dataType": "date", "property": "entry_time", "name": "Event Time", "options": [ { "enableDateFields": false, "number": "1", "value": "Last 1 hour", "key": "last_1_hour" }, { "enableDateFields": false, "number": "3", "isSelected": true, "value": "Last 3 hours", "key": "last_3_hours" }, { "enableDateFields": false, "number": "6", "value": "Last 6 hours", "key": "last_6_hours" }, { "enableDateFields": false, "number": "12", "value": "Last 12 hours", "key": "last_12_hours" }, { "enableDateFields": false, "number": "24", "value": "Last 24 hours", "key": "last_24_hours" }, { "enableDateFields": false, "number": "168", "value": "Last 7 days", "key": "last_168_hours" }, { "enableDateFields": true, "value": "Custom", "key": "custom" } ] }, { "isRequired": false, "fieldData": { "type": "enum" }, "dataType": "string", "property": "severity_level", "name": "Severity", "options": [ { "value": "Critical", "key": "critical" }, { "value": "Major", "key": "major" }, { "value": "Minor", "key": "minor" } ], "multiSelect": true }, { "isRequired": false, "fieldData": { "type": "url", "url": "dataservice/event/component/keyvalue" }, "dataType": "string", "property": "component", "name": "Component", "multiSelect": true }, { "isRequired": false, "fieldData": { "type": "url", "url": "dataservice/device/keyvalue" }, "dataType": "string", "property": "system_ip", "name": "System IP", "multiSelect": true }, { "isRequired": false, "fieldData": { "type": "url", "url": "dataservice/event/types/keyvalue" }, "dataType": "string", "property": "eventname", "name": "Event name", "multiSelect": true } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventResponseQueryFields" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Events-read" } }, "/event/query/input": { "get": { "tags": [ "Monitoring - Events" ], "description": "Get event field details", "operationId": "createEventsQueryConfig", "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/EventQueryInputResponse" }, "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": "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/ComViptelaVmanageServerEventResponseQueryInput" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Events-read" } }, "/event/severity": { "get": { "tags": [ "Monitoring - Events" ], "description": "Get alarms by severity", "operationId": "getBySeverities", "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 events filter by hours": { "description": "Get events filter by hours", "value": { "query": { "condition": "AND", "rules": [ { "field": "entry_time", "operator": "last_n_hours", "type": "date", "value": [ "10" ] } ] }, "size": 100 }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventRequestFilterByHours" }, "Get events filter between dates": { "description": "Get events 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": 100 }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventRequestFilterBetweenDates" }, "Get events filter by type": { "description": "Get events filter by type", "value": { "query": { "condition": "AND", "rules": [ { "field": "entry_time", "operator": "last_n_hours", "type": "date", "value": [ "10" ] }, { "field": "eventname", "operator": "in", "type": "string", "value": [ "memory-usage" ] } ] }, "size": 100 }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventRequestFilterByType" }, "Get events filter by system ip": { "description": "Get events 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/ComViptelaVmanageServerEventRequestFilterBySystemIp" }, "Get events filter by severity": { "description": "Get events filter by severity", "value": { "query": { "condition": "AND", "rules": [ { "field": "entry_time", "operator": "last_n_hours", "type": "date", "value": [ "10" ] }, { "field": "severity_level", "operator": "in", "type": "string", "value": [ "critical" ] } ] }, "size": 100 }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventRequestFilterBySeverity" }, "Get events filter by site-id": { "description": "Get events 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/ComViptelaVmanageServerEventRequestFilterBySites" } } }, { "name": "site-id", "in": "query", "description": "Specify the site-id to filter the events", "schema": { "pattern": "^[0-9]+$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "object", "properties": { "component": { "type": "string", "example": "System" }, "details": { "type": "string", "example": "host-name=vm12; user-name=admin; user-id=2276" }, "entry_time": { "type": "string" }, "eventname": { "type": "string", "example": "system-login-change" }, "host_name": { "type": "string", "example": "vm12" }, "severity_level": { "type": "string", "enum": [ "MINOR", "MAJOR", "MEDIUM", "CRITICAL" ] }, "system_ip": { "type": "string", "example": "172.16.255.22" } }, "$$ref": "#/components/schemas/EventsBySeverity" }, "$$ref": "#/components/schemas/EventSeverityResponse" }, "examples": { "Events": { "description": "Events", "value": { "data": [ { "entry_time": 1717494474191, "system_ip": "172.16.255.11", "eventname": "cpu-usage", "host_name": "vm1", "component": "System", "severity_level": "minor", "details": "host-name=vm1; cpu-status=usage-healthy; warning=System CPU usage is back to normal level (below 60%); cpu-1min-percentage=100; cpu-5min-percentage=59.00" }, { "entry_time": 1717494424040, "system_ip": "172.16.255.11", "eventname": "cpu-usage", "host_name": "vm1", "component": "System", "severity_level": "minor", "details": "host-name=vm1; cpu-status=usage-notice; warning=System CPU usage is above 60%; cpu-1min-percentage=100; cpu-5min-percentage=68.00" }, { "entry_time": 1717494036440, "system_ip": "172.16.255.22", "eventname": "security-root-cert-chain-installed", "host_name": "vm12", "component": "Security", "severity_level": "minor", "details": "host-name=vm12" }, { "entry_time": 1717494028056, "system_ip": "172.16.255.26", "eventname": "security-root-cert-chain-installed", "host_name": "vm16", "component": "Security", "severity_level": "minor", "details": "host-name=vm16" }, { "entry_time": 1717493916930, "system_ip": "172.16.255.21", "eventname": "dhcp-address-renewed", "host_name": "vm11", "component": "VPN", "severity_level": "minor", "details": "host-name=vm11; vpn-id=512; if-name=eth0; client-mac=00:50:56:00:01:1f; ip=10.0.1.31" }, { "entry_time": 1717493882579, "system_ip": "172.16.255.16", "eventname": "dhcp-address-renewed", "host_name": "vm6", "component": "VPN", "severity_level": "minor", "details": "host-name=vm6; vpn-id=512; if-name=eth0; client-mac=00:50:56:00:01:10; ip=10.0.1.16" }, { "entry_time": 1717493881309, "system_ip": "172.16.255.20", "eventname": "dhcp-address-renewed", "host_name": "vm10", "component": "VPN", "severity_level": "minor", "details": "host-name=vm10; vpn-id=0; if-name=eth0; client-mac=00:50:56:00:01:1e; ip=10.0.1.30" }, { "entry_time": 1717493517448, "system_ip": "172.16.255.22", "eventname": "system-login-change", "host_name": "vm12", "component": "System", "severity_level": "minor", "details": "host-name=vm12; user-name=admin; user-id=-28374" }, { "entry_time": 1717493517448, "system_ip": "172.16.255.22", "eventname": "system-login-change", "host_name": "vm12", "component": "System", "severity_level": "minor", "details": "host-name=vm12; user-name=admin; user-id=-28374" }, { "entry_time": 1717493018537, "system_ip": "172.16.255.26", "eventname": "dhcp-address-renewed", "host_name": "vm16", "component": "VPN", "severity_level": "minor", "details": "host-name=vm16; vpn-id=512; if-name=eth0; client-mac=00:50:56:00:01:24; ip=10.0.1.36" }, { "entry_time": 1717493018537, "system_ip": "172.16.255.26", "eventname": "dhcp-address-renewed", "host_name": "vm16", "component": "VPN", "severity_level": "minor", "details": "host-name=vm16; vpn-id=512; if-name=eth0; client-mac=00:50:56:00:01:24; ip=10.0.1.36" }, { "entry_time": 1717492082508, "system_ip": "172.16.255.16", "eventname": "dhcp-address-renewed", "host_name": "vm6", "component": "VPN", "severity_level": "minor", "details": "host-name=vm6; vpn-id=512; if-name=eth0; client-mac=00:50:56:00:01:10; ip=10.0.1.16" }, { "entry_time": 1717491129726, "system_ip": "172.16.255.15", "eventname": "cpu-usage", "host_name": "vm5", "component": "System", "severity_level": "minor", "details": "host-name=vm5; cpu-status=usage-healthy; warning=System CPU usage is back to normal level (below 60%); cpu-1min-percentage=42.00; cpu-5min-percentage=59.00" }, { "entry_time": 1717491119767, "system_ip": "172.16.255.15", "eventname": "cpu-usage", "host_name": "vm5", "component": "System", "severity_level": "minor", "details": "host-name=vm5; cpu-status=usage-notice; warning=System CPU usage is above 60%; cpu-1min-percentage=50.00; cpu-5min-percentage=61.00" }, { "entry_time": 1717491109539, "system_ip": "172.16.255.15", "eventname": "cpu-usage", "host_name": "vm5", "component": "System", "severity_level": "minor", "details": "host-name=vm5; cpu-status=usage-healthy; warning=System CPU usage is back to normal level (below 60%); cpu-1min-percentage=41.00; cpu-5min-percentage=60.00" }, { "entry_time": 1717490271278, "system_ip": "172.16.255.15", "eventname": "dhcp-address-renewed", "host_name": "vm5", "component": "VPN", "severity_level": "minor", "details": "host-name=vm5; vpn-id=512; if-name=eth0; client-mac=00:50:56:00:01:0f; ip=10.0.1.15" }, { "entry_time": 1717488474843, "system_ip": "172.16.255.19", "eventname": "dhcp-address-renewed", "host_name": "vm9", "component": "VPN", "severity_level": "minor", "details": "host-name=vm9; vpn-id=0; if-name=eth0; client-mac=00:50:56:00:01:13; ip=10.0.1.19" }, { "entry_time": 1717488471237, "system_ip": "172.16.255.15", "eventname": "dhcp-address-renewed", "host_name": "vm5", "component": "VPN", "severity_level": "minor", "details": "host-name=vm5; vpn-id=512; if-name=eth0; client-mac=00:50:56:00:01:0f; ip=10.0.1.15" }, { "entry_time": 1717488462547, "system_ip": "172.16.255.14", "eventname": "dhcp-address-renewed", "host_name": "vm4", "component": "VPN", "severity_level": "minor", "details": "host-name=vm4; vpn-id=512; if-name=eth0; client-mac=00:50:56:00:01:0e; ip=10.0.1.14" }, { "entry_time": 1717483994936, "system_ip": "172.16.255.22", "eventname": "dhcp-address-renewed", "host_name": "vm12", "component": "VPN", "severity_level": "minor", "details": "host-name=vm12; vpn-id=0; if-name=eth0; client-mac=00:50:56:00:01:20; ip=10.0.1.32" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventResponseSeverity" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Events-read" } }, "/event/severity/summary": { "get": { "tags": [ "Monitoring - Events" ], "description": "Get event severity histogram", "operationId": "getSeverityHistogram", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device system ip", "required": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "query", "in": "query", "description": "Query", "allowEmptyValue": true, "schema": { "type": "string" }, "examples": { "Empty": { "description": "Empty" }, "Get events filter by hours": { "description": "Get events filter by hours", "value": { "query": { "condition": "AND", "rules": [ { "field": "entry_time", "operator": "last_n_hours", "type": "date", "value": [ "10" ] } ] }, "size": 100 }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventRequestFilterByHours" }, "Get events filter between dates": { "description": "Get events 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": 100 }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventRequestFilterBetweenDates" }, "Get events filter by type": { "description": "Get events filter by type", "value": { "query": { "condition": "AND", "rules": [ { "field": "entry_time", "operator": "last_n_hours", "type": "date", "value": [ "10" ] }, { "field": "eventname", "operator": "in", "type": "string", "value": [ "memory-usage" ] } ] }, "size": 100 }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventRequestFilterByType" }, "Get events filter by system ip": { "description": "Get events 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/ComViptelaVmanageServerEventRequestFilterBySystemIp" }, "Get events filter by severity": { "description": "Get events filter by severity", "value": { "query": { "condition": "AND", "rules": [ { "field": "entry_time", "operator": "last_n_hours", "type": "date", "value": [ "10" ] }, { "field": "severity_level", "operator": "in", "type": "string", "value": [ "critical" ] } ] }, "size": 100 }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventRequestFilterBySeverity" }, "Get events filter by site-id": { "description": "Get events 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/ComViptelaVmanageServerEventRequestFilterBySites" } } }, { "name": "site-id", "in": "query", "description": "Specify the site-id to filter the events", "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": 1718015805314, "viewKeys": { "uniqueKey": [], "preferenceKey": "grid-DeviceEvent_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": "Severity", "property": "severity_level", "width": 150, "dataType": "string" } ], "fields": [ { "property": "entry_time", "dataType": "date" }, { "property": "count", "dataType": "number" }, { "property": "severity_level", "dataType": "string" } ], "chart": { "xAxis": [ "entry_time" ], "yAxis": [ "count" ], "series": [ "severity_level" ], "title": "view.chart.clientViewEventHistogram.events", "xAxisLabel": "view.chart.clientViewEventHistogram.time", "yAxisLabel": "view.chart.clientViewEventHistogram.count" } }, "data": [ { "entry_time": 1718002800000, "severity_level": "major", "count": 32 }, { "entry_time": 1718006400000, "severity_level": "major", "count": 96 }, { "entry_time": 1718010000000, "severity_level": "major", "count": 96 }, { "entry_time": 1718013600000, "severity_level": "major", "count": 56 } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventResponseSeveritySummary" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/event/types/keyvalue": { "get": { "tags": [ "Monitoring - Events" ], "description": "Get event types.", "operationId": "getEventTypesAsKeyValue", "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": { "data": [ { "key": "system-software-install-change", "value": "system-software-install-change" }, { "key": "system-software-install-status", "value": "system-software-install-status" }, { "key": "system-firmware-install-status", "value": "system-firmware-install-status" }, { "key": "im-event", "value": "im-event" }, { "key": "utd-notification", "value": "utd-notification" }, { "key": "utd-update", "value": "utd-update" }, { "key": "utd-ips-alert", "value": "utd-ips-alert" }, { "key": "utd-engine-status", "value": "utd-engine-status" }, { "key": "utd-sessions-max", "value": "utd-sessions-max" }, { "key": "utd-version-mismatch", "value": "utd-version-mismatch" }, { "key": "utd-file-reputation-retrospective-alert", "value": "utd-file-reputation-retrospective-alert" }, { "key": "utd-file-analysis-upload-state", "value": "utd-file-analysis-upload-state" }, { "key": "utd-file-reputation-alert", "value": "utd-file-reputation-alert" }, { "key": "utd-file-analysis-status-event", "value": "utd-file-analysis-status-event" }, { "key": "utd-file-reputation-status-event", "value": "utd-file-reputation-status-event" }, { "key": "utd-con", "value": "utd-con" }, { "key": "appqoe-event", "value": "appqoe-event" }, { "key": "data-policy-association-status", "value": "data-policy-association-status" }, { "key": "access-list-association-status", "value": "access-list-association-status" }, { "key": "device-policy-association-status", "value": "device-policy-association-status" }, { "key": "umbrella-anycast-server-switch", "value": "umbrella-anycast-server-switch" }, { "key": "system-software-patch-change", "value": "system-software-patch-change" }, { "key": "system-software-install-complete-change", "value": "system-software-install-complete-change" }, { "key": "bfd-state-change", "value": "bfd-state-change" }, { "key": "flash-fault", "value": "flash-fault" }, { "key": "emmc-fault", "value": "emmc-fault" }, { "key": "sdcard-fault", "value": "sdcard-fault" }, { "key": "tempsensor-fault", "value": "tempsensor-fault" }, { "key": "tempsensor-state", "value": "tempsensor-state" }, { "key": "fan-fault", "value": "fan-fault" }, { "key": "fantray-fault", "value": "fantray-fault" }, { "key": "pem-fault", "value": "pem-fault" }, { "key": "pem-state-change", "value": "pem-state-change" }, { "key": "pim-fault", "value": "pim-fault" }, { "key": "pim-state-change", "value": "pim-state-change" }, { "key": "sfp-state-change", "value": "sfp-state-change" }, { "key": "usb-state-change", "value": "usb-state-change" }, { "key": "sfp-support-state", "value": "sfp-support-state" }, { "key": "omp-number-of-vsmarts-change", "value": "omp-number-of-vsmarts-change" }, { "key": "omp-ro-gen-failure", "value": "omp-ro-gen-failure" }, { "key": "omp-state-change", "value": "omp-state-change" }, { "key": "omp-peer-state-change", "value": "omp-peer-state-change" }, { "key": "omp-tloc-state-change", "value": "omp-tloc-state-change" }, { "key": "omp-data-policy", "value": "omp-data-policy" }, { "key": "omp-policy", "value": "omp-policy" }, { "key": "control-connection-state-change", "value": "control-connection-state-change" }, { "key": "control-connection-auth-fail", "value": "control-connection-auth-fail" }, { "key": "control-vbond-state-change", "value": "control-vbond-state-change" }, { "key": "control-connection-tloc-ip-change", "value": "control-connection-tloc-ip-change" }, { "key": "control-no-active-vsmart", "value": "control-no-active-vsmart" }, { "key": "control-no-active-vbond", "value": "control-no-active-vbond" }, { "key": "control-vedge-list-request", "value": "control-vedge-list-request" }, { "key": "tunnel-ipsec-rekey", "value": "tunnel-ipsec-rekey" }, { "key": "tunnel-ipsec-manual-rekey", "value": "tunnel-ipsec-manual-rekey" }, { "key": "security-root-cert-chain-installed", "value": "security-root-cert-chain-installed" }, { "key": "pki-certificate-event", "value": "pki-certificate-event" }, { "key": "pki-certificate-expiry", "value": "pki-certificate-expiry" }, { "key": "security-certificate-installed", "value": "security-certificate-installed" }, { "key": "service-gre-state-update", "value": "service-gre-state-update" }, { "key": "security-new-csr-generated", "value": "security-new-csr-generated" }, { "key": "security-root-cert-chain-uninstalled", "value": "security-root-cert-chain-uninstalled" }, { "key": "security-clear-installed-certificate", "value": "security-clear-installed-certificate" }, { "key": "security-vedge-serial-file-uploaded", "value": "security-vedge-serial-file-uploaded" }, { "key": "security-vsmart-serial-file-uploaded", "value": "security-vsmart-serial-file-uploaded" }, { "key": "security-vedge-entry-added", "value": "security-vedge-entry-added" }, { "key": "security-vedge-entry-removed", "value": "security-vedge-entry-removed" }, { "key": "security-unclaimed-vedge-entry-added", "value": "security-unclaimed-vedge-entry-added" }, { "key": "security-vsmart-entry-added", "value": "security-vsmart-entry-added" }, { "key": "security-vsmart-entry-removed", "value": "security-vsmart-entry-removed" }, { "key": "ssl-certificate-warning", "value": "ssl-certificate-warning" }, { "key": "security-certificate-expired", "value": "security-certificate-expired" }, { "key": "vbond-reject-vedge-connection", "value": "vbond-reject-vedge-connection" }, { "key": "device-template-missing", "value": "device-template-missing" }, { "key": "device-template-attached-during-ztp", "value": "device-template-attached-during-ztp" }, { "key": "process-restart", "value": "process-restart" }, { "key": "process-down", "value": "process-down" }, { "key": "reboot-aborted", "value": "reboot-aborted" }, { "key": "disk-usage", "value": "disk-usage" }, { "key": "memory-usage", "value": "memory-usage" }, { "key": "aaa-admin-pwd-change", "value": "aaa-admin-pwd-change" }, { "key": "site-id-change", "value": "site-id-change" }, { "key": "domain-id-change", "value": "domain-id-change" }, { "key": "system-ip-change", "value": "system-ip-change" }, { "key": "org-name-change", "value": "org-name-change" }, { "key": "system-login-change", "value": "system-login-change" }, { "key": "system-logout-change", "value": "system-logout-change" }, { "key": "system-aaa-login-fail", "value": "system-aaa-login-fail" }, { "key": "cpu-usage", "value": "cpu-usage" }, { "key": "system-commit", "value": "system-commit" }, { "key": "pseudo-commit-status", "value": "pseudo-commit-status" }, { "key": "bgp-peer-state-change", "value": "bgp-peer-state-change" }, { "key": "interface-state-change", "value": "interface-state-change" }, { "key": "interface-bw", "value": "interface-bw" }, { "key": "interface-auto-bw", "value": "interface-auto-bw" }, { "key": "route-install-fail", "value": "route-install-fail" }, { "key": "tunnel-install-fail", "value": "tunnel-install-fail" }, { "key": "vrrp-group-state-change", "value": "vrrp-group-state-change" }, { "key": "ospf-neighbor-state-change", "value": "ospf-neighbor-state-change" }, { "key": "ospf-interface-state-change", "value": "ospf-interface-state-change" }, { "key": "pim-neighbor-state-change", "value": "pim-neighbor-state-change" }, { "key": "pim-interface-state-change", "value": "pim-interface-state-change" }, { "key": "pim-tunnel-state-change", "value": "pim-tunnel-state-change" }, { "key": "pim-tunnel-change", "value": "pim-tunnel-change" }, { "key": "system-reboot-issued", "value": "system-reboot-issued" }, { "key": "system-reboot-complete", "value": "system-reboot-complete" }, { "key": "dhcp-address-assigned", "value": "dhcp-address-assigned" }, { "key": "dhcp-address-renewed", "value": "dhcp-address-renewed" }, { "key": "dhcp-address-released", "value": "dhcp-address-released" }, { "key": "dhcp-request-rejected", "value": "dhcp-request-rejected" }, { "key": "dhcp-address-rejected", "value": "dhcp-address-rejected" }, { "key": "dhcp-server-state-change", "value": "dhcp-server-state-change" }, { "key": "sla-change", "value": "sla-change" }, { "key": "sla-violation", "value": "sla-violation" }, { "key": "sla-violation-pkt-drop", "value": "sla-violation-pkt-drop" }, { "key": "fib-update", "value": "fib-update" }, { "key": "fib-updates", "value": "fib-updates" }, { "key": "bridge-creation", "value": "bridge-creation" }, { "key": "bridge-deletion", "value": "bridge-deletion" }, { "key": "bridge-interface-state-change", "value": "bridge-interface-state-change" }, { "key": "bridge-max-mac-reached", "value": "bridge-max-mac-reached" }, { "key": "app-dpi-flows-out-of-memory", "value": "app-dpi-flows-out-of-memory" }, { "key": "app-dpi-flows-write-failed-vedge", "value": "app-dpi-flows-write-failed-vedge" }, { "key": "data-block-create", "value": "data-block-create" }, { "key": "data-block-delete", "value": "data-block-delete" }, { "key": "vmanage-connection-preference-changed", "value": "vmanage-connection-preference-changed" }, { "key": "cloudexpress-application-change", "value": "cloudexpress-application-change" }, { "key": "cloudexpress-score-change", "value": "cloudexpress-score-change" }, { "key": "cloudexpress-max-local-exit-exceeded", "value": "cloudexpress-max-local-exit-exceeded" }, { "key": "sim-state-change", "value": "sim-state-change" }, { "key": "interface-admin-state-change", "value": "interface-admin-state-change" }, { "key": "endpoint_tracker_state_change", "value": "endpoint_tracker_state_change" }, { "key": "domain-state-change", "value": "domain-state-change" }, { "key": "reg-state-change", "value": "reg-state-change" }, { "key": "bearer-change", "value": "bearer-change" }, { "key": "zbfw-flow-creation", "value": "zbfw-flow-creation" }, { "key": "zbfw-flow-deletion", "value": "zbfw-flow-deletion" }, { "key": "zbfw-clear-flow-table-full", "value": "zbfw-clear-flow-table-full" }, { "key": "zbfw-pkt-log", "value": "zbfw-pkt-log" }, { "key": "zbfw-sessions-maximum", "value": "zbfw-sessions-maximum" }, { "key": "zbfw-sess-rate-alert-on", "value": "zbfw-sess-rate-alert-on" }, { "key": "zbfw-sess-rate-alert-off", "value": "zbfw-sess-rate-alert-off" }, { "key": "zbfw-flow-table-full", "value": "zbfw-flow-table-full" }, { "key": "zbfw-half-open-limit-hit", "value": "zbfw-half-open-limit-hit" }, { "key": "sla-config", "value": "sla-config" }, { "key": "NETWORK_CREATE", "value": "NETWORK_CREATE" }, { "key": "NETWORK_DELETE", "value": "NETWORK_DELETE" }, { "key": "BRIDGE_CREATE", "value": "BRIDGE_CREATE" }, { "key": "BRIDGE_UPDATE", "value": "BRIDGE_UPDATE" }, { "key": "BRIDGE_DELETE", "value": "BRIDGE_DELETE" }, { "key": "WAN_DHCP_RENEW", "value": "WAN_DHCP_RENEW" }, { "key": "MGMT_DHCP_RENEW", "value": "MGMT_DHCP_RENEW" }, { "key": "INTF_STATUS_CHANGE", "value": "INTF_STATUS_CHANGE" }, { "key": "UPGRADE_REGISTER", "value": "UPGRADE_REGISTER" }, { "key": "UPGRADE_APPLY", "value": "UPGRADE_APPLY" }, { "key": "RBAC_USER_CREATE", "value": "RBAC_USER_CREATE" }, { "key": "RBAC_USER_PASSWORD_UPDATE", "value": "RBAC_USER_PASSWORD_UPDATE" }, { "key": "RBAC_USER_ROLE_UPDATE", "value": "RBAC_USER_ROLE_UPDATE" }, { "key": "RBAC_USER_DELETE", "value": "RBAC_USER_DELETE" }, { "key": "RBAC_USERS_INACTIVATED", "value": "RBAC_USERS_INACTIVATED" }, { "key": "RBAC_USER_ACTIVATED", "value": "RBAC_USER_ACTIVATED" }, { "key": "RBAC_PWD_EXPIRED", "value": "RBAC_PWD_EXPIRED" }, { "key": "SECURITY_SERVER_CREATE", "value": "SECURITY_SERVER_CREATE" }, { "key": "SECURITY_SERVER_UPDATE", "value": "SECURITY_SERVER_UPDATE" }, { "key": "SECURITY_SERVER_DELETE", "value": "SECURITY_SERVER_DELETE" }, { "key": "AAA_TYPE_CREATE", "value": "AAA_TYPE_CREATE" }, { "key": "AAA_TYPE_UPDATE", "value": "AAA_TYPE_UPDATE" }, { "key": "CERT_SWITCH_CERT", "value": "CERT_SWITCH_CERT" }, { "key": "CERT_CSR_CREATE", "value": "CERT_CSR_CREATE" }, { "key": "CERT_CA_CERT_INSTALL", "value": "CERT_CA_CERT_INSTALL" }, { "key": "REBOOT", "value": "REBOOT" }, { "key": "SHUTDOWN", "value": "SHUTDOWN" }, { "key": "LOGGING_FAILURE", "value": "LOGGING_FAILURE" }, { "key": "DISK_SPACE_ALMOST_FULL", "value": "DISK_SPACE_ALMOST_FULL" }, { "key": "ROTATED_LOGS_DELETE", "value": "ROTATED_LOGS_DELETE" }, { "key": "TIME_UPDATE", "value": "TIME_UPDATE" }, { "key": "TIMEZONE_UPDATE", "value": "TIMEZONE_UPDATE" }, { "key": "FILE_COPY_STATUS", "value": "FILE_COPY_STATUS" }, { "key": "FILE_DOWNLOAD_STATUS", "value": "FILE_DOWNLOAD_STATUS" }, { "key": "FILE_DOWNLOAD_START", "value": "FILE_DOWNLOAD_START" }, { "key": "FILE_DOWNLOAD_VERIFIED", "value": "FILE_DOWNLOAD_VERIFIED" }, { "key": "FILE_DOWNLOAD_DONE", "value": "FILE_DOWNLOAD_DONE" }, { "key": "FILE_DOWNLOAD_FAILED", "value": "FILE_DOWNLOAD_FAILED" }, { "key": "CREATE_IMAGE", "value": "CREATE_IMAGE" }, { "key": "DELETE_IMAGE", "value": "DELETE_IMAGE" }, { "key": "CREATE_FLAVOR", "value": "CREATE_FLAVOR" }, { "key": "VM_DEPLOYED", "value": "VM_DEPLOYED" }, { "key": "VM_ALIVE", "value": "VM_ALIVE" }, { "key": "SERVICE_ALIVE", "value": "SERVICE_ALIVE" }, { "key": "VM_UNDEPLOYED", "value": "VM_UNDEPLOYED" }, { "key": "SERVICE_UNDEPLOYED", "value": "SERVICE_UNDEPLOYED" }, { "key": "SERVICE_UPDATED", "value": "SERVICE_UPDATED" }, { "key": "VM_STOPPED", "value": "VM_STOPPED" }, { "key": "VM_STARTED", "value": "VM_STARTED" }, { "key": "VM_UPDATED", "value": "VM_UPDATED" }, { "key": "VM_REBOOTED", "value": "VM_REBOOTED" }, { "key": "VM_RECOVERY_INIT", "value": "VM_RECOVERY_INIT" }, { "key": "VM_RECOVERY_REBOOT", "value": "VM_RECOVERY_REBOOT" }, { "key": "VM_RECOVERY_COMPLETE", "value": "VM_RECOVERY_COMPLETE" }, { "key": "VM_MONITOR_UNSET", "value": "VM_MONITOR_UNSET" }, { "key": "VM_MONITOR_SET", "value": "VM_MONITOR_SET" }, { "key": "CIMC_PASSWORD_UPDATE", "value": "CIMC_PASSWORD_UPDATE" }, { "key": "FACTORY_RESET", "value": "FACTORY_RESET" }, { "key": "CPU_USAGE_HIGH", "value": "CPU_USAGE_HIGH" }, { "key": "viptela", "value": "viptela" }, { "key": "ccmEvent", "value": "ccmEvent" }, { "key": "umbrella-registration-success", "value": "umbrella-registration-success" }, { "key": "umbrella-registration-failure", "value": "umbrella-registration-failure" }, { "key": "site-id-mismatch", "value": "site-id-mismatch" }, { "key": "service-node-state", "value": "service-node-state" }, { "key": "appqoe-alarm", "value": "appqoe-alarm" }, { "key": "fw-alert", "value": "fw-alert" }, { "key": "ftm-zia-tunnel-setup", "value": "ftm-zia-tunnel-setup" }, { "key": "ftm-tunnel-setup", "value": "ftm-tunnel-setup" }, { "key": "ftm-zia-location-setup", "value": "ftm-zia-location-setup" }, { "key": "ftm-tunnel-tracker", "value": "ftm-tunnel-tracker" }, { "key": "dca-change-event", "value": "dca-change-event" }, { "key": "geo-fence-alert-status", "value": "geo-fence-alert-status" }, { "key": "app-list-app-aliases-notify", "value": "app-list-app-aliases-notify" }, { "key": "app-list-unsupported-app-notify", "value": "app-list-unsupported-app-notify" }, { "key": "tracker-state-change", "value": "tracker-state-change" }, { "key": "disk-read-speed", "value": "disk-read-speed" }, { "key": "disk-write-speed", "value": "disk-write-speed" }, { "key": "idmgr-pxgrid-connection", "value": "idmgr-pxgrid-connection" }, { "key": "qos-congestion", "value": "qos-congestion" }, { "key": "nat-update", "value": "nat-update" }, { "key": "aaa-password-expiry-warning", "value": "aaa-password-expiry-warning" }, { "key": "aaa-password-expired", "value": "aaa-password-expired" }, { "key": "data-policy-commit-failure", "value": "data-policy-commit-failure" }, { "key": "non-yang-cli-file-generated", "value": "non-yang-cli-file-generated" }, { "key": "cellular-network-status-change", "value": "cellular-network-status-change" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerEventResponseTypesKeyvalue" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/group": { "get": { "tags": [ "Troubleshooting Tools - Device Group" ], "description": "Retrieve device group list", "operationId": "listDeviceGroupList", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Example": { "description": "Example", "value": { "header": { "generatedOn": 1717579556360 }, "data": [ { "groupId": "all", "groupName": "All" }, { "groupId": "none", "groupName": "No groups" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerGroupDevicegroupapiResponseExampleGroup200" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/group/device": { "get": { "tags": [ "Troubleshooting Tools - Device Group" ], "description": "Retrieve device groups", "operationId": "listDeviceGroups", "parameters": [ { "name": "siteId", "in": "query", "description": "siteId", "schema": { "type": "string" }, "example": 400 } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Example": { "description": "Example", "value": { "header": {}, "data": [ { "name": "All", "sshuri": "dataservice/newssh/devices", "uri": "dataservice/device", "mapuri": "dataservice/group/map/devices", "linkuri": "dataservice/group/map/devices/links" }, { "name": "No groups", "sshuri": "dataservice/group/devices?groupId=none&ssh=true", "uri": "dataservice/group/devices?groupId=none", "mapuri": "dataservice/group/map/devices?groupId=none", "linkuri": "dataservice/group/map/devices/links?groupId=none" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerGroupDevicegroupapiResponseExampleGroupdevice200" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Example": { "description": "Example", "value": "can't parse JSON. Raw result:\n\nInvalid Query Param siteId", "$$ref": "#/components/examples/ComViptelaVmanageServerGroupDevicegroupapiResponseExampleGroupdevice400" } } } } }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/group/devices": { "get": { "tags": [ "Troubleshooting Tools - Device Group" ], "description": "Retrieve devices in group", "operationId": "listGroupDevices", "parameters": [ { "name": "groupId", "in": "query", "description": "groupId", "schema": { "type": "string" }, "example": "none" }, { "name": "ssh", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "vpnId", "in": "query", "schema": { "type": "array", "items": { "type": "object", "properties": { "vpn": { "type": "string" } }, "description": "This is the valid list of VPN-IDs", "$$ref": "#/components/schemas/VPNID" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Example": { "description": "Example", "value": { "header": { "generatedOn": 1717581207668, "viewKeys": { "uniqueKey": [ "system-ip" ], "preferenceKey": "grid-Device" }, "columns": [ { "title": "Hostname", "property": "host-name", "display": "iconAndText", "iconProperty": "device-type", "hideable": false, "icon": [ { "key": "vmanage", "value": "images/vmanage_table.png" }, { "key": "vedge", "value": "images/vedge_table.png" }, { "key": "vedge-vbond", "value": "images/vedge-vbond_table.png" }, { "key": "vsmart", "value": "images/vsmart_table.png" }, { "key": "vbond", "value": "images/vbond_table.png" } ], "width": 150, "dataType": "string" }, { "title": "Device Model", "property": "device-model", "display": "multiColumns", "hideable": false, "width": 100, "dataType": "deviceModel" }, { "title": "Site ID", "property": "site-id", "hideable": false, "width": 70, "dataType": "numberStr" }, { "title": "Site Name", "property": "site-name", "hideable": false, "width": 70, "dataType": "string" }, { "title": "System IP", "property": "system-ip", "hideable": false, "width": 110, "dataType": "ipv4" }, { "title": "Chassis Number/ID", "property": "uuid", "width": 220, "dataType": "string" }, { "title": "Reachability", "property": "reachability", "display": "multiColumns", "color": [ { "key": "reachable", "value": "616161", "property": "reachability" }, { "key": "unreachable", "value": "ef5350", "property": "reachability" }, { "key": "auth-failed", "value": "ffb300", "property": "reachability" }, { "key": "staging", "value": "ffb300", "property": "validity" } ], "width": 150, "minWidth": 150, "dataType": "string" }, { "title": "State", "property": "state", "display": "iconAndToolTip", "iconProperty": "state", "toolTipProperty": "state_description", "defaultPropertyKey": "reachability", "defaultPropertyValue": "reachable", "icon": [ { "key": "green", "value": "images/device_state_green.png" }, { "key": "red", "value": "images/device_state_red.png" }, { "key": "yellow", "value": "images/device_state_yellow.png" }, { "key": "default", "value": "images/device_state_other.png" } ], "width": 20, "dataType": "string" }, { "title": "BFD", "property": "bfdSessions", "width": 75, "minWidth": 65, "dataType": "numberStr" }, { "title": "Control", "property": "controlConnections", "width": 75, "minWidth": 65, "dataType": "numberStr" }, { "title": "Version", "property": "version", "width": 150, "dataType": "string" }, { "title": "Up Since", "property": "uptime-date", "displayFormat": "DD MMM YYYY h:mm:ss A z", "inputFormat": "unix-time", "width": 200, "dataType": "date" }, { "title": "Device Groups", "property": "device-groups", "width": 100, "dataType": "array" }, { "title": "Connected Manager", "property": "connectedVManages", "width": 500, "dataType": "array" } ], "fields": [ { "property": "host-name", "dataType": "string", "display": "iconAndText" }, { "property": "device-model", "dataType": "deviceModel", "display": "multiColumns" }, { "property": "site-id", "dataType": "numberStr" }, { "property": "site-name", "dataType": "string" }, { "property": "system-ip", "dataType": "ipv4" }, { "property": "uuid", "dataType": "string" }, { "property": "reachability", "dataType": "string", "display": "multiColumns" }, { "property": "state", "dataType": "string", "display": "iconAndToolTip" }, { "property": "bfdSessions", "dataType": "numberStr" }, { "property": "controlConnections", "dataType": "numberStr" }, { "property": "version", "dataType": "string" }, { "property": "uptime-date", "dataType": "date" }, { "property": "device-groups", "dataType": "array" }, { "property": "connectedVManages", "dataType": "array" }, { "property": "number-vsmart-peers", "dataType": "number" }, { "property": "board-serial", "dataType": "string" }, { "property": "lastupdated", "dataType": "date" } ] }, "data": [ { "deviceId": "172.16.255.22", "system-ip": "172.16.255.22", "host-name": "vm12", "reachability": "reachable", "status": "normal", "personality": "vmanage", "device-type": "vmanage", "device-groups": [ "No groups" ], "lastupdated": 1717579612528, "domain-id": "0", "board-serial": "12345982", "certificate-validity": "Valid", "max-controllers": "0", "uuid": "fdf4baa6-af9e-4b5b-b933-b0026b268b62", "controlConnections": "8", "device-model": "vmanage", "version": "20.15.0-81", "connectedVManages": [ "172.16.255.22" ], "site-id": "200", "latitude": "37.666684", "longitude": "-122.777023", "isDeviceGeoData": false, "platform": "x86_64", "uptime-date": 1717394160000, "statusOrder": 4, "device-os": "next", "validity": "valid", "state": "green", "state_description": "All daemons up", "model_sku": "None", "local-system-ip": "172.16.255.22", "total_cpu_count": "16", "testbed_mode": true, "layoutLevel": 1 }, { "deviceId": "172.16.255.20", "system-ip": "172.16.255.20", "host-name": "vm10", "reachability": "reachable", "status": "normal", "personality": "vsmart", "device-type": "vsmart", "device-groups": [ "No groups" ], "lastupdated": 1717579421535, "domain-id": "1", "board-serial": "12345980", "certificate-validity": "Valid", "uuid": "c37dbf3e-0f9b-4899-9ae1-80e9cfe7e2dc", "controlConnections": "9", "device-model": "vsmart", "version": "20.15.0-81", "connectedVManages": [ "172.16.255.22" ], "site-id": "200", "ompPeers": "6", "latitude": "37.666684", "longitude": "-122.777023", "isDeviceGeoData": false, "platform": "x86_64", "uptime-date": 1717393920000, "statusOrder": 4, "device-os": "next", "validity": "valid", "state": "green", "state_description": "All daemons up", "model_sku": "None", "local-system-ip": "172.16.255.20", "total_cpu_count": "2", "testbed_mode": true, "layoutLevel": 2 }, { "deviceId": "172.16.255.19", "system-ip": "172.16.255.19", "host-name": "vm9", "reachability": "reachable", "status": "normal", "personality": "vsmart", "device-type": "vsmart", "device-groups": [ "No groups" ], "lastupdated": 1717579456824, "domain-id": "1", "board-serial": "12345992", "certificate-validity": "Valid", "uuid": "ca2481c9-5318-4db4-becb-f24d49102dbd", "controlConnections": "9", "device-model": "vsmart", "version": "20.15.0-81", "connectedVManages": [ "172.16.255.22" ], "site-id": "100", "ompPeers": "6", "latitude": "37.666684", "longitude": "-122.777023", "isDeviceGeoData": false, "platform": "x86_64", "uptime-date": 1717393920000, "statusOrder": 4, "device-os": "next", "validity": "valid", "state": "green", "state_description": "All daemons up", "model_sku": "None", "local-system-ip": "172.16.255.19", "total_cpu_count": "2", "testbed_mode": true, "layoutLevel": 2 }, { "deviceId": "172.16.255.26", "system-ip": "172.16.255.26", "host-name": "vm16", "reachability": "reachable", "status": "normal", "personality": "vbond", "device-type": "vbond", "device-groups": [ "No groups" ], "lastupdated": 1717579844688, "board-serial": "12345984", "certificate-validity": "Valid", "uuid": "eb6b265f-7505-4fa6-9c15-d228a9ed8c85", "controlConnections": "12", "device-model": "vedge-cloud", "version": "20.15.0-81", "connectedVManages": [ "172.16.255.22" ], "latitude": "37.666684", "longitude": "-122.777023", "isDeviceGeoData": false, "platform": "mips64", "uptime-date": 1717393920000, "statusOrder": 4, "device-os": "next", "validity": "valid", "state": "green", "state_description": "All daemons up", "model_sku": "None", "local-system-ip": "172.16.255.26", "total_cpu_count": "2", "linux_cpu_count": "1", "testbed_mode": true, "layoutLevel": 3 }, { "deviceId": "172.16.255.11", "system-ip": "172.16.255.11", "host-name": "vm1", "reachability": "reachable", "status": "normal", "personality": "vedge", "device-type": "vedge", "timezone": "UTC", "device-groups": [ "No groups" ], "lastupdated": 1717579450372, "bfdSessionsUp": 3, "domain-id": "1", "board-serial": "12345979", "certificate-validity": "Valid", "max-controllers": "0", "uuid": "6861dd90-75aa-4fac-af70-734efa6fb98a", "bfdSessions": "3", "controlConnections": "3", "device-model": "vedge-cloud", "version": "20.9.5-801", "connectedVManages": [ "172.16.255.22" ], "site-id": "100", "ompPeers": "2", "latitude": "37.666684", "longitude": "-122.777023", "isDeviceGeoData": false, "platform": "x86_64", "uptime-date": 1717393860000, "statusOrder": 4, "device-os": "next", "validity": "valid", "state": "green", "state_description": "All daemons up", "model_sku": "None", "local-system-ip": "172.16.255.11", "total_cpu_count": "2", "linux_cpu_count": "1", "testbed_mode": true, "layoutLevel": 4 }, { "deviceId": "172.16.255.21", "system-ip": "172.16.255.21", "host-name": "vm11", "reachability": "reachable", "status": "normal", "personality": "vedge", "device-type": "vedge", "timezone": "UTC", "device-groups": [ "No groups" ], "lastupdated": 1717579460776, "bfdSessionsUp": 3, "domain-id": "1", "board-serial": "12345981", "certificate-validity": "Valid", "max-controllers": "0", "uuid": "e3582c64-2d19-4eb7-aa5f-9733e3f683a1", "bfdSessions": "3", "controlConnections": "3", "device-model": "vedge-cloud", "version": "20.9.5-801", "connectedVManages": [ "172.16.255.22" ], "site-id": "100", "ompPeers": "2", "latitude": "37.666684", "longitude": "-122.777023", "isDeviceGeoData": false, "platform": "x86_64", "uptime-date": 1717393860000, "statusOrder": 4, "device-os": "next", "validity": "valid", "state": "green", "state_description": "All daemons up", "model_sku": "None", "local-system-ip": "172.16.255.21", "total_cpu_count": "2", "linux_cpu_count": "1", "testbed_mode": true, "layoutLevel": 4 }, { "deviceId": "172.16.255.14", "system-ip": "172.16.255.14", "host-name": "vm4", "reachability": "reachable", "status": "normal", "personality": "vedge", "device-type": "vedge", "timezone": "UTC", "device-groups": [ "No groups" ], "lastupdated": 1717579482048, "bfdSessionsUp": 4, "domain-id": "1", "board-serial": "12345987", "certificate-validity": "Valid", "max-controllers": "0", "uuid": "11dcf4b2-18b8-44d0-9393-7e840580cac9", "bfdSessions": "4", "controlConnections": "3", "device-model": "vedge-cloud", "version": "20.9.5-801", "connectedVManages": [ "172.16.255.22" ], "site-id": "400", "ompPeers": "2", "latitude": "37.666684", "longitude": "-122.777023", "isDeviceGeoData": false, "platform": "x86_64", "uptime-date": 1717393860000, "statusOrder": 4, "device-os": "next", "validity": "valid", "state": "green", "state_description": "All daemons up", "model_sku": "None", "local-system-ip": "172.16.255.14", "total_cpu_count": "2", "linux_cpu_count": "1", "testbed_mode": true, "layoutLevel": 4 }, { "deviceId": "172.16.255.15", "system-ip": "172.16.255.15", "host-name": "vm5", "reachability": "reachable", "status": "normal", "personality": "vedge", "device-type": "vedge", "timezone": "UTC +0000", "device-groups": [ "No groups" ], "lastupdated": 1717569761962, "bfdSessionsUp": 4, "domain-id": "1", "board-serial": "12345715", "certificate-validity": "Valid", "max-controllers": "0", "uuid": "C8K-5e87e5c3-0923-4364-a729-d65d40298d76", "bfdSessions": "4", "controlConnections": "3", "device-model": "vedge-C8000V", "version": "17.15.01.0.1097", "connectedVManages": [ "172.16.255.22" ], "site-id": "500", "ompPeers": "2", "latitude": "37.666684", "longitude": "-122.777023", "isDeviceGeoData": false, "platform": "x86_64", "uptime-date": 1717394100000, "statusOrder": 4, "validity": "valid", "state": "green", "state_description": "All daemons up", "model_sku": "None", "local-system-ip": "172.16.255.15", "total_cpu_count": "4", "linux_cpu_count": "1", "testbed_mode": false, "layoutLevel": 4 }, { "deviceId": "172.16.255.16", "system-ip": "172.16.255.16", "host-name": "vm6", "reachability": "reachable", "status": "normal", "personality": "vedge", "device-type": "vedge", "timezone": "UTC", "device-groups": [ "No groups" ], "lastupdated": 1717579488170, "bfdSessionsUp": 4, "domain-id": "1", "board-serial": "12345989", "certificate-validity": "Valid", "max-controllers": "0", "uuid": "970b3f78-a713-49e4-890d-beffe5db7dd0", "bfdSessions": "4", "controlConnections": "3", "device-model": "vedge-cloud", "version": "20.9.5-801", "connectedVManages": [ "172.16.255.22" ], "site-id": "600", "ompPeers": "2", "latitude": "37.666684", "longitude": "-122.777023", "isDeviceGeoData": false, "platform": "x86_64", "uptime-date": 1717393860000, "statusOrder": 4, "device-os": "next", "validity": "valid", "state": "green", "state_description": "All daemons up", "model_sku": "None", "local-system-ip": "172.16.255.16", "total_cpu_count": "2", "linux_cpu_count": "1", "testbed_mode": true, "layoutLevel": 4 } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerGroupDevicegroupapiResponseExampleGroupdevices200" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/group/map/devices": { "get": { "tags": [ "Troubleshooting Tools - Device Group" ], "description": "Retrieve group devices for map", "operationId": "listGroupDevicesForMap", "parameters": [ { "name": "groupId", "in": "query", "description": "groupId", "schema": { "type": "string" }, "example": "none" }, { "name": "vpnId", "in": "query", "schema": { "type": "array", "items": { "type": "object", "properties": { "vpn": { "type": "string" } }, "description": "This is the valid list of VPN-IDs", "$$ref": "#/components/schemas/VPNID" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Map devices example": { "description": "Map devices example", "value": { "data": [ { "deviceId": "172.16.255.22", "system-ip": "172.16.255.22", "host-name": "vm12", "reachability": "reachable", "status": "normal", "personality": "vmanage", "device-type": "vmanage", "timezone": "UTC", "device-groups": [ "No groups" ], "lastupdated": 1654591560526, "domain-id": "0", "board-serial": "12345982", "certificate-validity": "Valid", "max-controllers": "0", "uuid": "3d93d480-a8e6-4e88-bcf4-dfa31a0b4f9a", "controlConnections": "8", "device-model": "vmanage", "version": "20.10.999-1966", "connectedVManages": [ "172.16.255.22" ], "site-id": "200", "latitude": "37.666684", "longitude": "-122.777023", "isDeviceGeoData": false, "platform": "x86_64", "uptime-date": 1652859000000, "statusOrder": 4, "device-os": "next", "validity": "valid", "state": "green", "state_description": "All daemons up", "model_sku": "None", "local-system-ip": "172.16.255.22", "total_cpu_count": "4", "testbed_mode": true, "layoutLevel": 1 } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerGroupDevicegroupapiResponseExampleMapdevices" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/group/map/devices/links": { "get": { "tags": [ "Troubleshooting Tools - Device Group" ], "description": "Retrieve devices in group for map", "operationId": "listGroupLinksForMap", "parameters": [ { "name": "groupId", "in": "query", "description": "groupId", "schema": { "type": "string" }, "example": "none" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Example": { "description": "Example", "value": { "links": [ { "linkKey": "172.16.255.19:default - 172.16.255.22:default", "source": "172.16.255.22", "target": "172.16.255.19", "linkType": "control", "group": 1, "status": "up", "linkKeyDisplay": "172.16.255.19 (default) - 172.16.255.22 (default)" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerGroupDevicegroupapiResponseExampleMapdeviceslinks" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/health/devices": { "get": { "tags": [ "Monitoring - Health" ], "description": "get the devices health properties", "operationId": "getDevicesHealth", "parameters": [ { "name": "page", "in": "query", "description": "Page Number", "schema": { "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "Page Size", "schema": { "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "Sort By Property", "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Sort Order", "schema": { "type": "string" } }, { "name": "startingDeviceId", "in": "query", "description": "Optional device ID to start first page", "schema": { "type": "string" } }, { "name": "siteId", "in": "query", "description": "Optional site ID to filter devices", "schema": { "type": "string" } }, { "name": "group_id", "in": "query", "description": "Optional group ID to filter devices", "schema": { "type": "string" } }, { "name": "groupId", "in": "query", "description": "Optional group ID to filter devices", "schema": { "type": "string" } }, { "name": "vpnId", "in": "query", "description": "Optional vpn ID to filter devices", "schema": { "type": "string" } }, { "name": "reachable", "in": "query", "schema": { "type": "boolean" } }, { "name": "controlStatus", "in": "query", "schema": { "type": "string" } }, { "name": "personality", "in": "query", "schema": { "type": "string" } }, { "name": "health", "in": "query", "schema": { "type": "string" } }, { "name": "site-id", "in": "query", "description": "Optional site ID list to filter devices", "schema": { "type": "string" } }, { "name": "featureType", "in": "query", "schema": { "type": "string", "enum": [ "cellular", "SCC" ] } }, { "name": "corSaasStatus", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeTenantvSmart", "in": "query", "description": "Include vSmarts in tenant view", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "devices": { "type": "array", "items": { "type": "object", "properties": { "bfd_sessions": { "type": "integer", "description": "bfd sessions total", "format": "int32", "example": 5 }, "bfd_sessions_up": { "type": "integer", "description": "bfd sessions up", "format": "int32", "example": 5 }, "board_serial_number": { "type": "string", "description": "board serial number", "example": "12345708" }, "cellularBit": { "type": "string", "description": "0:non-cellular device, 1: cellular device", "example": "1" }, "cellularEcio": { "type": "array", "items": { "type": "string", "description": "only for 3G", "example": "3G-Slot1:Good" } }, "cellularExtra": { "type": "object", "additionalProperties": { "type": "string", "description": "key-value structure, \"iosXEDevice\": \"true\" means if it polaris device" }, "description": "key-value structure, \"iosXEDevice\": \"true\" means if it polaris device" }, "cellularFailOverEvents": { "type": "array", "items": { "type": "string", "description": "format is Slot{slot}:{event_num}", "example": "Slot1:1" } }, "cellularHealth": { "type": "array", "items": { "type": "string", "description": "format is {signal_type}-Slot{slot}:{signal_health}", "example": "4G-Slot1:Good" } }, "cellularLinkUpTime": { "type": "array", "items": { "type": "string", "description": "format is Slot{slot}:{up_time}", "example": "Slot1:29291" } }, "cellularLoss": { "type": "array", "items": { "type": "string", "description": "format is Slot{slot}:{loss_num}", "example": "Slot1:0 packets" } }, "cellularRsrp": { "type": "array", "items": { "type": "string", "description": "format is {signal_type}-Slot{slot}:{signal_health}", "example": "4G-Slot1:Good" } }, "cellularRsrq": { "type": "array", "items": { "type": "string", "description": "format is {signal_type}-Slot{slot}:{signal_health}", "example": "4G-Slot1:Good" } }, "cellularRssi": { "type": "array", "items": { "type": "string", "description": "format is {signal_type}-Slot{slot}:{signal_health}", "example": "4G-Slot1:Good" } }, "cellularSinr": { "type": "array", "items": { "type": "string", "example": "4G-Slot1:Excellent" } }, "chassis_number": { "type": "string", "description": "chassis number", "example": "04a116f8-9a16-4bf6-9f1f-f58e2619312d" }, "cloudOnRampSaaSApps": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } } }, "cloudOnRampSaaSDeviceRole": { "type": "string" }, "configGroupId": { "type": "string", "description": "config group id", "example": "020c51b3-6200-4d40-bf92-4bd2b7aac14e" }, "configGroupName": { "type": "string", "description": "config group name", "example": "global_cg1" }, "configuration_device": { "type": "boolean" }, "connected_vmanages": { "type": "array", "items": { "type": "string", "description": "connected vmanage", "example": "169.254.10.3" } }, "controlConnectionsToVsmat": { "$ref": "#/components/schemas/DeviceHealthDetails", "$$ref": "#/components/schemas/DeviceHealthDetails" }, "control_connections": { "type": "integer", "format": "int32" }, "control_connections_up": { "type": "integer", "format": "int32" }, "cpu_load": { "type": "number", "format": "double" }, "device_groups": { "type": "array", "items": { "type": "string" } }, "device_model": { "type": "string", "description": "device model", "example": "vEdge Cloud" }, "device_type": { "type": "string", "description": "device type", "example": "vedge" }, "edgeServicesHealth": { "type": "object", "additionalProperties": { "type": "integer", "description": "edge services health", "format": "int32" }, "description": "edge services health", "example": { "GOOD": 1, "FAIR": 2, "POOR": 3 } }, "eoxDetails": { "type": "object", "properties": { "deviceScanDetails": { "type": "object", "properties": { "lastScanDateTime": { "type": "string" }, "scanCriteria": { "type": "string" }, "scanStatus": { "type": "string" } }, "$$ref": "#/components/schemas/CxAdvisoryDeviceScanDetails" }, "eoxList": { "type": "array", "items": { "type": "object", "$$ref": "#/components/schemas/JsonNode" } } }, "$$ref": "#/components/schemas/EoxDetails" }, "expected_vsmart_connections": { "type": "integer", "format": "int32" }, "has_geo_data": { "type": "boolean" }, "health": { "type": "string", "enum": [ "red", "yellow", "green" ] }, "ikev1Peers": { "type": "integer", "format": "int32" }, "ikev1Sa": { "type": "integer", "format": "int32" }, "ikev2Peers": { "type": "integer", "format": "int32" }, "ikev2Sa": { "type": "integer", "format": "int32" }, "latitude": { "type": "string", "description": "latitude", "example": "37.666684" }, "local_system_ip": { "type": "string", "description": "local system ip", "example": "172.16.254.2" }, "location": { "type": "string", "description": "location string", "example": "lat: 37.666684, long: -122.777023" }, "longitude": { "type": "string", "description": "longitude", "example": "-122.777023" }, "memory_utilization": { "type": "number", "format": "double" }, "name": { "type": "string", "description": "device name", "example": "vm3" }, "omp_peers": { "type": "integer", "description": "omp peers", "format": "int64", "example": 2 }, "omp_peers_up": { "type": "integer", "description": "omp peers up", "format": "int64", "example": 2 }, "personality": { "type": "string", "description": "personality of the device", "example": "vedge" }, "policyGroupId": { "type": "string", "description": "policy group id", "example": "d56d1c24-24de-4c6e-be0f-0a7de66324be" }, "policyGroupName": { "type": "string", "description": "policy group name", "example": "global_pg1" }, "powerUsage": { "type": "string" }, "qoe": { "type": "integer", "description": "quality of experience score", "format": "int32", "example": 10 }, "reachability": { "type": "string", "description": "reachability status", "example": "reachable", "enum": [ "reachable", "unreachable" ] }, "reason": { "type": "string", "description": "the reason if device is not healthy", "example": "Memory usage >= 75%." }, "region_list": { "type": "array", "items": { "type": "string" } }, "role": { "type": "integer", "description": "bitmap for the role", "format": "int32", "example": 1 }, "roleStr": { "type": "string", "description": "device role, can be CMAP_STATIC, DMVPN_HUB, DMVPN_SPOKE, FLEXVPN_SERVER, FLEXVPN_CLIENT, DVTI_IKEv1, SVTI_IKEv1, GETVPN_KS, GETVPN_GM, P2P_GRE, SSL_VPN_SERVER, or any combination of them", "example": "DMVPN_HUB|FLEXVPN_SERVER" }, "sdraSessionCounts": { "$ref": "#/components/schemas/DeviceHealthDetails", "$$ref": "#/components/schemas/DeviceHealthDetails" }, "sdra_ipsec_anyconnect": { "type": "integer", "format": "int64" }, "sdra_ipsec_enabled": { "type": "boolean" }, "sdra_ipsec_soho": { "type": "integer", "format": "int64" }, "sdra_ipsec_unknown": { "type": "integer", "format": "int64" }, "sdra_sslvpn_anyconnect": { "type": "integer", "format": "int64" }, "sdra_sslvpn_enabled": { "type": "boolean" }, "site_id": { "type": "string", "description": "site id", "example": "3" }, "site_name": { "type": "string", "description": "site name", "example": "SITE_500" }, "software_version": { "type": "string", "description": "software version", "example": "17.18.01" }, "sslVpnSa": { "type": "integer", "format": "int32" }, "system_ip": { "type": "string", "description": "system ip", "example": "169.254.10.10" }, "tags": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "temperatureStatus": { "type": "string" }, "totalIpsecSa": { "type": "integer", "format": "int32" }, "total_tloc_num": { "type": "integer", "description": "total tloc number", "format": "int64", "example": 0 }, "up_tloc_num": { "type": "integer", "description": "up tloc number", "format": "int64", "example": 0 }, "uptime_date": { "type": "integer", "format": "int64" }, "uuid": { "type": "string", "description": "device uuid", "example": "04a116f8-9a16-4bf6-9f1f-f58e2619312d" }, "vpn_ids": { "type": "array", "items": { "type": "string" } }, "vsmart_control_connections": { "type": "integer", "format": "int32" } }, "$$ref": "#/components/schemas/DeviceHealthDetails" } }, "header": { "type": "object", "additionalProperties": { "type": "object" } }, "total_devices": { "type": "integer", "format": "int32" } }, "$$ref": "#/components/schemas/DevicesHealth" }, "examples": { "devices health properties": { "description": "devices health properties", "value": { "total_devices": 3, "devices": [ { "name": "vm3", "personality": "vedge", "uuid": "04a116f8-9a16-4bf6-9f1f-f58e2619312d", "reachability": "reachable", "longitude": "-122.777023", "latitude": "37.666684", "health": "green", "qoe": 10, "location": "lat: 37.666684, long: -122.777023", "site_id": "3", "system_ip": "169.254.10.10", "device_type": "vedge", "local_system_ip": "172.16.254.2", "device_model": "vEdge Cloud", "software_version": "20.6.0-231", "cpu_load": 1.32, "memory_utilization": 25, "control_connections": 3, "control_connections_up": 3, "sdra_ipsec_anyconnect": 120, "sdra_ipsec_soho": 60, "sdra_ipsec_unknown": 30, "sdra_sslvpn_anyconnect": 0, "has_geo_data": true, "uptime_date": 1629963840000, "device_groups": [ "No groups" ], "connected_vmanages": [ "169.254.10.3" ], "bfd_sessions_up": 5, "bfd_sessions": 5, "omp_peers": 2, "omp_peers_up": 2, "board_serial_number": "12345708", "chassis_number": "04a116f8-9a16-4bf6-9f1f-f58e2619312d", "vpn_ids": null } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,RBAC VPN-read,RBAC VPN-write,System360 Diagnostic-read,System360 Diagnostic-write" } }, "/health/devices/overview": { "get": { "tags": [ "Monitoring - Health" ], "description": "gets devices health overview", "operationId": "getDevicesHealthOverview", "parameters": [ { "name": "vpn_id", "in": "query", "description": "Optional vpn ID to filter devices", "schema": { "type": "string" } }, { "name": "vpnId", "in": "query", "description": "Optional vpn ID to filter devices", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "fair": { "type": "integer", "format": "int32" }, "good": { "type": "integer", "format": "int32" }, "poor": { "type": "integer", "format": "int32" } }, "$$ref": "#/components/schemas/DevicesHealthOverview" }, "examples": { "devices health overview": { "description": "devices health overview", "value": { "good": 3, "fair": 3, "poor": 0 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,RBAC VPN-read,RBAC VPN-write,System-read" } }, "/notifications/rule": { "put": { "tags": [ "Monitoring - Alarms Notification" ], "description": "Update notification rule", "operationId": "updateNotificationRule", "parameters": [ { "name": "ruleId", "in": "query", "description": "Rule Id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "Notification rule", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Notification rule": { "description": "Notification rule", "value": "{\n \"notificationRuleName\":\"testwebhook\",\n \"severity\":\"Medium\",\n \"alarmName\":\"BFD_Node_Up\",\n \"accountDetails\":\"noreply@cisco.com\",\n \"webHookEnabled\":true,\n \"webhookUsername\":\"admin\",\n \"webhookPassword\":\"admin\",\n \"webhookUrl\":\"https://localhost:8444\",\n \"updatedBy\":\"admin\",\n \"devicesAttached\":\"1712133e-0246-4281-8152-3317b796d2bc\",\n \"emailThreshold\":5,\n \"sourceVpn\":512\n \"vpn\":10,\n \"vpnIpSubnet\":\"192.168.1.0/24\",\n \"accountDetailsArray\":[\n \"noreply@cisco.com\"\n ]\n}" } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Settings-write" }, "post": { "tags": [ "Monitoring - Alarms Notification" ], "description": "Add notification rule", "operationId": "createNotificationRule", "requestBody": { "description": "Notification rule", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Notification rule": { "description": "Notification rule", "value": { "notificationRuleName": "testwebhook", "severity": "Medium", "alarmName": "BFD_Node_Up", "accountDetails": "noreply@cisco.com", "webHookEnabled": true, "webhookUsername": "admin", "webhookPassword": "admin", "webhookUrl": "https://localhost:8444", "updatedBy": "admin", "devicesAttached": "1712133e-0246-4281-8152-3317b796d2bc", "emailThreshold": 5, "sourceVpn": 512, "vpn": 10, "vpnIpSubnet": "192.168.1.0/24", "accountDetailsArray": [ "noreply@cisco.com" ] } } } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Notification rule": { "description": "Notification rule", "value": "{\n \"accountDetails\": \"noreply@cisco.com\",\n \"accountDetailsArray\": [\n \"noreply@cisco.com\"\n ]\n \"alarmName\": \"BFD_Node_Up\",\n \"devicesAttached\": \"1712133e-0246-4281-8152-3317b796d2bc\",\n \"emailEnabled\": true,\n \"emailThreshold\": 5,\n \"notificationRuleName\": \"testwebhook\",\n \"severity\": \"Medium\",\n \"updatedBy\": \"admin\",\n \"webHookEnabled\": true,\n \"webhookPassword\": \"admin\",\n \"webhookUrl\": \"https://localhost:8444\",\n \"webhookUsername\": \"admin\",\n \"sourceVpn\":512,\n \"vpn\":10,\n \"vpnIpSubnet\":\"192.168.1.0/24\",\n}" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Settings-write" } }, "/notifications/rules": { "get": { "tags": [ "Monitoring - Alarms Notification" ], "description": "Get all rules or specific notification rule by its Id ", "operationId": "getNotificationRule", "parameters": [ { "name": "ruleId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "site-id", "in": "query", "schema": { "pattern": "^[0-9]+$", "type": "string" } } ], "responses": { "200": { "description": "search results matching criteria", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "@rid": { "type": "integer", "format": "int64", "example": 1158 }, "accountDetails": { "type": "string", "example": "cqx@cisco.com" }, "alarmName": { "type": "string", "example": "BFD_Node_Up" }, "devicesAttached": { "type": "string", "example": "1712133e-0246-4281-8152-3317b796d2bc" }, "emailThreshold": { "type": "integer", "format": "int64", "example": 5 }, "lastUpdated": { "type": "integer", "format": "int64", "example": 1588177200725 }, "notificationRuleId": { "type": "string", "example": "e947efc8-e86a-4eb4-b8ce-7ed0c2828f13" }, "notificationRuleName": { "type": "string", "example": "testwebhook" }, "severity": { "type": "string", "example": "Medium" }, "updatedBy": { "type": "string", "example": "admin" }, "webhookPassword": { "type": "string", "example": "$CRYPT$R21YRfP4HWOv+Z9nSi7zRw==$hEU/zplzA+IJlI/4LsNY/Q==" }, "webhookUrl": { "type": "string", "example": "https://localhost:8444" }, "webhookUsername": { "type": "string", "example": "admin" } }, "$$ref": "#/components/schemas/NotificationsRuleData" } } }, "$$ref": "#/components/schemas/NotificationsRulesResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Alarms-read" }, "delete": { "tags": [ "Monitoring - Alarms Notification" ], "description": "Delete notification rule", "operationId": "deleteNotificationRule", "parameters": [ { "name": "ruleId", "in": "query", "description": "Rule Id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Settings-write" } }, "/refreshtoken/{regionBaseUri}/{clientId}": { "get": { "tags": [ "Monitoring - SecureX Integration" ], "description": "Get Access Token for SecureX Ribbon", "operationId": "getSecureXRefreshToken", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "regionBaseUri", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/security/device/health": { "get": { "tags": [ "Monitoring - Security Policy" ], "summary": "security device health", "description": "Get security device health ", "operationId": "getSecurityDeviceHealth", "parameters": [ { "name": "deviceIp", "in": "query", "description": "deviceIp - Device IP", "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } } ], "responses": { "200": { "description": "search results matching criteria", "content": { "application/json": { "schema": { "type": "array", "items": { "required": [ "amp_cloud_reachability", "ips_cloud_reachability", "ips_last_upload", "ips_package_version", "utd_container_health" ], "type": "object", "properties": { "amp_cloud_reachability": { "type": "string", "example": "utd-file-repu-stat-connected", "enum": [ "utd-file-repu-stat-process-up", "utd-file-repu-stat-process-down", "utd-file-repu-stat-amp-module-load-fail", "utd-file-repu-stat-connected", "utd-file-repu-stat-not-connected", "utd-file-repu-stat-process-unknown" ] }, "ips_cloud_reachability": { "type": "string", "example": "utd-con-up", "enum": [ "utd-con-up", "utd-con-down", "utd-con-unknown" ] }, "ips_last_upload": { "type": "integer", "format": "int64", "example": 1692065659984 }, "ips_package_version": { "type": "string", "example": "31550.15.s" }, "utd_container_health": { "type": "string", "example": "utd-oper-status-green", "enum": [ "utd-oper-status-green", "utd-oper-status-yellow", "utd-oper-status-red", "utd-oper-status-down", "utd-oper-status-unknown" ] } }, "$$ref": "#/components/schemas/SecurityDeviceHealth" } } } } }, "400": { "description": "Bad Request" } } } }, "/security/policy/devicelist": { "get": { "tags": [ "Monitoring - Security Policy" ], "summary": "security policy device list", "description": "Get security policy device list ", "operationId": "getSecurityPolicyDeviceList_MonitoringSecurityPolicy_2703", "responses": { "200": { "description": "search results matching criteria", "content": { "application/json": { "schema": { "type": "array", "items": { "required": [ "amp_down", "amp_up", "ips_down", "ips_up", "urlf_down", "urlf_up", "zbfw_down", "zbfw_up" ], "type": "object", "properties": { "amp_down": { "type": "array", "description": "amp down values", "example": [ "1.1.1.1", "2.2.2.2", "3.3.3.3" ], "items": { "type": "string", "description": "amp down", "example": "1.1.1.1" } }, "amp_up": { "type": "array", "description": "amp up values", "example": [ "1.1.1.1", "2.2.2.2", "3.3.3.3" ], "items": { "type": "string", "description": "amp up", "example": "1.1.1.1" } }, "ips_down": { "type": "array", "description": "ips down values", "example": [ "1.1.1.1", "2.2.2.2", "3.3.3.3" ], "items": { "type": "string", "description": "ips down", "example": "1.1.1.1" } }, "ips_up": { "type": "array", "description": "ips up values", "example": [ "1.1.1.1", "2.2.2.2", "3.3.3.3" ], "items": { "type": "string", "description": "ips up", "example": "1.1.1.1" } }, "urlf_down": { "type": "array", "description": "urlf down values", "example": [ "1.1.1.1", "2.2.2.2", "3.3.3.3" ], "items": { "type": "string", "description": "urlf down", "example": "1.1.1.1" } }, "urlf_up": { "type": "array", "description": "urlf up values", "example": [ "1.1.1.1", "2.2.2.2", "3.3.3.3" ], "items": { "type": "string", "description": "urlf up", "example": "1.1.1.1" } }, "zbfw_down": { "type": "array", "description": "zbfw down values", "example": [ "1.1.1.1", "2.2.2.2", "3.3.3.3" ], "items": { "type": "string", "description": "zbfw down", "example": "1.1.1.1" } }, "zbfw_up": { "type": "array", "description": "zbfw up values", "example": [ "1.1.1.1", "2.2.2.2", "3.3.3.3" ], "items": { "type": "string", "description": "zbfw up", "example": "1.1.1.1" } } }, "$$ref": "#/components/schemas/SecurityPolicyDeviceList" } } } } }, "400": { "description": "Bad Request" } } } }, "/security/policy/fwall/device": { "post": { "tags": [ "Monitoring - Security Policy" ], "summary": "firewall devices list", "description": "Get firewall devices list ", "operationId": "getPostFwallByQuery", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "firewall device query": { "description": "firewall device query", "value": { "aggregation": { "field": [ { "property": "host_name", "sequence": 1 }, { "property": "siteid", "sequence": 2 } ], "metrics": [ { "property": "entry_time", "type": "top_hits", "size": 1 } ] }, "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "class" ], "field": "type", "type": "string", "operator": "in" }, { "value": [ "39" ], "field": "action", "type": "string", "operator": "equal" }, { "value": [ "SELF_TO_UNTRUST-seq-1-cm_" ], "field": "class_name", "type": "string", "operator": "equal" }, { "value": [ "SELF_TO_UNTRUST" ], "field": "policy_name", "type": "string", "operator": "equal" } ] } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceSecuritySecurityapiParameterExampleFwalldevice" } } } }, "required": true }, "responses": { "200": { "description": "search results matching criteria", "content": { "application/json": { "schema": { "type": "array", "items": { "required": [ "entry_time" ], "type": "object", "properties": { "device_ip": { "type": "string", "example": "1.1.1.1" }, "entry_time": { "type": "integer", "format": "int64", "example": 1639897200000 }, "host_name": { "type": "string", "example": "vm1" }, "site_name": { "type": "string", "example": "sjc" } }, "$$ref": "#/components/schemas/DeviceLists" } } } } }, "400": { "description": "Bad Request" } }, "x-roles-required": "Security-read,Device Monitoring-read" } }, "/security/policy/ips/device": { "post": { "tags": [ "Monitoring - Security Policy" ], "summary": "ips alert devices list", "description": "Get ips alert devices list ", "operationId": "getPostIPSAlertByQuery", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "ips alert device query": { "description": "ips alert device query", "value": { "aggregation": { "field": [ { "property": "host_name", "sequence": 1 }, { "property": "siteid", "sequence": 2 }, { "property": "src_ip", "sequence": 3 }, { "property": "dst_ip", "sequence": 4 } ], "metrics": [ { "property": "entry_time", "type": "top_hits", "size": 1 } ] }, "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "OS-OTHER Bash CGI environment variable injection attempt" ], "field": "message", "type": "string", "operator": "equal" }, { "value": [ "Critical" ], "field": "severity", "type": "string", "operator": "equal" }, { "value": [ "ips_alert" ], "field": "type", "type": "string", "operator": "in" } ] } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceSecuritySecurityapiParameterExampleIpsalertdevice" } } } }, "required": true }, "responses": { "200": { "description": "search results matching criteria", "content": { "application/json": { "schema": { "type": "array", "items": { "required": [ "entry_time" ], "type": "object", "properties": { "device_ip": { "type": "string", "example": "1.1.1.1" }, "entry_time": { "type": "integer", "format": "int64", "example": 1639897200000 }, "host_name": { "type": "string", "example": "vm1" }, "site_name": { "type": "string", "example": "sjc" } }, "$$ref": "#/components/schemas/DeviceLists" } } } } }, "400": { "description": "Bad Request" } }, "x-roles-required": "Security-read,Device Monitoring-read" } }, "/security/policy/urlf/device": { "post": { "tags": [ "Monitoring - Security Policy" ], "summary": "url filtering devices list", "description": "Get url filtering devices list ", "operationId": "getPostUrlFilteringByQuery", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "url filtering pass device query": { "description": "url filtering pass device query", "value": { "query": { "condition": "AND", "rules": [ { "field": "entry_time", "type": "date", "value": [ "24" ], "operator": "last_n_hours" }, { "field": "name", "type": "string", "value": [ "Financial Services" ], "operator": "equal" }, { "field": "pass", "type": "string", "value": [ "0" ], "operator": "greater" }, { "field": "type", "type": "string", "value": [ "urlf_category" ], "operator": "in" } ] }, "aggregation": { "field": [ { "property": "host_name", "sequence": 1 }, { "property": "siteid", "sequence": 2 }, { "property": "src_ip", "sequence": 3 }, { "property": "dst_ip", "sequence": 4 } ], "metrics": [ { "property": "entry_time", "type": "top_hits", "size": 1 } ] } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceSecuritySecurityapiParameterExampleUrlfilteringpassdevice" }, "url filtering block device query": { "description": "url filtering block device query", "value": { "query": { "condition": "AND", "rules": [ { "field": "entry_time", "type": "date", "value": [ "24" ], "operator": "last_n_hours" }, { "field": "name", "type": "string", "value": [ "Gambling" ], "operator": "equal" }, { "field": "block", "type": "string", "value": [ "0" ], "operator": "greater" }, { "field": "type", "type": "string", "value": [ "urlf_category" ], "operator": "in" } ] }, "aggregation": { "field": [ { "property": "host_name", "sequence": 1 }, { "property": "siteid", "sequence": 2 }, { "property": "src_ip", "sequence": 3 }, { "property": "dst_ip", "sequence": 4 } ], "metrics": [ { "property": "entry_time", "type": "top_hits", "size": 1 } ] } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceSecuritySecurityapiParameterExampleUrlfilteringblockdevice" }, "url filtering exempt white/black list device query": { "description": "url filtering exempt white/black list device query", "value": { "aggregation": { "field": [ { "property": "host_name", "sequence": 1 }, { "property": "siteid", "sequence": 2 }, { "property": "src_ip", "sequence": 3 }, { "property": "dst_ip", "sequence": 4 } ], "metrics": [ { "property": "entry_time", "type": "top_hits", "size": 1 } ] }, "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "0" ], "field": "whiteblack_list_hit_cnt", "type": "number", "operator": "greater" }, { "value": [ "urlf" ], "field": "type", "type": "string", "operator": "in" } ] } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceSecuritySecurityapiParameterExampleUrlfilteringexemptwitblklistdevice" }, "amp device query": { "description": "amp device query", "value": { "aggregation": { "field": [ { "property": "host_name", "sequence": 1 }, { "property": "siteid", "sequence": 2 }, { "property": "src_ip", "sequence": 3 }, { "property": "dst_ip", "sequence": 4 } ], "metrics": [ { "property": "entry_time", "type": "top_hits", "size": 1 } ] }, "query": { "condition": "AND", "rules": [ { "value": [ "48" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "pdf" ], "field": "filename", "type": "string", "operator": "equal" }, { "value": [ "0" ], "field": "disposition", "type": "string", "operator": "equal" }, { "value": [ "file_reputation_alert" ], "field": "type", "type": "string", "operator": "in" } ] } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceSecuritySecurityapiParameterExampleAmpdevice" } } } }, "required": true }, "responses": { "200": { "description": "search results matching criteria", "content": { "application/json": { "schema": { "type": "array", "items": { "required": [ "entry_time" ], "type": "object", "properties": { "device_ip": { "type": "string", "example": "1.1.1.1" }, "entry_time": { "type": "integer", "format": "int64", "example": 1639897200000 }, "host_name": { "type": "string", "example": "vm1" }, "site_name": { "type": "string", "example": "sjc" } }, "$$ref": "#/components/schemas/DeviceLists" } } } } }, "400": { "description": "Bad Request" } }, "x-roles-required": "Security-read,Device Monitoring-read" } }, "/server/info": { "get": { "tags": [ "Monitoring - Server Info" ], "description": "Get Server info", "operationId": "createServerInfo_MonitoringServerInfo_1203", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "vManage server info": { "description": "vManage server info", "value": { "Achitecture": "amd64", "Available processors": 8 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics": { "get": { "tags": [ "Monitoring - Stats Processing" ], "description": "Get statistics types", "operationId": "getStatisticType", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Stats type": { "description": "Stats type", "value": [ "interfacestatistics", "eioltestatistics", "providerdpistatistics", "sulstatistics", "qosstatistics", "devicesystemstatusstatistics", "bridgemacstatistics", "dpistatistics", "approutestatsstatistics", "provideraggregatedappsdpistatistics", "wlanclientinfostatistics", "flowlogstatistics", "urlf", "fwall", "vnfstatistics", "umbrella", "apphostingstatistics", "utddaqioxstatistics", "ipsalert", "aggregatedappsdpistatistics", "bridgeinterfacestatistics", "artstatistics", "trackerstatistics", "cloudxstatistics", "deviceevents", "sleofflinereport", "alarm", "auditlog", "deviceconfiguration", "nwpi", "nwpiflowraw", "speedtest" ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" }, "post": { "tags": [ "Monitoring - Tunnel Health" ], "description": "Get stats raw data", "operationId": "getStatsRawData_MonitoringTunnelHealth_1104", "parameters": [ { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order", "schema": { "type": "string" } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "field": [ { "property": "name", "sequence": 1 }, { "property": "proto", "sequence": 2 } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" }, "metrics": [ { "property": "latency", "type": "avg" }, { "property": "loss", "type": "avg" }, { "property": "loss_percentage", "type": "avg" }, { "property": "vqoe_score", "type": "avg" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "lte", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.106.1", "local_color": "lte", "src_ip": "10.1.15.15", "sla_class_names": "test_sla_class", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400052, "state": "Up", "local_system_ip": "172.16.255.15", "tenant": "default", "entry_time": 1589073783045, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.15", "fec_rx": 0, "src_port": 12366, "jitter": 1, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.15", "proto": "IPSEC", "vip_idx": 351, "dst_port": 12386, "name": "172.16.255.15:lte-172.16.255.16:lte", "sla_class_list": "0,1", "tunnel_color": "lte:lte", "host_name": "vm5", "id": "IuBG_HEB_JLsavezVkiZ" } ], "pageInfo": { "startTime": "1589073783045", "endTime": "1589072535795", "count": 15 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/aggregation": { "get": { "tags": [ "Monitoring - Tunnel Health" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getAggregationDataByQuery_MonitoringTunnelHealth_2303", "parameters": [ { "name": "query", "in": "query", "description": "Query filter", "schema": { "type": "string" }, "examples": { "query string": {} } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "post": { "tags": [ "Monitoring - Tunnel Health" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationDataByQuery_MonitoringTunnelHealth_2304", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default,dca" } }, "/statistics/apphosting": { "get": { "tags": [ "Monitoring - App Hosting" ], "description": "Get stats raw data", "operationId": "getStatDataRawData_MonitoringAppHosting_2203", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "metrics": [ { "property": "latency", "type": "avg" } ] } } }, { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by(emp:entry_time)", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "3g", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.101.2", "local_color": "lte", "src_ip": "10.1.14.14", "sla_class_names": "None", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400056, "state": "Up", "local_system_ip": "172.16.255.14", "tenant": "default", "entry_time": 1589073792008, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.14", "fec_rx": 0, "src_port": 12380, "jitter": 1, "remote_system_ip": "172.16.255.11", "vdevice_name": "172.16.255.14", "proto": "IPSEC", "vip_idx": 190, "dst_port": 12366, "name": "172.16.255.14:lte-172.16.255.11:3g", "sla_class_list": "0", "tunnel_color": "3g:lte", "host_name": "vm4", "id": "4OBG_HEB_JLsavezVUfr" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "post": { "tags": [ "Monitoring - App Hosting" ], "description": "Get stats raw data", "operationId": "getStatsRawData_MonitoringAppHosting_2204", "parameters": [ { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order", "schema": { "type": "string" } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "field": [ { "property": "name", "sequence": 1 }, { "property": "proto", "sequence": 2 } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" }, "metrics": [ { "property": "latency", "type": "avg" }, { "property": "loss", "type": "avg" }, { "property": "loss_percentage", "type": "avg" }, { "property": "vqoe_score", "type": "avg" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "lte", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.106.1", "local_color": "lte", "src_ip": "10.1.15.15", "sla_class_names": "test_sla_class", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400052, "state": "Up", "local_system_ip": "172.16.255.15", "tenant": "default", "entry_time": 1589073783045, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.15", "fec_rx": 0, "src_port": 12366, "jitter": 1, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.15", "proto": "IPSEC", "vip_idx": 351, "dst_port": 12386, "name": "172.16.255.15:lte-172.16.255.16:lte", "sla_class_list": "0,1", "tunnel_color": "lte:lte", "host_name": "vm5", "id": "IuBG_HEB_JLsavezVkiZ" } ], "pageInfo": { "startTime": "1589073783045", "endTime": "1589072535795", "count": 15 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/apphosting/aggregation": { "post": { "tags": [ "Monitoring - App Hosting" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationDataByQuery_MonitoringAppHosting_3404", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default,dca" }, "get": { "tags": [ "Monitoring - App Hosting" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getAggregationDataByQuery_MonitoringAppHosting_3403", "parameters": [ { "name": "query", "in": "query", "description": "Query filter", "schema": { "type": "string" }, "examples": { "query string": {} } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/apphosting/csv": { "get": { "tags": [ "Monitoring - App Hosting" ], "description": "Get raw data with optional query as CSV", "operationId": "getStatDataRawDataAsCSV_MonitoringAppHosting_2603", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" }, "examples": { "Search result in csv format": { "description": "Search result in csv format", "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/apphosting/doccount": { "get": { "tags": [ "Monitoring - App Hosting" ], "description": "Get response count of a query", "operationId": "getCount_MonitoringAppHosting_3103", "parameters": [ { "name": "query", "in": "query", "description": "Query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 17193 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Monitoring - App Hosting" ], "description": "Get response count of a query", "operationId": "getCountPost_MonitoringAppHosting_3104", "requestBody": { "description": "Query", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query": { "description": "Query", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 9642 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/apphosting/fields": { "get": { "tags": [ "Monitoring - App Hosting" ], "description": "Get fields and type", "operationId": "getStatDataFields_MonitoringAppHosting_2903", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "example": [ { "dataType": "string", "property": "mac" }, { "dataType": "string", "property": "vap" }, { "dataType": "number", "property": "rssi" }, { "dataType": "string", "property": "mode" }, { "dataType": "number", "property": "bandwidth" }, { "dataType": "string", "property": "data_security" }, { "dataType": "number", "property": "rx_rate" }, { "dataType": "string", "property": "assoc_time" }, { "dataType": "date", "property": "entry_time" }, { "dataType": "date", "property": "statcycletime" }, { "dataType": "string", "property": "ssid" }, { "dataType": "number", "property": "vip_idx" }, { "dataType": "date", "property": "vip_time" }, { "dataType": "string", "property": "vdevice_name" }, { "dataType": "string", "property": "host_name" }, { "dataType": "string", "property": "device_model" } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/apphosting/page": { "post": { "tags": [ "Monitoring - App Hosting" ], "description": "Get stats raw data", "operationId": "getPostStatsPaginationRawData_MonitoringAppHosting_2704", "parameters": [ { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" }, "get": { "tags": [ "Monitoring - App Hosting" ], "description": "Get stats raw data", "operationId": "getStatsPaginationRawData_MonitoringAppHosting_2703", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } }, { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/apphosting/query/fields": { "get": { "tags": [ "Monitoring - App Hosting" ], "description": "Get query fields", "operationId": "getStatQueryFields_MonitoringAppHosting_3503", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "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" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/apphostinginterface": { "post": { "tags": [ "Monitoring - App Hosting" ], "description": "Get stats raw data", "operationId": "getStatsRawData_MonitoringAppHosting_3104", "parameters": [ { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order", "schema": { "type": "string" } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "field": [ { "property": "name", "sequence": 1 }, { "property": "proto", "sequence": 2 } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" }, "metrics": [ { "property": "latency", "type": "avg" }, { "property": "loss", "type": "avg" }, { "property": "loss_percentage", "type": "avg" }, { "property": "vqoe_score", "type": "avg" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "lte", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.106.1", "local_color": "lte", "src_ip": "10.1.15.15", "sla_class_names": "test_sla_class", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400052, "state": "Up", "local_system_ip": "172.16.255.15", "tenant": "default", "entry_time": 1589073783045, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.15", "fec_rx": 0, "src_port": 12366, "jitter": 1, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.15", "proto": "IPSEC", "vip_idx": 351, "dst_port": 12386, "name": "172.16.255.15:lte-172.16.255.16:lte", "sla_class_list": "0,1", "tunnel_color": "lte:lte", "host_name": "vm5", "id": "IuBG_HEB_JLsavezVkiZ" } ], "pageInfo": { "startTime": "1589073783045", "endTime": "1589072535795", "count": 15 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "get": { "tags": [ "Monitoring - App Hosting" ], "description": "Get stats raw data", "operationId": "getStatDataRawData_MonitoringAppHosting_3103", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "metrics": [ { "property": "latency", "type": "avg" } ] } } }, { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by(emp:entry_time)", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "3g", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.101.2", "local_color": "lte", "src_ip": "10.1.14.14", "sla_class_names": "None", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400056, "state": "Up", "local_system_ip": "172.16.255.14", "tenant": "default", "entry_time": 1589073792008, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.14", "fec_rx": 0, "src_port": 12380, "jitter": 1, "remote_system_ip": "172.16.255.11", "vdevice_name": "172.16.255.14", "proto": "IPSEC", "vip_idx": 190, "dst_port": 12366, "name": "172.16.255.14:lte-172.16.255.11:3g", "sla_class_list": "0", "tunnel_color": "3g:lte", "host_name": "vm4", "id": "4OBG_HEB_JLsavezVUfr" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/apphostinginterface/aggregation": { "post": { "tags": [ "Monitoring - App Hosting" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationDataByQuery_MonitoringAppHosting_4304", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default,dca" }, "get": { "tags": [ "Monitoring - App Hosting" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getAggregationDataByQuery_MonitoringAppHosting_4303", "parameters": [ { "name": "query", "in": "query", "description": "Query filter", "schema": { "type": "string" }, "examples": { "query string": {} } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/apphostinginterface/csv": { "get": { "tags": [ "Monitoring - App Hosting" ], "description": "Get raw data with optional query as CSV", "operationId": "getStatDataRawDataAsCSV_MonitoringAppHosting_3503", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" }, "examples": { "Search result in csv format": { "description": "Search result in csv format", "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/apphostinginterface/doccount": { "post": { "tags": [ "Monitoring - App Hosting" ], "description": "Get response count of a query", "operationId": "getCountPost_MonitoringAppHosting_4004", "requestBody": { "description": "Query", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query": { "description": "Query", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 9642 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Monitoring - App Hosting" ], "description": "Get response count of a query", "operationId": "getCount_MonitoringAppHosting_4003", "parameters": [ { "name": "query", "in": "query", "description": "Query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 17193 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/apphostinginterface/fields": { "get": { "tags": [ "Monitoring - App Hosting" ], "description": "Get fields and type", "operationId": "getStatDataFields_MonitoringAppHosting_3803", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "example": [ { "dataType": "string", "property": "mac" }, { "dataType": "string", "property": "vap" }, { "dataType": "number", "property": "rssi" }, { "dataType": "string", "property": "mode" }, { "dataType": "number", "property": "bandwidth" }, { "dataType": "string", "property": "data_security" }, { "dataType": "number", "property": "rx_rate" }, { "dataType": "string", "property": "assoc_time" }, { "dataType": "date", "property": "entry_time" }, { "dataType": "date", "property": "statcycletime" }, { "dataType": "string", "property": "ssid" }, { "dataType": "number", "property": "vip_idx" }, { "dataType": "date", "property": "vip_time" }, { "dataType": "string", "property": "vdevice_name" }, { "dataType": "string", "property": "host_name" }, { "dataType": "string", "property": "device_model" } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/apphostinginterface/page": { "post": { "tags": [ "Monitoring - App Hosting" ], "description": "Get stats raw data", "operationId": "getPostStatsPaginationRawData_MonitoringAppHosting_3604", "parameters": [ { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" }, "get": { "tags": [ "Monitoring - App Hosting" ], "description": "Get stats raw data", "operationId": "getStatsPaginationRawData_MonitoringAppHosting_3603", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } }, { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/apphostinginterface/query/fields": { "get": { "tags": [ "Monitoring - App Hosting" ], "description": "Get query fields", "operationId": "getStatQueryFields_MonitoringAppHosting_4403", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "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" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/approute": { "get": { "tags": [ "Monitoring - Application Aware Routing" ], "description": "Get stats raw data", "operationId": "getStatDataRawData_MonitoringApplicationAwareRouting_2003", "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.11" ], "field": "vdevice_name", "type": "string", "operator": "in" }, { "value": [ "3g", "lte" ], "field": "local_color", "type": "string", "operator": "in" } ] } } }, { "name": "page", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "schema": { "type": "string", "enum": [ "asc", "ASC", "Asc", "desc", "DESC", "Desc" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "example": [ { "remote_color": "3g", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.101.2", "local_color": "lte", "src_ip": "10.1.14.14", "sla_class_names": "None", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400056, "state": "Up", "local_system_ip": "172.16.255.14", "tenant": "default", "entry_time": 1589073792008, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.14", "fec_rx": 0, "src_port": 12380, "jitter": 1, "remote_system_ip": "172.16.255.11", "vdevice_name": "172.16.255.14", "proto": "IPSEC", "vip_idx": 190, "dst_port": 12366, "name": "172.16.255.14:lte-172.16.255.11:3g", "sla_class_list": "0", "tunnel_color": "3g:lte", "host_name": "vm4", "id": "4OBG_HEB_JLsavezVUfr" } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Monitoring - Application Aware Routing" ], "description": "Get stats raw data", "operationId": "getStatsRawData_MonitoringApplicationAwareRouting_2004", "parameters": [ { "name": "page", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "schema": { "type": "string", "enum": [ "asc", "ASC", "Asc", "desc", "DESC", "Desc" ] } } ], "requestBody": { "description": "Query filter", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query filter": { "description": "Query filter", "value": "{\n \"query\": {\n \"condition\": \"AND\",\n \"rules\": [\n {\n \"value\": [\n \"24\"\n ],\n \"field\": \"entry_time\",\n \"type\": \"date\",\n \"operator\": \"last_n_hours\"\n },\n {\n \"value\": [\n \"172.16.255.11\"\n ],\n \"field\": \"vdevice_name\",\n \"type\": \"string\",\n \"operator\": \"in\"\n },\n {\n \"value\": [\n \"3g\",\n \"lte\"\n ],\n \"field\": \"local_color\",\n \"type\": \"string\",\n \"operator\": \"in\"\n }\n ]\n }\n}\n}" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "device_model": { "type": "string" }, "dst_ip": { "type": "string" }, "dst_port": { "type": "integer", "format": "int32" }, "entry_time": { "type": "string" }, "fec_re": { "type": "integer", "format": "int32" }, "fec_rx": { "type": "integer", "format": "int64" }, "fec_tx": { "type": "integer", "format": "int64" }, "host_name": { "type": "string" }, "id": { "type": "string" }, "jitter": { "type": "integer", "format": "int32" }, "latency": { "type": "number" }, "local_color": { "type": "string" }, "local_system_ip": { "type": "string" }, "loss": { "type": "integer", "format": "int32" }, "loss_percentage": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "proto": { "type": "string" }, "remote_color": { "type": "string" }, "remote_system_ip": { "type": "string" }, "rx_octets": { "type": "integer", "format": "int64" }, "rx_pkts": { "type": "integer", "format": "int64" }, "sla_class_list": { "type": "string" }, "sla_class_names": { "type": "string" }, "src_ip": { "type": "string" }, "src_port": { "type": "integer", "format": "int32" }, "statcycletime": { "type": "string" }, "state": { "type": "string" }, "tenant": { "type": "string" }, "total": { "type": "integer", "format": "int32" }, "tunnel_color": { "type": "string" }, "tx_octets": { "type": "number" }, "tx_pkts": { "type": "integer", "format": "int64" }, "vdevice_name": { "type": "string" }, "vip_idx": { "type": "integer", "format": "int32" }, "vmanage_system_ip": { "type": "string" }, "vqoe_score": { "type": "integer", "format": "int32" } }, "description": "app route specific response", "$$ref": "#/components/schemas/AppRouteResp" } }, "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": "app route response with page info", "$$ref": "#/components/schemas/AppRouteRespWithPageInfo" } }, "example": [ { "remote_color": "3g", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.101.2", "local_color": "lte", "src_ip": "10.1.14.14", "sla_class_names": "None", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400056, "state": "Up", "local_system_ip": "172.16.255.14", "tenant": "default", "entry_time": 1589073792008, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.14", "fec_rx": 0, "src_port": 12380, "jitter": 1, "remote_system_ip": "172.16.255.11", "vdevice_name": "172.16.255.14", "proto": "IPSEC", "vip_idx": 190, "dst_port": 12366, "name": "172.16.255.14:lte-172.16.255.11:3g", "sla_class_list": "0", "tunnel_color": "3g:lte", "host_name": "vm4", "id": "4OBG_HEB_JLsavezVUfr" } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/approute/aggregation": { "get": { "tags": [ "Monitoring - Application Aware Routing" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getAggregationDataByQuery_MonitoringApplicationAwareRouting_3203", "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.16" ], "field": "vdevice_name", "type": "string", "operator": "in" }, { "value": [ "100" ], "field": "loss_percentage", "type": "number", "operator": "less" } ] }, "aggregation": { "field": [ { "property": "local_color", "sequence": 1, "order": "asc" } ], "metrics": [ { "property": "loss_percentage", "type": "avg" }, { "property": "latency", "type": "avg" }, { "property": "jitter", "type": "avg" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "example": 5 }, "entry_time": { "type": "string", "example": "1674813600000" }, "local_color": { "type": "string", "example": "3g" }, "loss_percentage": { "type": "integer", "format": "int32", "example": 0 } }, "$$ref": "#/components/schemas/AppRouteAggResp" } }, "examples": { "Aggregated search result": { "description": "Aggregated search result", "value": "[\n {\n \"count\": 5,\n \"local_color\": \"3g\",\n \"loss_percentage\": 0\n \"jitter\": 0\n \"latency\": 0\n }\n ]" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Monitoring - Application Aware Routing" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationDataByQuery_MonitoringApplicationAwareRouting_3204", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.16" ], "field": "vdevice_name", "type": "string", "operator": "in" }, { "value": [ "100" ], "field": "loss_percentage", "type": "number", "operator": "less" } ] }, "aggregation": { "field": [ { "property": "local_color", "sequence": 1, "order": "asc" } ], "metrics": [ { "property": "loss_percentage", "type": "avg" }, { "property": "latency", "type": "avg" }, { "property": "jitter", "type": "avg" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "example": 5 }, "entry_time": { "type": "string", "example": "1674813600000" }, "local_color": { "type": "string", "example": "3g" }, "loss_percentage": { "type": "integer", "format": "int32", "example": 0 } }, "$$ref": "#/components/schemas/AppRouteAggResp" } }, "examples": { "Aggregated search result": { "description": "Aggregated search result", "value": "[\n {\n \"count\": 5,\n \"local_color\": \"3g\",\n \"loss_percentage\": 0\n \"jitter\": 0\n \"latency\": 0\n }\n ]" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/approute/app-agg/aggregation": { "post": { "tags": [ "Monitoring - Application Aware Routing" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationAppDataByQuery9", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "field": "latency", "type": "long", "value": [ "1" ], "operator": "greater" }, "fields": [ "latency" ], "aggregation": { "metrics": [ { "property": "latency", "type": "avg" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "object", "properties": { "latency": { "type": "string" } }, "$$ref": "#/components/schemas/AppRouteAppAggRespInner" }, "$$ref": "#/components/schemas/AppRouteAppAggResp" } }, "examples": { "Aggregated search result": { "description": "Aggregated search result", "value": [ { "latency": 0 } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/approute/csv": { "get": { "tags": [ "Monitoring - Application Aware Routing" ], "description": "Get raw data with optional query as CSV", "operationId": "getStatDataRawDataAsCSV_MonitoringApplicationAwareRouting_2403", "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.11" ], "field": "vdevice_name", "type": "string", "operator": "in" }, { "value": [ "3g", "lte" ], "field": "local_color", "type": "string", "operator": "in" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" }, "examples": { "Search result in csv format": { "description": "Search result in csv format", "value": " blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/approute/device/tunnel/summary": { "get": { "tags": [ "Monitoring - Application Aware Routing" ], "description": "Get statistics for top applications per tunnel in a grid table", "operationId": "getStatsAppRouteDeviceTunnelSummary", "parameters": [ { "name": "query", "in": "query", "description": "Query filter", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.11" ], "field": "vdevice_name", "type": "string", "operator": "in" }, { "value": [ "3g", "lte" ], "field": "local_color", "type": "string", "operator": "in" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "app_probe_class": { "type": "string" }, "entry_time": { "type": "string" }, "jitter": { "type": "integer", "format": "int32", "example": 0 }, "latency": { "type": "number" }, "loss_percentage": { "type": "number" }, "name": { "type": "string", "example": "172.16.255.11:lte-172.16.255.16:3g" }, "rx_octets": { "type": "integer", "format": "int32" }, "tx_octets": { "type": "integer", "format": "int32" } }, "$$ref": "#/components/schemas/AppRouteTunnelSummary" } } }, "$$ref": "#/components/schemas/AppRouteTunnenSummarResp" } }, "examples": { "Statistics for top application": { "description": "Statistics for top application", "value": [ { "name": "172.16.255.11:lte-172.16.255.15:3g", "jitter": 0, "rx_octets": 0, "tx_octets": 0, "loss_percentage": 0, "latency": 0, "entry_time": "", "app_probe_class": "" }, { "name": "172.16.255.11:lte-172.16.255.15:lte", "jitter": 0, "rx_octets": 0, "tx_octets": 0, "loss_percentage": 0, "latency": 0, "entry_time": "", "app_probe_class": "" }, { "name": "172.16.255.11:lte-172.16.255.16:3g", "jitter": 0, "rx_octets": 0, "tx_octets": 0, "loss_percentage": 0, "latency": 0, "entry_time": "", "app_probe_class": "" }, { "name": "172.16.255.11:lte-172.16.255.16:lte", "jitter": 0, "rx_octets": 0, "tx_octets": 0, "loss_percentage": 0, "latency": 0, "entry_time": "", "app_probe_class": "" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/approute/device/tunnels": { "get": { "tags": [ "Monitoring - Application Aware Routing" ], "description": "Get statistics for top applications per tunnel in a grid table", "operationId": "getStatsAppRouteDeviceTunnels", "parameters": [ { "name": "query", "in": "query", "description": "Query filter", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.11" ], "field": "vdevice_name", "type": "string", "operator": "in" }, { "value": [ "3g", "lte" ], "field": "local_color", "type": "string", "operator": "in" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "device_model": { "type": "string" }, "dst_ip": { "type": "string" }, "dst_port": { "type": "integer", "format": "int32" }, "entry_time": { "type": "string" }, "fec_re": { "type": "integer", "format": "int32" }, "fec_rx": { "type": "integer", "format": "int64" }, "fec_tx": { "type": "integer", "format": "int64" }, "host_name": { "type": "string" }, "id": { "type": "string" }, "jitter": { "type": "integer", "format": "int32" }, "latency": { "type": "number" }, "local_color": { "type": "string" }, "local_system_ip": { "type": "string" }, "loss": { "type": "integer", "format": "int32" }, "loss_percentage": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "proto": { "type": "string" }, "remote_color": { "type": "string" }, "remote_system_ip": { "type": "string" }, "rx_octets": { "type": "integer", "format": "int64" }, "rx_pkts": { "type": "integer", "format": "int64" }, "sla_class_list": { "type": "string" }, "sla_class_names": { "type": "string" }, "src_ip": { "type": "string" }, "src_port": { "type": "integer", "format": "int32" }, "statcycletime": { "type": "string" }, "state": { "type": "string" }, "tenant": { "type": "string" }, "total": { "type": "integer", "format": "int32" }, "tunnel_color": { "type": "string" }, "tx_octets": { "type": "number" }, "tx_pkts": { "type": "integer", "format": "int64" }, "vdevice_name": { "type": "string" }, "vip_idx": { "type": "integer", "format": "int32" }, "vmanage_system_ip": { "type": "string" }, "vqoe_score": { "type": "integer", "format": "int32" } }, "description": "app route specific response", "$$ref": "#/components/schemas/AppRouteResp" } }, "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": "app route response with page info", "$$ref": "#/components/schemas/AppRouteRespWithPageInfo" } }, "examples": { "Tunnel top statistics": { "description": "Tunnel top statistics", "value": [ { "remote_color": "lte", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 0, "tx_octets": 0, "dst_ip": "10.0.106.1", "local_color": "3g", "src_ip": "10.0.101.2", "sla_class_names": "None", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1677160200123, "siteid": 100, "state": "Up", "local_system_ip": "172.16.255.11", "tenant": "default", "entry_time": 1677159336845, "loss_percentage": 0, "app_probe_class": "None", "rx_pkts": 0, "vmanage_system_ip": "172.16.255.11", "fec_rx": 0, "src_port": 12366, "jitter": 0, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.11", "proto": "IPSEC", "vip_idx": 3718, "dst_port": 12366, "name": "172.16.255.11:3g-172.16.255.16:lte", "sla_class_list": "0", "tunnel_color": "3g:lte", "host_name": "vm1", "id": "0q-JfoYB04cEz_Q-t9i_" }, { "remote_color": "3g", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 0, "tx_octets": 0, "dst_ip": "10.0.106.2", "local_color": "lte", "src_ip": "10.0.101.1", "sla_class_names": "None", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1677160200123, "siteid": 100, "state": "Up", "local_system_ip": "172.16.255.11", "tenant": "default", "entry_time": 1677159336845, "loss_percentage": 0, "app_probe_class": "None", "rx_pkts": 0, "vmanage_system_ip": "172.16.255.11", "fec_rx": 0, "src_port": 12366, "jitter": 0, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.11", "proto": "IPSEC", "vip_idx": 3713, "dst_port": 12366, "name": "172.16.255.11:lte-172.16.255.16:3g", "sla_class_list": "0", "tunnel_color": "3g:lte", "host_name": "vm1", "id": "za-JfoYB04cEz_Q-t9i_" }, { "remote_color": "3g", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 0, "tx_octets": 0, "dst_ip": "10.0.106.2", "local_color": "3g", "src_ip": "10.0.101.2", "sla_class_names": "None", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1677160200123, "siteid": 100, "state": "Up", "local_system_ip": "172.16.255.11", "tenant": "default", "entry_time": 1677159336845, "loss_percentage": 0, "app_probe_class": "None", "rx_pkts": 0, "vmanage_system_ip": "172.16.255.11", "fec_rx": 0, "src_port": 12366, "jitter": 0, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.11", "proto": "IPSEC", "vip_idx": 3714, "dst_port": 12366, "name": "172.16.255.11:3g-172.16.255.16:3g", "sla_class_list": "0", "tunnel_color": "3g:3g", "host_name": "vm1", "id": "zq-JfoYB04cEz_Q-t9i_" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/approute/doccount": { "get": { "tags": [ "Monitoring - Application Aware Routing" ], "description": "Get response count of a query", "operationId": "getDocCount_MonitoringApplicationAwareRouting_2903", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.11" ], "field": "vdevice_name", "type": "string", "operator": "in" }, { "value": [ "3g", "lte" ], "field": "local_color", "type": "string", "operator": "in" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 17193 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Monitoring - Application Aware Routing" ], "description": "Get response count of a query", "operationId": "getDocCountPost", "requestBody": { "description": "Query", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query": { "description": "Query", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.11" ], "field": "vdevice_name", "type": "string", "operator": "in" }, { "value": [ "3g", "lte" ], "field": "local_color", "type": "string", "operator": "in" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 9642 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/approute/fec/aggregation": { "post": { "tags": [ "Monitoring - Application Aware Routing" ], "description": "Get aggregation data and fec recovery rate", "operationId": "getAppRouteFecAgg", "parameters": [ { "name": "site-id", "in": "query", "schema": { "pattern": "^[0-9]+$", "type": "string" } } ], "requestBody": { "description": "Query filter", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query filter": { "description": "Query filter", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.11" ], "field": "vdevice_name", "type": "string", "operator": "in" }, { "value": [ "172.16.255.11:lte-172.16.255.14:lte", "172.16.255.11:lte-172.16.255.15:3g" ], "field": "name", "type": "string", "operator": "in" }, { "value": [ "100" ], "field": "loss_percentage", "type": "number", "operator": "less" } ] }, "aggregation": { "field": [ { "property": "name", "sequence": 1 }, { "property": "state", "sequence": 1 }, { "property": "proto", "sequence": 2 } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" }, "metrics": [ { "property": "loss_percentage", "type": "avg" }, { "property": "fecLossRecovery", "type": "avg" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "object", "properties": { "count": { "type": "number" }, "entry_time": { "type": "string" }, "fecLossRecovery": { "type": "string" }, "loss_percentage": { "type": "number" }, "name": { "type": "string" }, "proto": { "type": "string" }, "state": { "type": "string" } }, "$$ref": "#/components/schemas/AppRouteFECAggRespInner" }, "$$ref": "#/components/schemas/AppRouteFECAggResp" } }, "examples": { "Aggregation data and fec recovery rate": { "description": "Aggregation data and fec recovery rate", "value": "[\n {\n \"loss_percentage\": 0.1066624445851805,\n \"entry_time\": 1676892600000,\n \"count\": 1578,\n \"proto\": \"IPSEC\",\n \"name\": \"172.16.254.16:default-172.16.254.2:default\",\n \"state\": \"Up\",\n \"fecLossRecovery\": \"-\",\n },\n {\n \"loss_percentage\": 0.1266624445851805,\n \"entry_time\": 1676892600000,\n \"count\": 1579,\n \"proto\": \"IPSEC\",\n \"name\": \"172.16.254.16:default-172.16.254.3:default\",\n \"state\": \"Up\",\n \"fecLossRecovery\": \"-\",\n }\n ]" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/approute/fields": { "get": { "tags": [ "Monitoring - Application Aware Routing" ], "description": "Get fields and type", "operationId": "getStatDataFields_MonitoringApplicationAwareRouting_2703", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "dataType": { "type": "string" }, "property": { "type": "string" } }, "$$ref": "#/components/schemas/AppRouteDocCountResponse" } }, "example": [ { "property": "vdevice_name", "dataType": "string" }, { "property": "host_name", "dataType": "string" }, { "property": "device_model", "dataType": "string" }, { "property": "statcycletime", "dataType": "date" }, { "property": "entry_time", "dataType": "date" }, { "property": "vip_idx", "dataType": "number" }, { "property": "local_system_ip", "dataType": "string" }, { "property": "remote_system_ip", "dataType": "string" }, { "property": "local_color", "dataType": "string" }, { "property": "remote_color", "dataType": "string" }, { "property": "proto", "dataType": "string" }, { "property": "window", "dataType": "number" }, { "property": "src_ip", "dataType": "string" }, { "property": "dst_ip", "dataType": "string" }, { "property": "src_port", "dataType": "number" }, { "property": "dst_port", "dataType": "number" }, { "property": "total", "dataType": "number" }, { "property": "latency", "dataType": "number" }, { "property": "loss_percentage", "dataType": "number" }, { "property": "jitter", "dataType": "number" }, { "property": "tx_pkts", "dataType": "number" }, { "property": "rx_pkts", "dataType": "number" }, { "property": "tx_octets", "dataType": "number" }, { "property": "rx_octets", "dataType": "number" }, { "property": "name", "dataType": "string" }, { "property": "loss", "dataType": "number" } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/approute/page": { "get": { "tags": [ "Monitoring - Application Aware Routing" ], "description": "Get stats raw data", "operationId": "getStatBulkRawData_MonitoringApplicationAwareRouting_2503", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.11" ], "field": "vdevice_name", "type": "string", "operator": "in" }, { "value": [ "3g", "lte" ], "field": "local_color", "type": "string", "operator": "in" } ] } } }, { "name": "scrollId", "in": "query", "schema": { "type": "string" } }, { "name": "count", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "example": 5 }, "entry_time": { "type": "string", "example": "1674813600000" }, "local_color": { "type": "string", "example": "3g" }, "loss_percentage": { "type": "integer", "format": "int32", "example": 0 } }, "$$ref": "#/components/schemas/AppRouteAggResp" } }, "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": "interface aggregation response with page info", "$$ref": "#/components/schemas/AppRouteAggRespWithPageInfo" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "3g", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 0, "tx_octets": 0, "dst_ip": "10.0.106.2", "local_color": "3g", "src_ip": "10.0.101.2", "sla_class_names": "None", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1677076800077, "siteid": 100, "state": "Up", "local_system_ip": "172.16.255.11", "tenant": "default", "entry_time": 1677075936838, "loss_percentage": 0, "app_probe_class": "None", "rx_pkts": 0, "vmanage_system_ip": "172.16.255.11", "fec_rx": 0, "src_port": 12366, "jitter": 0, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.11", "proto": "IPSEC", "vip_idx": 934, "dst_port": 12366, "name": "172.16.255.11:3g-172.16.255.16:3g", "sla_class_list": "0", "tunnel_color": "3g:3g", "host_name": "vm1", "id": "-auReYYB04cEz_Q-IvdV" }, { "remote_color": "lte", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 0, "tx_octets": 0, "dst_ip": "10.0.106.1", "local_color": "lte", "src_ip": "10.0.101.1", "sla_class_names": "None", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1677076800077, "siteid": 100, "state": "Up", "local_system_ip": "172.16.255.11", "tenant": "default", "entry_time": 1677075936838, "loss_percentage": 0, "app_probe_class": "None", "rx_pkts": 0, "vmanage_system_ip": "172.16.255.11", "fec_rx": 0, "src_port": 12366, "jitter": 0, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.11", "proto": "IPSEC", "vip_idx": 937, "dst_port": 12366, "name": "172.16.255.11:lte-172.16.255.16:lte", "sla_class_list": "0", "tunnel_color": "lte:lte", "host_name": "vm1", "id": "_KuReYYB04cEz_Q-IvdV" }, { "remote_color": "lte", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 0, "tx_octets": 0, "dst_ip": "10.0.106.1", "local_color": "3g", "src_ip": "10.0.101.2", "sla_class_names": "None", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1677076800077, "siteid": 100, "state": "Up", "local_system_ip": "172.16.255.11", "tenant": "default", "entry_time": 1677075936838, "loss_percentage": 0, "app_probe_class": "None", "rx_pkts": 0, "vmanage_system_ip": "172.16.255.11", "fec_rx": 0, "src_port": 12366, "jitter": 0, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.11", "proto": "IPSEC", "vip_idx": 938, "dst_port": 12366, "name": "172.16.255.11:3g-172.16.255.16:lte", "sla_class_list": "0", "tunnel_color": "3g:lte", "host_name": "vm1", "id": "_auReYYB04cEz_Q-IvdV" } ], "pageInfo": { "startTime": "1677076800076", "endTime": "1677076800077", "scrollId": "FGluY2x1ZGVfY29udGV4dF91dWlkDXF1ZXJ5QW5kRmV0Y2gBFnRpX1duVm1rUmhpMVJUdGk1R05PWHcAAAAAAAAkbhZVMG9reER2Y1NtT1ZwM2lBYmpEWVZ3_10", "hasMoreData": true, "count": 10, "totalCount": 1430 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Monitoring - Application Aware Routing" ], "description": "Get stats raw data", "operationId": "getPostStatBulkRawData_MonitoringApplicationAwareRouting_2504", "parameters": [ { "name": "scrollId", "in": "query", "schema": { "type": "string" } }, { "name": "count", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.11" ], "field": "vdevice_name", "type": "string", "operator": "in" }, { "value": [ "3g", "lte" ], "field": "local_color", "type": "string", "operator": "in" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "example": 5 }, "entry_time": { "type": "string", "example": "1674813600000" }, "local_color": { "type": "string", "example": "3g" }, "loss_percentage": { "type": "integer", "format": "int32", "example": 0 } }, "$$ref": "#/components/schemas/AppRouteAggResp" } }, "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": "interface aggregation response with page info", "$$ref": "#/components/schemas/AppRouteAggRespWithPageInfo" }, "example": { "data": [ { "remote_color": "lte", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.106.1", "local_color": "lte", "src_ip": "10.1.15.15", "sla_class_names": "test_sla_class", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400052, "state": "Up", "local_system_ip": "172.16.255.15", "tenant": "default", "entry_time": 1589073783045, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.15", "fec_rx": 0, "src_port": 12366, "jitter": 1, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.15", "proto": "IPSEC", "vip_idx": 351, "dst_port": 12386, "name": "172.16.255.15:lte-172.16.255.16:lte", "sla_class_list": "0,1", "tunnel_color": "lte:lte", "host_name": "vm5", "id": "IuBG_HEB_JLsavezVkiZ" } ], "pageInfo": { "startTime": "1666941702257", "endTime": "1666941699172", "count": 1000 } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/approute/query/fields": { "get": { "tags": [ "Monitoring - Application Aware Routing" ], "description": "Get query fields", "operationId": "getStatQueryFields_MonitoringApplicationAwareRouting_3303", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query fields": { "description": "Query fields", "value": [ { "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" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/approute/tloc": { "post": { "tags": [ "Monitoring - Application Aware Routing" ], "description": "Get tloc", "operationId": "getApprouteTloc", "requestBody": { "description": "Query filter", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query filter": { "description": "Query filter", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "field": [ { "property": "local_tloc", "sequence": 1, "size": 20 }, { "property": "siteid", "sequence": 2 } ], "metrics": [ { "property": "rx_octets", "type": "sum", "order": "desc" }, { "property": "tx_octets", "type": "sum", "order": "desc" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "object", "properties": { "count": { "type": "number" }, "local_tloc": { "type": "string" }, "rx_octets": { "type": "number" }, "siteid": { "type": "string" }, "tx_octets": { "type": "number" } }, "$$ref": "#/components/schemas/AppRouteTlocRespInner" }, "$$ref": "#/components/schemas/AppRouteTlocResp" } }, "example": [ { "rx_octets": 0, "tx_octets": 0, "count": 1401, "local_tloc": "172.1.1.1:mpls", "siteid": 607 } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/approute/transport/summary/{type}": { "get": { "tags": [ "Monitoring - Application Aware Routing" ], "description": "Get application-aware routing statistics summary from device", "operationId": "getAppRouteTransportSummaryType", "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" }, "example": "loss" }, { "name": "limit", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32", "default": 5 } }, { "name": "query", "in": "query", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.11" ], "field": "vdevice_name", "type": "string", "operator": "in" }, { "value": [ "3g", "lte" ], "field": "local_color", "type": "string", "operator": "in" } ] } } }, { "name": "site-id", "in": "query", "schema": { "pattern": "^[0-9]+$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "object", "properties": { "count": { "type": "number" }, "entry_time": { "type": "string" }, "fecLossRecovery": { "type": "string" }, "loss_percentage": { "type": "number" }, "name": { "type": "string" }, "proto": { "type": "string" }, "state": { "type": "string" } }, "$$ref": "#/components/schemas/AppRouteFECAggRespInner" }, "$$ref": "#/components/schemas/AppRouteFECAggResp" } }, "examples": { "Application-aware routing statistics summary": { "description": "Application-aware routing statistics summary", "value": [ { "entry_time": 1676892600000, "loss_percentage": 0, "color": "3g:3g", "jitter": 0, "latency": 0, "app_probe_class": "" }, { "entry_time": 1676818800000, "loss_percentage": 0, "color": "3g:lte", "jitter": 0, "latency": 0, "app_probe_class": "" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/approute/transport/{type}": { "get": { "tags": [ "Monitoring - Application Aware Routing" ], "description": "Get application-aware routing statistics from device", "operationId": "getAppRouteTransportType", "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" }, "example": "loss" }, { "name": "query", "in": "query", "description": "Query filter", "schema": { "type": "string" }, "example": { "query": { "field": "latency", "type": "long", "value": [ "1" ], "operator": "greater" }, "fields": [ "latency" ], "aggregation": { "metrics": [ { "property": "latency", "type": "avg" } ] } } }, { "name": "limit", "in": "query", "required": true, "schema": { "minimum": 1, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "app_probe_class": { "type": "string" }, "color": { "type": "string", "example": "3g" }, "entry_time": { "type": "string", "example": "1674813600000" }, "jitter": { "type": "string", "example": "0" }, "latency": { "type": "integer", "format": "int32", "example": 5 }, "loss_percentage": { "type": "integer", "format": "int32", "example": 0 } }, "$$ref": "#/components/schemas/AppRouteTransportResp" }, "example": [ { "latency": 0, "entry_time": 1673524800000, "jitter": 0, "color": "lte", "loss_percentage": 0, "app_probe_class": "None" } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/approute/tunnel/{type}/summary": { "get": { "tags": [ "Monitoring - Application Aware Routing" ], "description": "Get tunnel top statistics in as chart", "operationId": "getAppRouteTunnelSummaryType", "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" }, "example": "loss" }, { "name": "query", "in": "query", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.11" ], "field": "vdevice_name", "type": "string", "operator": "in" }, { "value": [ "3g", "lte" ], "field": "local_color", "type": "string", "operator": "in" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "device_model": { "type": "string" }, "dst_ip": { "type": "string" }, "dst_port": { "type": "integer", "format": "int32" }, "entry_time": { "type": "string" }, "fec_re": { "type": "integer", "format": "int32" }, "fec_rx": { "type": "integer", "format": "int64" }, "fec_tx": { "type": "integer", "format": "int64" }, "host_name": { "type": "string" }, "id": { "type": "string" }, "jitter": { "type": "integer", "format": "int32" }, "latency": { "type": "number" }, "local_color": { "type": "string" }, "local_system_ip": { "type": "string" }, "loss": { "type": "integer", "format": "int32" }, "loss_percentage": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "proto": { "type": "string" }, "remote_color": { "type": "string" }, "remote_system_ip": { "type": "string" }, "rx_octets": { "type": "integer", "format": "int64" }, "rx_pkts": { "type": "integer", "format": "int64" }, "sla_class_list": { "type": "string" }, "sla_class_names": { "type": "string" }, "src_ip": { "type": "string" }, "src_port": { "type": "integer", "format": "int32" }, "statcycletime": { "type": "string" }, "state": { "type": "string" }, "tenant": { "type": "string" }, "total": { "type": "integer", "format": "int32" }, "tunnel_color": { "type": "string" }, "tx_octets": { "type": "number" }, "tx_pkts": { "type": "integer", "format": "int64" }, "vdevice_name": { "type": "string" }, "vip_idx": { "type": "integer", "format": "int32" }, "vmanage_system_ip": { "type": "string" }, "vqoe_score": { "type": "integer", "format": "int32" } }, "description": "app route specific response", "$$ref": "#/components/schemas/AppRouteResp" } }, "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": "app route response with page info", "$$ref": "#/components/schemas/AppRouteRespWithPageInfo" } }, "examples": { "Tunnel top statistics": { "description": "Tunnel top statistics", "value": { "value": { "data": [ { "remote_color": "lte", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.106.1", "local_color": "lte", "src_ip": "10.1.15.15", "sla_class_names": "test_sla_class", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400052, "state": "Up", "local_system_ip": "172.16.255.15", "tenant": "default", "entry_time": 1589073783045, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.15", "fec_rx": 0, "src_port": 12366, "jitter": 1, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.15", "proto": "IPSEC", "vip_idx": 351, "dst_port": 12386, "name": "172.16.255.15:lte-172.16.255.16:lte", "sla_class_list": "0,1", "tunnel_color": "lte:lte", "host_name": "vm5", "id": "IuBG_HEB_JLsavezVkiZ" } ], "pageInfo": { "startTime": "1589073783045", "endTime": "1589072535795", "count": 15 } } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/approute/tunnels/health/{type}": { "get": { "tags": [ "Monitoring - Application Aware Routing" ], "description": "Get tunnel health", "operationId": "getAppRouteTunnelHealth", "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" }, "example": "loss" }, { "name": "limit", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32", "default": 10 } }, { "name": "last_n_hours", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32", "default": 3 } }, { "name": "last_n_minutes", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "start_time", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "end_time", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "deviceIP", "in": "query", "schema": { "type": "string" }, "example": "172.16.255.11" }, { "name": "site-id", "in": "query", "schema": { "pattern": "^[0-9]+$", "type": "string" } }, { "name": "regionName", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "app_probe_class": { "type": "string" }, "entry_time": { "type": "string" }, "jitter": { "type": "integer", "format": "int32", "example": 0 }, "latency": { "type": "number" }, "loss_percentage": { "type": "number" }, "name": { "type": "string", "example": "172.16.255.11:lte-172.16.255.16:3g" }, "rx_octets": { "type": "integer", "format": "int32" }, "tx_octets": { "type": "integer", "format": "int32" } }, "$$ref": "#/components/schemas/AppRouteTunnelSummary" } } }, "$$ref": "#/components/schemas/AppRouteTunnenSummarResp" } }, "examples": { "Tunnel top statistics": { "description": "Tunnel top statistics", "value": [ { "name": "172.16.255.11:lte-172.16.255.16:lte", "remote_system_ip": "172.16.255.16,", "remote_color": "lte", "remote-host-name": "vm6,", "remote_site_id": "600,", "remote_latitude": "32.0,", "remote_longitude": "-88.0,", "local_color": "gold,", "local_system_ip": "172.16.255.11,", "device-type": "vedge,", "deviceClass": "viptela-router,", "state": "Up,", "vqoe_score": "10,", "jitter": "0,", "rx_octets": "0,", "loss_percentage": "0,", "latency": "0,", "tx_octets": "0,", "health": "green" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/approute/tunnels/summary/{type}": { "get": { "tags": [ "Monitoring - Application Aware Routing" ], "description": "Get tunnel top statistics from device", "operationId": "getAppRouteTunnelsSummaryType", "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" }, "example": "loss" }, { "name": "query", "in": "query", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.11" ], "field": "vdevice_name", "type": "string", "operator": "in" }, { "value": [ "3g", "lte" ], "field": "local_color", "type": "string", "operator": "in" } ] } } }, { "name": "limit", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32", "default": 10 } }, { "name": "site-id", "in": "query", "schema": { "pattern": "^[0-9]+$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "app_probe_class": { "type": "string" }, "color": { "type": "string", "example": "3g" }, "entry_time": { "type": "string", "example": "1674813600000" }, "jitter": { "type": "string", "example": "0" }, "latency": { "type": "integer", "format": "int32", "example": 5 }, "loss_percentage": { "type": "integer", "format": "int32", "example": 0 } }, "$$ref": "#/components/schemas/AppRouteTransportResp" }, "example": [ { "name": "172.16.255.11:lte-172.16.255.16:3g", "jitter": 0, "rx_octets": 0, "tx_octets": 0, "loss_percentage": 0, "latency": 0, "app_probe_class": "" }, { "name": "172.16.255.11:lte-172.16.255.16:lte", "jitter": 0, "rx_octets": 0, "tx_octets": 0, "loss_percentage": 0, "latency": 0, "app_probe_class": "" } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/approute/tunnels/{type}": { "get": { "tags": [ "Monitoring - Application Aware Routing" ], "description": "Get tunnel top statistics from device", "operationId": "getAppRouteTunnelType", "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" }, "example": "loss" }, { "name": "query", "in": "query", "description": "Query filter", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.11" ], "field": "vdevice_name", "type": "string", "operator": "in" }, { "value": [ "3g", "lte" ], "field": "local_color", "type": "string", "operator": "in" } ] } } }, { "name": "limit", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "device_model": { "type": "string" }, "dst_ip": { "type": "string" }, "dst_port": { "type": "integer", "format": "int32" }, "entry_time": { "type": "string" }, "fec_re": { "type": "integer", "format": "int32" }, "fec_rx": { "type": "integer", "format": "int64" }, "fec_tx": { "type": "integer", "format": "int64" }, "host_name": { "type": "string" }, "id": { "type": "string" }, "jitter": { "type": "integer", "format": "int32" }, "latency": { "type": "number" }, "local_color": { "type": "string" }, "local_system_ip": { "type": "string" }, "loss": { "type": "integer", "format": "int32" }, "loss_percentage": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "proto": { "type": "string" }, "remote_color": { "type": "string" }, "remote_system_ip": { "type": "string" }, "rx_octets": { "type": "integer", "format": "int64" }, "rx_pkts": { "type": "integer", "format": "int64" }, "sla_class_list": { "type": "string" }, "sla_class_names": { "type": "string" }, "src_ip": { "type": "string" }, "src_port": { "type": "integer", "format": "int32" }, "statcycletime": { "type": "string" }, "state": { "type": "string" }, "tenant": { "type": "string" }, "total": { "type": "integer", "format": "int32" }, "tunnel_color": { "type": "string" }, "tx_octets": { "type": "number" }, "tx_pkts": { "type": "integer", "format": "int64" }, "vdevice_name": { "type": "string" }, "vip_idx": { "type": "integer", "format": "int32" }, "vmanage_system_ip": { "type": "string" }, "vqoe_score": { "type": "integer", "format": "int32" } }, "description": "app route specific response", "$$ref": "#/components/schemas/AppRouteResp" } }, "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": "app route response with page info", "$$ref": "#/components/schemas/AppRouteRespWithPageInfo" } }, "example": { "value": { "data": [ { "remote_color": "lte", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.106.1", "local_color": "lte", "src_ip": "10.1.15.15", "sla_class_names": "test_sla_class", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400052, "state": "Up", "local_system_ip": "172.16.255.15", "tenant": "default", "entry_time": 1589073783045, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.15", "fec_rx": 0, "src_port": 12366, "jitter": 1, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.15", "proto": "IPSEC", "vip_idx": 351, "dst_port": 12386, "name": "172.16.255.15:lte-172.16.255.16:lte", "sla_class_list": "0,1", "tunnel_color": "lte:lte", "host_name": "vm5", "id": "IuBG_HEB_JLsavezVkiZ" } ], "pageInfo": { "startTime": "1589073783045", "endTime": "1589072535795", "count": 15 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/art": { "get": { "tags": [ "Monitoring - ART" ], "description": "Get stats raw data", "operationId": "getStatDataRawData_MonitoringArt_1503", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "metrics": [ { "property": "latency", "type": "avg" } ] } } }, { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by(emp:entry_time)", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "3g", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.101.2", "local_color": "lte", "src_ip": "10.1.14.14", "sla_class_names": "None", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400056, "state": "Up", "local_system_ip": "172.16.255.14", "tenant": "default", "entry_time": 1589073792008, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.14", "fec_rx": 0, "src_port": 12380, "jitter": 1, "remote_system_ip": "172.16.255.11", "vdevice_name": "172.16.255.14", "proto": "IPSEC", "vip_idx": 190, "dst_port": 12366, "name": "172.16.255.14:lte-172.16.255.11:3g", "sla_class_list": "0", "tunnel_color": "3g:lte", "host_name": "vm4", "id": "4OBG_HEB_JLsavezVUfr" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "post": { "tags": [ "Monitoring - ART" ], "description": "Get stats raw data", "operationId": "getStatsRawData_MonitoringArt_1504", "parameters": [ { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order", "schema": { "type": "string" } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "field": [ { "property": "name", "sequence": 1 }, { "property": "proto", "sequence": 2 } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" }, "metrics": [ { "property": "latency", "type": "avg" }, { "property": "loss", "type": "avg" }, { "property": "loss_percentage", "type": "avg" }, { "property": "vqoe_score", "type": "avg" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "lte", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.106.1", "local_color": "lte", "src_ip": "10.1.15.15", "sla_class_names": "test_sla_class", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400052, "state": "Up", "local_system_ip": "172.16.255.15", "tenant": "default", "entry_time": 1589073783045, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.15", "fec_rx": 0, "src_port": 12366, "jitter": 1, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.15", "proto": "IPSEC", "vip_idx": 351, "dst_port": 12386, "name": "172.16.255.15:lte-172.16.255.16:lte", "sla_class_list": "0,1", "tunnel_color": "lte:lte", "host_name": "vm5", "id": "IuBG_HEB_JLsavezVkiZ" } ], "pageInfo": { "startTime": "1589073783045", "endTime": "1589072535795", "count": 15 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/art/aggregation": { "post": { "tags": [ "Monitoring - ART" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationDataByQuery_MonitoringArt_2704", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default,dca" }, "get": { "tags": [ "Monitoring - ART" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getAggregationDataByQuery_MonitoringArt_2703", "parameters": [ { "name": "query", "in": "query", "description": "Query filter", "schema": { "type": "string" }, "examples": { "query string": {} } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/art/csv": { "get": { "tags": [ "Monitoring - ART" ], "description": "Get raw data with optional query as CSV", "operationId": "getStatDataRawDataAsCSV_MonitoringArt_1903", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" }, "examples": { "Search result in csv format": { "description": "Search result in csv format", "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/art/doccount": { "post": { "tags": [ "Monitoring - ART" ], "description": "Get response count of a query", "operationId": "getCountPost_MonitoringArt_2404", "requestBody": { "description": "Query", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query": { "description": "Query", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 9642 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Monitoring - ART" ], "description": "Get response count of a query", "operationId": "getCount_MonitoringArt_2403", "parameters": [ { "name": "query", "in": "query", "description": "Query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 17193 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/art/fields": { "get": { "tags": [ "Monitoring - ART" ], "description": "Get fields and type", "operationId": "getStatDataFields_MonitoringArt_2203", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "example": [ { "dataType": "string", "property": "mac" }, { "dataType": "string", "property": "vap" }, { "dataType": "number", "property": "rssi" }, { "dataType": "string", "property": "mode" }, { "dataType": "number", "property": "bandwidth" }, { "dataType": "string", "property": "data_security" }, { "dataType": "number", "property": "rx_rate" }, { "dataType": "string", "property": "assoc_time" }, { "dataType": "date", "property": "entry_time" }, { "dataType": "date", "property": "statcycletime" }, { "dataType": "string", "property": "ssid" }, { "dataType": "number", "property": "vip_idx" }, { "dataType": "date", "property": "vip_time" }, { "dataType": "string", "property": "vdevice_name" }, { "dataType": "string", "property": "host_name" }, { "dataType": "string", "property": "device_model" } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/art/page": { "get": { "tags": [ "Monitoring - ART" ], "description": "Get stats raw data", "operationId": "getStatsPaginationRawData_MonitoringArt_2003", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } }, { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" }, "post": { "tags": [ "Monitoring - ART" ], "description": "Get stats raw data", "operationId": "getPostStatsPaginationRawData_MonitoringArt_2004", "parameters": [ { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/art/query/fields": { "get": { "tags": [ "Monitoring - ART" ], "description": "Get query fields", "operationId": "getStatQueryFields_MonitoringArt_2803", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "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" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/bfd": { "post": { "tags": [ "Monitoring - BFD" ], "description": "Get stats raw data", "operationId": "getStatsRawData_MonitoringBfd_1504", "parameters": [ { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order", "schema": { "type": "string" } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "field": [ { "property": "name", "sequence": 1 }, { "property": "proto", "sequence": 2 } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" }, "metrics": [ { "property": "latency", "type": "avg" }, { "property": "loss", "type": "avg" }, { "property": "loss_percentage", "type": "avg" }, { "property": "vqoe_score", "type": "avg" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "lte", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.106.1", "local_color": "lte", "src_ip": "10.1.15.15", "sla_class_names": "test_sla_class", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400052, "state": "Up", "local_system_ip": "172.16.255.15", "tenant": "default", "entry_time": 1589073783045, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.15", "fec_rx": 0, "src_port": 12366, "jitter": 1, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.15", "proto": "IPSEC", "vip_idx": 351, "dst_port": 12386, "name": "172.16.255.15:lte-172.16.255.16:lte", "sla_class_list": "0,1", "tunnel_color": "lte:lte", "host_name": "vm5", "id": "IuBG_HEB_JLsavezVkiZ" } ], "pageInfo": { "startTime": "1589073783045", "endTime": "1589072535795", "count": 15 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "default" }, "get": { "tags": [ "Monitoring - BFD" ], "description": "Get stats raw data", "operationId": "getStatDataRawData_MonitoringBfd_1503", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "metrics": [ { "property": "latency", "type": "avg" } ] } } }, { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by(emp:entry_time)", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "3g", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.101.2", "local_color": "lte", "src_ip": "10.1.14.14", "sla_class_names": "None", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400056, "state": "Up", "local_system_ip": "172.16.255.14", "tenant": "default", "entry_time": 1589073792008, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.14", "fec_rx": 0, "src_port": 12380, "jitter": 1, "remote_system_ip": "172.16.255.11", "vdevice_name": "172.16.255.14", "proto": "IPSEC", "vip_idx": 190, "dst_port": 12366, "name": "172.16.255.14:lte-172.16.255.11:3g", "sla_class_list": "0", "tunnel_color": "3g:lte", "host_name": "vm4", "id": "4OBG_HEB_JLsavezVUfr" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "default" } }, "/statistics/bfd/aggregation": { "post": { "tags": [ "Monitoring - BFD" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationDataByQuery_MonitoringBfd_2704", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "default,dca" }, "get": { "tags": [ "Monitoring - BFD" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getAggregationDataByQuery_MonitoringBfd_2703", "parameters": [ { "name": "query", "in": "query", "description": "Query filter", "schema": { "type": "string" }, "examples": { "query string": {} } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "default" } }, "/statistics/bfd/csv": { "get": { "tags": [ "Monitoring - BFD" ], "description": "Get raw data with optional query as CSV", "operationId": "getStatDataRawDataAsCSV_MonitoringBfd_1903", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" }, "examples": { "Search result in csv format": { "description": "Search result in csv format", "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "default" } }, "/statistics/bfd/doccount": { "post": { "tags": [ "Monitoring - BFD" ], "description": "Get response count of a query", "operationId": "getCountPost_MonitoringBfd_2404", "requestBody": { "description": "Query", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query": { "description": "Query", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 9642 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true }, "get": { "tags": [ "Monitoring - BFD" ], "description": "Get response count of a query", "operationId": "getCount_MonitoringBfd_2403", "parameters": [ { "name": "query", "in": "query", "description": "Query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 17193 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/statistics/bfd/fields": { "get": { "tags": [ "Monitoring - BFD" ], "description": "Get fields and type", "operationId": "getStatDataFields_MonitoringBfd_2203", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "example": [ { "dataType": "string", "property": "mac" }, { "dataType": "string", "property": "vap" }, { "dataType": "number", "property": "rssi" }, { "dataType": "string", "property": "mode" }, { "dataType": "number", "property": "bandwidth" }, { "dataType": "string", "property": "data_security" }, { "dataType": "number", "property": "rx_rate" }, { "dataType": "string", "property": "assoc_time" }, { "dataType": "date", "property": "entry_time" }, { "dataType": "date", "property": "statcycletime" }, { "dataType": "string", "property": "ssid" }, { "dataType": "number", "property": "vip_idx" }, { "dataType": "date", "property": "vip_time" }, { "dataType": "string", "property": "vdevice_name" }, { "dataType": "string", "property": "host_name" }, { "dataType": "string", "property": "device_model" } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/statistics/bfd/page": { "post": { "tags": [ "Monitoring - BFD" ], "description": "Get stats raw data", "operationId": "getPostStatsPaginationRawData_MonitoringBfd_2004", "parameters": [ { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Device Monitoring-read" }, "get": { "tags": [ "Monitoring - BFD" ], "description": "Get stats raw data", "operationId": "getStatsPaginationRawData_MonitoringBfd_2003", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } }, { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Device Monitoring-read" } }, "/statistics/bfd/query/fields": { "get": { "tags": [ "Monitoring - BFD" ], "description": "Get query fields", "operationId": "getStatQueryFields_MonitoringBfd_2803", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "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" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/statistics/bridgeinterface": { "get": { "tags": [ "Monitoring - Bridge" ], "description": "Get stats raw data", "operationId": "getStatDataRawData_MonitoringBridge_2703", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "metrics": [ { "property": "latency", "type": "avg" } ] } } }, { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by(emp:entry_time)", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "3g", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.101.2", "local_color": "lte", "src_ip": "10.1.14.14", "sla_class_names": "None", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400056, "state": "Up", "local_system_ip": "172.16.255.14", "tenant": "default", "entry_time": 1589073792008, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.14", "fec_rx": 0, "src_port": 12380, "jitter": 1, "remote_system_ip": "172.16.255.11", "vdevice_name": "172.16.255.14", "proto": "IPSEC", "vip_idx": 190, "dst_port": 12366, "name": "172.16.255.14:lte-172.16.255.11:3g", "sla_class_list": "0", "tunnel_color": "3g:lte", "host_name": "vm4", "id": "4OBG_HEB_JLsavezVUfr" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "post": { "tags": [ "Monitoring - Bridge" ], "description": "Get stats raw data", "operationId": "getStatsRawData_MonitoringBridge_2704", "parameters": [ { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order", "schema": { "type": "string" } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "field": [ { "property": "name", "sequence": 1 }, { "property": "proto", "sequence": 2 } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" }, "metrics": [ { "property": "latency", "type": "avg" }, { "property": "loss", "type": "avg" }, { "property": "loss_percentage", "type": "avg" }, { "property": "vqoe_score", "type": "avg" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "lte", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.106.1", "local_color": "lte", "src_ip": "10.1.15.15", "sla_class_names": "test_sla_class", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400052, "state": "Up", "local_system_ip": "172.16.255.15", "tenant": "default", "entry_time": 1589073783045, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.15", "fec_rx": 0, "src_port": 12366, "jitter": 1, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.15", "proto": "IPSEC", "vip_idx": 351, "dst_port": 12386, "name": "172.16.255.15:lte-172.16.255.16:lte", "sla_class_list": "0,1", "tunnel_color": "lte:lte", "host_name": "vm5", "id": "IuBG_HEB_JLsavezVkiZ" } ], "pageInfo": { "startTime": "1589073783045", "endTime": "1589072535795", "count": 15 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/bridgeinterface/aggregation": { "get": { "tags": [ "Monitoring - Bridge" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getAggregationDataByQuery_MonitoringBridge_3903", "parameters": [ { "name": "query", "in": "query", "description": "Query filter", "schema": { "type": "string" }, "examples": { "query string": {} } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "post": { "tags": [ "Monitoring - Bridge" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationDataByQuery_MonitoringBridge_3904", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default,dca" } }, "/statistics/bridgeinterface/csv": { "get": { "tags": [ "Monitoring - Bridge" ], "description": "Get raw data with optional query as CSV", "operationId": "getStatDataRawDataAsCSV_MonitoringBridge_3103", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" }, "examples": { "Search result in csv format": { "description": "Search result in csv format", "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/bridgeinterface/doccount": { "post": { "tags": [ "Monitoring - Bridge" ], "description": "Get response count of a query", "operationId": "getCountPost_MonitoringBridge_3604", "requestBody": { "description": "Query", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query": { "description": "Query", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 9642 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Monitoring - Bridge" ], "description": "Get response count of a query", "operationId": "getCount_MonitoringBridge_3603", "parameters": [ { "name": "query", "in": "query", "description": "Query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 17193 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/bridgeinterface/fields": { "get": { "tags": [ "Monitoring - Bridge" ], "description": "Get fields and type", "operationId": "getStatDataFields_MonitoringBridge_3403", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "example": [ { "dataType": "string", "property": "mac" }, { "dataType": "string", "property": "vap" }, { "dataType": "number", "property": "rssi" }, { "dataType": "string", "property": "mode" }, { "dataType": "number", "property": "bandwidth" }, { "dataType": "string", "property": "data_security" }, { "dataType": "number", "property": "rx_rate" }, { "dataType": "string", "property": "assoc_time" }, { "dataType": "date", "property": "entry_time" }, { "dataType": "date", "property": "statcycletime" }, { "dataType": "string", "property": "ssid" }, { "dataType": "number", "property": "vip_idx" }, { "dataType": "date", "property": "vip_time" }, { "dataType": "string", "property": "vdevice_name" }, { "dataType": "string", "property": "host_name" }, { "dataType": "string", "property": "device_model" } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/bridgeinterface/page": { "post": { "tags": [ "Monitoring - Bridge" ], "description": "Get stats raw data", "operationId": "getPostStatsPaginationRawData_MonitoringBridge_3204", "parameters": [ { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" }, "get": { "tags": [ "Monitoring - Bridge" ], "description": "Get stats raw data", "operationId": "getStatsPaginationRawData_MonitoringBridge_3203", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } }, { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/bridgeinterface/query/fields": { "get": { "tags": [ "Monitoring - Bridge" ], "description": "Get query fields", "operationId": "getStatQueryFields_MonitoringBridge_4003", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "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" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/bridgemac": { "post": { "tags": [ "Monitoring - Bridge" ], "description": "Get stats raw data", "operationId": "getStatsRawData_MonitoringBridge_2104", "parameters": [ { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order", "schema": { "type": "string" } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "field": [ { "property": "name", "sequence": 1 }, { "property": "proto", "sequence": 2 } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" }, "metrics": [ { "property": "latency", "type": "avg" }, { "property": "loss", "type": "avg" }, { "property": "loss_percentage", "type": "avg" }, { "property": "vqoe_score", "type": "avg" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "lte", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.106.1", "local_color": "lte", "src_ip": "10.1.15.15", "sla_class_names": "test_sla_class", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400052, "state": "Up", "local_system_ip": "172.16.255.15", "tenant": "default", "entry_time": 1589073783045, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.15", "fec_rx": 0, "src_port": 12366, "jitter": 1, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.15", "proto": "IPSEC", "vip_idx": 351, "dst_port": 12386, "name": "172.16.255.15:lte-172.16.255.16:lte", "sla_class_list": "0,1", "tunnel_color": "lte:lte", "host_name": "vm5", "id": "IuBG_HEB_JLsavezVkiZ" } ], "pageInfo": { "startTime": "1589073783045", "endTime": "1589072535795", "count": 15 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "get": { "tags": [ "Monitoring - Bridge" ], "description": "Get stats raw data", "operationId": "getStatDataRawData_MonitoringBridge_2103", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "metrics": [ { "property": "latency", "type": "avg" } ] } } }, { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by(emp:entry_time)", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "3g", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.101.2", "local_color": "lte", "src_ip": "10.1.14.14", "sla_class_names": "None", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400056, "state": "Up", "local_system_ip": "172.16.255.14", "tenant": "default", "entry_time": 1589073792008, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.14", "fec_rx": 0, "src_port": 12380, "jitter": 1, "remote_system_ip": "172.16.255.11", "vdevice_name": "172.16.255.14", "proto": "IPSEC", "vip_idx": 190, "dst_port": 12366, "name": "172.16.255.14:lte-172.16.255.11:3g", "sla_class_list": "0", "tunnel_color": "3g:lte", "host_name": "vm4", "id": "4OBG_HEB_JLsavezVUfr" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/bridgemac/aggregation": { "get": { "tags": [ "Monitoring - Bridge" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getAggregationDataByQuery_MonitoringBridge_3303", "parameters": [ { "name": "query", "in": "query", "description": "Query filter", "schema": { "type": "string" }, "examples": { "query string": {} } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "post": { "tags": [ "Monitoring - Bridge" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationDataByQuery_MonitoringBridge_3304", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default,dca" } }, "/statistics/bridgemac/csv": { "get": { "tags": [ "Monitoring - Bridge" ], "description": "Get raw data with optional query as CSV", "operationId": "getStatDataRawDataAsCSV_MonitoringBridge_2503", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" }, "examples": { "Search result in csv format": { "description": "Search result in csv format", "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/bridgemac/doccount": { "get": { "tags": [ "Monitoring - Bridge" ], "description": "Get response count of a query", "operationId": "getCount_MonitoringBridge_3003", "parameters": [ { "name": "query", "in": "query", "description": "Query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 17193 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Monitoring - Bridge" ], "description": "Get response count of a query", "operationId": "getCountPost_MonitoringBridge_3004", "requestBody": { "description": "Query", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query": { "description": "Query", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 9642 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/bridgemac/fields": { "get": { "tags": [ "Monitoring - Bridge" ], "description": "Get fields and type", "operationId": "getStatDataFields_MonitoringBridge_2803", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "example": [ { "dataType": "string", "property": "mac" }, { "dataType": "string", "property": "vap" }, { "dataType": "number", "property": "rssi" }, { "dataType": "string", "property": "mode" }, { "dataType": "number", "property": "bandwidth" }, { "dataType": "string", "property": "data_security" }, { "dataType": "number", "property": "rx_rate" }, { "dataType": "string", "property": "assoc_time" }, { "dataType": "date", "property": "entry_time" }, { "dataType": "date", "property": "statcycletime" }, { "dataType": "string", "property": "ssid" }, { "dataType": "number", "property": "vip_idx" }, { "dataType": "date", "property": "vip_time" }, { "dataType": "string", "property": "vdevice_name" }, { "dataType": "string", "property": "host_name" }, { "dataType": "string", "property": "device_model" } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/bridgemac/page": { "post": { "tags": [ "Monitoring - Bridge" ], "description": "Get stats raw data", "operationId": "getPostStatsPaginationRawData_MonitoringBridge_2604", "parameters": [ { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" }, "get": { "tags": [ "Monitoring - Bridge" ], "description": "Get stats raw data", "operationId": "getStatsPaginationRawData_MonitoringBridge_2603", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } }, { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/bridgemac/query/fields": { "get": { "tags": [ "Monitoring - Bridge" ], "description": "Get query fields", "operationId": "getStatQueryFields_MonitoringBridge_3403", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "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" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/cflowd": { "post": { "tags": [ "Monitoring - Cflowd" ], "description": "Get stats raw data", "operationId": "getStatsRawData_MonitoringCflowd_1804", "parameters": [ { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order", "schema": { "type": "string" } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "field": [ { "property": "name", "sequence": 1 }, { "property": "proto", "sequence": 2 } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" }, "metrics": [ { "property": "latency", "type": "avg" }, { "property": "loss", "type": "avg" }, { "property": "loss_percentage", "type": "avg" }, { "property": "vqoe_score", "type": "avg" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "lte", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.106.1", "local_color": "lte", "src_ip": "10.1.15.15", "sla_class_names": "test_sla_class", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400052, "state": "Up", "local_system_ip": "172.16.255.15", "tenant": "default", "entry_time": 1589073783045, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.15", "fec_rx": 0, "src_port": 12366, "jitter": 1, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.15", "proto": "IPSEC", "vip_idx": 351, "dst_port": 12386, "name": "172.16.255.15:lte-172.16.255.16:lte", "sla_class_list": "0,1", "tunnel_color": "lte:lte", "host_name": "vm5", "id": "IuBG_HEB_JLsavezVkiZ" } ], "pageInfo": { "startTime": "1589073783045", "endTime": "1589072535795", "count": 15 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "default" }, "get": { "tags": [ "Monitoring - Cflowd" ], "description": "Get stats raw data", "operationId": "getStatDataRawData_MonitoringCflowd_1803", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "metrics": [ { "property": "latency", "type": "avg" } ] } } }, { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by(emp:entry_time)", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "3g", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.101.2", "local_color": "lte", "src_ip": "10.1.14.14", "sla_class_names": "None", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400056, "state": "Up", "local_system_ip": "172.16.255.14", "tenant": "default", "entry_time": 1589073792008, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.14", "fec_rx": 0, "src_port": 12380, "jitter": 1, "remote_system_ip": "172.16.255.11", "vdevice_name": "172.16.255.14", "proto": "IPSEC", "vip_idx": 190, "dst_port": 12366, "name": "172.16.255.14:lte-172.16.255.11:3g", "sla_class_list": "0", "tunnel_color": "3g:lte", "host_name": "vm4", "id": "4OBG_HEB_JLsavezVUfr" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "default" } }, "/statistics/cflowd/aggregation": { "post": { "tags": [ "Monitoring - Cflowd" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationDataByQuery_MonitoringCflowd_3004", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "default,dca" }, "get": { "tags": [ "Monitoring - Cflowd" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getAggregationDataByQuery_MonitoringCflowd_3003", "parameters": [ { "name": "query", "in": "query", "description": "Query filter", "schema": { "type": "string" }, "examples": { "query string": {} } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "default" } }, "/statistics/cflowd/csv": { "get": { "tags": [ "Monitoring - Cflowd" ], "description": "Get raw data with optional query as CSV", "operationId": "getStatDataRawDataAsCSV_MonitoringCflowd_2203", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" }, "examples": { "Search result in csv format": { "description": "Search result in csv format", "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "default" } }, "/statistics/cflowd/doccount": { "post": { "tags": [ "Monitoring - Cflowd" ], "description": "Get response count of a query", "operationId": "getCountPost_MonitoringCflowd_2704", "requestBody": { "description": "Query", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query": { "description": "Query", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 9642 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true }, "get": { "tags": [ "Monitoring - Cflowd" ], "description": "Get response count of a query", "operationId": "getCount_MonitoringCflowd_2703", "parameters": [ { "name": "query", "in": "query", "description": "Query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 17193 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/statistics/cflowd/fields": { "get": { "tags": [ "Monitoring - Cflowd" ], "description": "Get fields and type", "operationId": "getStatDataFields_MonitoringCflowd_2503", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "example": [ { "dataType": "string", "property": "mac" }, { "dataType": "string", "property": "vap" }, { "dataType": "number", "property": "rssi" }, { "dataType": "string", "property": "mode" }, { "dataType": "number", "property": "bandwidth" }, { "dataType": "string", "property": "data_security" }, { "dataType": "number", "property": "rx_rate" }, { "dataType": "string", "property": "assoc_time" }, { "dataType": "date", "property": "entry_time" }, { "dataType": "date", "property": "statcycletime" }, { "dataType": "string", "property": "ssid" }, { "dataType": "number", "property": "vip_idx" }, { "dataType": "date", "property": "vip_time" }, { "dataType": "string", "property": "vdevice_name" }, { "dataType": "string", "property": "host_name" }, { "dataType": "string", "property": "device_model" } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/statistics/cflowd/page": { "get": { "tags": [ "Monitoring - Cflowd" ], "description": "Get stats raw data", "operationId": "getStatsPaginationRawData_MonitoringCflowd_2303", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } }, { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Device Monitoring-read" }, "post": { "tags": [ "Monitoring - Cflowd" ], "description": "Get stats raw data", "operationId": "getPostStatsPaginationRawData_MonitoringCflowd_2304", "parameters": [ { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Device Monitoring-read" } }, "/statistics/cflowd/query/fields": { "get": { "tags": [ "Monitoring - Cflowd" ], "description": "Get query fields", "operationId": "getStatQueryFields_MonitoringCflowd_3103", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "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" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/statistics/cloudx": { "post": { "tags": [ "Monitoring - CloudExpress" ], "description": "Get stats raw data", "operationId": "getStatsRawData_MonitoringCloudexpress_1804", "parameters": [ { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order", "schema": { "type": "string" } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "field": [ { "property": "name", "sequence": 1 }, { "property": "proto", "sequence": 2 } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" }, "metrics": [ { "property": "latency", "type": "avg" }, { "property": "loss", "type": "avg" }, { "property": "loss_percentage", "type": "avg" }, { "property": "vqoe_score", "type": "avg" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "lte", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.106.1", "local_color": "lte", "src_ip": "10.1.15.15", "sla_class_names": "test_sla_class", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400052, "state": "Up", "local_system_ip": "172.16.255.15", "tenant": "default", "entry_time": 1589073783045, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.15", "fec_rx": 0, "src_port": 12366, "jitter": 1, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.15", "proto": "IPSEC", "vip_idx": 351, "dst_port": 12386, "name": "172.16.255.15:lte-172.16.255.16:lte", "sla_class_list": "0,1", "tunnel_color": "lte:lte", "host_name": "vm5", "id": "IuBG_HEB_JLsavezVkiZ" } ], "pageInfo": { "startTime": "1589073783045", "endTime": "1589072535795", "count": 15 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "get": { "tags": [ "Monitoring - CloudExpress" ], "description": "Get stats raw data", "operationId": "getStatDataRawData_MonitoringCloudexpress_1803", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "metrics": [ { "property": "latency", "type": "avg" } ] } } }, { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by(emp:entry_time)", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "3g", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.101.2", "local_color": "lte", "src_ip": "10.1.14.14", "sla_class_names": "None", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400056, "state": "Up", "local_system_ip": "172.16.255.14", "tenant": "default", "entry_time": 1589073792008, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.14", "fec_rx": 0, "src_port": 12380, "jitter": 1, "remote_system_ip": "172.16.255.11", "vdevice_name": "172.16.255.14", "proto": "IPSEC", "vip_idx": 190, "dst_port": 12366, "name": "172.16.255.14:lte-172.16.255.11:3g", "sla_class_list": "0", "tunnel_color": "3g:lte", "host_name": "vm4", "id": "4OBG_HEB_JLsavezVUfr" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/cloudx/aggregation": { "get": { "tags": [ "Monitoring - CloudExpress" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getAggregationDataByQuery_MonitoringCloudexpress_3003", "parameters": [ { "name": "query", "in": "query", "description": "Query filter", "schema": { "type": "string" }, "examples": { "query string": {} } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "post": { "tags": [ "Monitoring - CloudExpress" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationDataByQuery_MonitoringCloudexpress_3004", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default,dca" } }, "/statistics/cloudx/csv": { "get": { "tags": [ "Monitoring - CloudExpress" ], "description": "Get raw data with optional query as CSV", "operationId": "getStatDataRawDataAsCSV_MonitoringCloudexpress_2203", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" }, "examples": { "Search result in csv format": { "description": "Search result in csv format", "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/cloudx/doccount": { "get": { "tags": [ "Monitoring - CloudExpress" ], "description": "Get response count of a query", "operationId": "getCount_MonitoringCloudexpress_2703", "parameters": [ { "name": "query", "in": "query", "description": "Query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 17193 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Monitoring - CloudExpress" ], "description": "Get response count of a query", "operationId": "getCountPost_MonitoringCloudexpress_2704", "requestBody": { "description": "Query", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query": { "description": "Query", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 9642 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/cloudx/fields": { "get": { "tags": [ "Monitoring - CloudExpress" ], "description": "Get fields and type", "operationId": "getStatDataFields_MonitoringCloudexpress_2503", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "example": [ { "dataType": "string", "property": "mac" }, { "dataType": "string", "property": "vap" }, { "dataType": "number", "property": "rssi" }, { "dataType": "string", "property": "mode" }, { "dataType": "number", "property": "bandwidth" }, { "dataType": "string", "property": "data_security" }, { "dataType": "number", "property": "rx_rate" }, { "dataType": "string", "property": "assoc_time" }, { "dataType": "date", "property": "entry_time" }, { "dataType": "date", "property": "statcycletime" }, { "dataType": "string", "property": "ssid" }, { "dataType": "number", "property": "vip_idx" }, { "dataType": "date", "property": "vip_time" }, { "dataType": "string", "property": "vdevice_name" }, { "dataType": "string", "property": "host_name" }, { "dataType": "string", "property": "device_model" } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/cloudx/page": { "get": { "tags": [ "Monitoring - CloudExpress" ], "description": "Get stats raw data", "operationId": "getStatsPaginationRawData_MonitoringCloudexpress_2303", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } }, { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" }, "post": { "tags": [ "Monitoring - CloudExpress" ], "description": "Get stats raw data", "operationId": "getPostStatsPaginationRawData_MonitoringCloudexpress_2304", "parameters": [ { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/cloudx/query/fields": { "get": { "tags": [ "Monitoring - CloudExpress" ], "description": "Get query fields", "operationId": "getStatQueryFields_MonitoringCloudexpress_3103", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "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" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/collect": { "get": { "tags": [ "Monitoring - Stats Processing" ], "description": "Start stats collect", "operationId": "startStatsCollection", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Status": { "description": "Status", "value": { "ActivateDataCollection": "success" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/collect/thread/status": { "get": { "tags": [ "Monitoring - Stats Processing" ], "description": "Get stats collect thread report", "operationId": "generateStatsCollectThreadReport", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Process thread report": { "description": "Process thread report", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "admin" } }, "/statistics/collection/reset/{processQueue}": { "get": { "tags": [ "Monitoring - Stats Processing" ], "description": "Reset stats collect thread report", "operationId": "resetStatsCollection", "parameters": [ { "name": "processQueue", "in": "path", "description": "Process queue", "required": true, "schema": { "maximum": 4, "minimum": -1, "type": "integer", "format": "int64", "default": -1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Status": { "description": "Status", "value": { "statisticsCollectionReset": "success" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "admin" } }, "/statistics/cryptovpn/common": { "post": { "tags": [ "Monitoring - Crypto VPN" ], "summary": "crypto vpn common data", "description": "Get crypto vpn common data ", "operationId": "getPostCryptoDataByQuery", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "crypto common query": { "description": "crypto common query", "value": { "aggregation": { "field": [ { "property": "host_name", "sequence": 1 } ], "metrics": [ { "property": "entry_time", "type": "top_hits", "size": 1 } ] }, "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceCryptoParameterExampleCrypto" } } } }, "required": true }, "responses": { "200": { "description": "search results matching criteria", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } }, "400": { "description": "Bad Request" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write" } }, "/statistics/cryptovpn/dmvpn": { "post": { "tags": [ "Monitoring - Crypto VPN" ], "summary": "crypto vpn dmvpn data", "description": "Get crypto vpn dmvpn data ", "operationId": "getPostCryptoDMVPNDataByQuery", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "crypto dmvpn query": { "description": "crypto dmvpn query", "value": { "aggregation": { "field": [ { "property": "idb", "sequence": 1 }, { "property": "nhs_ip", "sequence": 1 } ], "metrics": [ { "property": "entry_time", "type": "top_hits", "size": 1 } ] }, "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "vm1" ], "field": "host_name", "type": "string", "operator": "in" } ] } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceCryptoParameterExampleCryptodmvpn" } } } }, "required": true }, "responses": { "200": { "description": "search results matching criteria", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } }, "400": { "description": "Bad Request" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write" } }, "/statistics/csv": { "get": { "tags": [ "Monitoring - Tunnel Health" ], "description": "Get raw data with optional query as CSV", "operationId": "getStatDataRawDataAsCSV_MonitoringTunnelHealth_1503", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" }, "examples": { "Search result in csv format": { "description": "Search result in csv format", "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/demomode": { "get": { "tags": [ "Monitoring - Stats Processing" ], "description": "Enable statistic demo mode", "operationId": "enableStatisticsDemoMode", "parameters": [ { "name": "enable", "in": "query", "description": "Demo mode flag", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Demo mode": { "description": "Demo mode", "value": { "DemoMode": "Stats collection interval: 1 minute, Stats Processing interval: 1 min" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "admin" } }, "/statistics/device": { "get": { "tags": [ "Monitoring - Device Statistics" ], "description": "Get stats raw data", "operationId": "getStatDataRawData_MonitoringDeviceStatistics_1803", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "metrics": [ { "property": "latency", "type": "avg" } ] } } }, { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by(emp:entry_time)", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "3g", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.101.2", "local_color": "lte", "src_ip": "10.1.14.14", "sla_class_names": "None", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400056, "state": "Up", "local_system_ip": "172.16.255.14", "tenant": "default", "entry_time": 1589073792008, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.14", "fec_rx": 0, "src_port": 12380, "jitter": 1, "remote_system_ip": "172.16.255.11", "vdevice_name": "172.16.255.14", "proto": "IPSEC", "vip_idx": 190, "dst_port": 12366, "name": "172.16.255.14:lte-172.16.255.11:3g", "sla_class_list": "0", "tunnel_color": "3g:lte", "host_name": "vm4", "id": "4OBG_HEB_JLsavezVUfr" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "default" }, "post": { "tags": [ "Monitoring - Device Statistics" ], "description": "Get stats raw data", "operationId": "getStatsRawData_MonitoringDeviceStatistics_1804", "parameters": [ { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order", "schema": { "type": "string" } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "field": [ { "property": "name", "sequence": 1 }, { "property": "proto", "sequence": 2 } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" }, "metrics": [ { "property": "latency", "type": "avg" }, { "property": "loss", "type": "avg" }, { "property": "loss_percentage", "type": "avg" }, { "property": "vqoe_score", "type": "avg" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "lte", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.106.1", "local_color": "lte", "src_ip": "10.1.15.15", "sla_class_names": "test_sla_class", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400052, "state": "Up", "local_system_ip": "172.16.255.15", "tenant": "default", "entry_time": 1589073783045, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.15", "fec_rx": 0, "src_port": 12366, "jitter": 1, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.15", "proto": "IPSEC", "vip_idx": 351, "dst_port": 12386, "name": "172.16.255.15:lte-172.16.255.16:lte", "sla_class_list": "0,1", "tunnel_color": "lte:lte", "host_name": "vm5", "id": "IuBG_HEB_JLsavezVkiZ" } ], "pageInfo": { "startTime": "1589073783045", "endTime": "1589072535795", "count": 15 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "default" } }, "/statistics/device/aggregation": { "post": { "tags": [ "Monitoring - Device Statistics" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationDataByQuery_MonitoringDeviceStatistics_3004", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "default,dca" }, "get": { "tags": [ "Monitoring - Device Statistics" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getAggregationDataByQuery_MonitoringDeviceStatistics_3003", "parameters": [ { "name": "query", "in": "query", "description": "Query filter", "schema": { "type": "string" }, "examples": { "query string": {} } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "default" } }, "/statistics/device/csv": { "get": { "tags": [ "Monitoring - Device Statistics" ], "description": "Get raw data with optional query as CSV", "operationId": "getStatDataRawDataAsCSV_MonitoringDeviceStatistics_2203", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" }, "examples": { "Search result in csv format": { "description": "Search result in csv format", "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "default" } }, "/statistics/device/doccount": { "post": { "tags": [ "Monitoring - Device Statistics" ], "description": "Get response count of a query", "operationId": "getCountPost_MonitoringDeviceStatistics_2704", "requestBody": { "description": "Query", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query": { "description": "Query", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 9642 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true }, "get": { "tags": [ "Monitoring - Device Statistics" ], "description": "Get response count of a query", "operationId": "getCount_MonitoringDeviceStatistics_2703", "parameters": [ { "name": "query", "in": "query", "description": "Query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 17193 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/statistics/device/fields": { "get": { "tags": [ "Monitoring - Device Statistics" ], "description": "Get fields and type", "operationId": "getStatDataFields_MonitoringDeviceStatistics_2503", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "example": [ { "dataType": "string", "property": "mac" }, { "dataType": "string", "property": "vap" }, { "dataType": "number", "property": "rssi" }, { "dataType": "string", "property": "mode" }, { "dataType": "number", "property": "bandwidth" }, { "dataType": "string", "property": "data_security" }, { "dataType": "number", "property": "rx_rate" }, { "dataType": "string", "property": "assoc_time" }, { "dataType": "date", "property": "entry_time" }, { "dataType": "date", "property": "statcycletime" }, { "dataType": "string", "property": "ssid" }, { "dataType": "number", "property": "vip_idx" }, { "dataType": "date", "property": "vip_time" }, { "dataType": "string", "property": "vdevice_name" }, { "dataType": "string", "property": "host_name" }, { "dataType": "string", "property": "device_model" } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/statistics/device/page": { "get": { "tags": [ "Monitoring - Device Statistics" ], "description": "Get stats raw data", "operationId": "getStatsPaginationRawData_MonitoringDeviceStatistics_2303", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } }, { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Device Monitoring-read" }, "post": { "tags": [ "Monitoring - Device Statistics" ], "description": "Get stats raw data", "operationId": "getPostStatsPaginationRawData_MonitoringDeviceStatistics_2304", "parameters": [ { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Device Monitoring-read" } }, "/statistics/device/query/fields": { "get": { "tags": [ "Monitoring - Device Statistics" ], "description": "Get query fields", "operationId": "getStatQueryFields_MonitoringDeviceStatistics_3103", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "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" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/statistics/devicehealth/history": { "get": { "tags": [ "Monitoring - Device Health" ], "summary": "Device health history data", "description": "Get all device health history ", "operationId": "getDeviceHealthHistory", "parameters": [ { "name": "last_n_hours", "in": "query", "schema": { "maximum": 24, "minimum": 1, "type": "integer", "format": "int32", "default": 12 } }, { "name": "site", "in": "query", "schema": { "pattern": "^[0-9]+$", "type": "string" } }, { "name": "limit", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32", "default": 30 } } ], "responses": { "200": { "description": "search results matching criteria", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "cpu_load": { "type": "number", "format": "double", "example": 1.32 }, "health": { "type": "string", "example": "good", "enum": [ "good", "fair", "poor", "n/a" ] }, "health_score": { "type": "number", "format": "double", "example": 10 }, "history": { "type": "array", "items": { "type": "object", "properties": { "data": { "type": "object", "properties": { "jitter": { "type": "number", "format": "double" }, "latency": { "type": "number", "format": "double" }, "loss_percentage": { "type": "number", "format": "double" }, "rx_octets": { "type": "number" }, "state": { "type": "string", "enum": [ "Up", "Down" ] }, "tx_octets": { "type": "number" }, "vqoe_score": { "type": "number", "format": "double" } }, "$$ref": "#/components/schemas/TunnelHealthData" }, "entry_time": { "type": "number", "example": 1657780200000 }, "health": { "type": "string", "example": "good", "enum": [ "good", "fair", "poor", "n/a" ] }, "health_score": { "type": "number", "format": "double", "example": 10 } }, "$$ref": "#/components/schemas/DeviceHealthEntryItem" } }, "host_name": { "type": "string", "example": "vm11" }, "memory_utilization": { "type": "number", "format": "double", "example": 43.03 }, "qoe": { "type": "number", "format": "double", "example": 10 }, "reachability": { "type": "string", "example": "reachable" }, "site_id": { "type": "string", "example": "600" }, "system_ip": { "type": "string", "example": "172.16.255.21" } }, "$$ref": "#/components/schemas/DeviceHealthHistoryItem" } } } } }, "400": { "description": "Bad Request" } } } }, "/statistics/devicehealth/overview/{type}": { "get": { "tags": [ "Monitoring - Device Health" ], "summary": "Device health overview data", "description": "Get all device health overview ", "operationId": "getDeviceHealthOverview", "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "pattern": "^[a-zA-Z_-]+$", "type": "string" } }, { "name": "last_n_hours", "in": "query", "schema": { "maximum": 24, "minimum": 1, "type": "integer", "format": "int32", "default": 12 } }, { "name": "site", "in": "query", "schema": { "pattern": "^[0-9]+$", "type": "string" } }, { "name": "personality", "in": "query", "schema": { "type": "string", "enum": [ "vsmart", "vbond", "vmanage", "vedge" ], "default": "vedge" } }, { "name": "limit", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32", "default": 30 } } ], "responses": { "200": { "description": "search results matching criteria", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "object", "properties": { "fair": { "type": "array", "items": { "required": [ "cpu_load", "health", "health_score", "host_name", "memory_utilization", "qoe", "reachability", "site_id", "system_ip" ], "type": "object", "properties": { "cpu_load": { "type": "number", "format": "double", "example": 1.32 }, "health": { "type": "string", "example": "good", "enum": [ "good", "fair", "poor", "n/a" ] }, "health_score": { "type": "number", "format": "double", "example": 10 }, "host_name": { "type": "string", "example": "vm11" }, "memory_utilization": { "type": "number", "format": "double", "example": 43.03 }, "qoe": { "type": "number", "format": "double", "example": 10 }, "reachability": { "type": "string", "example": "reachable" }, "site_id": { "type": "string", "example": "600" }, "system_ip": { "type": "string", "example": "172.16.255.21" } }, "$$ref": "#/components/schemas/DeviceHealthDetailItem" } }, "good": { "type": "array", "items": { "required": [ "cpu_load", "health", "health_score", "host_name", "memory_utilization", "qoe", "reachability", "site_id", "system_ip" ], "type": "object", "properties": { "cpu_load": { "type": "number", "format": "double", "example": 1.32 }, "health": { "type": "string", "example": "good", "enum": [ "good", "fair", "poor", "n/a" ] }, "health_score": { "type": "number", "format": "double", "example": 10 }, "host_name": { "type": "string", "example": "vm11" }, "memory_utilization": { "type": "number", "format": "double", "example": 43.03 }, "qoe": { "type": "number", "format": "double", "example": 10 }, "reachability": { "type": "string", "example": "reachable" }, "site_id": { "type": "string", "example": "600" }, "system_ip": { "type": "string", "example": "172.16.255.21" } }, "$$ref": "#/components/schemas/DeviceHealthDetailItem" } }, "poor": { "type": "array", "items": { "required": [ "cpu_load", "health", "health_score", "host_name", "memory_utilization", "qoe", "reachability", "site_id", "system_ip" ], "type": "object", "properties": { "cpu_load": { "type": "number", "format": "double", "example": 1.32 }, "health": { "type": "string", "example": "good", "enum": [ "good", "fair", "poor", "n/a" ] }, "health_score": { "type": "number", "format": "double", "example": 10 }, "host_name": { "type": "string", "example": "vm11" }, "memory_utilization": { "type": "number", "format": "double", "example": 43.03 }, "qoe": { "type": "number", "format": "double", "example": 10 }, "reachability": { "type": "string", "example": "reachable" }, "site_id": { "type": "string", "example": "600" }, "system_ip": { "type": "string", "example": "172.16.255.21" } }, "$$ref": "#/components/schemas/DeviceHealthDetailItem" } } }, "$$ref": "#/components/schemas/DeviceHealthOverviewDetail" }, "total": { "type": "object", "properties": { "fair": { "type": "number", "example": 100 }, "good": { "type": "number", "example": 100 }, "poor": { "type": "number", "example": 100 } }, "$$ref": "#/components/schemas/DeviceHealthOverviewTotal" } }, "$$ref": "#/components/schemas/DeviceHealthOverview" } } } }, "400": { "description": "Bad Request" } } } }, "/statistics/doccount": { "get": { "tags": [ "Monitoring - Tunnel Health" ], "description": "Get response count of a query", "operationId": "getCount_MonitoringTunnelHealth_2003", "parameters": [ { "name": "query", "in": "query", "description": "Query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 17193 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Monitoring - Tunnel Health" ], "description": "Get response count of a query", "operationId": "getCountPost_MonitoringTunnelHealth_2004", "requestBody": { "description": "Query", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query": { "description": "Query", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 9642 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/download/{processType}/fetchvManageList": { "get": { "tags": [ "Monitoring - Stats Download" ], "operationId": "fetchList", "parameters": [ { "name": "processType", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "default response", "content": { "application/json": {} } } } } }, "/statistics/download/{processType}/file/{fileType}/{queue}/{deviceIp}/{token}/{fileName}": { "get": { "tags": [ "Monitoring - Stats Download" ], "description": "Downloading stats file", "operationId": "download", "parameters": [ { "name": "processType", "in": "path", "description": "Process type", "required": true, "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "fileType", "in": "path", "description": "File type", "required": true, "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "queue", "in": "path", "description": "Queue name", "required": true, "schema": { "pattern": "^[0-9]+$", "type": "string" } }, { "name": "deviceIp", "in": "path", "description": "Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } }, { "name": "token", "in": "path", "description": "Token", "required": true, "schema": { "type": "string" } }, { "name": "fileName", "in": "path", "description": "File name", "required": true, "schema": { "pattern": "^[a-zA-Z0-9\\-_./\\\\\\s]+$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/download/{processType}/filelist": { "post": { "tags": [ "Monitoring - Stats Download" ], "description": "Downloading list of stats file", "operationId": "downloadList", "parameters": [ { "name": "processType", "in": "path", "description": "Possible types are: remoteprocessing, dr", "required": true, "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "properties": { "valueType": { "type": "string", "enum": [ "ARRAY", "OBJECT", "STRING", "NUMBER", "TRUE", "FALSE", "NULL" ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/dpi": { "get": { "tags": [ "Monitoring - DPI" ], "description": "Get DPI stats raw data", "operationId": "getDPIStatsRawData", "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } }, { "name": "page", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "schema": { "type": "string", "enum": [ "asc", "ASC", "Asc", "desc", "DESC", "Desc" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "application": { "type": "string", "example": "icmp" }, "create_time": { "type": "integer", "format": "int64", "example": 1664150420729 }, "dest_ip": { "type": "string", "example": "10.74.49.77" }, "dest_port": { "type": "integer", "format": "int32", "example": 771 }, "device_model": { "type": "string", "example": "vedge-C8000V" }, "entry_time": { "type": "integer", "format": "int64", "example": 1664150431860 }, "expire_time": { "type": "integer", "format": "int64", "example": 1664150421784 }, "family": { "type": "string", "example": "network-service" }, "host_name": { "type": "string", "example": "C8Kv-77" }, "ip_proto": { "type": "integer", "format": "int32", "example": 1 }, "octets": { "type": "integer", "format": "int32", "example": 4032 }, "packets": { "type": "integer", "format": "int32", "example": 7 }, "source_ip": { "type": "string", "example": "10.124.10.249" }, "source_port": { "type": "integer", "format": "int32", "example": 0 }, "vdevice_name": { "type": "string", "example": "1.1.70.7" }, "vip_idx": { "type": "integer", "format": "int32", "example": 172060 }, "vpn_id": { "type": "integer", "format": "int32", "example": 512 } }, "$$ref": "#/components/schemas/DPIDataObject" } }, "pageInfo": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "example": 398 }, "endTime": { "type": "string", "example": "1664148997536" }, "startTime": { "type": "string", "example": "1664159158463" } }, "$$ref": "#/components/schemas/DPIResponsePageInfo" } }, "$$ref": "#/components/schemas/DPIResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" }, "post": { "tags": [ "Monitoring - DPI" ], "description": "Get DPI stats raw data", "operationId": "getDPIStatsRawDataPost", "parameters": [ { "name": "page", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "schema": { "type": "string", "enum": [ "asc", "ASC", "Asc", "desc", "DESC", "Desc" ] } } ], "requestBody": { "description": "User", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query filter": { "description": "Query filter", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "application": { "type": "string", "example": "icmp" }, "create_time": { "type": "integer", "format": "int64", "example": 1664150420729 }, "dest_ip": { "type": "string", "example": "10.74.49.77" }, "dest_port": { "type": "integer", "format": "int32", "example": 771 }, "device_model": { "type": "string", "example": "vedge-C8000V" }, "entry_time": { "type": "integer", "format": "int64", "example": 1664150431860 }, "expire_time": { "type": "integer", "format": "int64", "example": 1664150421784 }, "family": { "type": "string", "example": "network-service" }, "host_name": { "type": "string", "example": "C8Kv-77" }, "ip_proto": { "type": "integer", "format": "int32", "example": 1 }, "octets": { "type": "integer", "format": "int32", "example": 4032 }, "packets": { "type": "integer", "format": "int32", "example": 7 }, "source_ip": { "type": "string", "example": "10.124.10.249" }, "source_port": { "type": "integer", "format": "int32", "example": 0 }, "vdevice_name": { "type": "string", "example": "1.1.70.7" }, "vip_idx": { "type": "integer", "format": "int32", "example": 172060 }, "vpn_id": { "type": "integer", "format": "int32", "example": 512 } }, "$$ref": "#/components/schemas/DPIDataObject" } }, "pageInfo": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "example": 398 }, "endTime": { "type": "string", "example": "1664148997536" }, "startTime": { "type": "string", "example": "1664159158463" } }, "$$ref": "#/components/schemas/DPIResponsePageInfo" } }, "$$ref": "#/components/schemas/DPIResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/dpi/agg-app/aggregation": { "post": { "tags": [ "Monitoring - DPI" ], "description": "Get raw aggregated data and display applications with the highest utilization for a device", "operationId": "getAggAppDataPost", "parameters": [ { "name": "site-id", "in": "query", "schema": { "pattern": "^[0-9]+$", "type": "string" } } ], "requestBody": { "description": "Query filter", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query filter": { "description": "Query filter", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "1.1.60.7" ], "field": "vdevice_name", "type": "string", "operator": "in" } ] }, "aggregation": { "field": [ { "property": "family", "size": 200, "sequence": 1 } ], "metrics": [ { "property": "octets", "type": "sum", "order": "desc" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "example": 398 }, "family": { "type": "string", "example": "network-service" }, "octets": { "type": "integer", "format": "int32", "example": 18768 } }, "$$ref": "#/components/schemas/DPIAggregationResponseData" } }, "header": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "object", "properties": { "dataType": { "type": "string", "example": "number" }, "isDisplay": { "type": "boolean" }, "property": { "type": "string", "example": "octets" }, "title": { "type": "string", "example": "Octets" } }, "$$ref": "#/components/schemas/DPIAggregationResponseHeaderColumns" } }, "fields": { "type": "array", "items": { "type": "object", "properties": { "dataType": { "type": "string", "example": "number" }, "property": { "type": "string", "example": "octets" } }, "$$ref": "#/components/schemas/DPIAggregationResponseHeaderFields" } }, "generatedOn": { "type": "integer", "format": "int64", "example": 1664160118911 } }, "$$ref": "#/components/schemas/DPIAggregationResponseHeader" } }, "$$ref": "#/components/schemas/DPIAggregationResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,RBAC VPN-read,RBAC VPN-write" } }, "/statistics/dpi/aggregation": { "get": { "tags": [ "Monitoring - DPI" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getDPIStatsAggregationData", "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "field": [ { "property": "family", "size": 200, "sequence": 1 } ], "metrics": [ { "property": "octets", "type": "sum", "order": "desc" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "example": 398 }, "family": { "type": "string", "example": "network-service" }, "octets": { "type": "integer", "format": "int32", "example": 18768 } }, "$$ref": "#/components/schemas/DPIAggregationResponseData" } }, "header": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "object", "properties": { "dataType": { "type": "string", "example": "number" }, "isDisplay": { "type": "boolean" }, "property": { "type": "string", "example": "octets" }, "title": { "type": "string", "example": "Octets" } }, "$$ref": "#/components/schemas/DPIAggregationResponseHeaderColumns" } }, "fields": { "type": "array", "items": { "type": "object", "properties": { "dataType": { "type": "string", "example": "number" }, "property": { "type": "string", "example": "octets" } }, "$$ref": "#/components/schemas/DPIAggregationResponseHeaderFields" } }, "generatedOn": { "type": "integer", "format": "int64", "example": 1664160118911 } }, "$$ref": "#/components/schemas/DPIAggregationResponseHeader" } }, "$$ref": "#/components/schemas/DPIAggregationResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" }, "post": { "tags": [ "Monitoring - DPI" ], "description": "Get raw aggregated data and display applications with the highest utilization for a device", "operationId": "getDPIStatsAggregationDataPost", "requestBody": { "description": "User", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query filter": { "description": "Query filter", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "1.1.60.7" ], "field": "vdevice_name", "type": "string", "operator": "in" } ] }, "aggregation": { "field": [ { "property": "family", "size": 200, "sequence": 1 } ], "metrics": [ { "property": "octets", "type": "sum", "order": "desc" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "example": 398 }, "family": { "type": "string", "example": "network-service" }, "octets": { "type": "integer", "format": "int32", "example": 18768 } }, "$$ref": "#/components/schemas/DPIAggregationResponseData" } }, "header": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "object", "properties": { "dataType": { "type": "string", "example": "number" }, "isDisplay": { "type": "boolean" }, "property": { "type": "string", "example": "octets" }, "title": { "type": "string", "example": "Octets" } }, "$$ref": "#/components/schemas/DPIAggregationResponseHeaderColumns" } }, "fields": { "type": "array", "items": { "type": "object", "properties": { "dataType": { "type": "string", "example": "number" }, "property": { "type": "string", "example": "octets" } }, "$$ref": "#/components/schemas/DPIAggregationResponseHeaderFields" } }, "generatedOn": { "type": "integer", "format": "int64", "example": 1664160118911 } }, "$$ref": "#/components/schemas/DPIAggregationResponseHeader" } }, "$$ref": "#/components/schemas/DPIAggregationResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,RBAC VPN-read,RBAC VPN-write" } }, "/statistics/dpi/applications": { "get": { "tags": [ "Monitoring - DPI" ], "description": "Get detailed DPI application flows list in a grid table", "operationId": "getAggAppFlows", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "application": { "type": "string", "example": "ipfix" }, "octets": { "type": "number", "example": 72535008 } }, "$$ref": "#/components/schemas/DPIAppResponseData" } }, "header": { "type": "object", "properties": { "chart": { "type": "object", "properties": { "series": { "type": "array", "items": { "type": "string" } }, "title": { "type": "string", "example": "view.statistics.clientViewDpiApplication.dpiApplication" }, "xAxis": { "type": "array", "items": { "type": "string" } }, "xAxisLabel": { "type": "string", "example": "view.statistics.clientViewDpiApplication.time" }, "yAxis": { "type": "array", "items": { "type": "string" } }, "yAxisLabel": { "type": "string", "example": "view.statistics.clientViewDpiApplication.count" } }, "$$ref": "#/components/schemas/DPIAppResponseHeaderChart" }, "columns": { "type": "array", "items": { "type": "object", "properties": { "dataType": { "type": "string", "example": "string" }, "hideable": { "type": "boolean" }, "property": { "type": "string", "example": "application" }, "title": { "type": "string", "example": "Application" } }, "$$ref": "#/components/schemas/DPIAppResponseHeaderColumns" } }, "fields": { "type": "array", "items": { "type": "object", "properties": { "dataType": { "type": "string", "example": "string" }, "property": { "type": "string", "example": "application" } }, "$$ref": "#/components/schemas/DPIAppResponseHeaderFields" } }, "generatedOn": { "type": "number", "example": 1664506834428 }, "viewKeys": { "type": "object", "properties": { "preferenceKey": { "type": "string", "example": "grid-dpi_applications" }, "uniqueKey": { "type": "array", "items": { "type": "string" } } }, "$$ref": "#/components/schemas/DPIAppResponseHeaderViewKeys" } }, "$$ref": "#/components/schemas/DPIAppResponseHeader" } }, "$$ref": "#/components/schemas/DPIAppResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,RBAC VPN-read" } }, "/statistics/dpi/applications/summary": { "get": { "tags": [ "Monitoring - DPI" ], "description": "Get detailed DPI application flows summary", "operationId": "getAggAppFlowsSummary", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "site-id", "in": "query", "schema": { "pattern": "^[0-9]+$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "application": { "type": "string", "example": "ipfix" }, "octets": { "type": "number", "example": 72535008 } }, "$$ref": "#/components/schemas/DPIAppResponseData" } }, "header": { "type": "object", "properties": { "chart": { "type": "object", "properties": { "series": { "type": "array", "items": { "type": "string" } }, "title": { "type": "string", "example": "view.statistics.clientViewDpiApplication.dpiApplication" }, "xAxis": { "type": "array", "items": { "type": "string" } }, "xAxisLabel": { "type": "string", "example": "view.statistics.clientViewDpiApplication.time" }, "yAxis": { "type": "array", "items": { "type": "string" } }, "yAxisLabel": { "type": "string", "example": "view.statistics.clientViewDpiApplication.count" } }, "$$ref": "#/components/schemas/DPIAppResponseHeaderChart" }, "columns": { "type": "array", "items": { "type": "object", "properties": { "dataType": { "type": "string", "example": "string" }, "hideable": { "type": "boolean" }, "property": { "type": "string", "example": "application" }, "title": { "type": "string", "example": "Application" } }, "$$ref": "#/components/schemas/DPIAppResponseHeaderColumns" } }, "fields": { "type": "array", "items": { "type": "object", "properties": { "dataType": { "type": "string", "example": "string" }, "property": { "type": "string", "example": "application" } }, "$$ref": "#/components/schemas/DPIAppResponseHeaderFields" } }, "generatedOn": { "type": "number", "example": 1664506834428 }, "viewKeys": { "type": "object", "properties": { "preferenceKey": { "type": "string", "example": "grid-dpi_applications" }, "uniqueKey": { "type": "array", "items": { "type": "string" } } }, "$$ref": "#/components/schemas/DPIAppResponseHeaderViewKeys" } }, "$$ref": "#/components/schemas/DPIAppResponseHeader" } }, "$$ref": "#/components/schemas/DPIAppResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/dpi/csv": { "get": { "tags": [ "Monitoring - DPI" ], "description": "Get raw data with optional query as CSV", "operationId": "getDPIStatsRawDataAsCSV", "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/dpi/device/application/flowcount": { "get": { "tags": [ "Monitoring - DPI" ], "description": "Get application flow count per tunnel", "operationId": "getDPIDeviceAppUniqueFlowCount", "parameters": [ { "name": "deviceId", "in": "query", "required": true, "schema": { "pattern": "^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)((\\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)?$", "type": "string" } }, { "name": "interval", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "application", "in": "query", "schema": { "type": "string" } }, { "name": "window", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "family", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/dpi/device/applications": { "get": { "tags": [ "Monitoring - DPI" ], "description": "Get DPI application flows device aggregation data", "operationId": "getDPIDeviceAppAggregationData", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "octets": { "type": "number", "example": 25554477465 }, "vdevice_name": { "type": "string", "example": "172.16.255.15" } }, "$$ref": "#/components/schemas/DeviceAppResponseData" } }, "header": { "type": "object", "properties": { "chart": { "type": "object", "properties": { "series": { "type": "array", "items": { "type": "string" } }, "title": { "type": "string", "example": "view.statistics.clientViewDpiDevices.dpiDevice" }, "xAxis": { "type": "array", "items": { "type": "string" } }, "xAxisLabel": { "type": "string", "example": "view.statistics.clientViewDpiDevices.time" }, "yAxis": { "type": "array", "items": { "type": "string" } }, "yAxisLabel": { "type": "string", "example": "view.statistics.clientViewDpiDevices.count" } }, "$$ref": "#/components/schemas/DeviceAppResponseHeaderChart" }, "columns": { "type": "array", "items": { "type": "object", "properties": { "dataType": { "type": "string", "example": "string" }, "property": { "type": "string", "example": "vdevice_name" }, "title": { "type": "string", "example": "Devices" } }, "$$ref": "#/components/schemas/DeviceAppResponseHeaderColumns" } }, "fields": { "type": "array", "items": { "type": "object", "properties": { "dataType": { "type": "string", "example": "string" }, "property": { "type": "string", "example": "vdevice_name" } }, "$$ref": "#/components/schemas/DeviceAppResponseHeaderFields" } }, "generatedOn": { "type": "number", "example": 1664507953669 }, "viewKeys": { "type": "object", "properties": { "preferenceKey": { "type": "string", "example": "grid-dpi_devices" }, "uniqueKey": { "type": "array", "items": { "type": "string" } } }, "$$ref": "#/components/schemas/DeviceAppResponseHeaderViewKeys" } }, "$$ref": "#/components/schemas/DeviceAppResponseHeader" } }, "$$ref": "#/components/schemas/DeviceAppResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,RBAC VPN-read" } }, "/statistics/dpi/device/details/applications": { "get": { "tags": [ "Monitoring - DPI" ], "description": "Get detailed DPI device and application list", "operationId": "getDPIDeviceAppDetails", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "application": { "type": "string", "example": "skydrive" }, "create_time": { "type": "number", "example": 1664442429015 }, "dest_ip": { "type": "string", "example": "13.75.134.18" }, "dest_port": { "type": "number", "example": 8248 }, "device_model": { "type": "string", "example": "vedge-C8000V" }, "entry_time": { "type": "number", "example": 1664442435015 }, "expire_time": { "type": "number", "example": 1664442441015 }, "family": { "type": "string", "example": "web" }, "host_name": { "type": "string", "example": "vm5" }, "id": { "type": "string", "example": "782FiIMBjBC8ScfIzJ8_" }, "ip_proto": { "type": "number", "example": 17 }, "octets": { "type": "number", "example": 1000000 }, "packets": { "type": "number", "example": 10000 }, "source_ip": { "type": "string", "example": "12.166.184.245" }, "source_port": { "type": "number", "example": 2 }, "vdevice_name": { "type": "string", "example": "172.16.255.15" }, "vip_idx": { "type": "number", "example": 1 }, "vpn_id": { "type": "number", "example": 1 } }, "$$ref": "#/components/schemas/DeviceAppDetailResponseData" } }, "header": { "type": "object", "properties": { "chart": { "type": "object", "properties": { "series": { "type": "array", "items": { "type": "string" } }, "title": { "type": "string", "example": "view.statistics.viewDpiDevicesDetails.dpiDeviceAppli" }, "xAxis": { "type": "array", "items": { "type": "string" } }, "xAxisLabel": { "type": "string", "example": "view.statistics.viewDpiDevicesDetails.time" }, "yAxis": { "type": "array", "items": { "type": "string" } }, "yAxisLabel": { "type": "string", "example": "view.statistics.viewDpiDevicesDetails.count" } }, "$$ref": "#/components/schemas/DeviceAppDetailResponseHeaderChart" }, "columns": { "type": "array", "items": { "type": "object", "properties": { "dataType": { "type": "string", "example": "string" }, "property": { "type": "string", "example": "vdevice_name" }, "title": { "type": "string", "example": "Devices" } }, "$$ref": "#/components/schemas/DeviceAppResponseHeaderColumns" } }, "fields": { "type": "array", "items": { "type": "object", "properties": { "dataType": { "type": "string", "example": "string" }, "property": { "type": "string", "example": "vdevice_name" } }, "$$ref": "#/components/schemas/DeviceAppResponseHeaderFields" } }, "generatedOn": { "type": "number", "example": 1664508103301 }, "viewKeys": { "type": "object", "properties": { "preferenceKey": { "type": "string", "example": "grid-dpi_devices_detials" }, "uniqueKey": { "type": "array", "items": { "type": "string" } } }, "$$ref": "#/components/schemas/DeviceAppDetailResponseHeaderViewKeys" } }, "$$ref": "#/components/schemas/DeviceAppDetailResponseHeader" }, "pageInfo": { "type": "object", "properties": { "count": { "type": "number", "example": 10000 }, "endTime": { "type": "string", "example": "1664435237739" }, "startTime": { "type": "string", "example": "1664442435015" } }, "$$ref": "#/components/schemas/DeviceAppDetailResponsePageInfo" } }, "$$ref": "#/components/schemas/DeviceAppDetailResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/dpi/doccount": { "get": { "tags": [ "Monitoring - DPI" ], "description": "Get response count of a query", "operationId": "getDPIStatsCount", "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "example": 17193 } }, "$$ref": "#/components/schemas/CountResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" }, "post": { "tags": [ "Monitoring - DPI" ], "description": "Get response count of a query", "operationId": "getDPIStatsCountPost", "requestBody": { "description": "User", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query filter": { "description": "Query filter", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "example": 17193 } }, "$$ref": "#/components/schemas/CountResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/dpi/fields": { "get": { "tags": [ "Monitoring - DPI" ], "description": "Get fields and type", "operationId": "getDPIFields", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "fields": { "description": "fields", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/dpi/page": { "post": { "tags": [ "Monitoring - DPI" ], "description": "Get DPI stats pagination raw data", "operationId": "getDPIStatsPaginationRawDataPost", "parameters": [ { "name": "scrollId", "in": "query", "schema": { "type": "string" } }, { "name": "count", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "User", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query filter": { "description": "Query filter", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "application": { "type": "string", "example": "icmp" }, "create_time": { "type": "integer", "format": "int64", "example": 1664150420729 }, "dest_ip": { "type": "string", "example": "10.74.49.77" }, "dest_port": { "type": "integer", "format": "int32", "example": 771 }, "device_model": { "type": "string", "example": "vedge-C8000V" }, "entry_time": { "type": "integer", "format": "int64", "example": 1664150431860 }, "expire_time": { "type": "integer", "format": "int64", "example": 1664150421784 }, "family": { "type": "string", "example": "network-service" }, "host_name": { "type": "string", "example": "C8Kv-77" }, "ip_proto": { "type": "integer", "format": "int32", "example": 1 }, "octets": { "type": "integer", "format": "int32", "example": 4032 }, "packets": { "type": "integer", "format": "int32", "example": 7 }, "source_ip": { "type": "string", "example": "10.124.10.249" }, "source_port": { "type": "integer", "format": "int32", "example": 0 }, "vdevice_name": { "type": "string", "example": "1.1.70.7" }, "vip_idx": { "type": "integer", "format": "int32", "example": 172060 }, "vpn_id": { "type": "integer", "format": "int32", "example": 512 } }, "$$ref": "#/components/schemas/DPIDataObject" } }, "pageInfo": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "example": 100 }, "endTime": { "type": "string", "example": "1664148997536" }, "hasMoreData": { "type": "string", "example": "true" }, "scrollId": { "type": "string", "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ" }, "startTime": { "type": "string", "example": "1664159158463" }, "totalCount": { "type": "integer", "format": "int32", "example": 39802 } }, "$$ref": "#/components/schemas/DPIPaginationResponsePageInfo" } }, "$$ref": "#/components/schemas/DPIPaginationResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,RBAC VPN-read,RBAC VPN-write" }, "get": { "tags": [ "Monitoring - DPI" ], "description": "Get DPI stats pagination raw data", "operationId": "getDPIStatsPaginationRawData", "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } }, { "name": "scrollId", "in": "query", "schema": { "type": "string" } }, { "name": "count", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "application": { "type": "string", "example": "icmp" }, "create_time": { "type": "integer", "format": "int64", "example": 1664150420729 }, "dest_ip": { "type": "string", "example": "10.74.49.77" }, "dest_port": { "type": "integer", "format": "int32", "example": 771 }, "device_model": { "type": "string", "example": "vedge-C8000V" }, "entry_time": { "type": "integer", "format": "int64", "example": 1664150431860 }, "expire_time": { "type": "integer", "format": "int64", "example": 1664150421784 }, "family": { "type": "string", "example": "network-service" }, "host_name": { "type": "string", "example": "C8Kv-77" }, "ip_proto": { "type": "integer", "format": "int32", "example": 1 }, "octets": { "type": "integer", "format": "int32", "example": 4032 }, "packets": { "type": "integer", "format": "int32", "example": 7 }, "source_ip": { "type": "string", "example": "10.124.10.249" }, "source_port": { "type": "integer", "format": "int32", "example": 0 }, "vdevice_name": { "type": "string", "example": "1.1.70.7" }, "vip_idx": { "type": "integer", "format": "int32", "example": 172060 }, "vpn_id": { "type": "integer", "format": "int32", "example": 512 } }, "$$ref": "#/components/schemas/DPIDataObject" } }, "pageInfo": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "example": 100 }, "endTime": { "type": "string", "example": "1664148997536" }, "hasMoreData": { "type": "string", "example": "true" }, "scrollId": { "type": "string", "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ" }, "startTime": { "type": "string", "example": "1664159158463" }, "totalCount": { "type": "integer", "format": "int32", "example": 39802 } }, "$$ref": "#/components/schemas/DPIPaginationResponsePageInfo" } }, "$$ref": "#/components/schemas/DPIPaginationResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/dpi/pktdup/aggregation": { "post": { "tags": [ "Monitoring - DPI" ], "description": "Get time series aggregation data for packet duplication for an application over TLOCs if available", "operationId": "getDPIStatsAggregationDataForPacketDup", "requestBody": { "description": "User", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query filter": { "description": "Query filter", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "string" } }, "header": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "string" } }, "fields": { "type": "array", "items": { "type": "string" } }, "generatedOn": { "type": "number", "example": 1664508540280 } }, "$$ref": "#/components/schemas/FecAndPktDupResponseHeader" } }, "$$ref": "#/components/schemas/FecAndPktDupResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/dpi/query/fields": { "get": { "tags": [ "Monitoring - DPI" ], "description": "Get query fields", "operationId": "getDPIQueryFields", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "fields": { "description": "fields", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/dpi/recovery/aggregation": { "post": { "tags": [ "Monitoring - DPI" ], "description": "Get aggregation data and fec recovery rate if available", "operationId": "getDPIStatsAggregationDataForFec", "requestBody": { "description": "User", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query filter": { "description": "Query filter", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "string" } }, "header": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "string" } }, "fields": { "type": "array", "items": { "type": "string" } }, "generatedOn": { "type": "number", "example": 1664508540280 } }, "$$ref": "#/components/schemas/FecAndPktDupResponseHeader" } }, "$$ref": "#/components/schemas/FecAndPktDupResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,RBAC VPN-read,RBAC VPN-write" } }, "/statistics/eiolte": { "get": { "tags": [ "Monitoring - Cellular-EIOLTE" ], "description": "Get stats raw data", "operationId": "getStatDataRawData_MonitoringCellularEiolte_1803", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "metrics": [ { "property": "latency", "type": "avg" } ] } } }, { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by(emp:entry_time)", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "3g", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.101.2", "local_color": "lte", "src_ip": "10.1.14.14", "sla_class_names": "None", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400056, "state": "Up", "local_system_ip": "172.16.255.14", "tenant": "default", "entry_time": 1589073792008, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.14", "fec_rx": 0, "src_port": 12380, "jitter": 1, "remote_system_ip": "172.16.255.11", "vdevice_name": "172.16.255.14", "proto": "IPSEC", "vip_idx": 190, "dst_port": 12366, "name": "172.16.255.14:lte-172.16.255.11:3g", "sla_class_list": "0", "tunnel_color": "3g:lte", "host_name": "vm4", "id": "4OBG_HEB_JLsavezVUfr" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "post": { "tags": [ "Monitoring - Cellular-EIOLTE" ], "description": "Get stats raw data", "operationId": "getStatsRawData_MonitoringCellularEiolte_1804", "parameters": [ { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order", "schema": { "type": "string" } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "field": [ { "property": "name", "sequence": 1 }, { "property": "proto", "sequence": 2 } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" }, "metrics": [ { "property": "latency", "type": "avg" }, { "property": "loss", "type": "avg" }, { "property": "loss_percentage", "type": "avg" }, { "property": "vqoe_score", "type": "avg" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "lte", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.106.1", "local_color": "lte", "src_ip": "10.1.15.15", "sla_class_names": "test_sla_class", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400052, "state": "Up", "local_system_ip": "172.16.255.15", "tenant": "default", "entry_time": 1589073783045, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.15", "fec_rx": 0, "src_port": 12366, "jitter": 1, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.15", "proto": "IPSEC", "vip_idx": 351, "dst_port": 12386, "name": "172.16.255.15:lte-172.16.255.16:lte", "sla_class_list": "0,1", "tunnel_color": "lte:lte", "host_name": "vm5", "id": "IuBG_HEB_JLsavezVkiZ" } ], "pageInfo": { "startTime": "1589073783045", "endTime": "1589072535795", "count": 15 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/eiolte/aggregation": { "get": { "tags": [ "Monitoring - Cellular-EIOLTE" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getAggregationDataByQuery_MonitoringCellularEiolte_3003", "parameters": [ { "name": "query", "in": "query", "description": "Query filter", "schema": { "type": "string" }, "examples": { "query string": {} } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "post": { "tags": [ "Monitoring - Cellular-EIOLTE" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationDataByQuery_MonitoringCellularEiolte_3004", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default,dca" } }, "/statistics/eiolte/cellularAggregation": { "post": { "tags": [ "Monitoring - Cellular-EIOLTE" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "cellularAggregation", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregation": { "type": "object", "properties": { "field": { "type": "array", "items": { "required": [ "property", "size" ], "type": "object", "properties": { "order": { "type": "string", "enum": [ "asc", "desc" ] }, "orderType": { "type": "string", "writeOnly": true, "enum": [ "key", "count" ] }, "property": { "type": "object" }, "sequence": { "type": "integer", "format": "int32" }, "size": { "type": "integer", "format": "int32" }, "type": { "type": "string" } }, "$$ref": "#/components/schemas/DBQueryAggregationFieldObject" } }, "histogram": { "required": [ "order", "property", "type" ], "type": "object", "properties": { "interval": { "type": "integer", "format": "int32" }, "mindoccount": { "type": "integer", "format": "int64" }, "order": { "type": "string", "enum": [ "asc", "desc" ] }, "property": { "type": "object" }, "type": { "type": "string", "enum": [ "year", "quarter", "month", "week", "day", "hour", "minute", "second" ] } }, "$$ref": "#/components/schemas/DBQueryAggregationHistogramObject" }, "metrics": { "type": "array", "items": { "required": [ "property", "type" ], "type": "object", "properties": { "order": { "type": "string" }, "property": { "type": "object" }, "sequence": { "type": "string" }, "size": { "type": "string" }, "type": { "type": "string", "enum": [ "avg", "avgIf", "count", "sum", "max", "min", "cardinality", "top_hits", "argMax", "groupBitOr" ] } }, "$$ref": "#/components/schemas/DBQueryAggregationMetricObject" } } }, "$$ref": "#/components/schemas/DBQueryAggregationObject" }, "category": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object" } }, "plot_data": { "type": "array", "items": { "type": "string" } }, "query": { "required": [ "rules" ], "type": "object", "properties": { "condition": { "type": "string", "enum": [ "AND", "OR" ] }, "field": { "type": "object" }, "operator": { "type": "string", "enum": [ "between", "in", "not_in", "equal", "not_equal", "less_or_equal", "greater", "greater_or_equal", "less", "last_n_hours", "last_n_days", "last_n_weeks", "hasAny", "starts_with", "last_n_minutes" ] }, "rules": { "type": "array", "items": { "type": "object", "properties": { "condition": { "type": "string", "enum": [ "AND", "OR" ] }, "field": { "type": "object" }, "operator": { "type": "string", "enum": [ "between", "in", "not_in", "equal", "not_equal", "less_or_equal", "greater", "greater_or_equal", "less", "last_n_hours", "last_n_days", "last_n_weeks", "hasAny", "starts_with", "last_n_minutes" ] }, "rules": { "type": "array", "items": { "$ref": "#/components/schemas/DBQueryRuleObject", "$$ref": "#/components/schemas/DBQueryRuleObject" } }, "type": { "type": "string", "enum": [ "int", "string", "long", "double", "date", "specialString", "number", "array", "boolean" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "$$ref": "#/components/schemas/DBQueryRuleObject" } }, "type": { "type": "string", "enum": [ "int", "string", "long", "double", "date", "specialString", "number", "array", "boolean" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "$$ref": "#/components/schemas/DBQuerySpecObject" }, "size": { "type": "integer", "format": "int32" }, "sort": { "type": "array", "items": { "required": [ "field", "order" ], "type": "object", "properties": { "field": { "type": "object" }, "order": { "type": "string", "enum": [ "asc", "desc" ] }, "type": { "type": "string", "enum": [ "int", "string", "long", "double", "date", "specialString", "number", "array", "boolean" ] } }, "$$ref": "#/components/schemas/DBQuerySortObject" } } }, "description": "Statistics search DB Query JSON object", "$$ref": "#/components/schemas/StatisticsDBQueryParam" }, "examples": { "cellular aggregation": { "description": "cellular aggregation", "value": { "query": { "condition": "AND", "rules": [ { "field": "entry_time", "type": "date", "value": [ "1" ], "operator": "last_n_hours" }, { "field": "rat", "type": "string", "value": [ "Unknown" ], "operator": "not_equal" }, { "field": "bandclass", "type": "string", "value": [ "Unknown" ], "operator": "not_equal" } ] }, "aggregation": { "field": [ { "sequence": 1, "orderType": "count", "size": 5000, "property": "carrier", "order": "desc" }, { "sequence": 2, "orderType": "count", "size": 5000, "property": "host_name", "order": "desc" }, { "sequence": 1, "size": 5000, "property": "vdevice_name", "order": "desc" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Carrier List": { "description": "Carrier List", "value": { "data": [ { "carrier": "Test PLMN 1-1", "vdevice_name": "172.16.255.101", "host_name": "pm1-Slot2", "count": 86 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default,dca" } }, "/statistics/eiolte/csv": { "get": { "tags": [ "Monitoring - Cellular-EIOLTE" ], "description": "Get raw data with optional query as CSV", "operationId": "getStatDataRawDataAsCSV_MonitoringCellularEiolte_2203", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" }, "examples": { "Search result in csv format": { "description": "Search result in csv format", "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/eiolte/doccount": { "get": { "tags": [ "Monitoring - Cellular-EIOLTE" ], "description": "Get response count of a query", "operationId": "getCount_MonitoringCellularEiolte_2703", "parameters": [ { "name": "query", "in": "query", "description": "Query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 17193 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Monitoring - Cellular-EIOLTE" ], "description": "Get response count of a query", "operationId": "getCountPost_MonitoringCellularEiolte_2704", "requestBody": { "description": "Query", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query": { "description": "Query", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 9642 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/eiolte/fields": { "get": { "tags": [ "Monitoring - Cellular-EIOLTE" ], "description": "Get fields and type", "operationId": "getStatDataFields_MonitoringCellularEiolte_2503", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "example": [ { "dataType": "string", "property": "mac" }, { "dataType": "string", "property": "vap" }, { "dataType": "number", "property": "rssi" }, { "dataType": "string", "property": "mode" }, { "dataType": "number", "property": "bandwidth" }, { "dataType": "string", "property": "data_security" }, { "dataType": "number", "property": "rx_rate" }, { "dataType": "string", "property": "assoc_time" }, { "dataType": "date", "property": "entry_time" }, { "dataType": "date", "property": "statcycletime" }, { "dataType": "string", "property": "ssid" }, { "dataType": "number", "property": "vip_idx" }, { "dataType": "date", "property": "vip_time" }, { "dataType": "string", "property": "vdevice_name" }, { "dataType": "string", "property": "host_name" }, { "dataType": "string", "property": "device_model" } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/eiolte/page": { "get": { "tags": [ "Monitoring - Cellular-EIOLTE" ], "description": "Get stats raw data", "operationId": "getStatsPaginationRawData_MonitoringCellularEiolte_2303", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } }, { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" }, "post": { "tags": [ "Monitoring - Cellular-EIOLTE" ], "description": "Get stats raw data", "operationId": "getPostStatsPaginationRawData_MonitoringCellularEiolte_2304", "parameters": [ { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/eiolte/query/fields": { "get": { "tags": [ "Monitoring - Cellular-EIOLTE" ], "description": "Get query fields", "operationId": "getStatQueryFields_MonitoringCellularEiolte_3103", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "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" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/eiolte/uniqueAggregation": { "post": { "tags": [ "Monitoring - Cellular-EIOLTE" ], "description": "Get unique aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "uniqueAggregation", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregation": { "type": "object", "properties": { "field": { "type": "array", "items": { "required": [ "property", "size" ], "type": "object", "properties": { "order": { "type": "string", "enum": [ "asc", "desc" ] }, "orderType": { "type": "string", "writeOnly": true, "enum": [ "key", "count" ] }, "property": { "type": "object" }, "sequence": { "type": "integer", "format": "int32" }, "size": { "type": "integer", "format": "int32" }, "type": { "type": "string" } }, "$$ref": "#/components/schemas/DBQueryAggregationFieldObject" } }, "histogram": { "required": [ "order", "property", "type" ], "type": "object", "properties": { "interval": { "type": "integer", "format": "int32" }, "mindoccount": { "type": "integer", "format": "int64" }, "order": { "type": "string", "enum": [ "asc", "desc" ] }, "property": { "type": "object" }, "type": { "type": "string", "enum": [ "year", "quarter", "month", "week", "day", "hour", "minute", "second" ] } }, "$$ref": "#/components/schemas/DBQueryAggregationHistogramObject" }, "metrics": { "type": "array", "items": { "required": [ "property", "type" ], "type": "object", "properties": { "order": { "type": "string" }, "property": { "type": "object" }, "sequence": { "type": "string" }, "size": { "type": "string" }, "type": { "type": "string", "enum": [ "avg", "avgIf", "count", "sum", "max", "min", "cardinality", "top_hits", "argMax", "groupBitOr" ] } }, "$$ref": "#/components/schemas/DBQueryAggregationMetricObject" } } }, "$$ref": "#/components/schemas/DBQueryAggregationObject" }, "category": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object" } }, "plot_data": { "type": "array", "items": { "type": "string" } }, "query": { "required": [ "rules" ], "type": "object", "properties": { "condition": { "type": "string", "enum": [ "AND", "OR" ] }, "field": { "type": "object" }, "operator": { "type": "string", "enum": [ "between", "in", "not_in", "equal", "not_equal", "less_or_equal", "greater", "greater_or_equal", "less", "last_n_hours", "last_n_days", "last_n_weeks", "hasAny", "starts_with", "last_n_minutes" ] }, "rules": { "type": "array", "items": { "type": "object", "properties": { "condition": { "type": "string", "enum": [ "AND", "OR" ] }, "field": { "type": "object" }, "operator": { "type": "string", "enum": [ "between", "in", "not_in", "equal", "not_equal", "less_or_equal", "greater", "greater_or_equal", "less", "last_n_hours", "last_n_days", "last_n_weeks", "hasAny", "starts_with", "last_n_minutes" ] }, "rules": { "type": "array", "items": { "$ref": "#/components/schemas/DBQueryRuleObject", "$$ref": "#/components/schemas/DBQueryRuleObject" } }, "type": { "type": "string", "enum": [ "int", "string", "long", "double", "date", "specialString", "number", "array", "boolean" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "$$ref": "#/components/schemas/DBQueryRuleObject" } }, "type": { "type": "string", "enum": [ "int", "string", "long", "double", "date", "specialString", "number", "array", "boolean" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "$$ref": "#/components/schemas/DBQuerySpecObject" }, "size": { "type": "integer", "format": "int32" }, "sort": { "type": "array", "items": { "required": [ "field", "order" ], "type": "object", "properties": { "field": { "type": "object" }, "order": { "type": "string", "enum": [ "asc", "desc" ] }, "type": { "type": "string", "enum": [ "int", "string", "long", "double", "date", "specialString", "number", "array", "boolean" ] } }, "$$ref": "#/components/schemas/DBQuerySortObject" } } }, "description": "Statistics search DB Query JSON object", "$$ref": "#/components/schemas/StatisticsDBQueryParam" }, "examples": { "unique aggregation request": { "description": "unique aggregation request", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.101" ], "field": "vdevice_name", "type": "string", "operator": "in" }, { "value": [ "0" ], "field": "rssi", "type": "string", "operator": "not_equal" } ] }, "aggregation": { "field": [ { "property": "rsrp", "sequence": 1 }, { "property": "rsrq", "sequence": 2 }, { "property": "mcc", "sequence": 3 }, { "property": "mnc", "sequence": 4 }, { "property": "carrier", "sequence": 5 }, { "property": "rat", "sequence": 6 }, { "property": "ps_domain", "sequence": 7 }, { "property": "emm_state", "sequence": 8 }, { "property": "lteband", "sequence": 9 }, { "property": "ltebw", "sequence": 10 }, { "property": "lteca", "sequence": 11 }, { "property": "active_sim", "sequence": 12 }, { "property": "bandclass", "sequence": 13 }, { "property": "slot", "sequence": 14 } ], "metrics": [ { "property": "rssi", "type": "avg" } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" } } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceCellularEiolteCellulareioltemonitoringrestfulresourceRequestExampleUniqueaggregation" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "unique aggregation response": { "description": "unique aggregation response", "value": { "header": { "generatedOn": 1711080377596, "columns": [ { "property": "entry_time", "title": "Entry_time", "dataType": "date", "isDisplay": true }, { "property": "rssi", "title": "Rssi", "dataType": "double", "isDisplay": true }, { "property": "lteband", "title": "Lteband", "dataType": "number", "isDisplay": true }, { "property": "mnc", "title": "Mnc", "dataType": "number", "isDisplay": true }, { "property": "rat", "title": "Rat", "dataType": "string", "isDisplay": true }, { "property": "active_sim", "title": "Active_sim", "dataType": "number", "isDisplay": true }, { "property": "rsrp", "title": "Rsrp", "dataType": "number", "isDisplay": true }, { "property": "slot", "title": "Slot", "dataType": "number", "isDisplay": true }, { "property": "mcc", "title": "Mcc", "dataType": "number", "isDisplay": true }, { "property": "carrier", "title": "Carrier", "dataType": "string", "isDisplay": true }, { "property": "lteca", "title": "Lteca", "dataType": "string", "isDisplay": true }, { "property": "rsrq", "title": "Rsrq", "dataType": "number", "isDisplay": true }, { "property": "emm_state", "title": "Emm_state", "dataType": "string", "isDisplay": true }, { "property": "ltebw", "title": "Ltebw", "dataType": "string", "isDisplay": true }, { "property": "ps_domain", "title": "Ps_domain", "dataType": "string", "isDisplay": true }, { "property": "bandclass", "title": "Bandclass", "dataType": "string", "isDisplay": true } ], "fields": [ { "property": "entry_time", "dataType": "date" }, { "property": "rssi", "dataType": "double" }, { "property": "lteband", "dataType": "number" }, { "property": "mnc", "dataType": "number" }, { "property": "rat", "dataType": "string" }, { "property": "active_sim", "dataType": "number" }, { "property": "rsrp", "dataType": "number" }, { "property": "slot", "dataType": "number" }, { "property": "mcc", "dataType": "number" }, { "property": "carrier", "dataType": "string" }, { "property": "lteca", "dataType": "string" }, { "property": "rsrq", "dataType": "number" }, { "property": "emm_state", "dataType": "string" }, { "property": "ltebw", "dataType": "string" }, { "property": "ps_domain", "dataType": "string" }, { "property": "bandclass", "dataType": "string" } ] }, "entryTimeList": [ 1710993600000, 1710995400000, 1710997200000, 1710999000000, 1711000800000, 1711002600000, 1711004400000, 1711006200000, 1711008000000, 1711009800000, 1711011600000, 1711013400000, 1711015200000, 1711017000000, 1711018800000, 1711020600000, 1711022400000, 1711024200000, 1711026000000, 1711027800000, 1711029600000, 1711031400000, 1711033200000, 1711035000000, 1711036800000, 1711038600000, 1711040400000, 1711042200000, 1711044000000, 1711045800000, 1711047600000, 1711049400000, 1711051200000, 1711053000000, 1711054800000, 1711056600000, 1711058400000, 1711060200000, 1711062000000, 1711063800000, 1711065600000, 1711067400000, 1711069200000, 1711071000000, 1711072800000, 1711074600000, 1711076400000, 1711078200000, 1711080000000 ], "data": [ { "entry_time": 1710993600000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 48 }, { "entry_time": 1710995400000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1710997200000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 56 }, { "entry_time": 1710999000000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1711000800000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1711002600000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 60 }, { "entry_time": 1711004400000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1711006200000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1711008000000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1711009800000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1711011600000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 56 }, { "entry_time": 1711013400000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1711015200000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1711017000000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1711018800000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1711020600000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 60 }, { "entry_time": 1711022400000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1711024200000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 56 }, { "entry_time": 1711026000000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1711027800000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1711029600000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1711031400000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1711033200000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1711035000000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1711036800000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1711038600000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1711040400000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1711042200000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1711044000000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1711045800000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1711047600000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1711049400000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1711051200000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 56 }, { "entry_time": 1711053000000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1711054800000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 60 }, { "entry_time": 1711056600000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1711058400000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1711060200000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1711062000000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 56 }, { "entry_time": 1711063800000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1711065600000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1711067400000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1711069200000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1711071000000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1711072800000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1711074600000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1711076400000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 58 }, { "entry_time": 1711078200000, "rssi": -56, "rsrp": -83, "rsrq": -7, "mcc": 1, "mnc": 1, "carrier": "Test PLMN 1-1", "rat": "LTE", "ps_domain": "Attached", "emm_state": "Registered", "lteband": 1, "ltebw": "20Mhz", "lteca": "De-configured", "active_sim": 0, "bandclass": "LTE", "slot": 2, "count": 46 } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceCellularEiolteCellulareioltemonitoringrestfulresourceResponseExampleUniqueaggregation" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default,dca" } }, "/statistics/endpointTracker": { "post": { "tags": [ "Monitoring - Endpoint Tracker Status" ], "description": "Get stats raw data", "operationId": "getStatsRawData_MonitoringEndpointTrackerStatus_2704", "parameters": [ { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order", "schema": { "type": "string" } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "field": [ { "property": "name", "sequence": 1 }, { "property": "proto", "sequence": 2 } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" }, "metrics": [ { "property": "latency", "type": "avg" }, { "property": "loss", "type": "avg" }, { "property": "loss_percentage", "type": "avg" }, { "property": "vqoe_score", "type": "avg" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "lte", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.106.1", "local_color": "lte", "src_ip": "10.1.15.15", "sla_class_names": "test_sla_class", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400052, "state": "Up", "local_system_ip": "172.16.255.15", "tenant": "default", "entry_time": 1589073783045, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.15", "fec_rx": 0, "src_port": 12366, "jitter": 1, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.15", "proto": "IPSEC", "vip_idx": 351, "dst_port": 12386, "name": "172.16.255.15:lte-172.16.255.16:lte", "sla_class_list": "0,1", "tunnel_color": "lte:lte", "host_name": "vm5", "id": "IuBG_HEB_JLsavezVkiZ" } ], "pageInfo": { "startTime": "1589073783045", "endTime": "1589072535795", "count": 15 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "get": { "tags": [ "Monitoring - Endpoint Tracker Status" ], "description": "Get stats raw data", "operationId": "getStatDataRawData_MonitoringEndpointTrackerStatus_2703", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.15" ], "field": "vdevice_name", "type": "string", "operator": "in" } ] }, "size": 10000 } }, { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "entry_time": "1623811598645", "tracker_name": "track1", "vmanage_system_ip": "172.16.255.15", "host_name": "vm5", "vdevice_name": "172.16.255.15", "device_model": "vedge-CSR-1000v", "vpn_idx": 2, "tracker_status": "DOWN", "rtt_avg": 4, "rtt_min": 0, "rtt_max": 42, "tenant": "default", "statcycletime": "1623813001149", "id": "xELMEnoBED2frxv5D_e_" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,dca" } }, "/statistics/endpointTracker/aggregation": { "get": { "tags": [ "Monitoring - Endpoint Tracker Status" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getAggregationDataByQuery_MonitoringEndpointTrackerStatus_3903", "parameters": [ { "name": "query", "in": "query", "description": "Query filter", "schema": { "type": "string" }, "examples": { "query string": {} } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "post": { "tags": [ "Monitoring - Endpoint Tracker Status" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationDataByQuery_MonitoringEndpointTrackerStatus_3904", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default,dca" } }, "/statistics/endpointTracker/csv": { "get": { "tags": [ "Monitoring - Endpoint Tracker Status" ], "description": "Get raw data with optional query as CSV", "operationId": "getStatDataRawDataAsCSV_MonitoringEndpointTrackerStatus_3103", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" }, "examples": { "Search result in csv format": { "description": "Search result in csv format", "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/endpointTracker/doccount": { "get": { "tags": [ "Monitoring - Endpoint Tracker Status" ], "description": "Get response count of a query", "operationId": "getCount_MonitoringEndpointTrackerStatus_3603", "parameters": [ { "name": "query", "in": "query", "description": "Query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 17193 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Monitoring - Endpoint Tracker Status" ], "description": "Get response count of a query", "operationId": "getCountPost_MonitoringEndpointTrackerStatus_3604", "requestBody": { "description": "Query", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query": { "description": "Query", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 9642 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/endpointTracker/fields": { "get": { "tags": [ "Monitoring - Endpoint Tracker Status" ], "description": "Get fields and type", "operationId": "getStatDataFields_MonitoringEndpointTrackerStatus_3403", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "example": [ { "dataType": "string", "property": "mac" }, { "dataType": "string", "property": "vap" }, { "dataType": "number", "property": "rssi" }, { "dataType": "string", "property": "mode" }, { "dataType": "number", "property": "bandwidth" }, { "dataType": "string", "property": "data_security" }, { "dataType": "number", "property": "rx_rate" }, { "dataType": "string", "property": "assoc_time" }, { "dataType": "date", "property": "entry_time" }, { "dataType": "date", "property": "statcycletime" }, { "dataType": "string", "property": "ssid" }, { "dataType": "number", "property": "vip_idx" }, { "dataType": "date", "property": "vip_time" }, { "dataType": "string", "property": "vdevice_name" }, { "dataType": "string", "property": "host_name" }, { "dataType": "string", "property": "device_model" } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/endpointTracker/page": { "get": { "tags": [ "Monitoring - Endpoint Tracker Status" ], "description": "Get stats raw data", "operationId": "getStatsPaginationRawData_MonitoringEndpointTrackerStatus_3203", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } }, { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" }, "post": { "tags": [ "Monitoring - Endpoint Tracker Status" ], "description": "Get stats raw data", "operationId": "getPostStatsPaginationRawData_MonitoringEndpointTrackerStatus_3204", "parameters": [ { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/endpointTracker/query/fields": { "get": { "tags": [ "Monitoring - Endpoint Tracker Status" ], "description": "Get query fields", "operationId": "getStatQueryFields_MonitoringEndpointTrackerStatus_4003", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "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" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/fields": { "get": { "tags": [ "Monitoring - Tunnel Health" ], "description": "Get fields and type", "operationId": "getStatDataFields_MonitoringTunnelHealth_1803", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "example": [ { "dataType": "string", "property": "mac" }, { "dataType": "string", "property": "vap" }, { "dataType": "number", "property": "rssi" }, { "dataType": "string", "property": "mode" }, { "dataType": "number", "property": "bandwidth" }, { "dataType": "string", "property": "data_security" }, { "dataType": "number", "property": "rx_rate" }, { "dataType": "string", "property": "assoc_time" }, { "dataType": "date", "property": "entry_time" }, { "dataType": "date", "property": "statcycletime" }, { "dataType": "string", "property": "ssid" }, { "dataType": "number", "property": "vip_idx" }, { "dataType": "date", "property": "vip_time" }, { "dataType": "string", "property": "vdevice_name" }, { "dataType": "string", "property": "host_name" }, { "dataType": "string", "property": "device_model" } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/flowlog": { "get": { "tags": [ "Monitoring - Flowlog" ], "description": "Get stats raw data", "operationId": "getStatDataRawData_MonitoringFlowlog_1903", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } }, { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by(emp:entry_time)", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", "schema": { "type": "string" } }, { "name": "site-id", "in": "query", "schema": { "pattern": "^[0-9]+$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "entry_time": 1715135940274, "statcycletime": 1715135940274, "vpn_id": 4294967295, "src_ip": "192.168.1.10", "dest_ip": "10.0.0.1", "src_port": 443, "dest_port": 80, "dscp": 0, "ip_proto": 6, "ingress_intf": "eth0", "egress_intf": "eth1", "direction": "inbound", "policy_name": "default_rule", "action": "allow", "start_time": 1654041600, "total_pkts": 100, "total_bytes": 1024, "flow_active": "yes", "vdevice_name": "172.16.254.1", "vmanage_system_ip": "10.0.0.1", "host_name": "server1", "device_model": "modelX", "stats_data_id": "uuid1234", "tenant": "feb962f1-a182-4516-997e-4beb9c31515c" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "post": { "tags": [ "Monitoring - Flowlog" ], "description": "Get stats raw data", "operationId": "getStatDataRawDataPost", "parameters": [ { "name": "page", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "schema": { "type": "string", "enum": [ "asc", "ASC", "Asc", "desc", "DESC", "Desc" ] } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "entry_time": 1715135940274, "statcycletime": 1715135940274, "vpn_id": 4294967295, "src_ip": "192.168.1.10", "dest_ip": "10.0.0.1", "src_port": 443, "dest_port": 80, "dscp": 0, "ip_proto": 6, "ingress_intf": "eth0", "egress_intf": "eth1", "direction": "inbound", "policy_name": "default_rule", "action": "allow", "start_time": 1654041600, "total_pkts": 100, "total_bytes": 1024, "flow_active": "yes", "vdevice_name": "172.16.254.1", "vmanage_system_ip": "10.0.0.1", "host_name": "server1", "device_model": "modelX", "stats_data_id": "uuid1234", "tenant": "feb962f1-a182-4516-997e-4beb9c31515c" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/flowlog/aggregation": { "get": { "tags": [ "Monitoring - Flowlog" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getAggregationDataByQuery_MonitoringFlowlog_3103", "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string" } } ], "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 } }, "$$ref": "#/components/schemas/FlowlogAggreation" }, "entryTimeList": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "header": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "object", "properties": { "dataType": { "type": "string", "example": "date" }, "isDisplay": { "type": "boolean", "example": true }, "property": { "type": "string", "example": "entry_time" }, "title": { "type": "string", "example": "Entry_time" } }, "$$ref": "#/components/schemas/FlowlogAggregationResponseHeaderColumns" } }, "fields": { "type": "array", "items": { "type": "object", "properties": { "dataType": { "type": "string", "example": "date" }, "property": { "type": "string", "example": "entry_time" } }, "$$ref": "#/components/schemas/FlowlogAggregationResponseHeaderFields" } }, "generatedOn": { "type": "integer", "format": "int64", "example": 1664160118911 } }, "$$ref": "#/components/schemas/FlowlogAggregationResponseHeader" } }, "$$ref": "#/components/schemas/FlowlogAggregationResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "post": { "tags": [ "Monitoring - Flowlog" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationDataByQuery_MonitoringFlowlog_3104", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" } } } } } } }, "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 } }, "$$ref": "#/components/schemas/FlowlogAggreation" }, "entryTimeList": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "header": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "object", "properties": { "dataType": { "type": "string", "example": "date" }, "isDisplay": { "type": "boolean", "example": true }, "property": { "type": "string", "example": "entry_time" }, "title": { "type": "string", "example": "Entry_time" } }, "$$ref": "#/components/schemas/FlowlogAggregationResponseHeaderColumns" } }, "fields": { "type": "array", "items": { "type": "object", "properties": { "dataType": { "type": "string", "example": "date" }, "property": { "type": "string", "example": "entry_time" } }, "$$ref": "#/components/schemas/FlowlogAggregationResponseHeaderFields" } }, "generatedOn": { "type": "integer", "format": "int64", "example": 1664160118911 } }, "$$ref": "#/components/schemas/FlowlogAggregationResponseHeader" } }, "$$ref": "#/components/schemas/FlowlogAggregationResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default,dca" } }, "/statistics/flowlog/csv": { "get": { "tags": [ "Monitoring - Flowlog" ], "description": "Get raw data with optional query as CSV", "operationId": "getStatDataRawDataAsCSV_MonitoringFlowlog_2303", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" }, "examples": { "Search result in csv format": { "description": "Search result in csv format", "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/flowlog/doccount": { "post": { "tags": [ "Monitoring - Flowlog" ], "description": "Get response count of a query", "operationId": "getFlowlogCountPost", "requestBody": { "description": "Query", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query": { "description": "Query", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "example": 17193 } }, "$$ref": "#/components/schemas/CountResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Monitoring - Flowlog" ], "description": "Get response count of a query", "operationId": "getFlowlogCount", "parameters": [ { "name": "query", "in": "query", "description": "Query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "example": 17193 } }, "$$ref": "#/components/schemas/CountResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/flowlog/fields": { "get": { "tags": [ "Monitoring - Flowlog" ], "description": "Get fields and type", "operationId": "getFlowlogFields", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "object", "properties": { "dataType": { "type": "string", "example": "date" }, "property": { "type": "string", "example": "entry_time" } }, "$$ref": "#/components/schemas/GetStatDataFields" }, "$$ref": "#/components/schemas/GetStatDataFieldArray" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/flowlog/page": { "post": { "tags": [ "Monitoring - Flowlog" ], "description": "Get stats pagination raw data", "operationId": "getStatsPaginationRawDataPost", "parameters": [ { "name": "scrollId", "in": "query", "description": "Scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "example": "action" }, "dest_ip": { "type": "string", "example": "10.74.49.77" }, "dest_port": { "type": "integer", "format": "int32", "example": 771 }, "device_model": { "type": "string", "example": "vedge-cloud" }, "direction": { "type": "string", "example": "service" }, "dscp": { "type": "integer", "format": "int32", "example": 7 }, "egress_intf": { "type": "string", "example": "cpu" }, "entry_time": { "type": "integer", "format": "int64", "example": 1664150431860 }, "flow_active": { "type": "string", "example": "active" }, "host_name": { "type": "string", "example": "vm1" }, "ingress_intf": { "type": "string", "example": "GigabitEthernet5" }, "ip_proto": { "type": "integer", "format": "int32", "example": 7 }, "policy_name": { "type": "string", "example": "policy" }, "src_ip": { "type": "string", "example": "10.124.10.249" }, "src_port": { "type": "integer", "format": "int32", "example": 0 }, "start_time": { "type": "integer", "format": "int64", "example": 1664150431860 }, "statcycletime": { "type": "integer", "format": "int64", "example": 1664150431860 }, "stats_data_id": { "type": "string", "example": "4OBG_HEB_JLsavezVUfr" }, "tenant": { "type": "string", "example": "feb962f1-a182-4516-997e-4beb9c31515c" }, "total_bytes": { "type": "integer", "format": "int64", "example": 172060 }, "total_pkts": { "type": "integer", "format": "int64", "example": 172060 }, "vdevice_name": { "type": "string", "example": "10.124.10.249" }, "vmanage_system_ip": { "type": "string", "example": "10.124.10.249" }, "vpn_id": { "type": "integer", "format": "int32", "example": 512 } }, "$$ref": "#/components/schemas/FlowlogDataObject" } }, "pageInfo": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "example": 100 }, "endTime": { "type": "string", "example": "1664148997536" }, "hasMoreData": { "type": "string", "example": "true" }, "scrollId": { "type": "string", "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ" }, "startTime": { "type": "string", "example": "1664159158463" }, "totalCount": { "type": "integer", "format": "int32", "example": 39802 } }, "$$ref": "#/components/schemas/FlowlogPaginationResponsePageInfo" } }, "$$ref": "#/components/schemas/FlowlogPaginationResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" }, "get": { "tags": [ "Monitoring - Flowlog" ], "description": "Get stats pagination raw data", "operationId": "getStatsPaginationRawData_MonitoringFlowlog_2403", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } }, { "name": "scrollId", "in": "query", "description": "Scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "example": "action" }, "dest_ip": { "type": "string", "example": "10.74.49.77" }, "dest_port": { "type": "integer", "format": "int32", "example": 771 }, "device_model": { "type": "string", "example": "vedge-cloud" }, "direction": { "type": "string", "example": "service" }, "dscp": { "type": "integer", "format": "int32", "example": 7 }, "egress_intf": { "type": "string", "example": "cpu" }, "entry_time": { "type": "integer", "format": "int64", "example": 1664150431860 }, "flow_active": { "type": "string", "example": "active" }, "host_name": { "type": "string", "example": "vm1" }, "ingress_intf": { "type": "string", "example": "GigabitEthernet5" }, "ip_proto": { "type": "integer", "format": "int32", "example": 7 }, "policy_name": { "type": "string", "example": "policy" }, "src_ip": { "type": "string", "example": "10.124.10.249" }, "src_port": { "type": "integer", "format": "int32", "example": 0 }, "start_time": { "type": "integer", "format": "int64", "example": 1664150431860 }, "statcycletime": { "type": "integer", "format": "int64", "example": 1664150431860 }, "stats_data_id": { "type": "string", "example": "4OBG_HEB_JLsavezVUfr" }, "tenant": { "type": "string", "example": "feb962f1-a182-4516-997e-4beb9c31515c" }, "total_bytes": { "type": "integer", "format": "int64", "example": 172060 }, "total_pkts": { "type": "integer", "format": "int64", "example": 172060 }, "vdevice_name": { "type": "string", "example": "10.124.10.249" }, "vmanage_system_ip": { "type": "string", "example": "10.124.10.249" }, "vpn_id": { "type": "integer", "format": "int32", "example": 512 } }, "$$ref": "#/components/schemas/FlowlogDataObject" } }, "pageInfo": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "example": 100 }, "endTime": { "type": "string", "example": "1664148997536" }, "hasMoreData": { "type": "string", "example": "true" }, "scrollId": { "type": "string", "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ" }, "startTime": { "type": "string", "example": "1664159158463" }, "totalCount": { "type": "integer", "format": "int32", "example": 39802 } }, "$$ref": "#/components/schemas/FlowlogPaginationResponsePageInfo" } }, "$$ref": "#/components/schemas/FlowlogPaginationResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/flowlog/query/fields": { "get": { "tags": [ "Monitoring - Flowlog" ], "description": "Get query fields", "operationId": "getFlowlogQueryFields", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "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" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/fwall": { "get": { "tags": [ "Monitoring - Umbrella Patterns" ], "description": "Get stats raw data", "operationId": "getStatDataRawData_MonitoringUmbrellaPatterns_1703", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "metrics": [ { "property": "latency", "type": "avg" } ] } } }, { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by(emp:entry_time)", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "3g", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.101.2", "local_color": "lte", "src_ip": "10.1.14.14", "sla_class_names": "None", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400056, "state": "Up", "local_system_ip": "172.16.255.14", "tenant": "default", "entry_time": 1589073792008, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.14", "fec_rx": 0, "src_port": 12380, "jitter": 1, "remote_system_ip": "172.16.255.11", "vdevice_name": "172.16.255.14", "proto": "IPSEC", "vip_idx": 190, "dst_port": 12366, "name": "172.16.255.14:lte-172.16.255.11:3g", "sla_class_list": "0", "tunnel_color": "3g:lte", "host_name": "vm4", "id": "4OBG_HEB_JLsavezVUfr" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "post": { "tags": [ "Monitoring - Umbrella Patterns" ], "description": "Get stats raw data", "operationId": "getStatsRawData_MonitoringUmbrellaPatterns_1704", "parameters": [ { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order", "schema": { "type": "string" } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "field": [ { "property": "name", "sequence": 1 }, { "property": "proto", "sequence": 2 } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" }, "metrics": [ { "property": "latency", "type": "avg" }, { "property": "loss", "type": "avg" }, { "property": "loss_percentage", "type": "avg" }, { "property": "vqoe_score", "type": "avg" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "lte", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.106.1", "local_color": "lte", "src_ip": "10.1.15.15", "sla_class_names": "test_sla_class", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400052, "state": "Up", "local_system_ip": "172.16.255.15", "tenant": "default", "entry_time": 1589073783045, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.15", "fec_rx": 0, "src_port": 12366, "jitter": 1, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.15", "proto": "IPSEC", "vip_idx": 351, "dst_port": 12386, "name": "172.16.255.15:lte-172.16.255.16:lte", "sla_class_list": "0,1", "tunnel_color": "lte:lte", "host_name": "vm5", "id": "IuBG_HEB_JLsavezVkiZ" } ], "pageInfo": { "startTime": "1589073783045", "endTime": "1589072535795", "count": 15 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/fwall/aggregation": { "get": { "tags": [ "Monitoring - Umbrella Patterns" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getAggregationDataByQuery_MonitoringUmbrellaPatterns_2903", "parameters": [ { "name": "query", "in": "query", "description": "Query filter", "schema": { "type": "string" }, "examples": { "Monitoring - Umbrella Patterns": { "description": "generated by base class - Monitoring - Umbrella Patterns", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "12" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "zonepair" ], "field": "type", "type": "string", "operator": "in" }, { "value": [ "172.16.254.2" ], "field": "vdevice_name", "type": "string", "operator": "in" } ] }, "aggregation": { "metrics": [ { "property": "zp_aggr_byte_counts", "type": "sum", "order": "desc" } ] } }, "$$ref": "#/components/examples/ComViptelaVmanageServerElasticsearchAbstractstatisticsrestfulresourceParameterExampleUmbrellapatterns" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Monitoring - Umbrella Patterns": { "description": "generated by base class - Monitoring - Umbrella Patterns", "value": { "data": [ { "zp_aggr_byte_counts": 0 } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerElasticsearchAbstractstatisticsrestfulresourceResponseExampleUmbrellapatterns" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "post": { "tags": [ "Monitoring - Umbrella Patterns" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationDataByQuery_MonitoringUmbrellaPatterns_2904", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Monitoring - Umbrella Patterns": { "description": "generated by base class - Monitoring - Umbrella Patterns", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "12" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "zonepair" ], "field": "type", "type": "string", "operator": "in" }, { "value": [ "172.16.254.2" ], "field": "vdevice_name", "type": "string", "operator": "in" } ] }, "aggregation": { "metrics": [ { "property": "zp_aggr_byte_counts", "type": "sum", "order": "desc" } ] } }, "$$ref": "#/components/examples/ComViptelaVmanageServerElasticsearchAbstractstatisticsrestfulresourceParameterExampleUmbrellapatterns" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Monitoring - Umbrella Patterns": { "description": "generated by base class - Monitoring - Umbrella Patterns", "value": { "data": [ { "zp_aggr_byte_counts": 0 } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerElasticsearchAbstractstatisticsrestfulresourceResponseExampleUmbrellapatterns" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default,dca" } }, "/statistics/fwall/csv": { "get": { "tags": [ "Monitoring - Umbrella Patterns" ], "description": "Get raw data with optional query as CSV", "operationId": "getStatDataRawDataAsCSV_MonitoringUmbrellaPatterns_2103", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" }, "examples": { "Search result in csv format": { "description": "Search result in csv format", "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/fwall/doccount": { "post": { "tags": [ "Monitoring - Umbrella Patterns" ], "description": "Get response count of a query", "operationId": "getCountPost_MonitoringUmbrellaPatterns_2604", "requestBody": { "description": "Query", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query": { "description": "Query", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 9642 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Monitoring - Umbrella Patterns" ], "description": "Get response count of a query", "operationId": "getCount_MonitoringUmbrellaPatterns_2603", "parameters": [ { "name": "query", "in": "query", "description": "Query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 17193 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/fwall/fields": { "get": { "tags": [ "Monitoring - Umbrella Patterns" ], "description": "Get fields and type", "operationId": "getStatDataFields_MonitoringUmbrellaPatterns_2403", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "example": [ { "dataType": "string", "property": "mac" }, { "dataType": "string", "property": "vap" }, { "dataType": "number", "property": "rssi" }, { "dataType": "string", "property": "mode" }, { "dataType": "number", "property": "bandwidth" }, { "dataType": "string", "property": "data_security" }, { "dataType": "number", "property": "rx_rate" }, { "dataType": "string", "property": "assoc_time" }, { "dataType": "date", "property": "entry_time" }, { "dataType": "date", "property": "statcycletime" }, { "dataType": "string", "property": "ssid" }, { "dataType": "number", "property": "vip_idx" }, { "dataType": "date", "property": "vip_time" }, { "dataType": "string", "property": "vdevice_name" }, { "dataType": "string", "property": "host_name" }, { "dataType": "string", "property": "device_model" } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/fwall/page": { "get": { "tags": [ "Monitoring - Umbrella Patterns" ], "description": "Get stats raw data", "operationId": "getStatsPaginationRawData_MonitoringUmbrellaPatterns_2203", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } }, { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" }, "post": { "tags": [ "Monitoring - Umbrella Patterns" ], "description": "Get stats raw data", "operationId": "getPostStatsPaginationRawData_MonitoringUmbrellaPatterns_2204", "parameters": [ { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/fwall/query/fields": { "get": { "tags": [ "Monitoring - Umbrella Patterns" ], "description": "Get query fields", "operationId": "getStatQueryFields_MonitoringUmbrellaPatterns_3003", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "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" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/interface": { "get": { "tags": [ "Monitoring - Interface Statistics" ], "description": "Get stats raw data", "operationId": "getStatDataRawData_MonitoringInterfaceStatistics_2103", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "20.0.1.20" ], "field": "vdevice_name", "type": "string", "operator": "in" } ] } } }, { "name": "page", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "schema": { "type": "string", "enum": [ "asc", "ASC", "Asc", "desc", "DESC", "Desc" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "object", "properties": { "condition": { "type": "string", "example": "AND" }, "rules": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "array", "items": { "type": "string" } } }, "$$ref": "#/components/schemas/RuleTypes" } }, "$$ref": "#/components/schemas/QueryWithRule" } }, "$$ref": "#/components/schemas/InterfaceQuery" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "lte", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.106.1", "local_color": "lte", "src_ip": "10.1.15.15", "sla_class_names": "test_sla_class", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400052, "state": "Up", "local_system_ip": "172.16.255.15", "tenant": "default", "entry_time": 1589073783045, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.15", "fec_rx": 0, "src_port": 12366, "jitter": 1, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.15", "proto": "IPSEC", "vip_idx": 351, "dst_port": 12386, "name": "172.16.255.15:lte-172.16.255.16:lte", "sla_class_list": "0,1", "tunnel_color": "lte:lte", "host_name": "vm5", "id": "IuBG_HEB_JLsavezVkiZ" } ], "pageInfo": { "startTime": "1589073783045", "endTime": "1589072535795", "count": 15 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Monitoring - Interface Statistics" ], "description": "Get stats raw data", "operationId": "getStatsRawData_MonitoringInterfaceStatistics_2104", "parameters": [ { "name": "page", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "schema": { "type": "string", "enum": [ "asc", "ASC", "Asc", "desc", "DESC", "Desc" ] } } ], "requestBody": { "description": "Query filter", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query filter": { "description": "Query filter", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.55.16" ], "field": "vdevice_name", "type": "string", "operator": "in" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "device_model": { "type": "string" }, "dst_ip": { "type": "string" }, "dst_port": { "type": "integer", "format": "int32" }, "entry_time": { "type": "string" }, "fec_re": { "type": "integer", "format": "int32" }, "fec_rx": { "type": "integer", "format": "int64" }, "fec_tx": { "type": "integer", "format": "int64" }, "host_name": { "type": "string" }, "id": { "type": "string" }, "jitter": { "type": "integer", "format": "int32" }, "latency": { "type": "number" }, "local_color": { "type": "string" }, "local_system_ip": { "type": "string" }, "loss": { "type": "integer", "format": "int32" }, "loss_percentage": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "proto": { "type": "string" }, "remote_color": { "type": "string" }, "remote_system_ip": { "type": "string" }, "rx_octets": { "type": "integer", "format": "int64" }, "rx_pkts": { "type": "integer", "format": "int64" }, "sla_class_list": { "type": "string" }, "sla_class_names": { "type": "string" }, "src_ip": { "type": "string" }, "src_port": { "type": "integer", "format": "int32" }, "statcycletime": { "type": "string" }, "state": { "type": "string" }, "tenant": { "type": "string" }, "total": { "type": "integer", "format": "int32" }, "tunnel_color": { "type": "string" }, "tx_octets": { "type": "number" }, "tx_pkts": { "type": "integer", "format": "int64" }, "vdevice_name": { "type": "string" }, "vip_idx": { "type": "integer", "format": "int32" }, "vmanage_system_ip": { "type": "string" }, "vqoe_score": { "type": "integer", "format": "int32" } }, "description": "interface specific response", "$$ref": "#/components/schemas/InterfaceResp" } }, "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": "interface response with page info", "$$ref": "#/components/schemas/InterfaceRespWithPageInfo" } }, "examples": { "QueryFields": { "description": "QueryFields", "value": { "data": [ { "remote_color": "lte", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.106.1", "local_color": "lte", "src_ip": "10.1.15.15", "sla_class_names": "test_sla_class", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400052, "state": "Up", "local_system_ip": "172.16.255.15", "tenant": "default", "entry_time": 1589073783045, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.15", "fec_rx": 0, "src_port": 12366, "jitter": 1, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.15", "proto": "IPSEC", "vip_idx": 351, "dst_port": 12386, "name": "172.16.255.15:lte-172.16.255.16:lte", "sla_class_list": "0,1", "tunnel_color": "lte:lte", "host_name": "vm5", "id": "IuBG_HEB_JLsavezVkiZ" } ], "pageInfo": { "startTime": "1589073783045", "endTime": "1589072535795", "count": 15 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/interface/aggregation": { "get": { "tags": [ "Monitoring - Interface Statistics" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getAggregationDataByQuery_MonitoringInterfaceStatistics_3303", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24000" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.16" ], "field": "vdevice_name", "type": "string", "operator": "in" }, { "value": [ "ge0/1", "system", "vmanage_system", "eth0", "loopback65528", "ge0/0" ], "field": "interface", "type": "string", "operator": "in" } ] }, "sort": [ { "field": "entry_time", "type": "date", "order": "asc" } ], "aggregation": { "field": [ { "property": "interface", "sequence": 1 } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" }, "metrics": [ { "property": "rx_kbps", "type": "avg" }, { "property": "tx_kbps", "type": "avg" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "entry_time": { "type": "string" }, "interface": { "type": "string" }, "rx_kbps": { "type": "number" }, "tx_kbps": { "type": "number" }, "vdevice_name": { "type": "string" } }, "$$ref": "#/components/schemas/InterfaceAggResp" } }, "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": "interface aggregation response with page info", "$$ref": "#/components/schemas/InterfaceAggRespWithPageInfo" } }, "examples": { "Aggregated Data": { "description": "Aggregated Data", "value": [ { "entry_time": 1673766000000, "count": 1, "interface": "eth0", "tx_kbps": 0, "rx_kbps": 1 }, { "entry_time": 1673766000000, "count": 1, "interface": "ge0/0", "tx_kbps": 0, "rx_kbps": 0 }, { "entry_time": 1673766000000, "count": 1, "interface": "ge0/1", "tx_kbps": 0, "rx_kbps": 0 }, { "entry_time": 1673766000000, "count": 1, "interface": "loopback65528", "tx_kbps": 0, "rx_kbps": 0 }, { "entry_time": 1673767800000, "count": 6, "interface": "eth0", "tx_kbps": 0, "rx_kbps": 0 }, { "entry_time": 1673767800000, "count": 6, "interface": "ge0/0", "tx_kbps": 0, "rx_kbps": 0 }, { "entry_time": 1673767800000, "count": 6, "interface": "ge0/1", "tx_kbps": 0, "rx_kbps": 0 }, { "entry_time": 1673767800000, "count": 6, "interface": "loopback65528", "tx_kbps": 0, "rx_kbps": 0 }, { "entry_time": 1673769600000, "count": 6, "interface": "eth0", "tx_kbps": 1.8333333333333333, "rx_kbps": 0.8333333333333334 }, { "entry_time": 1673769600000, "count": 6, "interface": "ge0/0", "tx_kbps": 0.3333333333333333, "rx_kbps": 2.8333333333333335 }, { "entry_time": 1673769600000, "count": 6, "interface": "ge0/1", "tx_kbps": 0, "rx_kbps": 0 }, { "entry_time": 1673769600000, "count": 6, "interface": "loopback65528", "tx_kbps": 0, "rx_kbps": 0 }, { "entry_time": 1673769600000, "count": 2, "interface": "system", "tx_kbps": 0, "rx_kbps": 0 }, { "entry_time": 1673771400000, "count": 6, "interface": "eth0", "tx_kbps": 0, "rx_kbps": 0 }, { "entry_time": 1673771400000, "count": 6, "interface": "ge0/0", "tx_kbps": 5, "rx_kbps": 48.833333333333336 }, { "entry_time": 1673771400000, "count": 6, "interface": "ge0/1", "tx_kbps": 0, "rx_kbps": 0 } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Monitoring - Interface Statistics" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationDataByQuery_MonitoringInterfaceStatistics_3304", "requestBody": { "description": "Query filter", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query filter": { "description": "Query filter", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "168" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.11" ], "field": "vdevice_name", "type": "string", "operator": "in" }, { "value": [ "ge0/1", "ge0/2", "ge0/4", "ge0/7", "loopback1", "loopback2" ], "field": "interface", "type": "string", "operator": "in" } ] }, "sort": [ { "field": "entry_time", "type": "date", "order": "asc" } ], "aggregation": { "field": [ { "property": "interface", "sequence": 1 } ], "histogram": { "property": "entry_time", "type": "hour", "interval": 6, "order": "asc" }, "metrics": [ { "property": "rx_kbps", "type": "avg" }, { "property": "tx_kbps", "type": "avg" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "entry_time": { "type": "string" }, "interface": { "type": "string" }, "rx_kbps": { "type": "number" }, "tx_kbps": { "type": "number" }, "vdevice_name": { "type": "string" } }, "$$ref": "#/components/schemas/InterfaceAggResp" } }, "examples": { "Aggregated Data": { "description": "Aggregated Data", "value": [ { "entry_time": 1673766000000, "count": 1, "interface": "eth0", "tx_kbps": 0, "rx_kbps": 1 }, { "entry_time": 1673766000000, "count": 1, "interface": "ge0/0", "tx_kbps": 0, "rx_kbps": 0 }, { "entry_time": 1673766000000, "count": 1, "interface": "ge0/1", "tx_kbps": 0, "rx_kbps": 0 }, { "entry_time": 1673766000000, "count": 1, "interface": "loopback65528", "tx_kbps": 0, "rx_kbps": 0 }, { "entry_time": 1673767800000, "count": 6, "interface": "eth0", "tx_kbps": 0, "rx_kbps": 0 }, { "entry_time": 1673767800000, "count": 6, "interface": "ge0/0", "tx_kbps": 0, "rx_kbps": 0 }, { "entry_time": 1673767800000, "count": 6, "interface": "ge0/1", "tx_kbps": 0, "rx_kbps": 0 }, { "entry_time": 1673767800000, "count": 6, "interface": "loopback65528", "tx_kbps": 0, "rx_kbps": 0 }, { "entry_time": 1673769600000, "count": 6, "interface": "eth0", "tx_kbps": 1.8333333333333333, "rx_kbps": 0.8333333333333334 }, { "entry_time": 1673769600000, "count": 6, "interface": "ge0/0", "tx_kbps": 0.3333333333333333, "rx_kbps": 2.8333333333333335 }, { "entry_time": 1673769600000, "count": 6, "interface": "ge0/1", "tx_kbps": 0, "rx_kbps": 0 }, { "entry_time": 1673769600000, "count": 6, "interface": "loopback65528", "tx_kbps": 0, "rx_kbps": 0 }, { "entry_time": 1673769600000, "count": 2, "interface": "system", "tx_kbps": 0, "rx_kbps": 0 }, { "entry_time": 1673771400000, "count": 6, "interface": "eth0", "tx_kbps": 0, "rx_kbps": 0 }, { "entry_time": 1673771400000, "count": 6, "interface": "ge0/0", "tx_kbps": 5, "rx_kbps": 48.833333333333336 }, { "entry_time": 1673771400000, "count": 6, "interface": "ge0/1", "tx_kbps": 0, "rx_kbps": 0 } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/interface/app-agg/aggregation": { "post": { "tags": [ "Monitoring - Interface Statistics" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationAppDataByQuery_MonitoringInterfaceStatistics_4104", "requestBody": { "description": "Query filter", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query filter": { "description": "Query filter", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "2400" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.16" ], "field": "vdevice_name", "type": "string", "operator": "in" }, { "value": [ "ge0/1", "system", "vmanage_system", "eth0", "loopback65528", "ge0/0" ], "field": "interface", "type": "string", "operator": "in" } ] }, "sort": [ { "field": "entry_time", "type": "date", "order": "asc" } ], "aggregation": { "field": [ { "property": "interface", "sequence": 1 } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" }, "metrics": [ { "property": "rx_kbps", "type": "avg" }, { "property": "tx_kbps", "type": "avg" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "entry_time": { "type": "string" }, "interface": { "type": "string" }, "rx_kbps": { "type": "number" }, "tx_kbps": { "type": "number" }, "vdevice_name": { "type": "string" } }, "$$ref": "#/components/schemas/InterfaceAggResp" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/interface/ccapacity/distribution": { "get": { "tags": [ "Monitoring - Interface Statistics" ], "description": "Get bandwidth distribution", "operationId": "getBandwidthDistribution", "parameters": [ { "name": "site-id", "in": "query", "schema": { "pattern": "^[0-9]+$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "avg_down_capacity_percentage": { "type": "number" }, "avg_up_capacity_percentage": { "type": "number" }, "bw_down": { "type": "integer", "format": "int64" }, "bw_up": { "type": "number" }, "count": { "type": "integer", "format": "int64" }, "interface": { "type": "string" }, "max_down_capacity_percentage": { "type": "number" }, "max_up_capacity_percentage": { "type": "number" }, "min_down_capacity_percentage": { "type": "number" }, "min_up_capacity_percentage": { "type": "integer", "format": "int32" }, "range": { "type": "string" }, "vdevice_name": { "type": "string" } }, "$$ref": "#/components/schemas/CapacityRespData" } }, "distribution": { "type": "object", "properties": { "100": { "type": "integer", "format": "int64" }, "0-25": { "type": "integer", "format": "int64" }, "25-50": { "type": "integer", "format": "int64" }, "50-75": { "type": "integer", "format": "int64" }, "75-100": { "type": "integer", "format": "int64" }, "uncategorized": { "type": "integer", "format": "int64" } }, "$$ref": "#/components/schemas/CapDistribution" } }, "$$ref": "#/components/schemas/CapacityResp" }, "examples": { "Bandwidth Distribution": { "description": "Bandwidth Distribution", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "1.1.60.7" ], "field": "vdevice_name", "type": "string", "operator": "in" } ] }, "aggregation": { "field": [ { "property": "family", "size": 200, "sequence": 1 } ], "metrics": [ { "property": "octets", "type": "sum", "order": "desc" } ] } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/interface/csv": { "get": { "tags": [ "Monitoring - Interface Statistics" ], "description": "Get raw data with optional query as CSV", "operationId": "getStatDataRawDataAsCSV_MonitoringInterfaceStatistics_2503", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "20.0.1.20" ], "field": "vdevice_name", "type": "string", "operator": "in" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" }, "example": "{\n \"blob\": https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd\n}" } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/interface/doccount": { "get": { "tags": [ "Monitoring - Interface Statistics" ], "description": "Get response count of a query", "operationId": "getCount10", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "20.0.1.20" ], "field": "vdevice_name", "type": "string", "operator": "in" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "example": { "count": 17193 } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Monitoring - Interface Statistics" ], "description": "Get response count of a query", "operationId": "getCountPost_MonitoringInterfaceStatistics_3004", "requestBody": { "description": "Query filter", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query": { "description": "Query", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "20.0.1.20" ], "field": "vdevice_name", "type": "string", "operator": "in" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "example": { "count": 17193 } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/interface/fields": { "get": { "tags": [ "Monitoring - Interface Statistics" ], "description": "Get fields and type", "operationId": "getStatDataFields_MonitoringInterfaceStatistics_2803", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "dataType": { "type": "string" }, "property": { "type": "string" } }, "$$ref": "#/components/schemas/InterfaceDocCountRequest" } }, "examples": { "Interface Fields": { "description": "Interface Fields", "value": [ { "property": "entry_time", "dataType": "date" }, { "property": "vip_idx", "dataType": "number" }, { "property": "statcycletime", "dataType": "date" }, { "property": "vdevice_name", "dataType": "string" }, { "property": "device_model", "dataType": "string", "display": "keyvalue" }, { "property": "host_name", "dataType": "string" }, { "property": "vpn_id", "dataType": "number" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/interface/page": { "get": { "tags": [ "Monitoring - Interface Statistics" ], "description": "Get stats raw data", "operationId": "getStatBulkRawData_MonitoringInterfaceStatistics_2603", "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "20.0.1.20" ], "field": "vdevice_name", "type": "string", "operator": "in" } ] } } }, { "name": "scrollId", "in": "query", "schema": { "type": "string" } }, { "name": "count", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "entry_time": { "type": "string" }, "interface": { "type": "string" }, "rx_kbps": { "type": "number" }, "tx_kbps": { "type": "number" }, "vdevice_name": { "type": "string" } }, "$$ref": "#/components/schemas/InterfaceAggResp" } }, "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": "interface aggregation response with page info", "$$ref": "#/components/schemas/InterfaceAggRespWithPageInfo" }, "examples": { "Response with page info": { "description": "Response with page info", "value": "[\n {\n \"down_capacity_percentage\": 0,\n \"tx_pps\": 0,\n \"total_mbps\": 0,\n \"device_model\": \"vedge-cloud\",\n \"rx_kbps\": 0,\n \"interface\": \"system\",\n \"tx_octets\": 0,\n \"oper_status\": \"Up\",\n \"rx_errors\": 0,\n \"bw_down\": 10000,\n \"tx_pkts\": 0,\n \"tx_errors\": 0,\n \"rx_octets\": 0,\n \"statcycletime\": 1673959200022,\n \"admin_status\": \"Up\",\n \"bw_up\": 10000,\n \"interface_type\": \"logical\",\n \"tenant\": \"default\",\n \"entry_time\": 1673958142101,\n \"vip_time\": 1673958142101,\n \"af_type\": \"IPv4\",\n \"rx_pkts\": 0,\n \"rx_pps\": 0,\n \"vmanage_system_ip\": \"172.16.255.21\",\n \"tx_drops\": 0,\n \"rx_drops\": 0,\n \"tx_kbps\": 0,\n \"vdevice_name\": \"172.16.255.21\",\n \"up_capacity_percentage\": 0,\n \"vip_idx\": 284,\n \"host_name\": \"vm11\",\n \"vpn_id\": 0,\n \"id\": \"RQG-v4UBrf5pDUb4VeQc\"\n },\n {\n \"down_capacity_percentage\": 0,\n \"tx_pps\": 0,\n \"total_mbps\": 0,\n \"device_model\": \"vedge-cloud\",\n \"rx_kbps\": 0,\n \"interface\": \"ge0/5\",\n \"tx_octets\": 0,\n \"oper_status\": \"Down\",\n \"rx_errors\": 0,\n \"bw_down\": 0,\n \"tx_pkts\": 0,\n \"tx_errors\": 0,\n \"rx_octets\": 0,\n \"statcycletime\": 1673959200022,\n \"admin_status\": \"Down\",\n \"bw_up\": 0,\n \"interface_type\": \"physical\",\n \"tenant\": \"default\",\n \"entry_time\": 1673958414824,\n \"vip_time\": 1673958414825,\n \"af_type\": \"IPv4\",\n \"rx_pkts\": 0,\n \"rx_pps\": 0,\n \"vmanage_system_ip\": \"172.16.255.21\",\n \"tx_drops\": 0,\n \"rx_drops\": 0,\n \"tx_kbps\": 0,\n \"vdevice_name\": \"172.16.255.21\",\n \"up_capacity_percentage\": 0,\n \"vip_idx\": 293,\n \"host_name\": \"vm11\",\n \"vpn_id\": 0,\n \"id\": \"TgG-v4UBrf5pDUb4VeQc\"\n }\n ],\n \"pageInfo\": {\n \"startTime\": \"1673959200022\",\n \"endTime\": \"1673959200022\",\n \"scrollId\": \"FGluY2x1ZGVfY29udGV4dF91dWlkDXF1ZXJ5QW5kRmV0Y2gBFmxUeXprSGJ0VHRpam43TkwwaUVBUHcAAAAAAAAgaRZxdXlabXpNb1FOR1hRNVlQcGdfSldn_10\",\n \"hasMoreData\": true,\n \"count\": 10,\n \"totalCount\": 27624\n }\n}" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Monitoring - Interface Statistics" ], "description": "Get stats raw data", "operationId": "getPostStatBulkRawData_MonitoringInterfaceStatistics_2604", "parameters": [ { "name": "scrollId", "in": "query", "schema": { "type": "string" } }, { "name": "count", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Query filter", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.55.16" ], "field": "vdevice_name", "type": "string", "operator": "in" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "entry_time": { "type": "string" }, "interface": { "type": "string" }, "rx_kbps": { "type": "number" }, "tx_kbps": { "type": "number" }, "vdevice_name": { "type": "string" } }, "$$ref": "#/components/schemas/InterfaceAggResp" } }, "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": "interface aggregation response with page info", "$$ref": "#/components/schemas/InterfaceAggRespWithPageInfo" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/interface/query/fields": { "get": { "tags": [ "Monitoring - Interface Statistics" ], "description": "Get query fields", "operationId": "getStatQueryFields_MonitoringInterfaceStatistics_3403", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Interface Query Fields": { "description": "Interface Query Fields", "value": [ { "isRequired": true, "fieldData": { "type": "dateList" }, "dataType": "date", "property": "entry_time", "name": "Event Time", "options": [ { "enableDateFields": false, "number": "1", "value": "Last 1 hour", "key": "last_1_hour" }, { "enableDateFields": false, "number": "3", "value": "Last 3 hours", "key": "last_3_hours" }, { "enableDateFields": false, "number": "6", "value": "Last 6 hours", "key": "last_6_hours" }, { "enableDateFields": false, "number": "12", "value": "Last 12 hours", "key": "last_12_hours" }, { "enableDateFields": false, "number": "24", "isSelected": true, "value": "Last 24 hours", "key": "last_24_hours" }, { "enableDateFields": false, "number": "168", "value": "Last 7 days", "key": "last_168_hours" }, { "enableDateFields": true, "value": "Custom", "key": "custom" } ] } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/interface/type": { "get": { "tags": [ "Monitoring - Interface Statistics" ], "description": "Get statistics per interface", "operationId": "getStatisticsPerInterface", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "20.0.1.20" ], "field": "vdevice_name", "type": "string", "operator": "in" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "entry_time": { "type": "string" }, "interface": { "type": "string" }, "rx_kbps": { "type": "number" }, "tx_kbps": { "type": "number" }, "vdevice_name": { "type": "string" } }, "$$ref": "#/components/schemas/InterfaceAggResp" }, "examples": { "Interface by type": { "description": "Interface by type", "value": [ { "down_capacity_percentage": 0, "tx_pps": 0, "total_mbps": 0, "device_model": "vedge-cloud", "rx_kbps": 0, "interface": "system", "tx_octets": 0, "oper_status": "Up", "rx_errors": 0, "bw_down": 10000, "tx_pkts": 0, "tx_errors": 0, "rx_octets": 0, "statcycletime": 1673959200022, "admin_status": "Up", "bw_up": 10000, "interface_type": "logical", "tenant": "default", "entry_time": 1673958142101, "vip_time": 1673958142101, "af_type": "IPv4", "rx_pkts": 0, "rx_pps": 0, "vmanage_system_ip": "172.16.255.21", "tx_drops": 0, "rx_drops": 0, "tx_kbps": 0, "vdevice_name": "172.16.255.21", "up_capacity_percentage": 0, "vip_idx": 284, "host_name": "vm11", "vpn_id": 0, "id": "RQG-v4UBrf5pDUb4VeQc" }, { "down_capacity_percentage": 0, "tx_pps": 0, "total_mbps": 0, "device_model": "vedge-cloud", "rx_kbps": 0, "interface": "ge0/5", "tx_octets": 0, "oper_status": "Down", "rx_errors": 0, "bw_down": 0, "tx_pkts": 0, "tx_errors": 0, "rx_octets": 0, "statcycletime": 1673959200022, "admin_status": "Down", "bw_up": 0, "interface_type": "physical", "tenant": "default", "entry_time": 1673958414824, "vip_time": 1673958414825, "af_type": "IPv4", "rx_pkts": 0, "rx_pps": 0, "vmanage_system_ip": "172.16.255.21", "tx_drops": 0, "rx_drops": 0, "tx_kbps": 0, "vdevice_name": "172.16.255.21", "up_capacity_percentage": 0, "vip_idx": 293, "host_name": "vm11", "vpn_id": 0, "id": "TgG-v4UBrf5pDUb4VeQc" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/ipsalert": { "get": { "tags": [ "Monitoring - IPsAlert" ], "description": "Get stats raw data", "operationId": "getStatDataRawData_MonitoringIpsalert_2003", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "metrics": [ { "property": "latency", "type": "avg" } ] } } }, { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by(emp:entry_time)", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "3g", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.101.2", "local_color": "lte", "src_ip": "10.1.14.14", "sla_class_names": "None", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400056, "state": "Up", "local_system_ip": "172.16.255.14", "tenant": "default", "entry_time": 1589073792008, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.14", "fec_rx": 0, "src_port": 12380, "jitter": 1, "remote_system_ip": "172.16.255.11", "vdevice_name": "172.16.255.14", "proto": "IPSEC", "vip_idx": 190, "dst_port": 12366, "name": "172.16.255.14:lte-172.16.255.11:3g", "sla_class_list": "0", "tunnel_color": "3g:lte", "host_name": "vm4", "id": "4OBG_HEB_JLsavezVUfr" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "post": { "tags": [ "Monitoring - IPsAlert" ], "description": "Get stats raw data", "operationId": "getStatsRawData_MonitoringIpsalert_2004", "parameters": [ { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order", "schema": { "type": "string" } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "field": [ { "property": "name", "sequence": 1 }, { "property": "proto", "sequence": 2 } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" }, "metrics": [ { "property": "latency", "type": "avg" }, { "property": "loss", "type": "avg" }, { "property": "loss_percentage", "type": "avg" }, { "property": "vqoe_score", "type": "avg" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "lte", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.106.1", "local_color": "lte", "src_ip": "10.1.15.15", "sla_class_names": "test_sla_class", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400052, "state": "Up", "local_system_ip": "172.16.255.15", "tenant": "default", "entry_time": 1589073783045, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.15", "fec_rx": 0, "src_port": 12366, "jitter": 1, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.15", "proto": "IPSEC", "vip_idx": 351, "dst_port": 12386, "name": "172.16.255.15:lte-172.16.255.16:lte", "sla_class_list": "0,1", "tunnel_color": "lte:lte", "host_name": "vm5", "id": "IuBG_HEB_JLsavezVkiZ" } ], "pageInfo": { "startTime": "1589073783045", "endTime": "1589072535795", "count": 15 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/ipsalert/aggregation": { "get": { "tags": [ "Monitoring - IPsAlert" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getAggregationDataByQuery_MonitoringIpsalert_3203", "parameters": [ { "name": "query", "in": "query", "description": "Query filter", "schema": { "type": "string" }, "examples": { "Monitoring - IPsAlert": { "description": "generated by base class - Monitoring - IPsAlert", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.254.2" ], "field": "vdevice_name", "type": "string", "operator": "in" }, { "value": [ "ips_alert" ], "field": "type", "type": "string", "operator": "in" } ] }, "aggregation": { "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" }, "field": [ { "property": "severity", "size": 10, "sequence": 1 } ] } }, "$$ref": "#/components/examples/ComViptelaVmanageServerElasticsearchAbstractstatisticsrestfulresourceParameterExampleIpsalert" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Monitoring - IPsAlert": { "description": "generated by base class - Monitoring - IPsAlert", "value": { "data": [] }, "$$ref": "#/components/examples/ComViptelaVmanageServerElasticsearchAbstractstatisticsrestfulresourceResponseExampleIpsalert" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "post": { "tags": [ "Monitoring - IPsAlert" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationDataByQuery_MonitoringIpsalert_3204", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Monitoring - IPsAlert": { "description": "generated by base class - Monitoring - IPsAlert", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.254.2" ], "field": "vdevice_name", "type": "string", "operator": "in" }, { "value": [ "ips_alert" ], "field": "type", "type": "string", "operator": "in" } ] }, "aggregation": { "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" }, "field": [ { "property": "severity", "size": 10, "sequence": 1 } ] } }, "$$ref": "#/components/examples/ComViptelaVmanageServerElasticsearchAbstractstatisticsrestfulresourceParameterExampleIpsalert" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Monitoring - IPsAlert": { "description": "generated by base class - Monitoring - IPsAlert", "value": { "data": [] }, "$$ref": "#/components/examples/ComViptelaVmanageServerElasticsearchAbstractstatisticsrestfulresourceResponseExampleIpsalert" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default,dca" } }, "/statistics/ipsalert/csv": { "get": { "tags": [ "Monitoring - IPsAlert" ], "description": "Get raw data with optional query as CSV", "operationId": "getStatDataRawDataAsCSV_MonitoringIpsalert_2403", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" }, "examples": { "Search result in csv format": { "description": "Search result in csv format", "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/ipsalert/doccount": { "get": { "tags": [ "Monitoring - IPsAlert" ], "description": "Get response count of a query", "operationId": "getCount_MonitoringIpsalert_2903", "parameters": [ { "name": "query", "in": "query", "description": "Query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 17193 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Monitoring - IPsAlert" ], "description": "Get response count of a query", "operationId": "getCountPost_MonitoringIpsalert_2904", "requestBody": { "description": "Query", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query": { "description": "Query", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 9642 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/ipsalert/fields": { "get": { "tags": [ "Monitoring - IPsAlert" ], "description": "Get fields and type", "operationId": "getStatDataFields_MonitoringIpsalert_2703", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "example": [ { "dataType": "string", "property": "mac" }, { "dataType": "string", "property": "vap" }, { "dataType": "number", "property": "rssi" }, { "dataType": "string", "property": "mode" }, { "dataType": "number", "property": "bandwidth" }, { "dataType": "string", "property": "data_security" }, { "dataType": "number", "property": "rx_rate" }, { "dataType": "string", "property": "assoc_time" }, { "dataType": "date", "property": "entry_time" }, { "dataType": "date", "property": "statcycletime" }, { "dataType": "string", "property": "ssid" }, { "dataType": "number", "property": "vip_idx" }, { "dataType": "date", "property": "vip_time" }, { "dataType": "string", "property": "vdevice_name" }, { "dataType": "string", "property": "host_name" }, { "dataType": "string", "property": "device_model" } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/ipsalert/page": { "post": { "tags": [ "Monitoring - IPsAlert" ], "description": "Get stats raw data", "operationId": "getPostStatsPaginationRawData_MonitoringIpsalert_2504", "parameters": [ { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" }, "get": { "tags": [ "Monitoring - IPsAlert" ], "description": "Get stats raw data", "operationId": "getStatsPaginationRawData_MonitoringIpsalert_2503", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } }, { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/ipsalert/query/fields": { "get": { "tags": [ "Monitoring - IPsAlert" ], "description": "Get query fields", "operationId": "getStatQueryFields_MonitoringIpsalert_3303", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "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" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/nwa": { "post": { "tags": [ "Monitoring - Network Availability" ], "description": "Get network availability raw data based on input query and filters.", "operationId": "getAggregationDataByQuery_MonitoringNetworkAvailability_1504", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "site" ], "field": "type", "type": "string", "operator": "in" } ] } } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "required": [ "health", "jitter", "latency", "loss" ], "type": "object", "properties": { "availability": { "type": "number", "example": 0.9 }, "health": { "type": "string", "example": "good", "enum": [ "good", "fair", "poor" ] }, "jitter": { "type": "number", "example": 40 }, "latency": { "type": "number", "example": 500 }, "latitude": { "type": "string", "example": "12.1114325" }, "longitude": { "type": "string", "example": "120.235674" }, "loss": { "type": "number", "example": 1.2 }, "siteid": { "type": "string", "example": "100" }, "sitename": { "type": "string", "example": "sjc" } }, "$$ref": "#/components/schemas/NetworkAvailabilityResp" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/nwa/aggregation": { "post": { "tags": [ "Monitoring - Network Availability" ], "description": "Get network availability aggregated data based on input query and filters.", "operationId": "getPostAggregationDataByQuery_MonitoringNetworkAvailability_2704", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "site availability table query string": { "description": "site availability table query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "site" ], "field": "type", "type": "string", "operator": "in" } ] }, "aggregation": { "field": [ { "property": "site_id", "sequence": 1, "size": 100 } ], "metrics": [ { "property": "down_time", "type": "sum", "order": "desc" } ] } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceNetworkavailabilityStatisticsapiParameterExampleSiteavailabilitytable" }, "link availability table query string": { "description": "link availability table query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "link" ], "field": "type", "type": "string", "operator": "in" } ] }, "aggregation": { "field": [ { "property": "system_ip", "sequence": 1, "size": 100 }, { "property": "color", "sequence": 2, "size": 100 } ], "metrics": [ { "property": "down_time", "type": "sum", "order": "desc" } ] } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceNetworkavailabilityStatisticsapiParameterExampleLinkavailabilitytable" }, "site availability chart query string": { "description": "site availability chart query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "site" ], "field": "type", "type": "string", "operator": "in" } ] }, "aggregation": { "field": [ { "property": "site_id", "sequence": 1, "size": 100 } ], "metrics": [ { "property": "down_time", "type": "sum", "order": "desc" } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 60, "order": "asc" } } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceNetworkavailabilityStatisticsapiParameterExampleSiteavailabilitychart" }, "link availability chart query string": { "description": "link availability chart query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "link" ], "field": "type", "type": "string", "operator": "in" } ] }, "aggregation": { "field": [ { "property": "system_ip", "sequence": 1, "size": 100 }, { "property": "color", "sequence": 1, "size": 100 } ], "metrics": [ { "property": "down_time", "type": "sum", "order": "desc" } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 60, "order": "asc" } } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceNetworkavailabilityStatisticsapiParameterExampleLinkavailabilitychart" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "required": [ "health", "jitter", "latency", "loss" ], "type": "object", "properties": { "availability": { "type": "number", "example": 0.9 }, "health": { "type": "string", "example": "good", "enum": [ "good", "fair", "poor" ] }, "jitter": { "type": "number", "example": 40 }, "latency": { "type": "number", "example": 500 }, "latitude": { "type": "string", "example": "12.1114325" }, "longitude": { "type": "string", "example": "120.235674" }, "loss": { "type": "number", "example": 1.2 }, "siteid": { "type": "string", "example": "100" }, "sitename": { "type": "string", "example": "sjc" } }, "$$ref": "#/components/schemas/NetworkAvailabilityResp" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write" } }, "/statistics/nwa/details": { "post": { "tags": [ "Monitoring - Network Availability" ], "description": "Get network availability aggregated data with details based on input query and filters.", "operationId": "getDetailAggregationDataByQuery", "parameters": [ { "name": "includePrev", "in": "query", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "site availability table query string": { "description": "site availability table query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "site" ], "field": "type", "type": "string", "operator": "in" } ] }, "aggregation": { "field": [ { "property": "site_id", "sequence": 1, "size": 100 } ], "metrics": [ { "property": "down_time", "type": "sum", "order": "desc" } ] } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceNetworkavailabilityStatisticsapiParameterExampleSiteavailabilitytable" }, "link availability table query string": { "description": "link availability table query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "link" ], "field": "type", "type": "string", "operator": "in" } ] }, "aggregation": { "field": [ { "property": "system_ip", "sequence": 1, "size": 100 }, { "property": "color", "sequence": 2, "size": 100 } ], "metrics": [ { "property": "down_time", "type": "sum", "order": "desc" } ] } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceNetworkavailabilityStatisticsapiParameterExampleLinkavailabilitytable" }, "site availability chart query string": { "description": "site availability chart query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "site" ], "field": "type", "type": "string", "operator": "in" } ] }, "aggregation": { "field": [ { "property": "site_id", "sequence": 1, "size": 100 } ], "metrics": [ { "property": "down_time", "type": "sum", "order": "desc" } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 60, "order": "asc" } } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceNetworkavailabilityStatisticsapiParameterExampleSiteavailabilitychart" }, "link availability chart query string": { "description": "link availability chart query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "link" ], "field": "type", "type": "string", "operator": "in" } ] }, "aggregation": { "field": [ { "property": "system_ip", "sequence": 1, "size": 100 }, { "property": "color", "sequence": 1, "size": 100 } ], "metrics": [ { "property": "down_time", "type": "sum", "order": "desc" } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 60, "order": "asc" } } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceNetworkavailabilityStatisticsapiParameterExampleLinkavailabilitychart" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "required": [ "health", "jitter", "latency", "loss" ], "type": "object", "properties": { "availability": { "type": "number", "example": 0.9 }, "health": { "type": "string", "example": "good", "enum": [ "good", "fair", "poor" ] }, "jitter": { "type": "number", "example": 40 }, "latency": { "type": "number", "example": 500 }, "latitude": { "type": "string", "example": "12.1114325" }, "longitude": { "type": "string", "example": "120.235674" }, "loss": { "type": "number", "example": 1.2 }, "siteid": { "type": "string", "example": "100" }, "sitename": { "type": "string", "example": "sjc" } }, "$$ref": "#/components/schemas/NetworkAvailabilityResp" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write" } }, "/statistics/on-demand/queue": { "get": { "tags": [ "Monitoring - DPI - On-demand troubleshooting" ], "description": "gets current on-demand queue entries", "operationId": "getQueueEntries", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Queue Entries": { "description": "Queue Entries", "value": { "entries": [ { "status": "COMPLETED", "complete": true, "data_type": "ConnectionEvents", "tenant_id": "default", "start_time": 0, "creationTime": 1640765713644, "value": 48, "completionTime": 1640765718372, "end_time": 0, "startProcessingTime": 1640765717682, "time_period": "LAST_N_HOURS", "id": "0a43d31b-fde9-400a-b0ed-319f72115323", "device_id": "172.16.255.11" }, { "status": "QUEUED", "complete": false, "data_type": "DPI", "tenant_id": "default", "start_time": 0, "creationTime": 1640764758920, "value": 24, "completionTime": 0, "end_time": 0, "startProcessingTime": 0, "time_period": "LAST_N_HOURS", "id": "93629fed-ec81-4f37-9c85-24b577191c9c", "device_id": "10.0.1.17" }, { "status": "COMPLETED", "complete": true, "data_type": "DPI", "tenant_id": "default", "start_time": 0, "creationTime": 1640765915038, "value": 48, "completionTime": 1640765918258, "end_time": 0, "startProcessingTime": 1640765917678, "time_period": "LAST_N_HOURS", "id": "d9111cd6-59ab-482c-bd95-41fdaba9fc5b", "device_id": "172.16.255.11" }, { "status": "QUEUED", "complete": false, "data_type": "ConnectionEvents", "tenant_id": "default", "start_time": 0, "creationTime": 1640767377708, "value": 24, "completionTime": 0, "end_time": 0, "startProcessingTime": 0, "time_period": "LAST_N_HOURS", "id": "544ce0e1-9f57-4266-b789-ed50d043761c", "device_id": "10.0.1.17" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,RBAC VPN-read,RBAC VPN-write" }, "post": { "tags": [ "Monitoring - DPI - On-demand troubleshooting" ], "description": "Create on-demand troubleshooting queue entry", "operationId": "createQueueEntry", "requestBody": { "description": "On-demand queue entry", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "OnDemandQueueEntry": { "description": "OnDemandQueueEntry", "value": { "device_id": "10.0.1.17", "data_type": "DPI", "time_period": "LAST_N_HOURS", "value": 24 } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "OnDemandQueueEntry": { "description": "OnDemandQueueEntry", "value": { "complete": false, "creationTime": 1641373054019, "startProcessingTime": 0, "completionTime": 0, "id": "bc4e2dbe-a226-4a01-aa1a-1859978014d3", "device_id": "169.254.10.10", "data_type": "DPI", "time_period": "LAST_N_HOURS", "tenant_id": "a200c754-22bc-4a99-b0b9-a2957755e3ba", "value": 3, "start_time": 0, "end_time": 0, "status": "QUEUED" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,RBAC VPN-read" } }, "/statistics/on-demand/queue/properties": { "get": { "tags": [ "Monitoring - DPI - On-demand troubleshooting" ], "description": "gets current size of on-demand queue", "operationId": "getQueueProperties", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Queue size is 2": { "description": "Queue size is 2", "value": { "tenant_current_size": 2, "max_size": 20, "tenant_max_size": 5 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,RBAC VPN-read,RBAC VPN-write" } }, "/statistics/on-demand/queue/{entryId}": { "delete": { "tags": [ "Monitoring - DPI - On-demand troubleshooting" ], "description": "removes on-demand queue entry", "operationId": "deleteQueueEntry", "parameters": [ { "name": "entryId", "in": "path", "description": "Entry Id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,RBAC VPN-read" }, "put": { "tags": [ "Monitoring - DPI - On-demand troubleshooting" ], "description": "Updates on-demand troubleshooting queue entry", "operationId": "updateQueueEntry", "parameters": [ { "name": "entryId", "in": "path", "description": "Entry Id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "On-demand queue entry", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "OnDemandQueueEntry": { "description": "OnDemandQueueEntry", "value": { "device_id": "10.0.1.17", "data_type": "DPI", "time_period": "LAST_N_HOURS", "value": 24 } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "OnDemandQueueEntry": { "description": "OnDemandQueueEntry", "value": { "id": "ac031e7b-9c6e-4375-8589-ad503f9d52d2", "device_id": "10.0.1.17", "data_type": "DPI", "time_period": "LAST_N_HOURS", "value": 24 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,RBAC VPN-read" } }, "/statistics/page": { "get": { "tags": [ "Monitoring - Tunnel Health" ], "description": "Get stats raw data", "operationId": "getStatsPaginationRawData_MonitoringTunnelHealth_1603", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } }, { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" }, "post": { "tags": [ "Monitoring - Tunnel Health" ], "description": "Get stats raw data", "operationId": "getPostStatsPaginationRawData_MonitoringTunnelHealth_1604", "parameters": [ { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/perfmon/aggregation": { "post": { "tags": [ "Monitoring - Performance Monitor" ], "summary": "one site one application line chart data", "description": "Get one application one site line chart data ", "operationId": "getPostAggregationDataByQuery_MonitoringPerformanceMonitor_3104", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "all paths chart query string": { "description": "all paths chart query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "3pc" ], "field": "application", "type": "string", "operator": "equal" }, { "value": [ "600" ], "field": "siteid", "type": "string", "operator": "equal" } ] }, "aggregation": { "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" }, "metrics": [ { "property": "qoe", "type": "avg" } ] } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDevicePerfmonStatisticsapiParameterExamplePerfmonpathchart" } } } }, "required": true }, "responses": { "200": { "description": "search results matching criteria", "content": { "application/json": { "schema": { "type": "array", "items": { "required": [ "entry_time", "qoe" ], "type": "object", "properties": { "entry_time": { "type": "integer", "format": "int64", "example": 1639897200000 }, "qoe": { "type": "number", "format": "double", "example": 9 } }, "$$ref": "#/components/schemas/ApplicationSiteChartItem" } } } } }, "400": { "description": "Bad Request" } }, "x-roles-required": "Application Monitoring-read,Application Monitoring-write" } }, "/statistics/perfmon/application/heatmap/detail": { "get": { "tags": [ "Monitoring - Performance Monitor" ], "summary": "single application site health detail within time-range", "description": "Get single applicaiton site health detail in a time range ", "operationId": "getApplicationHeatMapDetail", "parameters": [ { "name": "application", "in": "query", "required": true, "schema": { "pattern": "^[a-zA-Z0-9-_\\s]+$", "type": "string" } }, { "name": "siteid", "in": "query", "schema": { "pattern": "^[0-9]+$", "type": "string" } }, { "name": "start_time", "in": "query", "description": "Heatmap single box entry_time", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "heatmap_time", "in": "query", "description": "Heatmap generation time", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "last_n_hours", "in": "query", "schema": { "type": "string", "enum": [ "1", "3", "6", "12", "24" ], "default": "12" } } ], "responses": { "200": { "description": "search results matching criteria", "content": { "application/json": { "schema": { "type": "array", "items": { "required": [ "fair_site", "good_site", "poor_site" ], "type": "object", "properties": { "fair_site": { "type": "integer", "format": "int32", "example": 1 }, "good_site": { "type": "integer", "format": "int32", "example": 10 }, "poor_site": { "type": "integer", "format": "int32", "example": 1 } }, "$$ref": "#/components/schemas/ApplicationHeatMapDetail" } } } } }, "400": { "description": "Bad Request" } } } }, "/statistics/perfmon/application/site/health": { "post": { "tags": [ "Monitoring - Performance Monitor" ], "summary": "one site one application health data", "description": "Get one application health for one site ", "operationId": "getApplicationSiteHealth", "parameters": [ { "name": "health", "in": "query", "schema": { "type": "string", "enum": [ "GOOD", "FAIR", "POOR" ] } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "all paths table query string": { "description": "all paths table query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "3pc" ], "field": "application", "type": "string", "operator": "equal" }, { "value": [ "600" ], "field": "siteid", "type": "string", "operator": "equal" } ] }, "aggregation": { "field": [ { "property": "path", "sequence": 1 } ], "metrics": [ { "property": "qoe", "type": "avg" }, { "property": "jitter", "type": "avg" }, { "property": "lost_samples", "type": "sum" }, { "property": "total_samples", "type": "sum" }, { "property": "latency", "type": "avg" } ] } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDevicePerfmonStatisticsapiParameterExamplePerfmonpathtable" } } } }, "required": true }, "responses": { "200": { "description": "search results matching criteria", "content": { "application/json": { "schema": { "type": "array", "items": { "required": [ "health", "jitter", "latency", "loss", "path" ], "type": "object", "properties": { "health": { "pattern": "(good|fair|poor)", "type": "string", "example": "good" }, "jitter": { "type": "number", "format": "double", "example": 1 }, "latency": { "type": "number", "format": "double", "example": 10 }, "loss": { "type": "number", "format": "double", "example": 1 }, "path": { "type": "string", "example": "Tunnel3->SIG" }, "qoe": { "type": "number", "format": "double", "example": 9 } }, "$$ref": "#/components/schemas/ApplicationSiteItem" } } } } }, "400": { "description": "Bad Request" } }, "x-roles-required": "Application Monitoring-read,Application Monitoring-write" } }, "/statistics/perfmon/application/sites/health": { "get": { "tags": [ "Monitoring - Performance Monitor" ], "summary": "all sites one application health data", "description": "Get one application health for all sites ", "operationId": "getApplicationSitesHealth", "parameters": [ { "name": "application", "in": "query", "required": true, "schema": { "pattern": "^[a-zA-Z0-9-_\\s]+$", "type": "string" } }, { "name": "isHeatMap", "in": "query", "schema": { "type": "boolean" } }, { "name": "last_n_hours", "in": "query", "schema": { "type": "string", "enum": [ "1", "3", "6", "12", "24" ] } }, { "name": "health", "in": "query", "schema": { "type": "string", "enum": [ "GOOD", "FAIR", "POOR" ] } } ], "responses": { "200": { "description": "search results matching criteria", "content": { "application/json": { "schema": { "type": "array", "items": { "required": [ "fair_path", "good_path", "health", "poor_path", "siteid" ], "type": "object", "properties": { "fair_path": { "type": "integer", "format": "int32", "example": 1 }, "good_path": { "type": "integer", "format": "int32", "example": 10 }, "health": { "pattern": "(good|fair|poor)", "type": "string", "example": "good" }, "poor_path": { "type": "integer", "format": "int32", "example": 1 }, "siteid": { "type": "string", "example": "100" } }, "$$ref": "#/components/schemas/ApplicationSitesItem" } } } } }, "400": { "description": "Bad Request" } }, "x-roles-required": "Application Monitoring-read,Application Monitoring-write" } }, "/statistics/perfmon/applications/site/health": { "get": { "tags": [ "Monitoring - Performance Monitor" ], "summary": "one site all applications health data", "description": "Get all applications health for one site ", "operationId": "getApplicationsSiteHealth", "parameters": [ { "name": "siteid", "in": "query", "required": true, "schema": { "pattern": "^[0-9]+$", "type": "string" } }, { "name": "isHeatMap", "in": "query", "schema": { "type": "boolean" } }, { "name": "last_n_hours", "in": "query", "schema": { "type": "string", "enum": [ "1", "3", "6", "12", "24" ] } }, { "name": "health", "in": "query", "schema": { "type": "string", "enum": [ "GOOD", "FAIR", "POOR" ] } }, { "name": "includeUsage", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "search results matching criteria", "content": { "application/json": { "schema": { "type": "array", "items": { "required": [ "application", "family", "health", "jitter", "latency", "loss" ], "type": "object", "properties": { "application": { "type": "string", "example": "http" }, "family": { "type": "string", "example": "audio" }, "health": { "pattern": "(good|fair|poor)", "type": "string", "example": "good" }, "jitter": { "type": "number", "format": "double", "example": 1 }, "latency": { "type": "number", "format": "double", "example": 10 }, "loss": { "type": "number", "format": "double", "example": 1 } }, "$$ref": "#/components/schemas/ApplicationsSiteItem" } } } } }, "400": { "description": "Bad Request" } }, "x-roles-required": "Application Monitoring-read,Application Monitoring-write" } }, "/statistics/perfmon/applications/sites/health": { "get": { "tags": [ "Monitoring - Performance Monitor" ], "summary": "all sites all applications health data", "description": "Get applications health for all sites ", "operationId": "getApplicationsSitesHealth", "parameters": [ { "name": "isHeatMap", "in": "query", "schema": { "type": "boolean" } }, { "name": "last_n_hours", "in": "query", "schema": { "type": "string", "enum": [ "1", "3", "6", "12", "24" ] } }, { "name": "health", "in": "query", "schema": { "type": "string", "enum": [ "GOOD", "FAIR", "POOR" ] } }, { "name": "includeUsage", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "useCache", "in": "query", "description": "Use cache data", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "search results matching criteria", "content": { "application/json": { "schema": { "type": "array", "items": { "required": [ "application", "fair_site", "family", "good_site", "health", "poor_site" ], "type": "object", "properties": { "application": { "type": "string", "example": "http" }, "fair_site": { "type": "integer", "format": "int32", "example": 1 }, "family": { "type": "string", "example": "audio" }, "good_site": { "type": "integer", "format": "int32", "example": 10 }, "health": { "pattern": "(good|fair|poor)", "type": "string", "example": "good" }, "poor_site": { "type": "integer", "format": "int32", "example": 1 } }, "$$ref": "#/components/schemas/ApplicationsSitesItem" } } } } }, "400": { "description": "Bad Request" } }, "x-roles-required": "Application Monitoring-read,Application Monitoring-write" } }, "/statistics/powerconsumption": { "post": { "tags": [ "Monitoring - Power Consumption Statistics" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getStatsRawData_MonitoringPowerConsumptionStatistics_2804", "parameters": [ { "name": "page", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "schema": { "type": "string", "enum": [ "asc", "ASC", "Asc", "desc", "DESC", "Desc" ] } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "power consumption query": { "description": "power consumption query", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "12" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.15" ], "field": "vdevice_name", "type": "string", "operator": "in" } ] }, "fields": [ "entry_time", "count", "power_usage", "current_reading" ], "sort": [ { "field": "entry_time", "type": "date", "order": "asc" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDevicePowerconsumptionStatisticsapiParameterExamplePowerconsumption" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "cost": { "type": "number", "example": 0.029 }, "count": { "type": "integer", "format": "int32", "example": 1 }, "emission": { "type": "number", "example": 0.031 }, "entry_time": { "type": "integer", "format": "int32", "example": 171705600 }, "power_usage": { "type": "number", "example": 0.19 } }, "$$ref": "#/components/schemas/PowerConsumptionRespData" } }, "entryTimeList": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "header": { "type": "object", "properties": { "chart": { "type": "object", "properties": { "series": { "type": "array", "items": { "type": "string" } }, "title": { "type": "string" }, "xAxis": { "type": "array", "items": { "type": "string" } }, "xAxisLabel": { "type": "string" }, "yAxis": { "type": "array", "items": { "type": "string" } }, "yAxisLabel": { "type": "string" } }, "$$ref": "#/components/schemas/ChartObject" }, "columns": { "required": [ "dataType", "property", "title" ], "type": "object", "properties": { "dataType": { "type": "string", "example": "date" }, "displayFormat": { "type": "string", "example": "DD MMM YYYY h:mm:ss A z" }, "hideable": { "type": "boolean", "example": true }, "inputFormat": { "type": "string", "example": "unix-time" }, "isDisplay": { "type": "boolean", "example": true }, "minWidth": { "type": "integer", "format": "int32", "example": 300 }, "property": { "type": "string", "example": "entry_time" }, "title": { "type": "string", "example": "Timestamp" }, "width": { "type": "integer", "format": "int32", "example": 220 } }, "$$ref": "#/components/schemas/PowerConsumptionColumns" }, "fields": { "type": "object", "properties": { "dataType": { "type": "string", "example": "date" }, "property": { "type": "string", "example": "entry_time" } }, "$$ref": "#/components/schemas/GetStatDataFields" }, "generatedOn": { "type": "integer", "format": "int64" }, "viewKeys": { "type": "object", "properties": { "preferenceKey": { "type": "string" }, "uniqueKey": { "type": "array", "items": { "type": "string" } } }, "$$ref": "#/components/schemas/PowerConsumptionViewKeys" } }, "$$ref": "#/components/schemas/PowerConsumptionRespHeader" } }, "$$ref": "#/components/schemas/PowerConsumptionResp" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Energy Management-read" } }, "/statistics/powerconsumption/aggregation": { "post": { "tags": [ "Monitoring - Power Consumption Statistics" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationDataByQuery_MonitoringPowerConsumptionStatistics_4004", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "power consumption aggregation query": { "description": "power consumption aggregation query", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "12" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "" ], "field": "dir", "type": "string", "operator": "in" }, { "value": [ "SystemEnergy" ], "field": "comp_name", "type": "string", "operator": "in" } ] }, "sort": [ { "field": "entry_time", "type": "date", "order": "asc" } ], "aggregation": { "histogram": { "property": "entry_time", "type": "hour", "interval": 1, "order": "asc" }, "metrics": [ { "property": "power_usage", "type": "sum" }, { "property": "emission", "type": "sum" }, { "property": "cost", "type": "sum" } ] } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDevicePowerconsumptionStatisticsapiParameterExamplePowerconsumptionaggregation" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "cost": { "type": "number", "example": 0.029 }, "count": { "type": "integer", "format": "int32", "example": 1 }, "emission": { "type": "number", "example": 0.031 }, "entry_time": { "type": "integer", "format": "int32", "example": 171705600 }, "power_usage": { "type": "number", "example": 0.19 } }, "$$ref": "#/components/schemas/PowerConsumptionRespData" } }, "entryTimeList": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "header": { "type": "object", "properties": { "chart": { "type": "object", "properties": { "series": { "type": "array", "items": { "type": "string" } }, "title": { "type": "string" }, "xAxis": { "type": "array", "items": { "type": "string" } }, "xAxisLabel": { "type": "string" }, "yAxis": { "type": "array", "items": { "type": "string" } }, "yAxisLabel": { "type": "string" } }, "$$ref": "#/components/schemas/ChartObject" }, "columns": { "required": [ "dataType", "property", "title" ], "type": "object", "properties": { "dataType": { "type": "string", "example": "date" }, "displayFormat": { "type": "string", "example": "DD MMM YYYY h:mm:ss A z" }, "hideable": { "type": "boolean", "example": true }, "inputFormat": { "type": "string", "example": "unix-time" }, "isDisplay": { "type": "boolean", "example": true }, "minWidth": { "type": "integer", "format": "int32", "example": 300 }, "property": { "type": "string", "example": "entry_time" }, "title": { "type": "string", "example": "Timestamp" }, "width": { "type": "integer", "format": "int32", "example": 220 } }, "$$ref": "#/components/schemas/PowerConsumptionColumns" }, "fields": { "type": "object", "properties": { "dataType": { "type": "string", "example": "date" }, "property": { "type": "string", "example": "entry_time" } }, "$$ref": "#/components/schemas/GetStatDataFields" }, "generatedOn": { "type": "integer", "format": "int64" }, "viewKeys": { "type": "object", "properties": { "preferenceKey": { "type": "string" }, "uniqueKey": { "type": "array", "items": { "type": "string" } } }, "$$ref": "#/components/schemas/PowerConsumptionViewKeys" } }, "$$ref": "#/components/schemas/PowerConsumptionRespHeader" } }, "$$ref": "#/components/schemas/PowerConsumptionResp" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Energy Management-read" } }, "/statistics/powerconsumption/device": { "post": { "tags": [ "Monitoring - Power Consumption Statistics" ], "description": "Get Power Consumption Per Device stats", "operationId": "getPowerConsumptionDevice", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "power consumption per device query": { "description": "power consumption per device query", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "12" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "" ], "field": "dir", "type": "string", "operator": "in" }, { "value": [ "SystemEnergy" ], "field": "comp_name", "type": "string", "operator": "in" } ] }, "aggregation": { "metrics": [ { "property": "power_usage", "type": "sum" }, { "property": "emission", "type": "sum" }, { "property": "cost", "type": "sum" } ], "field": [ { "property": "vdevice_name" }, { "property": "site_id" } ] } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDevicePowerconsumptionStatisticsapiParameterExamplePowerconsumptiondevice" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "carbon_intensity": { "type": "number", "example": 460.4 }, "change": { "type": "number", "example": 0.3518 }, "cost": { "type": "number", "example": 0.315 }, "devices": { "type": "array", "items": { "type": "object", "properties": { "carbon_intensity": { "type": "number", "example": 460.4 }, "change": { "type": "number", "example": 0.3518 }, "cost": { "type": "number", "example": 0.315 }, "device_model": { "type": "string", "example": "vedge-C8300-1N1S-6T" }, "device_type": { "type": "string", "example": "vedge" }, "emission": { "type": "number", "example": 0.338 }, "local_system_ip": { "type": "string", "example": "172.16.255.16" }, "name": { "type": "string", "example": "pm5" }, "power_usage": { "type": "number", "example": 2.098 }, "site_id": { "type": "string", "example": "600" }, "site_name": { "type": "string", "example": "SITE_600" }, "system_ip": { "type": "string", "example": "172.16.255.16" }, "uuid": { "type": "string", "format": "uuid" } }, "$$ref": "#/components/schemas/PowerConsumptionDeviceEntry" } }, "emission": { "type": "number", "example": 0.338 }, "power_usage": { "type": "number", "example": 2.098 }, "site_id": { "type": "string", "example": "500" }, "site_name": { "type": "string", "example": "SITE_500" } }, "$$ref": "#/components/schemas/PowerConsumptionSiteEntry" } } }, "$$ref": "#/components/schemas/PowerConsumptionDeviceResp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Energy Management-read" } }, "/statistics/powerconsumption/energymix": { "post": { "tags": [ "Monitoring - Power Consumption Statistics" ], "description": "Get Power Consumption Energy Mix", "operationId": "getPowerConsumptionEnergyMix", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "power consumption energy mix query": { "description": "power consumption energy mix query", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "12" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "" ], "field": "dir", "type": "string", "operator": "in" }, { "value": [ "SystemEnergy" ], "field": "comp_name", "type": "string", "operator": "in" } ] }, "aggregation": { "metrics": [ { "property": "power_usage", "type": "sum" } ] } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDevicePowerconsumptionStatisticsapiParameterExamplePowerconsumptionenergymix" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "energyMix": { "type": "array", "items": { "type": "object", "properties": { "percentage": { "type": "number", "example": 12 }, "property": { "type": "string", "example": "nuclear" }, "usage": { "type": "number", "example": 12 } }, "$$ref": "#/components/schemas/PowerConsumptionBreakDown" } }, "low_carbon": { "type": "number", "example": 68 } }, "$$ref": "#/components/schemas/PowerConsumptionEnergyMixResp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Energy Management-read" } }, "/statistics/powerconsumption/supportdevicelist": { "get": { "tags": [ "Monitoring - Power Consumption Statistics" ], "description": "Get power consumption collection supported device list", "operationId": "getSupportedDeviceList", "parameters": [ { "name": "last_n_hours", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 24 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "devices": { "type": "array", "items": { "type": "object", "properties": { "device_model": { "type": "string", "example": "vedge-C8000V" }, "local_system_ip": { "type": "string", "example": "172.16.255.15" }, "name": { "type": "string", "example": "vm5" }, "site_id": { "type": "string", "example": "500" }, "site_name": { "type": "string", "example": "SITE_500" }, "system_ip": { "type": "string", "example": "172.16.255.15" }, "uuid": { "type": "string", "example": "C8K-f8472498-bb89-4e88-a2da-1760257c0825" } }, "$$ref": "#/components/schemas/DeviceListEntry" } }, "supported-devices": { "type": "array", "items": { "type": "object", "properties": { "device_model": { "type": "string", "example": "vedge-C8000V" }, "hasEstimated": { "type": "boolean", "example": true }, "local_system_ip": { "type": "string", "example": "172.16.255.16" }, "name": { "type": "string", "example": "vm6" }, "site_id": { "type": "string", "example": "600" }, "site_name": { "type": "string", "example": "SITE_600" }, "system_ip": { "type": "string", "example": "172.16.255.16" }, "uuid": { "type": "string", "example": "C8K-f8472498-bb89-4e88-a2da-1760257c0825" } }, "$$ref": "#/components/schemas/SupportedDeviceListEntry" } } }, "$$ref": "#/components/schemas/SupportedDeviceList" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Energy Management-read" } }, "/statistics/powerconsumption/total": { "post": { "tags": [ "Monitoring - Power Consumption Statistics" ], "description": "Get Power Consumption Total stats", "operationId": "getPowerConsumptionTotal", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "power consumption total query": { "description": "power consumption total query", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "12" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "" ], "field": "dir", "type": "string", "operator": "in" }, { "value": [ "SystemEnergy" ], "field": "comp_name", "type": "string", "operator": "in" } ] }, "aggregation": { "metrics": [ { "property": "power_usage", "type": "sum" }, { "property": "emission", "type": "sum" }, { "property": "cost", "type": "sum" } ] } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDevicePowerconsumptionStatisticsapiParameterExamplePowerconsumptiontotal" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "carbon_intensity": { "type": "number", "example": 460.4 }, "change": { "type": "number", "example": 0.2518 }, "cost": { "type": "number", "example": 0.215 }, "emission": { "type": "number", "example": 0.238 }, "power_usage": { "type": "number", "example": 3.098 } }, "$$ref": "#/components/schemas/PowerConsumptionTotalResp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Energy Management-read" } }, "/statistics/ppl/ctg": { "post": { "tags": [ "Monitoring - PPL" ], "description": "Get stats raw data", "operationId": "getStatsRawData_MonitoringPpl_1904", "parameters": [ { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order", "schema": { "type": "string" } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "field": [ { "property": "name", "sequence": 1 }, { "property": "proto", "sequence": 2 } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" }, "metrics": [ { "property": "latency", "type": "avg" }, { "property": "loss", "type": "avg" }, { "property": "loss_percentage", "type": "avg" }, { "property": "vqoe_score", "type": "avg" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "lte", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.106.1", "local_color": "lte", "src_ip": "10.1.15.15", "sla_class_names": "test_sla_class", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400052, "state": "Up", "local_system_ip": "172.16.255.15", "tenant": "default", "entry_time": 1589073783045, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.15", "fec_rx": 0, "src_port": 12366, "jitter": 1, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.15", "proto": "IPSEC", "vip_idx": 351, "dst_port": 12386, "name": "172.16.255.15:lte-172.16.255.16:lte", "sla_class_list": "0,1", "tunnel_color": "lte:lte", "host_name": "vm5", "id": "IuBG_HEB_JLsavezVkiZ" } ], "pageInfo": { "startTime": "1589073783045", "endTime": "1589072535795", "count": 15 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "get": { "tags": [ "Monitoring - PPL" ], "description": "Get stats raw data", "operationId": "getStatDataRawData_MonitoringPpl_1903", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "metrics": [ { "property": "latency", "type": "avg" } ] } } }, { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by(emp:entry_time)", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "3g", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.101.2", "local_color": "lte", "src_ip": "10.1.14.14", "sla_class_names": "None", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400056, "state": "Up", "local_system_ip": "172.16.255.14", "tenant": "default", "entry_time": 1589073792008, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.14", "fec_rx": 0, "src_port": 12380, "jitter": 1, "remote_system_ip": "172.16.255.11", "vdevice_name": "172.16.255.14", "proto": "IPSEC", "vip_idx": 190, "dst_port": 12366, "name": "172.16.255.14:lte-172.16.255.11:3g", "sla_class_list": "0", "tunnel_color": "3g:lte", "host_name": "vm4", "id": "4OBG_HEB_JLsavezVUfr" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/ppl/ctg/aggregation": { "post": { "tags": [ "Monitoring - PPL" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationDataByQuery_MonitoringPpl_3104", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default,dca" }, "get": { "tags": [ "Monitoring - PPL" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getAggregationDataByQuery_MonitoringPpl_3103", "parameters": [ { "name": "query", "in": "query", "description": "Query filter", "schema": { "type": "string" }, "examples": { "query string": {} } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/ppl/ctg/csv": { "get": { "tags": [ "Monitoring - PPL" ], "description": "Get raw data with optional query as CSV", "operationId": "getStatDataRawDataAsCSV_MonitoringPpl_2303", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" }, "examples": { "Search result in csv format": { "description": "Search result in csv format", "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/ppl/ctg/doccount": { "post": { "tags": [ "Monitoring - PPL" ], "description": "Get response count of a query", "operationId": "getCountPost_MonitoringPpl_2804", "requestBody": { "description": "Query", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query": { "description": "Query", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 9642 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Monitoring - PPL" ], "description": "Get response count of a query", "operationId": "getCount_MonitoringPpl_2803", "parameters": [ { "name": "query", "in": "query", "description": "Query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 17193 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/ppl/ctg/fields": { "get": { "tags": [ "Monitoring - PPL" ], "description": "Get fields and type", "operationId": "getStatDataFields_MonitoringPpl_2603", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "example": [ { "dataType": "string", "property": "mac" }, { "dataType": "string", "property": "vap" }, { "dataType": "number", "property": "rssi" }, { "dataType": "string", "property": "mode" }, { "dataType": "number", "property": "bandwidth" }, { "dataType": "string", "property": "data_security" }, { "dataType": "number", "property": "rx_rate" }, { "dataType": "string", "property": "assoc_time" }, { "dataType": "date", "property": "entry_time" }, { "dataType": "date", "property": "statcycletime" }, { "dataType": "string", "property": "ssid" }, { "dataType": "number", "property": "vip_idx" }, { "dataType": "date", "property": "vip_time" }, { "dataType": "string", "property": "vdevice_name" }, { "dataType": "string", "property": "host_name" }, { "dataType": "string", "property": "device_model" } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/ppl/ctg/page": { "get": { "tags": [ "Monitoring - PPL" ], "description": "Get stats raw data", "operationId": "getStatsPaginationRawData_MonitoringPpl_2403", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } }, { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" }, "post": { "tags": [ "Monitoring - PPL" ], "description": "Get stats raw data", "operationId": "getPostStatsPaginationRawData_MonitoringPpl_2404", "parameters": [ { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/ppl/ctg/query/fields": { "get": { "tags": [ "Monitoring - PPL" ], "description": "Get query fields", "operationId": "getStatQueryFields_MonitoringPpl_3203", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "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" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/ppl/reordering": { "post": { "tags": [ "Monitoring - PPL" ], "description": "Get stats raw data", "operationId": "getStatsRawData_MonitoringPpl_2604", "parameters": [ { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order", "schema": { "type": "string" } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "field": [ { "property": "name", "sequence": 1 }, { "property": "proto", "sequence": 2 } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" }, "metrics": [ { "property": "latency", "type": "avg" }, { "property": "loss", "type": "avg" }, { "property": "loss_percentage", "type": "avg" }, { "property": "vqoe_score", "type": "avg" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "lte", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.106.1", "local_color": "lte", "src_ip": "10.1.15.15", "sla_class_names": "test_sla_class", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400052, "state": "Up", "local_system_ip": "172.16.255.15", "tenant": "default", "entry_time": 1589073783045, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.15", "fec_rx": 0, "src_port": 12366, "jitter": 1, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.15", "proto": "IPSEC", "vip_idx": 351, "dst_port": 12386, "name": "172.16.255.15:lte-172.16.255.16:lte", "sla_class_list": "0,1", "tunnel_color": "lte:lte", "host_name": "vm5", "id": "IuBG_HEB_JLsavezVkiZ" } ], "pageInfo": { "startTime": "1589073783045", "endTime": "1589072535795", "count": 15 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "get": { "tags": [ "Monitoring - PPL" ], "description": "Get stats raw data", "operationId": "getStatDataRawData_MonitoringPpl_2603", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "metrics": [ { "property": "latency", "type": "avg" } ] } } }, { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by(emp:entry_time)", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "3g", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.101.2", "local_color": "lte", "src_ip": "10.1.14.14", "sla_class_names": "None", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400056, "state": "Up", "local_system_ip": "172.16.255.14", "tenant": "default", "entry_time": 1589073792008, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.14", "fec_rx": 0, "src_port": 12380, "jitter": 1, "remote_system_ip": "172.16.255.11", "vdevice_name": "172.16.255.14", "proto": "IPSEC", "vip_idx": 190, "dst_port": 12366, "name": "172.16.255.14:lte-172.16.255.11:3g", "sla_class_list": "0", "tunnel_color": "3g:lte", "host_name": "vm4", "id": "4OBG_HEB_JLsavezVUfr" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/ppl/reordering/aggregation": { "get": { "tags": [ "Monitoring - PPL" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getAggregationDataByQuery_MonitoringPpl_3803", "parameters": [ { "name": "query", "in": "query", "description": "Query filter", "schema": { "type": "string" }, "examples": { "query string": {} } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "post": { "tags": [ "Monitoring - PPL" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationDataByQuery_MonitoringPpl_3804", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default,dca" } }, "/statistics/ppl/reordering/csv": { "get": { "tags": [ "Monitoring - PPL" ], "description": "Get raw data with optional query as CSV", "operationId": "getStatDataRawDataAsCSV_MonitoringPpl_3003", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" }, "examples": { "Search result in csv format": { "description": "Search result in csv format", "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/ppl/reordering/doccount": { "post": { "tags": [ "Monitoring - PPL" ], "description": "Get response count of a query", "operationId": "getCountPost_MonitoringPpl_3504", "requestBody": { "description": "Query", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query": { "description": "Query", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 9642 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Monitoring - PPL" ], "description": "Get response count of a query", "operationId": "getCount_MonitoringPpl_3503", "parameters": [ { "name": "query", "in": "query", "description": "Query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 17193 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/ppl/reordering/fields": { "get": { "tags": [ "Monitoring - PPL" ], "description": "Get fields and type", "operationId": "getStatDataFields_MonitoringPpl_3303", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "example": [ { "dataType": "string", "property": "mac" }, { "dataType": "string", "property": "vap" }, { "dataType": "number", "property": "rssi" }, { "dataType": "string", "property": "mode" }, { "dataType": "number", "property": "bandwidth" }, { "dataType": "string", "property": "data_security" }, { "dataType": "number", "property": "rx_rate" }, { "dataType": "string", "property": "assoc_time" }, { "dataType": "date", "property": "entry_time" }, { "dataType": "date", "property": "statcycletime" }, { "dataType": "string", "property": "ssid" }, { "dataType": "number", "property": "vip_idx" }, { "dataType": "date", "property": "vip_time" }, { "dataType": "string", "property": "vdevice_name" }, { "dataType": "string", "property": "host_name" }, { "dataType": "string", "property": "device_model" } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/ppl/reordering/page": { "get": { "tags": [ "Monitoring - PPL" ], "description": "Get stats raw data", "operationId": "getStatsPaginationRawData_MonitoringPpl_3103", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } }, { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" }, "post": { "tags": [ "Monitoring - PPL" ], "description": "Get stats raw data", "operationId": "getPostStatsPaginationRawData_MonitoringPpl_3104", "parameters": [ { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/ppl/reordering/query/fields": { "get": { "tags": [ "Monitoring - PPL" ], "description": "Get query fields", "operationId": "getStatQueryFields_MonitoringPpl_3903", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "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" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/process": { "get": { "tags": [ "Monitoring - Stats Processing" ], "description": "Process stats data", "operationId": "processStatisticsData", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Status": { "description": "Status", "value": { "ActivateDataProcessing": "success" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "admin" } }, "/statistics/process/counters": { "get": { "tags": [ "Monitoring - Stats Processing" ], "description": "Get statistics processing counters", "operationId": "getStatisticsProcessingCounters", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Statistics processing counters": { "description": "Statistics processing counters", "value": [] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "admin" } }, "/statistics/process/status": { "get": { "tags": [ "Monitoring - Stats Processing" ], "description": "Get stats process report", "operationId": "generateStatsProcessReport", "parameters": [ { "name": "processQueue", "in": "query", "description": "Process queue", "schema": { "maximum": 4, "minimum": -1, "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Process report": { "description": "Process report", "value": [] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "admin" } }, "/statistics/process/thread/status": { "get": { "tags": [ "Monitoring - Stats Processing" ], "description": "Get stats process thread report", "operationId": "generateStatsProcessThreadReport", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Process thread report": { "description": "Process thread report", "value": [] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "admin" } }, "/statistics/qfp": { "post": { "tags": [ "Monitoring - Qfp" ], "description": "Get stats raw data", "operationId": "getStatsRawData_MonitoringQfp_1504", "parameters": [ { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order", "schema": { "type": "string" } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "field": [ { "property": "name", "sequence": 1 }, { "property": "proto", "sequence": 2 } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" }, "metrics": [ { "property": "latency", "type": "avg" }, { "property": "loss", "type": "avg" }, { "property": "loss_percentage", "type": "avg" }, { "property": "vqoe_score", "type": "avg" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "lte", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.106.1", "local_color": "lte", "src_ip": "10.1.15.15", "sla_class_names": "test_sla_class", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400052, "state": "Up", "local_system_ip": "172.16.255.15", "tenant": "default", "entry_time": 1589073783045, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.15", "fec_rx": 0, "src_port": 12366, "jitter": 1, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.15", "proto": "IPSEC", "vip_idx": 351, "dst_port": 12386, "name": "172.16.255.15:lte-172.16.255.16:lte", "sla_class_list": "0,1", "tunnel_color": "lte:lte", "host_name": "vm5", "id": "IuBG_HEB_JLsavezVkiZ" } ], "pageInfo": { "startTime": "1589073783045", "endTime": "1589072535795", "count": 15 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "get": { "tags": [ "Monitoring - Qfp" ], "description": "Get stats raw data", "operationId": "getStatDataRawData_MonitoringQfp_1503", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "metrics": [ { "property": "latency", "type": "avg" } ] } } }, { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by(emp:entry_time)", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "3g", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.101.2", "local_color": "lte", "src_ip": "10.1.14.14", "sla_class_names": "None", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400056, "state": "Up", "local_system_ip": "172.16.255.14", "tenant": "default", "entry_time": 1589073792008, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.14", "fec_rx": 0, "src_port": 12380, "jitter": 1, "remote_system_ip": "172.16.255.11", "vdevice_name": "172.16.255.14", "proto": "IPSEC", "vip_idx": 190, "dst_port": 12366, "name": "172.16.255.14:lte-172.16.255.11:3g", "sla_class_list": "0", "tunnel_color": "3g:lte", "host_name": "vm4", "id": "4OBG_HEB_JLsavezVUfr" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/qfp/aggregation": { "get": { "tags": [ "Monitoring - Qfp" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getAggregationDataByQuery_MonitoringQfp_2703", "parameters": [ { "name": "query", "in": "query", "description": "Query filter", "schema": { "type": "string" }, "examples": { "query string": {} } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "post": { "tags": [ "Monitoring - Qfp" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationDataByQuery_MonitoringQfp_2704", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default,dca" } }, "/statistics/qfp/csv": { "get": { "tags": [ "Monitoring - Qfp" ], "description": "Get raw data with optional query as CSV", "operationId": "getStatDataRawDataAsCSV_MonitoringQfp_1903", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" }, "examples": { "Search result in csv format": { "description": "Search result in csv format", "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/qfp/doccount": { "get": { "tags": [ "Monitoring - Qfp" ], "description": "Get response count of a query", "operationId": "getCount_MonitoringQfp_2403", "parameters": [ { "name": "query", "in": "query", "description": "Query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 17193 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Monitoring - Qfp" ], "description": "Get response count of a query", "operationId": "getCountPost_MonitoringQfp_2404", "requestBody": { "description": "Query", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query": { "description": "Query", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 9642 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/qfp/fields": { "get": { "tags": [ "Monitoring - Qfp" ], "description": "Get fields and type", "operationId": "getStatDataFields_MonitoringQfp_2203", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "example": [ { "dataType": "string", "property": "mac" }, { "dataType": "string", "property": "vap" }, { "dataType": "number", "property": "rssi" }, { "dataType": "string", "property": "mode" }, { "dataType": "number", "property": "bandwidth" }, { "dataType": "string", "property": "data_security" }, { "dataType": "number", "property": "rx_rate" }, { "dataType": "string", "property": "assoc_time" }, { "dataType": "date", "property": "entry_time" }, { "dataType": "date", "property": "statcycletime" }, { "dataType": "string", "property": "ssid" }, { "dataType": "number", "property": "vip_idx" }, { "dataType": "date", "property": "vip_time" }, { "dataType": "string", "property": "vdevice_name" }, { "dataType": "string", "property": "host_name" }, { "dataType": "string", "property": "device_model" } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/qfp/page": { "get": { "tags": [ "Monitoring - Qfp" ], "description": "Get stats raw data", "operationId": "getStatsPaginationRawData_MonitoringQfp_2003", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } }, { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" }, "post": { "tags": [ "Monitoring - Qfp" ], "description": "Get stats raw data", "operationId": "getPostStatsPaginationRawData_MonitoringQfp_2004", "parameters": [ { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/qfp/query/fields": { "get": { "tags": [ "Monitoring - Qfp" ], "description": "Get query fields", "operationId": "getStatQueryFields_MonitoringQfp_2803", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "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" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/qfpdrop": { "get": { "tags": [ "Monitoring - Qfp Drop Statistics" ], "description": "Get stats raw data", "operationId": "getStatDataRawData_MonitoringQfpDropStatistics_1903", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "metrics": [ { "property": "latency", "type": "avg" } ] } } }, { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by(emp:entry_time)", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "3g", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.101.2", "local_color": "lte", "src_ip": "10.1.14.14", "sla_class_names": "None", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400056, "state": "Up", "local_system_ip": "172.16.255.14", "tenant": "default", "entry_time": 1589073792008, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.14", "fec_rx": 0, "src_port": 12380, "jitter": 1, "remote_system_ip": "172.16.255.11", "vdevice_name": "172.16.255.14", "proto": "IPSEC", "vip_idx": 190, "dst_port": 12366, "name": "172.16.255.14:lte-172.16.255.11:3g", "sla_class_list": "0", "tunnel_color": "3g:lte", "host_name": "vm4", "id": "4OBG_HEB_JLsavezVUfr" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "post": { "tags": [ "Monitoring - Qfp Drop Statistics" ], "description": "Get stats raw data", "operationId": "getStatsRawData_MonitoringQfpDropStatistics_1904", "parameters": [ { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order", "schema": { "type": "string" } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "field": [ { "property": "name", "sequence": 1 }, { "property": "proto", "sequence": 2 } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" }, "metrics": [ { "property": "latency", "type": "avg" }, { "property": "loss", "type": "avg" }, { "property": "loss_percentage", "type": "avg" }, { "property": "vqoe_score", "type": "avg" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "lte", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.106.1", "local_color": "lte", "src_ip": "10.1.15.15", "sla_class_names": "test_sla_class", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400052, "state": "Up", "local_system_ip": "172.16.255.15", "tenant": "default", "entry_time": 1589073783045, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.15", "fec_rx": 0, "src_port": 12366, "jitter": 1, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.15", "proto": "IPSEC", "vip_idx": 351, "dst_port": 12386, "name": "172.16.255.15:lte-172.16.255.16:lte", "sla_class_list": "0,1", "tunnel_color": "lte:lte", "host_name": "vm5", "id": "IuBG_HEB_JLsavezVkiZ" } ], "pageInfo": { "startTime": "1589073783045", "endTime": "1589072535795", "count": 15 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/qfpdrop/aggregation": { "get": { "tags": [ "Monitoring - Qfp Drop Statistics" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getAggregationDataByQuery_MonitoringQfpDropStatistics_3103", "parameters": [ { "name": "query", "in": "query", "description": "Query filter", "schema": { "type": "string" }, "examples": { "Monitoring - Qfp Drop Statistics": { "description": "generated by base class - Monitoring - Qfp Drop Statistics", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "12" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.15" ], "field": "vdevice_name", "type": "string", "operator": "in" } ] }, "aggregation": { "field": [ { "property": "drop_name", "sequence": 1 } ], "metrics": [ { "property": "pkts", "type": "sum" } ] } }, "$$ref": "#/components/examples/ComViptelaVmanageServerElasticsearchAbstractstatisticsrestfulresourceParameterExampleQfpdropstatistics" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Monitoring - Qfp Drop Statistics": { "description": "generated by base class - Monitoring - Qfp Drop Statistics", "value": { "header": { "generatedOn": 1739864940509, "columns": [ { "property": "drop_name", "title": "Drop_name", "dataType": "string", "isDisplay": true }, { "property": "pkts", "title": "Pkts", "dataType": "number", "isDisplay": true } ], "fields": [ { "property": "drop_name", "dataType": "string" }, { "property": "pkts", "dataType": "number" } ] }, "data": [ { "pkts": 3667, "drop_name": "UnconfiguredIpv6Fia", "count": 20, "description": "Unconfigured IPv6 feature invocation array (FIA)." }, { "pkts": 39, "drop_name": "UnconfiguredIpv4Fia", "count": 2, "description": "Unconfigured IPv4 feature invocation array (FIA)." }, { "pkts": 1701, "drop_name": "Disabled", "count": 1, "description": "Disabled." }, { "pkts": 5, "drop_name": "Ipv6NoRoute", "count": 1, "description": "IPv6 no route." }, { "pkts": 2, "drop_name": "IpsecInput", "count": 1, "description": "IPSEC input." }, { "pkts": 2, "drop_name": "Ipv4NoRoute", "count": 1, "description": "IPv4 no route." }, { "pkts": 17, "drop_name": "SdwanImplicitAclDrop", "count": 1, "description": "Software defined WAN (SDWAN) implicit access control list (ACL)." } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerElasticsearchAbstractstatisticsrestfulresourceResponseExampleQfpdropstatistics" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "post": { "tags": [ "Monitoring - Qfp Drop Statistics" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationDataByQuery_MonitoringQfpDropStatistics_3104", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "12" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.15" ], "field": "vdevice_name", "type": "string", "operator": "in" } ] }, "aggregation": { "field": [ { "property": "drop_name", "sequence": 1 } ], "metrics": [ { "property": "pkts", "type": "sum" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Aggregated search result": { "description": "Aggregated search result", "value": { "header": { "generatedOn": 1739866313557, "columns": [ { "property": "drop_name", "title": "Drop_name", "dataType": "string", "isDisplay": true }, { "property": "pkts", "title": "Pkts", "dataType": "number", "isDisplay": true } ], "fields": [ { "property": "drop_name", "dataType": "string" }, { "property": "pkts", "dataType": "number" } ] }, "data": [ { "pkts": 5055, "drop_name": "UnconfiguredIpv6Fia", "count": 24, "description": "Unconfigured IPv6 feature invocation array (FIA)." }, { "pkts": 24, "drop_name": "SdwanImplicitAclDrop", "count": 12, "description": "Software defined WAN (SDWAN) implicit access control list (ACL)." } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,System-read" } }, "/statistics/qfpdrop/csv": { "get": { "tags": [ "Monitoring - Qfp Drop Statistics" ], "description": "Get raw data with optional query as CSV", "operationId": "getStatDataRawDataAsCSV_MonitoringQfpDropStatistics_2303", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" }, "examples": { "Search result in csv format": { "description": "Search result in csv format", "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/qfpdrop/doccount": { "get": { "tags": [ "Monitoring - Qfp Drop Statistics" ], "description": "Get response count of a query", "operationId": "getCount_MonitoringQfpDropStatistics_2803", "parameters": [ { "name": "query", "in": "query", "description": "Query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 17193 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Monitoring - Qfp Drop Statistics" ], "description": "Get response count of a query", "operationId": "getCountPost_MonitoringQfpDropStatistics_2804", "requestBody": { "description": "Query", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query": { "description": "Query", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 9642 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/qfpdrop/fields": { "get": { "tags": [ "Monitoring - Qfp Drop Statistics" ], "description": "Get fields and type", "operationId": "getStatDataFields_MonitoringQfpDropStatistics_2603", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "example": [ { "dataType": "string", "property": "mac" }, { "dataType": "string", "property": "vap" }, { "dataType": "number", "property": "rssi" }, { "dataType": "string", "property": "mode" }, { "dataType": "number", "property": "bandwidth" }, { "dataType": "string", "property": "data_security" }, { "dataType": "number", "property": "rx_rate" }, { "dataType": "string", "property": "assoc_time" }, { "dataType": "date", "property": "entry_time" }, { "dataType": "date", "property": "statcycletime" }, { "dataType": "string", "property": "ssid" }, { "dataType": "number", "property": "vip_idx" }, { "dataType": "date", "property": "vip_time" }, { "dataType": "string", "property": "vdevice_name" }, { "dataType": "string", "property": "host_name" }, { "dataType": "string", "property": "device_model" } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/qfpdrop/overview/droptype/{typename}": { "get": { "tags": [ "Monitoring - Qfp Drop Statistics" ], "description": "Get qfp drop statistics overview by drop type", "operationId": "getQfpDropOverviewByDropType", "parameters": [ { "name": "typename", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "last_n_hours", "in": "query", "schema": { "maximum": 24, "minimum": 1, "type": "integer", "format": "int32", "default": 12 } }, { "name": "limit", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32", "default": 10000 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "bytes": { "type": "integer", "format": "int32", "example": 18970 }, "deviceModel": { "type": "string", "example": "C8000v" }, "deviceType": { "type": "string", "example": "vedge" }, "hostName": { "type": "string", "example": "vm4" }, "localSystemIp": { "type": "string", "example": "172.16.255.14" }, "personality": { "type": "string", "example": "vedge" }, "pkts": { "type": "integer", "format": "int32", "example": 172 }, "reachability": { "type": "string", "example": "reachable" }, "siteId": { "type": "string", "example": "400" }, "siteName": { "type": "string", "example": "SITE_400" }, "uuid": { "type": "string", "example": "C8K-b8c08267-156c-42a9-a0f8-8fdd1d5f44b9" } }, "$$ref": "#/components/schemas/QfpDropTypeDataItem" } } }, "$$ref": "#/components/schemas/QfpDropTypeData" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/qfpdrop/overview/{type}": { "get": { "tags": [ "Monitoring - Qfp Drop Statistics" ], "description": "Get qfp drop statistics overview", "operationId": "getQfpDropOverview", "parameters": [ { "name": "type", "in": "path", "description": "Qfp Drop filter", "required": true, "schema": { "pattern": "droptype|device", "type": "string", "enum": [ "droptype", "device" ] } }, { "name": "last_n_hours", "in": "query", "schema": { "maximum": 24, "minimum": 1, "type": "integer", "format": "int32", "default": 12 } }, { "name": "limit", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32", "default": 1000 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "alarms": { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "integer", "format": "int64", "example": 10 }, "ruleName": { "type": "string", "example": "interface-state-change" }, "ruleNameDisplay": { "type": "string", "example": "Interface_State_Change" }, "severity": { "type": "string", "example": "Critical" } }, "$$ref": "#/components/schemas/DeviceAlarmData" } }, "count": { "type": "integer", "format": "int64", "example": 50 }, "hostName": { "type": "string", "example": "vm4" }, "siteId": { "type": "string", "example": "400" }, "siteName": { "type": "string", "example": "SITE_400" }, "systemIp": { "type": "string", "example": "172.16.255.14" } }, "$$ref": "#/components/schemas/FilterByDeviceData" } } }, "$$ref": "#/components/schemas/QfpDropOverviewFilterByDevice" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "bytes": { "type": "integer", "format": "int32", "example": 18970 }, "devices": { "type": "integer", "format": "int32", "example": 1 }, "dropName": { "type": "string", "example": "UnconfiguredIpv6Fia" }, "pkts": { "type": "integer", "format": "int32", "example": 172 }, "prevBytes": { "type": "integer", "format": "int32", "example": 20013 }, "prevPkts": { "type": "integer", "format": "int32", "example": 182 } }, "$$ref": "#/components/schemas/FilterByDropTypeData" } } }, "$$ref": "#/components/schemas/QfpDropOverviewFilterByDropType" } ] }, "examples": { "QfpDropOverviewFilterByDevice": { "description": "QfpDropOverviewFilterByDevice", "value": { "data": [ { "pkts": 5433, "bytes": 557404, "drops": [ { "drop_name": "UnconfiguredIpv6Fia", "pkts": 3667, "bytes": 398503 }, { "drop_name": "Disabled", "pkts": 1701, "bytes": 143279 }, { "drop_name": "UnconfiguredIpv4Fia", "pkts": 39, "bytes": 12573 }, { "drop_name": "SdwanImplicitAclDrop", "pkts": 17, "bytes": 2297 }, { "drop_name": "Ipv6NoRoute", "pkts": 5, "bytes": 280 }, { "drop_name": "IpsecInput", "pkts": 2, "bytes": 342 }, { "drop_name": "Ipv4NoRoute", "pkts": 2, "bytes": 130 } ], "site_id": "500", "site_name": "SITE_500", "host_name": "vm5", "system-ip": "172.16.255.15", "local-system-ip": "172.16.255.15", "device-model": "vedge-C8000V", "device-type": "vedge", "uuid": "C8K-e12ae656-f457-4f70-a3db-d3f6be21984f", "personality": "vedge", "reachability": "reachable" }, { "pkts": 5410, "bytes": 555699, "drops": [ { "drop_name": "UnconfiguredIpv6Fia", "pkts": 3666, "bytes": 398391 }, { "drop_name": "Disabled", "pkts": 1682, "bytes": 141947 }, { "drop_name": "UnconfiguredIpv4Fia", "pkts": 39, "bytes": 12573 }, { "drop_name": "SdwanImplicitAclDrop", "pkts": 14, "bytes": 1820 }, { "drop_name": "Ipv6NoRoute", "pkts": 5, "bytes": 280 }, { "drop_name": "IpsecInput", "pkts": 4, "bytes": 688 } ], "site_id": "600", "site_name": "SITE_600", "host_name": "vm6", "system-ip": "172.16.255.16", "local-system-ip": "172.16.255.16", "device-model": "vedge-C8000V", "device-type": "vedge", "uuid": "C8K-ebbe542d-49d9-443a-bdd2-5a974372c7e8", "personality": "vedge", "reachability": "reachable" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceQfpdropQfpdropstatisticsapiResponseExampleQfpdropoverviewfilterbydevice" }, "QfpDropOverviewFilterByDropType": { "description": "QfpDropOverviewFilterByDropType", "value": { "data": [ { "drop_name": "UnconfiguredIpv6Fia", "pkts": 7333, "bytes": 796894, "devices": 2, "prev_pkts": 0, "prev_bytes": 0 }, { "drop_name": "Disabled", "pkts": 3383, "bytes": 285226, "devices": 2, "prev_pkts": 0, "prev_bytes": 0 }, { "drop_name": "UnconfiguredIpv4Fia", "pkts": 78, "bytes": 25146, "devices": 2, "prev_pkts": 0, "prev_bytes": 0 }, { "drop_name": "SdwanImplicitAclDrop", "pkts": 31, "bytes": 4117, "devices": 2, "prev_pkts": 0, "prev_bytes": 0 }, { "drop_name": "Ipv6NoRoute", "pkts": 10, "bytes": 560, "devices": 2, "prev_pkts": 0, "prev_bytes": 0 }, { "drop_name": "IpsecInput", "pkts": 6, "bytes": 1030, "devices": 2, "prev_pkts": 0, "prev_bytes": 0 }, { "drop_name": "Ipv4NoRoute", "pkts": 2, "bytes": 130, "devices": 1, "prev_pkts": 0, "prev_bytes": 0 } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDeviceQfpdropQfpdropstatisticsapiResponseExampleQfpdropoverviewfilterbydroptype" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/qfpdrop/page": { "get": { "tags": [ "Monitoring - Qfp Drop Statistics" ], "description": "Get stats raw data", "operationId": "getStatsPaginationRawData_MonitoringQfpDropStatistics_2403", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } }, { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" }, "post": { "tags": [ "Monitoring - Qfp Drop Statistics" ], "description": "Get stats raw data", "operationId": "getPostStatsPaginationRawData_MonitoringQfpDropStatistics_2404", "parameters": [ { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/qfpdrop/query/fields": { "get": { "tags": [ "Monitoring - Qfp Drop Statistics" ], "description": "Get query fields", "operationId": "getStatQueryFields_MonitoringQfpDropStatistics_3203", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "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" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/qos": { "get": { "tags": [ "Monitoring - QoS" ], "description": "Get stats raw data", "operationId": "getStatDataRawData_MonitoringQos_1503", "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "12" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.11" ], "field": "vdevice_name", "type": "string", "operator": "in" }, { "value": [ "ge0/0" ], "field": "interface", "type": "string", "operator": "in" } ] } } }, { "name": "page", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "schema": { "type": "string", "enum": [ "asc", "ASC", "Asc", "desc", "DESC", "Desc" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "device_model": { "type": "string" }, "drop_in_bytes": { "type": "number" }, "drop_in_kbps": { "type": "integer", "format": "int32" }, "drop_in_pkts": { "type": "integer", "format": "int32" }, "drop_in_pps": { "type": "integer", "format": "int64" }, "entry_time": { "type": "string" }, "host_name": { "type": "string" }, "id": { "type": "string" }, "interface": { "type": "string" }, "queue_name": { "type": "string" }, "queued_bytes": { "type": "number" }, "queued_bytes_in_kbps": { "type": "number" }, "queued_pkts": { "type": "number" }, "red_drop_bytes": { "type": "number" }, "red_drop_pkts": { "type": "number" }, "statcycletime": { "type": "string" }, "tail_drop_bytes": { "type": "integer", "format": "int64" }, "tail_drop_pkts": { "type": "integer", "format": "int64" }, "tenant": { "type": "string" }, "time_interval": { "type": "integer", "format": "int32" }, "tx_bytes": { "type": "number" }, "tx_bytes_in_kbps": { "type": "integer", "format": "int64" }, "tx_bytes_in_pps": { "type": "integer", "format": "int64" }, "tx_pkts": { "type": "number" }, "vdevice_name": { "type": "string" }, "vip_idx": { "type": "string" }, "vip_time": { "type": "string" }, "vmanage_system_ip": { "type": "string" } }, "description": "QOS specific response", "$$ref": "#/components/schemas/QoSResp" } }, "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": "QoS response with page info", "$$ref": "#/components/schemas/QoSRespWithPageInfo" } }, "example": { "data": [ { "drop_in_kbps": 0, "device_model": "vedge-cloud", "interface": "ge0/0", "time_interval": 300, "queued_pkts": 0, "tx_pkts": 0, "statcycletime": 1676971800123, "drop_in_bytes": 0, "tx_bytes": 0, "tenant": "default", "entry_time": 1676971204628, "drop_in_pkts": 0, "vip_time": 1676971204628, "tail_drop_bytes": 0, "tx_bytes_in_pps": 0, "vmanage_system_ip": "172.16.255.11", "queued_bytes": 0, "queue_name": "Queue4", "red_drop_bytes": 0, "queued_bytes_in_kbps": 0, "red_drop_pkts": 0, "vdevice_name": "172.16.255.11", "vip_idx": 1448708, "drop_in_pps": 0, "tail_drop_pkts": 0, "tx_bytes_in_kbps": 0, "host_name": "vm1", "id": "z7ROc4YB8aNY7Lff9mZW" } ], "pageInfo": { "startTime": "1589073783045", "endTime": "1589072535795", "count": 15 } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Monitoring - QoS" ], "description": "Get stats raw data", "operationId": "getStatsRawData12", "parameters": [ { "name": "page", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "schema": { "type": "string", "enum": [ "asc", "ASC", "Asc", "desc", "DESC", "Desc" ] } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "12" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.11" ], "field": "vdevice_name", "type": "string", "operator": "in" }, { "value": [ "ge0/0" ], "field": "interface", "type": "string", "operator": "in" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "device_model": { "type": "string" }, "drop_in_bytes": { "type": "number" }, "drop_in_kbps": { "type": "integer", "format": "int32" }, "drop_in_pkts": { "type": "integer", "format": "int32" }, "drop_in_pps": { "type": "integer", "format": "int64" }, "entry_time": { "type": "string" }, "host_name": { "type": "string" }, "id": { "type": "string" }, "interface": { "type": "string" }, "queue_name": { "type": "string" }, "queued_bytes": { "type": "number" }, "queued_bytes_in_kbps": { "type": "number" }, "queued_pkts": { "type": "number" }, "red_drop_bytes": { "type": "number" }, "red_drop_pkts": { "type": "number" }, "statcycletime": { "type": "string" }, "tail_drop_bytes": { "type": "integer", "format": "int64" }, "tail_drop_pkts": { "type": "integer", "format": "int64" }, "tenant": { "type": "string" }, "time_interval": { "type": "integer", "format": "int32" }, "tx_bytes": { "type": "number" }, "tx_bytes_in_kbps": { "type": "integer", "format": "int64" }, "tx_bytes_in_pps": { "type": "integer", "format": "int64" }, "tx_pkts": { "type": "number" }, "vdevice_name": { "type": "string" }, "vip_idx": { "type": "string" }, "vip_time": { "type": "string" }, "vmanage_system_ip": { "type": "string" } }, "description": "QOS specific response", "$$ref": "#/components/schemas/QoSResp" } }, "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": "QoS response with page info", "$$ref": "#/components/schemas/QoSRespWithPageInfo" } }, "example": { "data": [ { "drop_in_kbps": 0, "device_model": "vedge-cloud", "interface": "ge0/0", "time_interval": 300, "queued_pkts": 0, "tx_pkts": 0, "statcycletime": 1676971800123, "drop_in_bytes": 0, "tx_bytes": 0, "tenant": "default", "entry_time": 1676971204628, "drop_in_pkts": 0, "vip_time": 1676971204628, "tail_drop_bytes": 0, "tx_bytes_in_pps": 0, "vmanage_system_ip": "172.16.255.11", "queued_bytes": 0, "queue_name": "Queue4", "red_drop_bytes": 0, "queued_bytes_in_kbps": 0, "red_drop_pkts": 0, "vdevice_name": "172.16.255.11", "vip_idx": 1448708, "drop_in_pps": 0, "tail_drop_pkts": 0, "tx_bytes_in_kbps": 0, "host_name": "vm1", "id": "z7ROc4YB8aNY7Lff9mZW" } ], "pageInfo": { "startTime": "1589073783045", "endTime": "1589072535795", "count": 15 } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/qos/aggregation": { "post": { "tags": [ "Monitoring - QoS" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationDataByQuery_MonitoringQos_2704", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "168" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.11" ], "field": "vdevice_name", "type": "string", "operator": "in" }, { "value": [ "ge0/0" ], "field": "interface", "type": "string", "operator": "in" } ] }, "aggregation": { "field": [ { "property": "queue_name", "sequence": 1, "size": 20 } ], "histogram": { "property": "entry_time", "type": "hour", "interval": 6, "order": "asc" }, "metrics": [ { "property": "tx_bytes_in_kbps", "type": "avg", "order": "desc" }, { "property": "drop_in_kbps", "type": "avg" } ] }, "sort": [ { "field": "entry_time", "type": "date", "order": "asc" } ] } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "example": 5 }, "entry_time": { "type": "string", "example": "1674813600000" }, "jitter": { "type": "integer", "format": "int32", "example": 0 }, "latency": { "type": "integer", "format": "int32", "example": 0 }, "local_color": { "type": "string", "example": "3g" }, "loss_percentage": { "type": "integer", "format": "int32", "example": 0 } }, "$$ref": "#/components/schemas/QoSAggResp" } }, "example": "[\n {\n \"entry_time\": 1678924800000,\n \"count\": 72,\n \"queue_name\": \"Queue4\",\n \"drop_in_kbps\": 0,\n \"tx_bytes_in_kbps\": 0\n },\n {\n \"entry_time\": 1678924800000,\n \"count\": 72,\n \"queue_name\": \"Queue5\",\n \"drop_in_kbps\": 0,\n \"tx_bytes_in_kbps\": 0\n },\n {\n \"entry_time\": 1678924800000,\n \"count\": 72,\n \"queue_name\": \"Queue6\",\n \"drop_in_kbps\": 0,\n \"tx_bytes_in_kbps\": 0\n }" } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Monitoring - QoS" ], "description": "Monitoring - QoS", "operationId": "getAggregationDataByQuery_MonitoringQos_2703", "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "168" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.11" ], "field": "vdevice_name", "type": "string", "operator": "in" }, { "value": [ "ge0/0" ], "field": "interface", "type": "string", "operator": "in" } ] }, "aggregation": { "field": [ { "property": "queue_name", "sequence": 1, "size": 20 } ], "histogram": { "property": "entry_time", "type": "hour", "interval": 6, "order": "asc" }, "metrics": [ { "property": "tx_bytes_in_kbps", "type": "avg", "order": "desc" }, { "property": "drop_in_kbps", "type": "avg" } ] }, "sort": [ { "field": "entry_time", "type": "date", "order": "asc" } ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "example": 5 }, "entry_time": { "type": "string", "example": "1674813600000" }, "jitter": { "type": "integer", "format": "int32", "example": 0 }, "latency": { "type": "integer", "format": "int32", "example": 0 }, "local_color": { "type": "string", "example": "3g" }, "loss_percentage": { "type": "integer", "format": "int32", "example": 0 } }, "$$ref": "#/components/schemas/QoSAggResp" } }, "example": [ { "entry_time": 1678924800000, "count": 72, "queue_name": "Queue4", "drop_in_kbps": 0, "tx_bytes_in_kbps": 0 }, { "entry_time": 1678924800000, "count": 72, "queue_name": "Queue5", "drop_in_kbps": 0, "tx_bytes_in_kbps": 0 }, { "entry_time": 1678924800000, "count": 72, "queue_name": "Queue6", "drop_in_kbps": 0, "tx_bytes_in_kbps": 0 } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/qos/app-agg/aggregation": { "post": { "tags": [ "Monitoring - QoS" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationAppDataByQuery_MonitoringQos_3504", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.16" ], "field": "vdevice_name", "type": "string", "operator": "in" }, { "value": [ "ge0/0" ], "field": "interface", "type": "number", "operator": "in" } ] }, "aggregation": { "field": [ { "property": "queue_name", "sequence": 1, "size": 20 } ], "histogram": { "property": "entry_time", "type": "hour", "interval": 6, "order": "asc" }, "metrics": [ { "property": "tx_bytes_in_kbps", "type": "avg", "order": "desc" }, { "property": "drop_in_kbps", "type": "avg" }, { "property": "jitter", "type": "avg" } ], "sort": [ { "property": "entry_time", "type": "date", "order": "desc" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "example": 5 }, "entry_time": { "type": "string", "example": "1674813600000" }, "jitter": { "type": "integer", "format": "int32", "example": 0 }, "latency": { "type": "integer", "format": "int32", "example": 0 }, "local_color": { "type": "string", "example": "3g" }, "loss_percentage": { "type": "integer", "format": "int32", "example": 0 } }, "$$ref": "#/components/schemas/QoSAggResp" } }, "example": [ { "entry_time": 1678881600000, "count": 72, "queue_name": "Queue1", "drop_in_kbps": 0, "jitter": 0, "tx_bytes_in_kbps": 0 }, { "entry_time": 1678881600000, "count": 72, "queue_name": "Queue2", "drop_in_kbps": 0, "jitter": 0, "tx_bytes_in_kbps": 0 } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/qos/csv": { "get": { "tags": [ "Monitoring - QoS" ], "description": "Get raw data with optional query as CSV", "operationId": "getStatDataRawDataAsCSV12", "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "12" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.11" ], "field": "vdevice_name", "type": "string", "operator": "in" }, { "value": [ "ge0/0" ], "field": "interface", "type": "string", "operator": "in" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" }, "example": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/qos/doccount": { "get": { "tags": [ "Monitoring - QoS" ], "description": "Get response count of a query", "operationId": "getCount13", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "12" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.11" ], "field": "vdevice_name", "type": "string", "operator": "in" }, { "value": [ "ge0/0" ], "field": "interface", "type": "string", "operator": "in" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "example": { "count": 17193 } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Monitoring - QoS" ], "description": "Get response count of a query", "operationId": "getCountPost13", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "12" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.11" ], "field": "vdevice_name", "type": "string", "operator": "in" }, { "value": [ "ge0/0" ], "field": "interface", "type": "string", "operator": "in" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "example": { "count": 17193 } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/qos/fields": { "get": { "tags": [ "Monitoring - QoS" ], "description": "Get fields and type", "operationId": "getStatDataFields13", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "example": [ { "dataType": "string", "property": "mac" }, { "dataType": "string", "property": "vap" }, { "dataType": "number", "property": "rssi" }, { "dataType": "string", "property": "mode" }, { "dataType": "number", "property": "bandwidth" }, { "dataType": "string", "property": "data_security" }, { "dataType": "number", "property": "rx_rate" }, { "dataType": "string", "property": "assoc_time" }, { "dataType": "date", "property": "entry_time" }, { "dataType": "date", "property": "statcycletime" }, { "dataType": "string", "property": "ssid" }, { "dataType": "number", "property": "vip_idx" }, { "dataType": "date", "property": "vip_time" }, { "dataType": "string", "property": "vdevice_name" }, { "dataType": "string", "property": "host_name" }, { "dataType": "string", "property": "device_model" } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/qos/page": { "get": { "tags": [ "Monitoring - QoS" ], "description": "Get stats raw data", "operationId": "getStatBulkRawData_MonitoringQos_2003", "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "12" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.11" ], "field": "vdevice_name", "type": "string", "operator": "in" }, { "value": [ "ge0/0" ], "field": "interface", "type": "string", "operator": "in" } ] } } }, { "name": "scrollId", "in": "query", "schema": { "type": "string" } }, { "name": "count", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "device_model": { "type": "string" }, "drop_in_bytes": { "type": "number" }, "drop_in_kbps": { "type": "integer", "format": "int32" }, "drop_in_pkts": { "type": "integer", "format": "int32" }, "drop_in_pps": { "type": "integer", "format": "int64" }, "entry_time": { "type": "string" }, "host_name": { "type": "string" }, "id": { "type": "string" }, "interface": { "type": "string" }, "queue_name": { "type": "string" }, "queued_bytes": { "type": "number" }, "queued_bytes_in_kbps": { "type": "number" }, "queued_pkts": { "type": "number" }, "red_drop_bytes": { "type": "number" }, "red_drop_pkts": { "type": "number" }, "statcycletime": { "type": "string" }, "tail_drop_bytes": { "type": "integer", "format": "int64" }, "tail_drop_pkts": { "type": "integer", "format": "int64" }, "tenant": { "type": "string" }, "time_interval": { "type": "integer", "format": "int32" }, "tx_bytes": { "type": "number" }, "tx_bytes_in_kbps": { "type": "integer", "format": "int64" }, "tx_bytes_in_pps": { "type": "integer", "format": "int64" }, "tx_pkts": { "type": "number" }, "vdevice_name": { "type": "string" }, "vip_idx": { "type": "string" }, "vip_time": { "type": "string" }, "vmanage_system_ip": { "type": "string" } }, "description": "QOS specific response", "$$ref": "#/components/schemas/QoSResp" } }, "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": "QoS response with page info", "$$ref": "#/components/schemas/QoSRespWithPageInfo" }, "example": { "data": [ { "drop_in_kbps": 0, "device_model": "vedge-cloud", "interface": "ge0/0", "time_interval": 300, "queued_pkts": 0, "tx_pkts": 0, "statcycletime": 1676971800123, "drop_in_bytes": 0, "tx_bytes": 0, "tenant": "default", "entry_time": 1676971204628, "drop_in_pkts": 0, "vip_time": 1676971204628, "tail_drop_bytes": 0, "tx_bytes_in_pps": 0, "vmanage_system_ip": "172.16.255.11", "queued_bytes": 0, "queue_name": "Queue4", "red_drop_bytes": 0, "queued_bytes_in_kbps": 0, "red_drop_pkts": 0, "vdevice_name": "172.16.255.11", "vip_idx": 1448708, "drop_in_pps": 0, "tail_drop_pkts": 0, "tx_bytes_in_kbps": 0, "host_name": "vm1", "id": "z7ROc4YB8aNY7Lff9mZW" } ], "pageInfo": { "startTime": "647394800045,", "endTime": "1647394800047,", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10,", "hasMoreData": "true,", "count": "5,", "totalCount": 11140 } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Monitoring - QoS" ], "description": "Get stats raw data", "operationId": "getPostStatBulkRawData12", "parameters": [ { "name": "scrollId", "in": "query", "schema": { "type": "string" } }, { "name": "count", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "12" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.11" ], "field": "vdevice_name", "type": "string", "operator": "in" }, { "value": [ "ge0/0" ], "field": "interface", "type": "string", "operator": "in" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "device_model": { "type": "string" }, "drop_in_bytes": { "type": "number" }, "drop_in_kbps": { "type": "integer", "format": "int32" }, "drop_in_pkts": { "type": "integer", "format": "int32" }, "drop_in_pps": { "type": "integer", "format": "int64" }, "entry_time": { "type": "string" }, "host_name": { "type": "string" }, "id": { "type": "string" }, "interface": { "type": "string" }, "queue_name": { "type": "string" }, "queued_bytes": { "type": "number" }, "queued_bytes_in_kbps": { "type": "number" }, "queued_pkts": { "type": "number" }, "red_drop_bytes": { "type": "number" }, "red_drop_pkts": { "type": "number" }, "statcycletime": { "type": "string" }, "tail_drop_bytes": { "type": "integer", "format": "int64" }, "tail_drop_pkts": { "type": "integer", "format": "int64" }, "tenant": { "type": "string" }, "time_interval": { "type": "integer", "format": "int32" }, "tx_bytes": { "type": "number" }, "tx_bytes_in_kbps": { "type": "integer", "format": "int64" }, "tx_bytes_in_pps": { "type": "integer", "format": "int64" }, "tx_pkts": { "type": "number" }, "vdevice_name": { "type": "string" }, "vip_idx": { "type": "string" }, "vip_time": { "type": "string" }, "vmanage_system_ip": { "type": "string" } }, "description": "QOS specific response", "$$ref": "#/components/schemas/QoSResp" } }, "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": "QoS response with page info", "$$ref": "#/components/schemas/QoSRespWithPageInfo" }, "example": { "data": [ { "drop_in_kbps": 0, "device_model": "vedge-cloud", "interface": "ge0/0", "time_interval": 300, "queued_pkts": 0, "tx_pkts": 0, "statcycletime": 1676971800123, "drop_in_bytes": 0, "tx_bytes": 0, "tenant": "default", "entry_time": 1676971204628, "drop_in_pkts": 0, "vip_time": 1676971204628, "tail_drop_bytes": 0, "tx_bytes_in_pps": 0, "vmanage_system_ip": "172.16.255.11", "queued_bytes": 0, "queue_name": "Queue4", "red_drop_bytes": 0, "queued_bytes_in_kbps": 0, "red_drop_pkts": 0, "vdevice_name": "172.16.255.11", "vip_idx": 1448708, "drop_in_pps": 0, "tail_drop_pkts": 0, "tx_bytes_in_kbps": 0, "host_name": "vm1", "id": "z7ROc4YB8aNY7Lff9mZW" } ], "pageInfo": { "startTime": "647394800045,", "endTime": "1647394800047,", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10,", "hasMoreData": "true,", "count": "5,", "totalCount": 11140 } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/qos/query/fields": { "get": { "tags": [ "Monitoring - QoS" ], "description": "Get query fields", "operationId": "getStatQueryFields_MonitoringQos_2803", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "dataType": { "type": "string", "example": "date" }, "fieldData": { "type": "object", "properties": { "type": { "type": "string", "example": "dateList" } }, "$$ref": "#/components/schemas/QoSQueryFieldsRespFieldData" }, "isRequired": { "type": "boolean", "example": true }, "name": { "type": "string", "example": "Event Time" }, "options": { "type": "array", "items": { "type": "object", "properties": { "enabledDateFields": { "type": "boolean", "example": false }, "key": { "type": "string", "example": "last_3_hours" }, "number": { "type": "string", "example": "1" }, "value": { "type": "string", "example": "last 1 hour" } }, "$$ref": "#/components/schemas/QueryFieldsOption" } }, "property": { "type": "string", "example": "entry_time" } }, "$$ref": "#/components/schemas/QoSQueryFieldsResp" }, "example": { "data": [ { "isRequired": true, "fieldData": { "type": "dateList" }, "dataType": "date", "property": "entry_time", "name": "Event Time", "options": [ { "enableDateFields": false, "number": "1", "value": "Last 1 hour", "key": "last_1_hour" }, { "enableDateFields": false, "number": "3", "value": "Last 3 hours", "key": "last_3_hours" }, { "enableDateFields": false, "number": "6", "value": "Last 6 hours", "key": "last_6_hours" }, { "enableDateFields": false, "number": "12", "value": "Last 12 hours", "key": "last_12_hours" }, { "enableDateFields": false, "number": "24", "isSelected": true, "value": "Last 24 hours", "key": "last_24_hours" }, { "enableDateFields": false, "number": "168", "value": "Last 7 days", "key": "last_168_hours" }, { "enableDateFields": true, "value": "Custom", "key": "custom" } ] } ], "header": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/qos/session/summary": { "get": { "tags": [ "Monitoring - QoS" ], "description": "Get per-tunnel QoS sessions summary", "operationId": "getSessionQosSummaryStat", "parameters": [ { "name": "vdevice_name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "last_n_hours", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32", "default": 24 } }, { "name": "start_time", "in": "query", "schema": { "type": "string" } }, { "name": "end_time", "in": "query", "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "schema": { "type": "string", "enum": [ "tx_bytes_in_kbps", "queued_bytes_in_kbps", "drop_in_kbps" ] } }, { "name": "sortOrder", "in": "query", "schema": { "type": "string", "enum": [ "asc", "ASC", "Asc", "desc", "DESC", "Desc" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "number", "example": 441 }, "drop_in_kbps": { "type": "number", "example": 0 }, "host_name": { "type": "string", "example": "vm6" }, "queued_bytes_in_kbps": { "type": "number", "example": 0.499 }, "tunnel_endpoint": { "type": "string", "example": "172.16.255.15_lte_172.16.255.16_lte_ipsec" }, "tx_bytes_in_kbps": { "type": "number", "example": 0.499 } }, "$$ref": "#/components/schemas/QosSessionSummaryObject" } } }, "$$ref": "#/components/schemas/QosSessionSummaryResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/query/fields": { "get": { "tags": [ "Monitoring - Tunnel Health" ], "description": "Get query fields", "operationId": "getStatQueryFields_MonitoringTunnelHealth_2403", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "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" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/sdra/headends": { "get": { "tags": [ "Monitoring - SDRA" ], "description": "Get SD-WAN Remote Access Head-end summary", "operationId": "getSdraHeadendSummary", "parameters": [ { "name": "site", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ipsec_enabled": { "type": "integer", "format": "int64" }, "sslvpn_enabled": { "type": "integer", "format": "int64" } }, "$$ref": "#/components/schemas/SdraHeadendSummary" }, "examples": { "SDRA Head-end Summary": { "description": "SDRA Head-end Summary", "value": "{\n \"ipsec_enabled\": 5,\n \"sslvpn_enabled\": 2,\n}" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/sdra/sessions": { "get": { "tags": [ "Monitoring - SDRA" ], "description": "Get SD-WAN Remote Access session summary", "operationId": "getSdraSessionSummary", "parameters": [ { "name": "site", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "top": { "type": "array", "items": { "type": "object", "properties": { "host_name": { "type": "string" }, "ipsec_anyconnect": { "type": "integer", "format": "int64" }, "ipsec_soho": { "type": "integer", "format": "int64" }, "ipsec_unknown": { "type": "integer", "format": "int64" }, "site_id": { "type": "integer", "format": "int64" }, "sslvpn_anyconnect": { "type": "integer", "format": "int64" }, "system_ip": { "type": "string" } }, "$$ref": "#/components/schemas/SdraDeviceStatsShort" } }, "total": { "type": "object", "properties": { "ipsec_anyconnect": { "type": "integer", "format": "int64" }, "ipsec_soho": { "type": "integer", "format": "int64" }, "ipsec_unknown": { "type": "integer", "format": "int64" }, "sslvpn_anyconnect": { "type": "integer", "format": "int64" } }, "$$ref": "#/components/schemas/SdraSessionCount" } }, "$$ref": "#/components/schemas/SdraSessionSummary" }, "examples": { "SDRA Session Summary": { "description": "SDRA Session Summary", "value": "{\n \"total\": {\n \"ipsec_anyconnect\": 50,\n \"ipsec_soho\": 20,\n \"ipsec_unknown\": 25,\n \"sslvpn_anyconnect\": 200,\n }, \"top\": [\n {\n \"system_ip\": \"1.1.1.1\",\n \"site_id\": 10,\n \"host_name\": vm10,\n \"ipsec_anyconnect\": 3,\n \"ipsec_soho\": 5,\n \"ipsec_unknown\": 11,\n \"sslvpn_anyconnect\": 0,\n },\n {\n \"system_ip\": \"2.2.2.2\",\n \"site_id\": 20,\n \"host_name\": vm20,\n \"ipsec_anyconnect\": 0,\n \"ipsec_soho\": 0,\n \"ipsec_unknown\": 0,\n \"sslvpn_anyconnect\": 85,\n }\n ]\n}" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/settings/disable/devicelist/{indexName}": { "get": { "tags": [ "Monitoring - Status" ], "description": "Get list of disabled devices for a statistics index", "operationId": "getDisabledDeviceList", "parameters": [ { "name": "indexName", "in": "path", "description": "Index name", "required": true, "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Disabled device list": { "description": "Disabled device list", "value": [ "172.16.255.14" ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Settings-read" }, "put": { "tags": [ "Monitoring - Status" ], "description": "Update list of disabled devices for a statistics index", "operationId": "updateStatisticsDeviceList", "parameters": [ { "name": "indexName", "in": "path", "description": "Index name", "required": true, "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } } ], "requestBody": { "description": "Disabled device", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Disabled device": { "description": "Disabled device", "value": [ "172.16.255.14" ] } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Update status": { "description": "Update status", "value": { "response": true } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Settings-write" } }, "/statistics/settings/status": { "put": { "tags": [ "Monitoring - Status" ], "description": "Update statistics settings", "operationId": "updateStatisticsSettings", "requestBody": { "description": "Stats setting", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats setting": { "description": "Stats setting", "value": [ { "indexName": "interfacestatistics", "status": "enable" } ] } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Settings-write,dca" }, "get": { "tags": [ "Monitoring - Status" ], "description": "Get statistics settings", "operationId": "getStatisticsSettings", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Statistics settings": { "description": "Statistics settings", "value": [ { "indexName": "approutestatsstatistics", "status": "enable", "displayName": "Approute" }, { "indexName": "interfacestatistics", "status": "enable", "displayName": "Interface" }, { "indexName": "wlanclientinfostatistics", "status": "enable", "displayName": "Wlan Client Info" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Settings-read,dca" } }, "/statistics/settings/status/device": { "get": { "tags": [ "Monitoring - Status" ], "description": "Get list of enabled device for statistics index", "operationId": "getEnabledIndexForDevice", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Enabled device": { "description": "Enabled device", "value": [ "interfacestatistics", "eioltestatistics", "sulstatistics", "qosstatistics", "devicesystemstatusstatistics", "bridgemacstatistics", "dpistatistics", "approutestatsstatistics", "wlanclientinfostatistics", "flowlogstatistics", "urlf", "fwall", "vnfstatistics", "umbrella", "apphostingstatistics", "utddaqioxstatistics", "ipsalert", "aggregatedappsdpistatistics", "bridgeinterfacestatistics", "artstatistics", "trackerstatistics", "cloudxstatistics" ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Settings-read" } }, "/statistics/sitehealth": { "get": { "tags": [ "Monitoring - SiteHealth Monitor" ], "description": "Get stats raw data", "operationId": "getStatDataRawData_MonitoringSitehealthMonitor_2203", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "metrics": [ { "property": "latency", "type": "avg" } ] } } }, { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by(emp:entry_time)", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "3g", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.101.2", "local_color": "lte", "src_ip": "10.1.14.14", "sla_class_names": "None", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400056, "state": "Up", "local_system_ip": "172.16.255.14", "tenant": "default", "entry_time": 1589073792008, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.14", "fec_rx": 0, "src_port": 12380, "jitter": 1, "remote_system_ip": "172.16.255.11", "vdevice_name": "172.16.255.14", "proto": "IPSEC", "vip_idx": 190, "dst_port": 12366, "name": "172.16.255.14:lte-172.16.255.11:3g", "sla_class_list": "0", "tunnel_color": "3g:lte", "host_name": "vm4", "id": "4OBG_HEB_JLsavezVUfr" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "post": { "tags": [ "Monitoring - SiteHealth Monitor" ], "description": "Get stats raw data", "operationId": "getStatsRawData_MonitoringSitehealthMonitor_2204", "parameters": [ { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order", "schema": { "type": "string" } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "field": [ { "property": "name", "sequence": 1 }, { "property": "proto", "sequence": 2 } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" }, "metrics": [ { "property": "latency", "type": "avg" }, { "property": "loss", "type": "avg" }, { "property": "loss_percentage", "type": "avg" }, { "property": "vqoe_score", "type": "avg" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "lte", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.106.1", "local_color": "lte", "src_ip": "10.1.15.15", "sla_class_names": "test_sla_class", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400052, "state": "Up", "local_system_ip": "172.16.255.15", "tenant": "default", "entry_time": 1589073783045, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.15", "fec_rx": 0, "src_port": 12366, "jitter": 1, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.15", "proto": "IPSEC", "vip_idx": 351, "dst_port": 12386, "name": "172.16.255.15:lte-172.16.255.16:lte", "sla_class_list": "0,1", "tunnel_color": "lte:lte", "host_name": "vm5", "id": "IuBG_HEB_JLsavezVkiZ" } ], "pageInfo": { "startTime": "1589073783045", "endTime": "1589072535795", "count": 15 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/sitehealth/aggregation": { "get": { "tags": [ "Monitoring - SiteHealth Monitor" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getAggregationDataByQuery_MonitoringSitehealthMonitor_3403", "parameters": [ { "name": "query", "in": "query", "description": "Query filter", "schema": { "type": "string" }, "examples": { "query string": {} } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "post": { "tags": [ "Monitoring - SiteHealth Monitor" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationDataByQuery_MonitoringSitehealthMonitor_3404", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default,dca" } }, "/statistics/sitehealth/common": { "get": { "tags": [ "Monitoring - SiteHealth Monitor" ], "summary": "sitehealth data", "description": "Get all site health ", "operationId": "getSiteHealth", "parameters": [ { "name": "isHeatMap", "in": "query", "schema": { "pattern": "^true$|^false$", "type": "string", "default": "false" } }, { "name": "last_n_hours", "in": "query", "schema": { "maximum": 24, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "interval", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32", "default": 30 } }, { "name": "health", "in": "query", "schema": { "type": "string", "enum": [ "GOOD", "FAIR", "POOR" ] } }, { "name": "start_time", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "end_time", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "includeDetails", "in": "query", "schema": { "pattern": "^true$|^false$", "type": "string", "default": "false" } }, { "name": "includeRegion", "in": "query", "schema": { "pattern": "^true$|^false$", "type": "string", "default": "false" } }, { "name": "regionName", "in": "query", "schema": { "type": "string" } }, { "name": "deviceType", "in": "query", "schema": { "type": "string", "enum": [ "controller", "vedge", "all" ] } }, { "name": "sortBy", "in": "query", "description": "To sort results by given field.device_count: To sort by device_count, includeDetails needs to be true.", "schema": { "type": "string", "example": "device_count" } } ], "responses": { "200": { "description": "search results matching criteria", "content": { "application/json": { "schema": { "type": "array", "items": { "required": [ "apps_health", "apps_usage", "devices_health", "site_health", "site_id", "tunnels_health" ], "type": "object", "properties": { "apps_health": { "type": "string", "example": "good", "enum": [ "good", "fair", "poor" ] }, "apps_usage": { "type": "number", "example": 1000 }, "devices_health": { "type": "string", "example": "good", "enum": [ "good", "fair", "poor" ] }, "site_health": { "type": "string", "example": "good", "enum": [ "good", "fair", "poor" ] }, "site_id": { "type": "string", "example": "600" }, "tunnels_health": { "type": "string", "example": "good", "enum": [ "good", "fair", "poor" ] } }, "$$ref": "#/components/schemas/SiteHealthItem" } } } } }, "400": { "description": "Bad Request" } } } }, "/statistics/sitehealth/csv": { "get": { "tags": [ "Monitoring - SiteHealth Monitor" ], "description": "Get raw data with optional query as CSV", "operationId": "getStatDataRawDataAsCSV_MonitoringSitehealthMonitor_2603", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" }, "examples": { "Search result in csv format": { "description": "Search result in csv format", "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/sitehealth/doccount": { "get": { "tags": [ "Monitoring - SiteHealth Monitor" ], "description": "Get response count of a query", "operationId": "getCount_MonitoringSitehealthMonitor_3103", "parameters": [ { "name": "query", "in": "query", "description": "Query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 17193 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Monitoring - SiteHealth Monitor" ], "description": "Get response count of a query", "operationId": "getCountPost_MonitoringSitehealthMonitor_3104", "requestBody": { "description": "Query", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query": { "description": "Query", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 9642 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/sitehealth/fields": { "get": { "tags": [ "Monitoring - SiteHealth Monitor" ], "description": "Get fields and type", "operationId": "getStatDataFields_MonitoringSitehealthMonitor_2903", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "example": [ { "dataType": "string", "property": "mac" }, { "dataType": "string", "property": "vap" }, { "dataType": "number", "property": "rssi" }, { "dataType": "string", "property": "mode" }, { "dataType": "number", "property": "bandwidth" }, { "dataType": "string", "property": "data_security" }, { "dataType": "number", "property": "rx_rate" }, { "dataType": "string", "property": "assoc_time" }, { "dataType": "date", "property": "entry_time" }, { "dataType": "date", "property": "statcycletime" }, { "dataType": "string", "property": "ssid" }, { "dataType": "number", "property": "vip_idx" }, { "dataType": "date", "property": "vip_time" }, { "dataType": "string", "property": "vdevice_name" }, { "dataType": "string", "property": "host_name" }, { "dataType": "string", "property": "device_model" } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/sitehealth/page": { "get": { "tags": [ "Monitoring - SiteHealth Monitor" ], "description": "Get stats raw data", "operationId": "getStatsPaginationRawData_MonitoringSitehealthMonitor_2703", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } }, { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" }, "post": { "tags": [ "Monitoring - SiteHealth Monitor" ], "description": "Get stats raw data", "operationId": "getPostStatsPaginationRawData_MonitoringSitehealthMonitor_2704", "parameters": [ { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/sitehealth/query/fields": { "get": { "tags": [ "Monitoring - SiteHealth Monitor" ], "description": "Get query fields", "operationId": "getStatQueryFields_MonitoringSitehealthMonitor_3503", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "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" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/sitehealth/topology": { "get": { "tags": [ "Monitoring - SiteHealth Monitor" ], "summary": "sitehealth data", "description": "Get all site health topology ", "operationId": "getSiteHealthTopology", "parameters": [ { "name": "last_n_hours", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "start_time", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "end_time", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "interval", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32", "default": 30 } } ], "responses": { "200": { "description": "search results matching criteria", "content": { "application/json": { "schema": { "type": "array", "items": { "required": [ "fair_site_count", "good_site_count", "poor_site_count" ], "type": "object", "properties": { "fair_site_count": { "type": "number", "example": 20 }, "good_site_count": { "type": "number", "example": 30 }, "poor_site_count": { "type": "number", "example": 10 } }, "$$ref": "#/components/schemas/SiteHealthTopologyItem" } } } } }, "400": { "description": "Bad Request" } } } }, "/statistics/speedtest": { "get": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "description": "Get stats raw data", "operationId": "getStatDataRawData_TroubleshootingToolsDiagnostics_2103", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "metrics": [ { "property": "latency", "type": "avg" } ] } } }, { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by(emp:entry_time)", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "3g", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.101.2", "local_color": "lte", "src_ip": "10.1.14.14", "sla_class_names": "None", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400056, "state": "Up", "local_system_ip": "172.16.255.14", "tenant": "default", "entry_time": 1589073792008, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.14", "fec_rx": 0, "src_port": 12380, "jitter": 1, "remote_system_ip": "172.16.255.11", "vdevice_name": "172.16.255.14", "proto": "IPSEC", "vip_idx": 190, "dst_port": 12366, "name": "172.16.255.14:lte-172.16.255.11:3g", "sla_class_list": "0", "tunnel_color": "3g:lte", "host_name": "vm4", "id": "4OBG_HEB_JLsavezVUfr" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "post": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "description": "Get stats raw data", "operationId": "getStatsRawData_TroubleshootingToolsDiagnostics_2104", "parameters": [ { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order", "schema": { "type": "string" } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "172.16.255.11" ], "field": "source_local_ip", "type": "string", "operator": "in" }, { "value": [ "completed" ], "field": "status", "type": "string", "operator": "in" } ] }, "size": 10000 } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "header": { "generatedOn": 1719824542590, "viewKeys": { "uniqueKey": [], "preferenceKey": "grid-raw_speedtest" }, "columns": [ { "title": "Time", "property": "entry_time", "displayFormat": "DD MMM YYYY h:mm:ss A z", "inputFormat": "unix-time", "dataType": "date" }, { "title": "Destination Device", "property": "destination_local_ip", "dataType": "string" }, { "title": "Source Circuit", "property": "source_circuit", "dataType": "string" }, { "title": "Destination Circuit", "property": "destination_circuit", "dataType": "string" }, { "title": "Down Speed (Mbps)", "property": "down_speed", "dataType": "number" }, { "title": "Up Speed (Mbps)", "property": "up_speed", "dataType": "number" }, { "title": "Down Bandwidth (Mbps)", "property": "down_bw", "display": "formatKbpsToMbps", "dataType": "number" }, { "title": "Up Bandwidth (Mbps)", "property": "up_bw", "display": "formatKbpsToMbps", "dataType": "number" } ], "fields": [ { "property": "entry_time", "dataType": "date" }, { "property": "destination_local_ip", "dataType": "string" }, { "property": "source_circuit", "dataType": "string" }, { "property": "destination_circuit", "dataType": "string" }, { "property": "down_speed", "dataType": "number" }, { "property": "up_speed", "dataType": "number" }, { "property": "down_bw", "dataType": "number", "display": "formatKbpsToMbps" }, { "property": "up_bw", "dataType": "number", "display": "formatKbpsToMbps" }, { "property": "session_id", "dataType": "string" }, { "property": "speedtest_id", "dataType": "string" }, { "property": "logid", "dataType": "number" }, { "property": "deviceUUID", "dataType": "string" }, { "property": "status", "dataType": "string" } ], "chart": {} }, "pageInfo": { "startTime": "1719821609758", "endTime": "1719821609758", "count": 1 }, "data": [ { "entry_time": 1719821609758, "up_speed": 228, "down_speed": 227.71, "up_bw": "NA", "down_bw": "NA", "destination_ip": "172.16.255.16", "destination_local_ip": "172.16.255.16", "source_ip": "172.16.255.11", "source_local_ip": "172.16.255.11", "source_circuit": "", "destination_circuit": "--", "session_id": "83a52af4-8daf-46e1-9f8c-34ab4225eff5", "speedtest_id": "", "logid": 4, "device_uuid": "C8K-9abc344d-9193-41bb-bc1d-26c834c31d5e", "status": "completed", "error": "None", "tenant": "default", "port": "80", "source_interface": "Tunnel0", "destination_interface": "Tunnel0", "source_interface_addr": "100.0.0.1", "destination_interface_addr": "100.0.0.6" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/speedtest/aggregation": { "post": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationDataByQuery_TroubleshootingToolsDiagnostics_3304", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default,dca" }, "get": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getAggregationDataByQuery_TroubleshootingToolsDiagnostics_3303", "parameters": [ { "name": "query", "in": "query", "description": "Query filter", "schema": { "type": "string" }, "examples": { "query string": {} } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/speedtest/csv": { "get": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "description": "Get raw data with optional query as CSV", "operationId": "getStatDataRawDataAsCSV_TroubleshootingToolsDiagnostics_2503", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" }, "examples": { "Search result in csv format": { "description": "Search result in csv format", "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/speedtest/doccount": { "get": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "description": "Get response count of a query", "operationId": "getCount_TroubleshootingToolsDiagnostics_3003", "parameters": [ { "name": "query", "in": "query", "description": "Query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 17193 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "description": "Get response count of a query", "operationId": "getCountPost_TroubleshootingToolsDiagnostics_3004", "requestBody": { "description": "Query", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query": { "description": "Query", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 9642 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/speedtest/fields": { "get": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "description": "Get fields and type", "operationId": "getStatDataFields_TroubleshootingToolsDiagnostics_2803", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "example": [ { "dataType": "string", "property": "mac" }, { "dataType": "string", "property": "vap" }, { "dataType": "number", "property": "rssi" }, { "dataType": "string", "property": "mode" }, { "dataType": "number", "property": "bandwidth" }, { "dataType": "string", "property": "data_security" }, { "dataType": "number", "property": "rx_rate" }, { "dataType": "string", "property": "assoc_time" }, { "dataType": "date", "property": "entry_time" }, { "dataType": "date", "property": "statcycletime" }, { "dataType": "string", "property": "ssid" }, { "dataType": "number", "property": "vip_idx" }, { "dataType": "date", "property": "vip_time" }, { "dataType": "string", "property": "vdevice_name" }, { "dataType": "string", "property": "host_name" }, { "dataType": "string", "property": "device_model" } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/speedtest/page": { "post": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "description": "Get stats raw data", "operationId": "getPostStatsPaginationRawData_TroubleshootingToolsDiagnostics_2604", "parameters": [ { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" }, "get": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "description": "Get stats raw data", "operationId": "getStatsPaginationRawData_TroubleshootingToolsDiagnostics_2603", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } }, { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/speedtest/query/fields": { "get": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "description": "Get query fields", "operationId": "getStatQueryFields_TroubleshootingToolsDiagnostics_3403", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "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" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/sul/connections": { "get": { "tags": [ "Monitoring - Security Unified Logging Connection Events" ], "description": "Get security connection events stats raw data", "operationId": "getSulStatDataRawData", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.15" ], "field": "vdevice_name", "type": "string", "operator": "in" } ] } } }, { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "ip_proto": 6, "device_model": "vedge-CSR-1000v", "egress_intf": "cpu", "packets": 5, "src_ip": "10.20.24.1", "fw_zone_pair": "ulogging_in2out", "statcycletime": 1616121001459, "octets": 300, "sdvt_drop_reason_name": "Service Node not healthy", "tenant": "default", "dest_port": 80, "entry_time": 1616120034778, "create_time": 1616120009235, "fw_dst_zone": "ulogging_z_out", "end_time": 1616120024267, "fw_action": "Pass", "vmanage_system_ip": "172.16.255.15", "fw_src_zone": "ulogging_z_in", "fw_policy": "p1", "src_port": 34128, "start_time": 1616120009235, "application": "unknown", "fw_protocol": "http", "ingress_intf": "GigabitEthernet5", "fw_class": "1", "vdevice_name": "172.16.255.15", "dest_ip": "103.235.46.39", "vip_idx": 1, "family": "network-service", "host_name": "vm5", "vpn_id": 1, "id": "_dlRSHgBQcANHsKKdbP0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" }, "post": { "tags": [ "Monitoring - Security Unified Logging Connection Events" ], "description": "Get stats raw data", "operationId": "getStatsRawData_MonitoringSecurityUnifiedLoggingConnectionEvents_2704", "parameters": [ { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order", "schema": { "type": "string" } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.15" ], "field": "vdevice_name", "type": "string", "operator": "in" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "ip_proto": 6, "device_model": "vedge-CSR-1000v", "egress_intf": "cpu", "packets": 5, "src_ip": "10.20.24.1", "fw_zone_pair": "ulogging_in2out", "statcycletime": 1616121001459, "octets": 300, "sdvt_drop_reason_name": "Service Node not healthy", "tenant": "default", "dest_port": 80, "entry_time": 1616120034778, "create_time": 1616120009235, "fw_dst_zone": "ulogging_z_out", "end_time": 1616120024267, "fw_action": "Pass", "vmanage_system_ip": "172.16.255.15", "fw_src_zone": "ulogging_z_in", "fw_policy": "p1", "src_port": 34128, "start_time": 1616120009235, "application": "unknown", "fw_protocol": "http", "ingress_intf": "GigabitEthernet5", "fw_class": "1", "vdevice_name": "172.16.255.15", "dest_ip": "103.235.46.39", "vip_idx": 1, "family": "network-service", "host_name": "vm5", "vpn_id": 1, "id": "_dlRSHgBQcANHsKKdbP0" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/sul/connections/aggregation": { "get": { "tags": [ "Monitoring - Security Unified Logging Connection Events" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getAggregationDataByQuery_MonitoringSecurityUnifiedLoggingConnectionEvents_3903", "parameters": [ { "name": "query", "in": "query", "description": "Query filter", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.15" ], "field": "vdevice_name", "type": "string", "operator": "in" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Aggregated each result": { "description": "Aggregated each result", "value": { "data": [ { "latency": 0.6404125644631974 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" }, "post": { "tags": [ "Monitoring - Security Unified Logging Connection Events" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationDataByQuery_MonitoringSecurityUnifiedLoggingConnectionEvents_3904", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.15" ], "field": "vdevice_name", "type": "string", "operator": "in" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Aggregated search result": { "description": "Aggregated search result", "value": { "data": [ { "ip_proto": 6, "device_model": "vedge-CSR-1000v", "egress_intf": "cpu", "packets": 5, "src_ip": "10.20.24.1", "statcycletime": 1616170802027, "octets": 300, "sdvt_drop_reason_name": "Service Node not healthy", "tenant": "default", "dest_port": 80, "entry_time": 1616170026992, "create_time": 1616170001492, "end_time": 1616170016505, "fw_action": "Pass", "vmanage_system_ip": "172.16.255.15", "fw_policy": "p1", "src_port": 53105, "start_time": 1616170001492, "application": "unknown", "fw_protocol": "http", "ingress_intf": "GigabitEthernet5", "fw_class": "1", "vdevice_name": "172.16.255.15", "dest_ip": "90.130.70.73", "vip_idx": 1, "family": "network-service", "host_name": "vm5", "vpn_id": 1, "id": "uNlJS3gBQcANHsKKW_5s" } ], "pageInfo": { "startTime": "1615956601540", "endTime": "1616170802027", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAQXMWSm81WWtQX1NUeXU4UnpKYm9VV2Nudw==_500", "hasMoreData": false, "count": 14, "totalCount": 14 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,dca" } }, "/statistics/sul/connections/app-agg/aggregation": { "post": { "tags": [ "Monitoring - Security Unified Logging Connection Events" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationAppDataByQuery_MonitoringSecurityUnifiedLoggingConnectionEvents_4704", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "field": "latency", "type": "long", "value": [ "1" ], "operator": "greater" }, "fields": [ "latency" ], "aggregation": { "metrics": [ { "property": "latency", "type": "avg" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Aggregated search result": { "description": "Aggregated search result", "value": { "data": [ { "latency": 0.6404125644631974 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,dca" } }, "/statistics/sul/connections/csv": { "get": { "tags": [ "Monitoring - Security Unified Logging Connection Events" ], "description": "Get raw data with optional query as CSV", "operationId": "getStatDataRawDataAsCSV_MonitoringSecurityUnifiedLoggingConnectionEvents_3103", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "168" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "1" ], "field": "vpn_id", "type": "int", "operator": "in" }, { "value": [ "p1" ], "field": "fw_policy", "type": "string", "operator": "in" }, { "value": [ "172.16.255.15" ], "field": "vdevice_name", "type": "string", "operator": "in" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" }, "examples": { "Search result in csv format": { "description": "Search result in csv format", "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/sul/connections/doccount": { "get": { "tags": [ "Monitoring - Security Unified Logging Connection Events" ], "description": "Get response count of a query", "operationId": "getCount_MonitoringSecurityUnifiedLoggingConnectionEvents_3603", "parameters": [ { "name": "query", "in": "query", "description": "Query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.15" ], "field": "vdevice_name", "type": "string", "operator": "in" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 9642 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Monitoring - Security Unified Logging Connection Events" ], "description": "Get response count of a query", "operationId": "getCountPost_MonitoringSecurityUnifiedLoggingConnectionEvents_3604", "requestBody": { "description": "Query", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query": { "description": "Query", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.15" ], "field": "vdevice_name", "type": "string", "operator": "in" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 9642 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/sul/connections/fields": { "get": { "tags": [ "Monitoring - Security Unified Logging Connection Events" ], "description": "Get fields and type", "operationId": "getStatDataFields_MonitoringSecurityUnifiedLoggingConnectionEvents_3403", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "example": [ { "dataType": "string", "property": "mac" }, { "dataType": "string", "property": "vap" }, { "dataType": "number", "property": "rssi" }, { "dataType": "string", "property": "mode" }, { "dataType": "number", "property": "bandwidth" }, { "dataType": "string", "property": "data_security" }, { "dataType": "number", "property": "rx_rate" }, { "dataType": "string", "property": "assoc_time" }, { "dataType": "date", "property": "entry_time" }, { "dataType": "date", "property": "statcycletime" }, { "dataType": "string", "property": "ssid" }, { "dataType": "number", "property": "vip_idx" }, { "dataType": "date", "property": "vip_time" }, { "dataType": "string", "property": "vdevice_name" }, { "dataType": "string", "property": "host_name" }, { "dataType": "string", "property": "device_model" } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/sul/connections/filter/policy_name/{policyType}": { "get": { "tags": [ "Monitoring - Security Unified Logging Connection Events" ], "description": "Get filter Policy Name list", "operationId": "getFilterPolicyNameList", "parameters": [ { "name": "policyType", "in": "path", "description": "Policy type", "required": true, "schema": { "type": "string", "enum": [ "zoneBasedFW", "intrusionPrevention", "urlFiltering", "advancedMalwareProtection" ] } }, { "name": "query", "in": "query", "description": "query string", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "field": "vdevice_name", "type": "string", "operator": "in", "value": [ "172.16.255.15" ] } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Filter Policy Name list": { "description": "Filter Policy Name list", "value": [ { "fw_policy": "FW-Block-AV" }, { "fw_policy": "FW-Block-p2p" }, { "fw_policy": "FW_policy1" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/sul/connections/page": { "get": { "tags": [ "Monitoring - Security Unified Logging Connection Events" ], "description": "Get stats raw data", "operationId": "getStatsPaginationRawData_MonitoringSecurityUnifiedLoggingConnectionEvents_3203", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } }, { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" }, "post": { "tags": [ "Monitoring - Security Unified Logging Connection Events" ], "description": "Get stats raw data", "operationId": "getPostStatsPaginationRawData_MonitoringSecurityUnifiedLoggingConnectionEvents_3204", "parameters": [ { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/sul/connections/query/fields": { "get": { "tags": [ "Monitoring - Security Unified Logging Connection Events" ], "description": "Get query fields", "operationId": "getStatQueryFields_MonitoringSecurityUnifiedLoggingConnectionEvents_4003", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "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" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/system": { "post": { "tags": [ "Real-Time Monitoring - Device System Stats" ], "description": "Get stats raw data", "operationId": "getStatsRawData_RealTimeMonitoringDeviceSystemStats_1804", "parameters": [ { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order", "schema": { "type": "string" } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "field": [ { "property": "name", "sequence": 1 }, { "property": "proto", "sequence": 2 } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" }, "metrics": [ { "property": "latency", "type": "avg" }, { "property": "loss", "type": "avg" }, { "property": "loss_percentage", "type": "avg" }, { "property": "vqoe_score", "type": "avg" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "lte", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.106.1", "local_color": "lte", "src_ip": "10.1.15.15", "sla_class_names": "test_sla_class", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400052, "state": "Up", "local_system_ip": "172.16.255.15", "tenant": "default", "entry_time": 1589073783045, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.15", "fec_rx": 0, "src_port": 12366, "jitter": 1, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.15", "proto": "IPSEC", "vip_idx": 351, "dst_port": 12386, "name": "172.16.255.15:lte-172.16.255.16:lte", "sla_class_list": "0,1", "tunnel_color": "lte:lte", "host_name": "vm5", "id": "IuBG_HEB_JLsavezVkiZ" } ], "pageInfo": { "startTime": "1589073783045", "endTime": "1589072535795", "count": 15 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "get": { "tags": [ "Real-Time Monitoring - Device System Stats" ], "description": "Get stats raw data", "operationId": "getStatDataRawData_RealTimeMonitoringDeviceSystemStats_1803", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "metrics": [ { "property": "latency", "type": "avg" } ] } } }, { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by(emp:entry_time)", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "3g", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.101.2", "local_color": "lte", "src_ip": "10.1.14.14", "sla_class_names": "None", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400056, "state": "Up", "local_system_ip": "172.16.255.14", "tenant": "default", "entry_time": 1589073792008, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.14", "fec_rx": 0, "src_port": 12380, "jitter": 1, "remote_system_ip": "172.16.255.11", "vdevice_name": "172.16.255.14", "proto": "IPSEC", "vip_idx": 190, "dst_port": 12366, "name": "172.16.255.14:lte-172.16.255.11:3g", "sla_class_list": "0", "tunnel_color": "3g:lte", "host_name": "vm4", "id": "4OBG_HEB_JLsavezVUfr" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/system/aggregation": { "get": { "tags": [ "Real-Time Monitoring - Device System Stats" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getAggregationDataByQuery_RealTimeMonitoringDeviceSystemStats_3003", "parameters": [ { "name": "query", "in": "query", "description": "Query filter", "schema": { "type": "string" }, "examples": { "query string": {} } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "post": { "tags": [ "Real-Time Monitoring - Device System Stats" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationDataByQuery_RealTimeMonitoringDeviceSystemStats_3004", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default,dca" } }, "/statistics/system/cpu": { "get": { "tags": [ "Real-Time Monitoring - Device System Stats" ], "description": "Get device system CPU stats list", "operationId": "createDeviceSystemCPUStat", "parameters": [ { "name": "query", "in": "query", "description": "Query filter", "required": true, "schema": { "type": "string", "example": "\"{\\\"query\\\":{\\\"condition\\\":\\\"AND\\\",\\\"rules\\\":[{\\\"value\\\":[\\\"1\\\"],\\\"field\\\":\\\"entry_time\\\",\\\"type\\\":\\\"date\\\",\\\"operator\\\":\\\"last_n_hours\\\"},{\\\"value\\\":[\\\"172.16.255.11\\\"],\\\"field\\\":\\\"vdevice_name\\\",\\\"type\\\":\\\"string\\\",\\\"operator\\\":\\\"in\\\"}]}}\"" } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device system stats": { "description": "Device system stats", "value": { "data": [ { "mem_used": 842211328, "disk_avail": 7370178560, "device_model": "vedge-cloud", "mem_cached": 440655872, "mem_util": 0.43, "min1_avg": 1.05, "disk_used": 168906752, "statcycletime": 1656927601936, "tenant": "default", "entry_time": 1656925196144, "runningp": 0, "cpu_user": 1.15, "cpu_idle_new": 94.86, "vip_time": 1656925196144, "min15_avg": 1.08, "totalp": 325, "cpu_idle": 94.86, "mem_buffers": 76447744, "cpu_system": 3.99, "vmanage_system_ip": "172.16.255.11", "min5_avg": 1.07, "cpu_min1_avg": 1.05, "mem_free": 597938176, "vdevice_name": "172.16.255.11", "vip_idx": 6977, "cpu_min15_avg": 1.08, "system_ip": "172.16.255.11", "cpu_user_new": 1.15, "cpu_system_new": 3.99, "host_name": "vm1", "cpu_min5_avg": 1.07, "id": "ZE2UyIEBC5z8Ij_cxb8R" }, { "mem_used": 842907648, "disk_avail": 7369719808, "device_model": "vedge-cloud", "mem_cached": 441020416, "mem_util": 0.43, "min1_avg": 1.06, "disk_used": 169365504, "statcycletime": 1656927601936, "tenant": "default", "entry_time": 1656925256204, "runningp": 0, "cpu_user": 10.17, "cpu_idle_new": 76.16, "vip_time": 1656925256205, "min15_avg": 1.08, "totalp": 326, "cpu_idle": 76.16, "mem_buffers": 76447744, "cpu_system": 13.67, "vmanage_system_ip": "172.16.255.11", "min5_avg": 1.07, "cpu_min1_avg": 1.06, "mem_free": 596877312, "vdevice_name": "172.16.255.11", "vip_idx": 6978, "cpu_min15_avg": 1.08, "system_ip": "172.16.255.11", "cpu_user_new": 10.17, "cpu_system_new": 13.67, "host_name": "vm1", "cpu_min5_avg": 1.07, "id": "W02UyIEBC5z8Ij_cxb8R" }, { "mem_used": 842715136, "disk_avail": 7369719808, "device_model": "vedge-cloud", "mem_cached": 441020416, "mem_util": 0.43, "min1_avg": 1.02, "disk_used": 169365504, "statcycletime": 1656927601936, "tenant": "default", "entry_time": 1656925316264, "runningp": 0, "cpu_user": 1.34, "cpu_idle_new": 92.22, "vip_time": 1656925316264, "min15_avg": 1.08, "totalp": 326, "cpu_idle": 92.22, "mem_buffers": 76447744, "cpu_system": 6.44, "vmanage_system_ip": "172.16.255.11", "min5_avg": 1.06, "cpu_min1_avg": 1.02, "mem_free": 597069824, "vdevice_name": "172.16.255.11", "vip_idx": 6979, "cpu_min15_avg": 1.08, "system_ip": "172.16.255.11", "cpu_user_new": 1.34, "cpu_system_new": 6.44, "host_name": "vm1", "cpu_min5_avg": 1.06, "id": "XE2UyIEBC5z8Ij_cxb8R" }, { "mem_used": 842813440, "disk_avail": 7369719808, "device_model": "vedge-cloud", "mem_cached": 441020416, "mem_util": 0.43, "min1_avg": 1.01, "disk_used": 169365504, "statcycletime": 1656927601936, "tenant": "default", "entry_time": 1656925376319, "runningp": 0, "cpu_user": 1.17, "cpu_idle_new": 94.02, "vip_time": 1656925376319, "min15_avg": 1.07, "totalp": 326, "cpu_idle": 94.02, "mem_buffers": 76447744, "cpu_system": 4.81, "vmanage_system_ip": "172.16.255.11", "min5_avg": 1.04, "cpu_min1_avg": 1.01, "mem_free": 596971520, "vdevice_name": "172.16.255.11", "vip_idx": 6980, "cpu_min15_avg": 1.07, "system_ip": "172.16.255.11", "cpu_user_new": 1.17, "cpu_system_new": 4.81, "host_name": "vm1", "cpu_min5_avg": 1.04, "id": "XU2UyIEBC5z8Ij_cxb8R" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/system/csv": { "get": { "tags": [ "Real-Time Monitoring - Device System Stats" ], "description": "Get raw data with optional query as CSV", "operationId": "getStatDataRawDataAsCSV_RealTimeMonitoringDeviceSystemStats_2203", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" }, "examples": { "Search result in csv format": { "description": "Search result in csv format", "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/system/doccount": { "post": { "tags": [ "Real-Time Monitoring - Device System Stats" ], "description": "Get response count of a query", "operationId": "getCountPost_RealTimeMonitoringDeviceSystemStats_2704", "requestBody": { "description": "Query", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query": { "description": "Query", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 9642 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Real-Time Monitoring - Device System Stats" ], "description": "Get response count of a query", "operationId": "getCount_RealTimeMonitoringDeviceSystemStats_2703", "parameters": [ { "name": "query", "in": "query", "description": "Query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 17193 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/system/fields": { "get": { "tags": [ "Real-Time Monitoring - Device System Stats" ], "description": "Get fields and type", "operationId": "getStatDataFields_RealTimeMonitoringDeviceSystemStats_2503", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "example": [ { "dataType": "string", "property": "mac" }, { "dataType": "string", "property": "vap" }, { "dataType": "number", "property": "rssi" }, { "dataType": "string", "property": "mode" }, { "dataType": "number", "property": "bandwidth" }, { "dataType": "string", "property": "data_security" }, { "dataType": "number", "property": "rx_rate" }, { "dataType": "string", "property": "assoc_time" }, { "dataType": "date", "property": "entry_time" }, { "dataType": "date", "property": "statcycletime" }, { "dataType": "string", "property": "ssid" }, { "dataType": "number", "property": "vip_idx" }, { "dataType": "date", "property": "vip_time" }, { "dataType": "string", "property": "vdevice_name" }, { "dataType": "string", "property": "host_name" }, { "dataType": "string", "property": "device_model" } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/system/memory": { "get": { "tags": [ "Real-Time Monitoring - Device System Stats" ], "description": "Get device system memory stats list", "operationId": "createDeviceSystemMemoryStat", "parameters": [ { "name": "query", "in": "query", "description": "Query filter", "required": true, "schema": { "type": "string", "example": "\"{\\\"query\\\":{\\\"condition\\\":\\\"AND\\\",\\\"rules\\\":[{\\\"value\\\":[\\\"1\\\"],\\\"field\\\":\\\"entry_time\\\",\\\"type\\\":\\\"date\\\",\\\"operator\\\":\\\"last_n_hours\\\"},{\\\"value\\\":[\\\"172.16.255.11\\\"],\\\"field\\\":\\\"vdevice_name\\\",\\\"type\\\":\\\"string\\\",\\\"operator\\\":\\\"in\\\"}]}}\"" } }, { "name": "deviceId", "in": "query", "description": "deviceId - Device IP", "required": true, "schema": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "example": "169.254.10.10" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device system stats": { "description": "Device system stats", "value": { "data": [ { "mem_used": 842715136, "disk_avail": 7369719808, "device_model": "vedge-cloud", "mem_cached": 441020416, "mem_util": 0.43, "min1_avg": 1.02, "disk_used": 169365504, "statcycletime": 1656927601936, "tenant": "default", "entry_time": 1656925316264, "runningp": 0, "cpu_user": 1.34, "cpu_idle_new": 92.22, "vip_time": 1656925316264, "min15_avg": 1.08, "totalp": 326, "cpu_idle": 92.22, "mem_buffers": 76447744, "cpu_system": 6.44, "vmanage_system_ip": "172.16.255.11", "min5_avg": 1.06, "cpu_min1_avg": 1.02, "mem_free": 597069824, "vdevice_name": "172.16.255.11", "vip_idx": 6979, "cpu_min15_avg": 1.08, "system_ip": "172.16.255.11", "cpu_user_new": 1.34, "cpu_system_new": 6.44, "host_name": "vm1", "cpu_min5_avg": 1.06, "id": "XE2UyIEBC5z8Ij_cxb8R" }, { "mem_used": 842813440, "disk_avail": 7369719808, "device_model": "vedge-cloud", "mem_cached": 441020416, "mem_util": 0.43, "min1_avg": 1.01, "disk_used": 169365504, "statcycletime": 1656927601936, "tenant": "default", "entry_time": 1656925376319, "runningp": 0, "cpu_user": 1.17, "cpu_idle_new": 94.02, "vip_time": 1656925376319, "min15_avg": 1.07, "totalp": 326, "cpu_idle": 94.02, "mem_buffers": 76447744, "cpu_system": 4.81, "vmanage_system_ip": "172.16.255.11", "min5_avg": 1.04, "cpu_min1_avg": 1.01, "mem_free": 596971520, "vdevice_name": "172.16.255.11", "vip_idx": 6980, "cpu_min15_avg": 1.07, "system_ip": "172.16.255.11", "cpu_user_new": 1.17, "cpu_system_new": 4.81, "host_name": "vm1", "cpu_min5_avg": 1.04, "id": "XU2UyIEBC5z8Ij_cxb8R" }, { "mem_used": 842711040, "disk_avail": 7369719808, "device_model": "vedge-cloud", "mem_cached": 441024512, "mem_util": 0.43, "min1_avg": 1.11, "disk_used": 169365504, "statcycletime": 1656927601936, "tenant": "default", "entry_time": 1656925436376, "runningp": 0, "cpu_user": 1.24, "cpu_idle_new": 93.19, "vip_time": 1656925436376, "min15_avg": 1.08, "totalp": 326, "cpu_idle": 93.19, "mem_buffers": 76447744, "cpu_system": 5.57, "vmanage_system_ip": "172.16.255.11", "min5_avg": 1.07, "cpu_min1_avg": 1.11, "mem_free": 597069824, "vdevice_name": "172.16.255.11", "vip_idx": 6981, "cpu_min15_avg": 1.08, "system_ip": "172.16.255.11", "cpu_user_new": 1.24, "cpu_system_new": 5.57, "host_name": "vm1", "cpu_min5_avg": 1.07, "id": "Xk2UyIEBC5z8Ij_cxb8R" }, { "mem_used": 842600448, "disk_avail": 7369719808, "device_model": "vedge-cloud", "mem_cached": 441069568, "mem_util": 0.43, "min1_avg": 1.04, "disk_used": 169365504, "statcycletime": 1656927601936, "tenant": "default", "entry_time": 1656925496428, "runningp": 0, "cpu_user": 1.3, "cpu_idle_new": 93.16, "vip_time": 1656925496428, "min15_avg": 1.07, "totalp": 326, "cpu_idle": 93.16, "mem_buffers": 76447744, "cpu_system": 5.54, "vmanage_system_ip": "172.16.255.11", "min5_avg": 1.05, "cpu_min1_avg": 1.04, "mem_free": 597135360, "vdevice_name": "172.16.255.11", "vip_idx": 6982, "cpu_min15_avg": 1.07, "system_ip": "172.16.255.11", "cpu_user_new": 1.3, "cpu_system_new": 5.54, "host_name": "vm1", "cpu_min5_avg": 1.05, "id": "X02UyIEBC5z8Ij_cxb8R" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/system/page": { "get": { "tags": [ "Real-Time Monitoring - Device System Stats" ], "description": "Get stats raw data", "operationId": "getStatsPaginationRawData_RealTimeMonitoringDeviceSystemStats_2303", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } }, { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" }, "post": { "tags": [ "Real-Time Monitoring - Device System Stats" ], "description": "Get stats raw data", "operationId": "getPostStatsPaginationRawData_RealTimeMonitoringDeviceSystemStats_2304", "parameters": [ { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/system/query/fields": { "get": { "tags": [ "Real-Time Monitoring - Device System Stats" ], "description": "Get query fields", "operationId": "getStatQueryFields_RealTimeMonitoringDeviceSystemStats_3103", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "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" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/system/stats": { "get": { "tags": [ "Monitoring - System Status Stats" ], "description": "Get stats raw data", "operationId": "getStatDataRawData_MonitoringSystemStatusStats_2403", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "metrics": [ { "property": "latency", "type": "avg" } ] } } }, { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by(emp:entry_time)", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "3g", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.101.2", "local_color": "lte", "src_ip": "10.1.14.14", "sla_class_names": "None", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400056, "state": "Up", "local_system_ip": "172.16.255.14", "tenant": "default", "entry_time": 1589073792008, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.14", "fec_rx": 0, "src_port": 12380, "jitter": 1, "remote_system_ip": "172.16.255.11", "vdevice_name": "172.16.255.14", "proto": "IPSEC", "vip_idx": 190, "dst_port": 12366, "name": "172.16.255.14:lte-172.16.255.11:3g", "sla_class_list": "0", "tunnel_color": "3g:lte", "host_name": "vm4", "id": "4OBG_HEB_JLsavezVUfr" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "default" }, "post": { "tags": [ "Monitoring - System Status Stats" ], "description": "Get stats raw data", "operationId": "getStatsRawData_MonitoringSystemStatusStats_2404", "parameters": [ { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order", "schema": { "type": "string" } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "field": [ { "property": "name", "sequence": 1 }, { "property": "proto", "sequence": 2 } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" }, "metrics": [ { "property": "latency", "type": "avg" }, { "property": "loss", "type": "avg" }, { "property": "loss_percentage", "type": "avg" }, { "property": "vqoe_score", "type": "avg" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "lte", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.106.1", "local_color": "lte", "src_ip": "10.1.15.15", "sla_class_names": "test_sla_class", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400052, "state": "Up", "local_system_ip": "172.16.255.15", "tenant": "default", "entry_time": 1589073783045, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.15", "fec_rx": 0, "src_port": 12366, "jitter": 1, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.15", "proto": "IPSEC", "vip_idx": 351, "dst_port": 12386, "name": "172.16.255.15:lte-172.16.255.16:lte", "sla_class_list": "0,1", "tunnel_color": "lte:lte", "host_name": "vm5", "id": "IuBG_HEB_JLsavezVkiZ" } ], "pageInfo": { "startTime": "1589073783045", "endTime": "1589072535795", "count": 15 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "default" } }, "/statistics/system/stats/aggregation": { "post": { "tags": [ "Monitoring - System Status Stats" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationDataByQuery_MonitoringSystemStatusStats_3604", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "default,dca" }, "get": { "tags": [ "Monitoring - System Status Stats" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getAggregationDataByQuery_MonitoringSystemStatusStats_3603", "parameters": [ { "name": "query", "in": "query", "description": "Query filter", "schema": { "type": "string" }, "examples": { "query string": {} } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "default" } }, "/statistics/system/stats/csv": { "get": { "tags": [ "Monitoring - System Status Stats" ], "description": "Get raw data with optional query as CSV", "operationId": "getStatDataRawDataAsCSV_MonitoringSystemStatusStats_2803", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" }, "examples": { "Search result in csv format": { "description": "Search result in csv format", "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "default" } }, "/statistics/system/stats/doccount": { "get": { "tags": [ "Monitoring - System Status Stats" ], "description": "Get response count of a query", "operationId": "getCount_MonitoringSystemStatusStats_3303", "parameters": [ { "name": "query", "in": "query", "description": "Query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 17193 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true }, "post": { "tags": [ "Monitoring - System Status Stats" ], "description": "Get response count of a query", "operationId": "getCountPost_MonitoringSystemStatusStats_3304", "requestBody": { "description": "Query", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query": { "description": "Query", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 9642 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/statistics/system/stats/fields": { "get": { "tags": [ "Monitoring - System Status Stats" ], "description": "Get fields and type", "operationId": "getStatDataFields_MonitoringSystemStatusStats_3103", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "example": [ { "dataType": "string", "property": "mac" }, { "dataType": "string", "property": "vap" }, { "dataType": "number", "property": "rssi" }, { "dataType": "string", "property": "mode" }, { "dataType": "number", "property": "bandwidth" }, { "dataType": "string", "property": "data_security" }, { "dataType": "number", "property": "rx_rate" }, { "dataType": "string", "property": "assoc_time" }, { "dataType": "date", "property": "entry_time" }, { "dataType": "date", "property": "statcycletime" }, { "dataType": "string", "property": "ssid" }, { "dataType": "number", "property": "vip_idx" }, { "dataType": "date", "property": "vip_time" }, { "dataType": "string", "property": "vdevice_name" }, { "dataType": "string", "property": "host_name" }, { "dataType": "string", "property": "device_model" } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/statistics/system/stats/page": { "get": { "tags": [ "Monitoring - System Status Stats" ], "description": "Get stats raw data", "operationId": "getStatsPaginationRawData_MonitoringSystemStatusStats_2903", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } }, { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Device Monitoring-read" }, "post": { "tags": [ "Monitoring - System Status Stats" ], "description": "Get stats raw data", "operationId": "getPostStatsPaginationRawData_MonitoringSystemStatusStats_2904", "parameters": [ { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Device Monitoring-read" } }, "/statistics/system/stats/query/fields": { "get": { "tags": [ "Monitoring - System Status Stats" ], "description": "Get query fields", "operationId": "getStatQueryFields_MonitoringSystemStatusStats_3703", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "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" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/statistics/temperature": { "get": { "tags": [ "Monitoring - Temperature Statistics" ], "description": "Get stats raw data", "operationId": "getStatDataRawData_MonitoringTemperatureStatistics_2303", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "metrics": [ { "property": "latency", "type": "avg" } ] } } }, { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by(emp:entry_time)", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "3g", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.101.2", "local_color": "lte", "src_ip": "10.1.14.14", "sla_class_names": "None", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400056, "state": "Up", "local_system_ip": "172.16.255.14", "tenant": "default", "entry_time": 1589073792008, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.14", "fec_rx": 0, "src_port": 12380, "jitter": 1, "remote_system_ip": "172.16.255.11", "vdevice_name": "172.16.255.14", "proto": "IPSEC", "vip_idx": 190, "dst_port": 12366, "name": "172.16.255.14:lte-172.16.255.11:3g", "sla_class_list": "0", "tunnel_color": "3g:lte", "host_name": "vm4", "id": "4OBG_HEB_JLsavezVUfr" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "post": { "tags": [ "Monitoring - Temperature Statistics" ], "description": "Get stats raw data", "operationId": "getStatsRawData_MonitoringTemperatureStatistics_2304", "parameters": [ { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order", "schema": { "type": "string" } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "field": [ { "property": "name", "sequence": 1 }, { "property": "proto", "sequence": 2 } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" }, "metrics": [ { "property": "latency", "type": "avg" }, { "property": "loss", "type": "avg" }, { "property": "loss_percentage", "type": "avg" }, { "property": "vqoe_score", "type": "avg" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "lte", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.106.1", "local_color": "lte", "src_ip": "10.1.15.15", "sla_class_names": "test_sla_class", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400052, "state": "Up", "local_system_ip": "172.16.255.15", "tenant": "default", "entry_time": 1589073783045, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.15", "fec_rx": 0, "src_port": 12366, "jitter": 1, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.15", "proto": "IPSEC", "vip_idx": 351, "dst_port": 12386, "name": "172.16.255.15:lte-172.16.255.16:lte", "sla_class_list": "0,1", "tunnel_color": "lte:lte", "host_name": "vm5", "id": "IuBG_HEB_JLsavezVkiZ" } ], "pageInfo": { "startTime": "1589073783045", "endTime": "1589072535795", "count": 15 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/temperature/aggregation": { "get": { "tags": [ "Monitoring - Temperature Statistics" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getAggregationDataByQuery_MonitoringTemperatureStatistics_3503", "parameters": [ { "name": "query", "in": "query", "description": "Query filter", "schema": { "type": "string" }, "examples": { "Monitoring - Temperature Statistics": { "description": "generated by base class - Monitoring - Temperature Statistics", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "6" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.15" ], "field": "vdevice_name", "type": "string", "operator": "in" } ] }, "aggregation": { "metrics": [ { "property": "current_reading", "type": "avg" } ], "field": [ { "property": "slot_loc" }, { "property": "comp_name" } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" } } }, "$$ref": "#/components/examples/ComViptelaVmanageServerElasticsearchAbstractstatisticsrestfulresourceParameterExampleTemperaturestatistics" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Monitoring - Temperature Statistics": { "description": "generated by base class - Monitoring - Temperature Statistics", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "6" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.15" ], "field": "vdevice_name", "type": "string", "operator": "in" } ] }, "aggregation": { "metrics": [ { "property": "current_reading", "type": "avg" } ], "field": [ { "property": "slot_loc" }, { "property": "comp_name" } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" } } }, "$$ref": "#/components/examples/ComViptelaVmanageServerElasticsearchAbstractstatisticsrestfulresourceParameterExampleTemperaturestatistics" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "post": { "tags": [ "Monitoring - Temperature Statistics" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationDataByQuery_MonitoringTemperatureStatistics_3504", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Monitoring - Temperature Statistics": { "description": "generated by base class - Monitoring - Temperature Statistics", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "6" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.255.15" ], "field": "vdevice_name", "type": "string", "operator": "in" } ] }, "aggregation": { "metrics": [ { "property": "current_reading", "type": "avg" } ], "field": [ { "property": "slot_loc" }, { "property": "comp_name" } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" } } }, "$$ref": "#/components/examples/ComViptelaVmanageServerElasticsearchAbstractstatisticsrestfulresourceParameterExampleTemperaturestatistics" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Monitoring - Temperature Statistics": { "description": "generated by base class - Monitoring - Temperature Statistics", "value": { "header": { "generatedOn": 1741076666609, "columns": [ { "property": "entry_time", "title": "Entry_time", "dataType": "date", "isDisplay": true }, { "property": "comp_name", "title": "Comp_name", "dataType": "string", "isDisplay": true }, { "property": "current_reading", "title": "Current_reading", "dataType": "double", "isDisplay": true }, { "property": "slot_loc", "title": "Slot_loc", "dataType": "string", "isDisplay": true } ], "fields": [ { "property": "entry_time", "dataType": "date" }, { "property": "comp_name", "dataType": "string" }, { "property": "current_reading", "dataType": "double" }, { "property": "slot_loc", "dataType": "string" } ] }, "entryTimeList": [ 1741053600000, 1741055400000, 1741057200000, 1741059000000, 1741060800000, 1741062600000, 1741064400000, 1741066200000, 1741068000000, 1741069800000, 1741071600000, 1741073400000, 1741075200000 ], "data": [ { "entry_time": 1741053600000, "current_reading": 18, "slot_loc": "Slot1", "comp_name": "Comp2", "count": 3 }, { "entry_time": 1741053600000, "current_reading": 10.333, "slot_loc": "Slot2", "comp_name": "Comp1", "count": 3 }, { "entry_time": 1741053600000, "current_reading": 15.333, "slot_loc": "Slot1", "comp_name": "Comp1", "count": 3 }, { "entry_time": 1741053600000, "current_reading": 20.333, "slot_loc": "Slot2", "comp_name": "Comp2", "count": 3 }, { "entry_time": 1741055400000, "current_reading": 43, "slot_loc": "Slot1", "comp_name": "Comp2", "count": 3 }, { "entry_time": 1741055400000, "current_reading": 10.333, "slot_loc": "Slot2", "comp_name": "Comp1", "count": 3 }, { "entry_time": 1741055400000, "current_reading": 25, "slot_loc": "Slot1", "comp_name": "Comp1", "count": 3 }, { "entry_time": 1741055400000, "current_reading": 7, "slot_loc": "Slot2", "comp_name": "Comp2", "count": 3 }, { "entry_time": 1741057200000, "current_reading": 30.667, "slot_loc": "Slot2", "comp_name": "Comp1", "count": 3 }, { "entry_time": 1741057200000, "current_reading": 13, "slot_loc": "Slot1", "comp_name": "Comp2", "count": 3 }, { "entry_time": 1741057200000, "current_reading": 48, "slot_loc": "Slot2", "comp_name": "Comp2", "count": 3 }, { "entry_time": 1741057200000, "current_reading": 16.333, "slot_loc": "Slot1", "comp_name": "Comp1", "count": 3 }, { "entry_time": 1741059000000, "current_reading": 20.333, "slot_loc": "Slot1", "comp_name": "Comp2", "count": 3 }, { "entry_time": 1741059000000, "current_reading": 22.667, "slot_loc": "Slot2", "comp_name": "Comp1", "count": 3 }, { "entry_time": 1741059000000, "current_reading": 17.333, "slot_loc": "Slot1", "comp_name": "Comp1", "count": 3 }, { "entry_time": 1741059000000, "current_reading": 27.333, "slot_loc": "Slot2", "comp_name": "Comp2", "count": 3 } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerElasticsearchAbstractstatisticsrestfulresourceResponseExampleTemperaturestatistics" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default,dca" } }, "/statistics/temperature/csv": { "get": { "tags": [ "Monitoring - Temperature Statistics" ], "description": "Get raw data with optional query as CSV", "operationId": "getStatDataRawDataAsCSV_MonitoringTemperatureStatistics_2703", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" }, "examples": { "Search result in csv format": { "description": "Search result in csv format", "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/temperature/doccount": { "get": { "tags": [ "Monitoring - Temperature Statistics" ], "description": "Get response count of a query", "operationId": "getCount_MonitoringTemperatureStatistics_3203", "parameters": [ { "name": "query", "in": "query", "description": "Query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 17193 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Monitoring - Temperature Statistics" ], "description": "Get response count of a query", "operationId": "getCountPost_MonitoringTemperatureStatistics_3204", "requestBody": { "description": "Query", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query": { "description": "Query", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 9642 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/temperature/fields": { "get": { "tags": [ "Monitoring - Temperature Statistics" ], "description": "Get fields and type", "operationId": "getStatDataFields_MonitoringTemperatureStatistics_3003", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "example": [ { "dataType": "string", "property": "mac" }, { "dataType": "string", "property": "vap" }, { "dataType": "number", "property": "rssi" }, { "dataType": "string", "property": "mode" }, { "dataType": "number", "property": "bandwidth" }, { "dataType": "string", "property": "data_security" }, { "dataType": "number", "property": "rx_rate" }, { "dataType": "string", "property": "assoc_time" }, { "dataType": "date", "property": "entry_time" }, { "dataType": "date", "property": "statcycletime" }, { "dataType": "string", "property": "ssid" }, { "dataType": "number", "property": "vip_idx" }, { "dataType": "date", "property": "vip_time" }, { "dataType": "string", "property": "vdevice_name" }, { "dataType": "string", "property": "host_name" }, { "dataType": "string", "property": "device_model" } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/temperature/overview": { "get": { "tags": [ "Monitoring - Temperature Statistics" ], "description": "Get temperature and power statistics overview", "operationId": "getTemperatureOverview", "parameters": [ { "name": "last_n_hours", "in": "query", "schema": { "maximum": 24, "minimum": 1, "type": "integer", "format": "int32", "default": 12 } }, { "name": "limit", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32", "default": 30 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "object", "properties": { "fair": { "type": "array", "items": { "type": "object", "properties": { "deviceModel": { "type": "string", "example": "vedge-cloud" }, "hostName": { "type": "string", "example": "vm5" }, "localSystemIp": { "type": "string", "example": "172.16.255.15" }, "powerConsumption": { "type": "string", "example": "20.1" }, "siteId": { "type": "string", "example": "500" }, "siteName": { "type": "string", "example": "SITE_500" }, "systemIp": { "type": "string", "example": "172.16.255.15" }, "temperatureStatus": { "type": "string", "example": "good", "enum": [ "good", "fair", "poor" ] } }, "$$ref": "#/components/schemas/DeviceTemperatureDetail" } }, "good": { "type": "array", "items": { "type": "object", "properties": { "deviceModel": { "type": "string", "example": "vedge-cloud" }, "hostName": { "type": "string", "example": "vm5" }, "localSystemIp": { "type": "string", "example": "172.16.255.15" }, "powerConsumption": { "type": "string", "example": "20.1" }, "siteId": { "type": "string", "example": "500" }, "siteName": { "type": "string", "example": "SITE_500" }, "systemIp": { "type": "string", "example": "172.16.255.15" }, "temperatureStatus": { "type": "string", "example": "good", "enum": [ "good", "fair", "poor" ] } }, "$$ref": "#/components/schemas/DeviceTemperatureDetail" } }, "poor": { "type": "array", "items": { "type": "object", "properties": { "deviceModel": { "type": "string", "example": "vedge-cloud" }, "hostName": { "type": "string", "example": "vm5" }, "localSystemIp": { "type": "string", "example": "172.16.255.15" }, "powerConsumption": { "type": "string", "example": "20.1" }, "siteId": { "type": "string", "example": "500" }, "siteName": { "type": "string", "example": "SITE_500" }, "systemIp": { "type": "string", "example": "172.16.255.15" }, "temperatureStatus": { "type": "string", "example": "good", "enum": [ "good", "fair", "poor" ] } }, "$$ref": "#/components/schemas/DeviceTemperatureDetail" } } }, "$$ref": "#/components/schemas/TemperatureOverviewResponseDetail" }, "total": { "type": "object", "properties": { "fair": { "type": "number", "example": 0 }, "good": { "type": "number", "example": 18 }, "poor": { "type": "number", "example": 0 } }, "$$ref": "#/components/schemas/TemperatureOverviewResponseTotal" } }, "$$ref": "#/components/schemas/TemperatureOverviewResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/temperature/page": { "get": { "tags": [ "Monitoring - Temperature Statistics" ], "description": "Get stats raw data", "operationId": "getStatsPaginationRawData_MonitoringTemperatureStatistics_2803", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } }, { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" }, "post": { "tags": [ "Monitoring - Temperature Statistics" ], "description": "Get stats raw data", "operationId": "getPostStatsPaginationRawData_MonitoringTemperatureStatistics_2804", "parameters": [ { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/temperature/query/fields": { "get": { "tags": [ "Monitoring - Temperature Statistics" ], "description": "Get query fields", "operationId": "getStatQueryFields_MonitoringTemperatureStatistics_3603", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "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" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/tunnelhealth/history": { "get": { "tags": [ "Monitoring - Tunnel Health" ], "summary": "Tunnel health history data", "description": "Get all tunnel health history ", "operationId": "statisticsApprouteTunnelhealthHistoryGet", "parameters": [ { "name": "last_n_hours", "in": "query", "schema": { "maximum": 24, "minimum": 1, "type": "integer", "format": "int32", "default": 12 } }, { "name": "start_time", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "end_time", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "time_interval_minutes", "in": "query", "schema": { "minimum": 5, "type": "integer", "format": "int32" } }, { "name": "site", "in": "query", "schema": { "pattern": "^[0-9]+$", "type": "string" } }, { "name": "limit", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32", "default": 30 } } ], "responses": { "200": { "description": "search results matching criteria", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "health": { "type": "string", "example": "good", "enum": [ "good", "fair", "poor", "n/a" ] }, "health_score": { "type": "number", "format": "double" }, "history": { "type": "array", "items": { "type": "object", "properties": { "data": { "type": "object", "properties": { "jitter": { "type": "number", "format": "double" }, "latency": { "type": "number", "format": "double" }, "loss_percentage": { "type": "number", "format": "double" }, "rx_octets": { "type": "number" }, "state": { "type": "string", "enum": [ "Up", "Down" ] }, "tx_octets": { "type": "number" }, "vqoe_score": { "type": "number", "format": "double" } }, "$$ref": "#/components/schemas/TunnelHealthData" }, "entry_time": { "type": "number", "example": 1657780200000 }, "health": { "type": "string", "example": "good", "enum": [ "good", "fair", "poor", "n/a" ] }, "health_score": { "type": "number", "format": "double", "example": 10 } }, "$$ref": "#/components/schemas/DeviceHealthEntryItem" } }, "local_color": { "type": "string", "example": "lte" }, "local_system_ip": { "type": "string", "example": "172.16.255.21" }, "name": { "type": "string", "example": "vm11:lte-vm6:lte" }, "remote_color": { "type": "string", "example": "lte" }, "remote_system_ip": { "type": "string", "example": "172.16.255.16" }, "summary": { "type": "object", "properties": { "jitter": { "type": "number", "format": "double" }, "latency": { "type": "number", "format": "double" }, "loss_percentage": { "type": "number", "format": "double" }, "rx_octets": { "type": "number" }, "state": { "type": "string", "enum": [ "Up", "Down" ] }, "tx_octets": { "type": "number" }, "vqoe_score": { "type": "number", "format": "double" } }, "$$ref": "#/components/schemas/TunnelHealthData" } }, "$$ref": "#/components/schemas/TunnelHealthHistoryItem" } } } } }, "400": { "description": "Bad Request" } } } }, "/statistics/tunnelhealth/overview/{type}": { "get": { "tags": [ "Monitoring - Tunnel Health" ], "summary": "Tunnel health overview data", "description": "Get all tunnel health overview ", "operationId": "statisticsApprouteTunnelhealthOverviewTypeGet", "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "pattern": "^[a-zA-Z_-]+$", "type": "string" } }, { "name": "last_n_hours", "in": "query", "schema": { "maximum": 24, "minimum": 1, "type": "integer", "format": "int32", "default": 12 } }, { "name": "site", "in": "query", "schema": { "pattern": "^[0-9]+$", "type": "string" } }, { "name": "limit", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int32", "default": 30 } } ], "responses": { "200": { "description": "search results matching criteria", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "object", "properties": { "fair": { "type": "array", "items": { "type": "object", "properties": { "health": { "type": "string", "example": "good", "enum": [ "good", "fair", "poor", "n/a" ] }, "health_score": { "type": "number", "format": "double" }, "jitter": { "type": "number", "format": "double" }, "latency": { "type": "number", "format": "double" }, "local_color": { "type": "string", "example": "lte" }, "local_system_ip": { "type": "string", "example": "172.16.255.21" }, "loss_percentage": { "type": "number", "format": "double" }, "name": { "type": "string", "example": "vm11:lte-vm6:lte" }, "remote_color": { "type": "string", "example": "lte" }, "remote_system_ip": { "type": "string", "example": "172.16.255.16" }, "rx_octets": { "type": "number" }, "state": { "type": "string", "enum": [ "Up", "Down" ] }, "tx_octets": { "type": "number" }, "vqoe_score": { "type": "number", "format": "double" } }, "$$ref": "#/components/schemas/TunnelHealthOverviewEntry" } }, "good": { "type": "array", "items": { "type": "object", "properties": { "health": { "type": "string", "example": "good", "enum": [ "good", "fair", "poor", "n/a" ] }, "health_score": { "type": "number", "format": "double" }, "jitter": { "type": "number", "format": "double" }, "latency": { "type": "number", "format": "double" }, "local_color": { "type": "string", "example": "lte" }, "local_system_ip": { "type": "string", "example": "172.16.255.21" }, "loss_percentage": { "type": "number", "format": "double" }, "name": { "type": "string", "example": "vm11:lte-vm6:lte" }, "remote_color": { "type": "string", "example": "lte" }, "remote_system_ip": { "type": "string", "example": "172.16.255.16" }, "rx_octets": { "type": "number" }, "state": { "type": "string", "enum": [ "Up", "Down" ] }, "tx_octets": { "type": "number" }, "vqoe_score": { "type": "number", "format": "double" } }, "$$ref": "#/components/schemas/TunnelHealthOverviewEntry" } }, "poor": { "type": "array", "items": { "type": "object", "properties": { "health": { "type": "string", "example": "good", "enum": [ "good", "fair", "poor", "n/a" ] }, "health_score": { "type": "number", "format": "double" }, "jitter": { "type": "number", "format": "double" }, "latency": { "type": "number", "format": "double" }, "local_color": { "type": "string", "example": "lte" }, "local_system_ip": { "type": "string", "example": "172.16.255.21" }, "loss_percentage": { "type": "number", "format": "double" }, "name": { "type": "string", "example": "vm11:lte-vm6:lte" }, "remote_color": { "type": "string", "example": "lte" }, "remote_system_ip": { "type": "string", "example": "172.16.255.16" }, "rx_octets": { "type": "number" }, "state": { "type": "string", "enum": [ "Up", "Down" ] }, "tx_octets": { "type": "number" }, "vqoe_score": { "type": "number", "format": "double" } }, "$$ref": "#/components/schemas/TunnelHealthOverviewEntry" } } }, "$$ref": "#/components/schemas/TunnelHealthOverviewDetail" }, "total": { "type": "object", "properties": { "fair": { "type": "number", "example": 100 }, "good": { "type": "number", "example": 100 }, "poor": { "type": "number", "example": 100 } }, "$$ref": "#/components/schemas/TunnelHealthOverviewTotal" } }, "$$ref": "#/components/schemas/TunnelHealthOverview" } } } }, "400": { "description": "Bad Request" } } } }, "/statistics/umbrella": { "get": { "tags": [ "Monitoring - Umbrella" ], "description": "Get stats raw data", "operationId": "getStatDataRawData_MonitoringUmbrella_2003", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "metrics": [ { "property": "latency", "type": "avg" } ] } } }, { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by(emp:entry_time)", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "3g", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.101.2", "local_color": "lte", "src_ip": "10.1.14.14", "sla_class_names": "None", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400056, "state": "Up", "local_system_ip": "172.16.255.14", "tenant": "default", "entry_time": 1589073792008, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.14", "fec_rx": 0, "src_port": 12380, "jitter": 1, "remote_system_ip": "172.16.255.11", "vdevice_name": "172.16.255.14", "proto": "IPSEC", "vip_idx": 190, "dst_port": 12366, "name": "172.16.255.14:lte-172.16.255.11:3g", "sla_class_list": "0", "tunnel_color": "3g:lte", "host_name": "vm4", "id": "4OBG_HEB_JLsavezVUfr" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "post": { "tags": [ "Monitoring - Umbrella" ], "description": "Get stats raw data", "operationId": "getStatsRawData_MonitoringUmbrella_2004", "parameters": [ { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order", "schema": { "type": "string" } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "field": [ { "property": "name", "sequence": 1 }, { "property": "proto", "sequence": 2 } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" }, "metrics": [ { "property": "latency", "type": "avg" }, { "property": "loss", "type": "avg" }, { "property": "loss_percentage", "type": "avg" }, { "property": "vqoe_score", "type": "avg" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "lte", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.106.1", "local_color": "lte", "src_ip": "10.1.15.15", "sla_class_names": "test_sla_class", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400052, "state": "Up", "local_system_ip": "172.16.255.15", "tenant": "default", "entry_time": 1589073783045, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.15", "fec_rx": 0, "src_port": 12366, "jitter": 1, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.15", "proto": "IPSEC", "vip_idx": 351, "dst_port": 12386, "name": "172.16.255.15:lte-172.16.255.16:lte", "sla_class_list": "0,1", "tunnel_color": "lte:lte", "host_name": "vm5", "id": "IuBG_HEB_JLsavezVkiZ" } ], "pageInfo": { "startTime": "1589073783045", "endTime": "1589072535795", "count": 15 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/umbrella/aggregation": { "post": { "tags": [ "Monitoring - Umbrella" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationDataByQuery_MonitoringUmbrella_3204", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Monitoring - Umbrella": { "description": "generated by base class - Monitoring - Umbrella", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.254.3" ], "field": "vdevice_name", "type": "string", "operator": "in" }, { "value": [ "umbrella" ], "field": "type", "type": "string", "operator": "in" } ] }, "aggregation": { "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" }, "metrics": [ { "property": "local_domain_bypass_total_pkts", "type": "sum" } ] } }, "$$ref": "#/components/examples/ComViptelaVmanageServerElasticsearchAbstractstatisticsrestfulresourceParameterExampleUmbrella" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Monitoring - Umbrella": { "description": "generated by base class - Monitoring - Umbrella", "value": { "data": [ { "entry_time": 1639897200000, "count": 0, "local_domain_bypass_total_pkts": 0 }, { "entry_time": 1639899000000, "count": 0, "local_domain_bypass_total_pkts": 0 }, { "entry_time": 1639900800000, "count": 0, "local_domain_bypass_total_pkts": 0 }, { "entry_time": 1639902600000, "count": 0, "local_domain_bypass_total_pkts": 0 }, { "entry_time": 1639904400000, "count": 0, "local_domain_bypass_total_pkts": 0 } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerElasticsearchAbstractstatisticsrestfulresourceResponseExampleUmbrella" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default,dca" }, "get": { "tags": [ "Monitoring - Umbrella" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getAggregationDataByQuery_MonitoringUmbrella_3203", "parameters": [ { "name": "query", "in": "query", "description": "Query filter", "schema": { "type": "string" }, "examples": { "Monitoring - Umbrella": { "description": "generated by base class - Monitoring - Umbrella", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.254.3" ], "field": "vdevice_name", "type": "string", "operator": "in" }, { "value": [ "umbrella" ], "field": "type", "type": "string", "operator": "in" } ] }, "aggregation": { "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" }, "metrics": [ { "property": "local_domain_bypass_total_pkts", "type": "sum" } ] } }, "$$ref": "#/components/examples/ComViptelaVmanageServerElasticsearchAbstractstatisticsrestfulresourceParameterExampleUmbrella" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Monitoring - Umbrella": { "description": "generated by base class - Monitoring - Umbrella", "value": { "data": [ { "entry_time": 1639897200000, "count": 0, "local_domain_bypass_total_pkts": 0 }, { "entry_time": 1639899000000, "count": 0, "local_domain_bypass_total_pkts": 0 }, { "entry_time": 1639900800000, "count": 0, "local_domain_bypass_total_pkts": 0 }, { "entry_time": 1639902600000, "count": 0, "local_domain_bypass_total_pkts": 0 }, { "entry_time": 1639904400000, "count": 0, "local_domain_bypass_total_pkts": 0 } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerElasticsearchAbstractstatisticsrestfulresourceResponseExampleUmbrella" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/umbrella/csv": { "get": { "tags": [ "Monitoring - Umbrella" ], "description": "Get raw data with optional query as CSV", "operationId": "getStatDataRawDataAsCSV_MonitoringUmbrella_2403", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" }, "examples": { "Search result in csv format": { "description": "Search result in csv format", "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/umbrella/doccount": { "post": { "tags": [ "Monitoring - Umbrella" ], "description": "Get response count of a query", "operationId": "getCountPost_MonitoringUmbrella_2904", "requestBody": { "description": "Query", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query": { "description": "Query", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 9642 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Monitoring - Umbrella" ], "description": "Get response count of a query", "operationId": "getCount_MonitoringUmbrella_2903", "parameters": [ { "name": "query", "in": "query", "description": "Query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 17193 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/umbrella/fields": { "get": { "tags": [ "Monitoring - Umbrella" ], "description": "Get fields and type", "operationId": "getStatDataFields_MonitoringUmbrella_2703", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "example": [ { "dataType": "string", "property": "mac" }, { "dataType": "string", "property": "vap" }, { "dataType": "number", "property": "rssi" }, { "dataType": "string", "property": "mode" }, { "dataType": "number", "property": "bandwidth" }, { "dataType": "string", "property": "data_security" }, { "dataType": "number", "property": "rx_rate" }, { "dataType": "string", "property": "assoc_time" }, { "dataType": "date", "property": "entry_time" }, { "dataType": "date", "property": "statcycletime" }, { "dataType": "string", "property": "ssid" }, { "dataType": "number", "property": "vip_idx" }, { "dataType": "date", "property": "vip_time" }, { "dataType": "string", "property": "vdevice_name" }, { "dataType": "string", "property": "host_name" }, { "dataType": "string", "property": "device_model" } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/umbrella/page": { "get": { "tags": [ "Monitoring - Umbrella" ], "description": "Get stats raw data", "operationId": "getStatsPaginationRawData_MonitoringUmbrella_2503", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } }, { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" }, "post": { "tags": [ "Monitoring - Umbrella" ], "description": "Get stats raw data", "operationId": "getPostStatsPaginationRawData_MonitoringUmbrella_2504", "parameters": [ { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/umbrella/query/fields": { "get": { "tags": [ "Monitoring - Umbrella" ], "description": "Get query fields", "operationId": "getStatQueryFields_MonitoringUmbrella_3303", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "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" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/urlf": { "post": { "tags": [ "Monitoring - URL Filtering" ], "description": "Get stats raw data", "operationId": "getStatsRawData_MonitoringUrlFiltering_1604", "parameters": [ { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order", "schema": { "type": "string" } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "field": [ { "property": "name", "sequence": 1 }, { "property": "proto", "sequence": 2 } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" }, "metrics": [ { "property": "latency", "type": "avg" }, { "property": "loss", "type": "avg" }, { "property": "loss_percentage", "type": "avg" }, { "property": "vqoe_score", "type": "avg" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "lte", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.106.1", "local_color": "lte", "src_ip": "10.1.15.15", "sla_class_names": "test_sla_class", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400052, "state": "Up", "local_system_ip": "172.16.255.15", "tenant": "default", "entry_time": 1589073783045, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.15", "fec_rx": 0, "src_port": 12366, "jitter": 1, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.15", "proto": "IPSEC", "vip_idx": 351, "dst_port": 12386, "name": "172.16.255.15:lte-172.16.255.16:lte", "sla_class_list": "0,1", "tunnel_color": "lte:lte", "host_name": "vm5", "id": "IuBG_HEB_JLsavezVkiZ" } ], "pageInfo": { "startTime": "1589073783045", "endTime": "1589072535795", "count": 15 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "get": { "tags": [ "Monitoring - URL Filtering" ], "description": "Get stats raw data", "operationId": "getStatDataRawData_MonitoringUrlFiltering_1603", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "metrics": [ { "property": "latency", "type": "avg" } ] } } }, { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by(emp:entry_time)", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "3g", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.101.2", "local_color": "lte", "src_ip": "10.1.14.14", "sla_class_names": "None", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400056, "state": "Up", "local_system_ip": "172.16.255.14", "tenant": "default", "entry_time": 1589073792008, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.14", "fec_rx": 0, "src_port": 12380, "jitter": 1, "remote_system_ip": "172.16.255.11", "vdevice_name": "172.16.255.14", "proto": "IPSEC", "vip_idx": 190, "dst_port": 12366, "name": "172.16.255.14:lte-172.16.255.11:3g", "sla_class_list": "0", "tunnel_color": "3g:lte", "host_name": "vm4", "id": "4OBG_HEB_JLsavezVUfr" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/urlf/aggregation": { "get": { "tags": [ "Monitoring - URL Filtering" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getAggregationDataByQuery_MonitoringUrlFiltering_2803", "parameters": [ { "name": "query", "in": "query", "description": "Query filter", "schema": { "type": "string" }, "examples": { "Monitoring - URL Filtering": { "description": "generated by base class - Monitoring - URL Filtering", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.254.2" ], "field": "vdevice_name", "type": "string", "operator": "in" }, { "value": [ "urlf" ], "field": "type", "type": "string", "operator": "in" } ] }, "aggregation": { "metrics": [ { "property": "reputation_block", "type": "sum" }, { "property": "blacklist_hit_cnt", "type": "sum" } ] } }, "$$ref": "#/components/examples/ComViptelaVmanageServerElasticsearchAbstractstatisticsrestfulresourceParameterExampleUrlfiltering" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Monitoring - URL Filtering": { "description": "generated by base class - Monitoring - URL Filtering", "value": { "data": [ { "blacklist_hit_cnt": 0, "reputation_block": 0 } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerElasticsearchAbstractstatisticsrestfulresourceResponseExampleUrlfiltering" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "post": { "tags": [ "Monitoring - URL Filtering" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationDataByQuery_MonitoringUrlFiltering_2804", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Monitoring - URL Filtering": { "description": "generated by base class - Monitoring - URL Filtering", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" }, { "value": [ "172.16.254.2" ], "field": "vdevice_name", "type": "string", "operator": "in" }, { "value": [ "urlf" ], "field": "type", "type": "string", "operator": "in" } ] }, "aggregation": { "metrics": [ { "property": "reputation_block", "type": "sum" }, { "property": "blacklist_hit_cnt", "type": "sum" } ] } }, "$$ref": "#/components/examples/ComViptelaVmanageServerElasticsearchAbstractstatisticsrestfulresourceParameterExampleUrlfiltering" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Monitoring - URL Filtering": { "description": "generated by base class - Monitoring - URL Filtering", "value": { "data": [ { "blacklist_hit_cnt": 0, "reputation_block": 0 } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerElasticsearchAbstractstatisticsrestfulresourceResponseExampleUrlfiltering" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default,dca" } }, "/statistics/urlf/csv": { "get": { "tags": [ "Monitoring - URL Filtering" ], "description": "Get raw data with optional query as CSV", "operationId": "getStatDataRawDataAsCSV_MonitoringUrlFiltering_2003", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" }, "examples": { "Search result in csv format": { "description": "Search result in csv format", "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/urlf/doccount": { "get": { "tags": [ "Monitoring - URL Filtering" ], "description": "Get response count of a query", "operationId": "getCount_MonitoringUrlFiltering_2503", "parameters": [ { "name": "query", "in": "query", "description": "Query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 17193 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Monitoring - URL Filtering" ], "description": "Get response count of a query", "operationId": "getCountPost_MonitoringUrlFiltering_2504", "requestBody": { "description": "Query", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query": { "description": "Query", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 9642 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/urlf/fields": { "get": { "tags": [ "Monitoring - URL Filtering" ], "description": "Get fields and type", "operationId": "getStatDataFields_MonitoringUrlFiltering_2303", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "example": [ { "dataType": "string", "property": "mac" }, { "dataType": "string", "property": "vap" }, { "dataType": "number", "property": "rssi" }, { "dataType": "string", "property": "mode" }, { "dataType": "number", "property": "bandwidth" }, { "dataType": "string", "property": "data_security" }, { "dataType": "number", "property": "rx_rate" }, { "dataType": "string", "property": "assoc_time" }, { "dataType": "date", "property": "entry_time" }, { "dataType": "date", "property": "statcycletime" }, { "dataType": "string", "property": "ssid" }, { "dataType": "number", "property": "vip_idx" }, { "dataType": "date", "property": "vip_time" }, { "dataType": "string", "property": "vdevice_name" }, { "dataType": "string", "property": "host_name" }, { "dataType": "string", "property": "device_model" } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/urlf/page": { "get": { "tags": [ "Monitoring - URL Filtering" ], "description": "Get stats raw data", "operationId": "getStatsPaginationRawData_MonitoringUrlFiltering_2103", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } }, { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" }, "post": { "tags": [ "Monitoring - URL Filtering" ], "description": "Get stats raw data", "operationId": "getPostStatsPaginationRawData_MonitoringUrlFiltering_2104", "parameters": [ { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/urlf/query/fields": { "get": { "tags": [ "Monitoring - URL Filtering" ], "description": "Get query fields", "operationId": "getStatQueryFields_MonitoringUrlFiltering_2903", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "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" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/vnfstatistics": { "get": { "tags": [ "Monitoring - VNF Interface Statistics" ], "description": "Get stats raw data", "operationId": "getStatDataRawData_MonitoringVnfInterfaceStatistics_2503", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "metrics": [ { "property": "latency", "type": "avg" } ] } } }, { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by(emp:entry_time)", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "3g", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.101.2", "local_color": "lte", "src_ip": "10.1.14.14", "sla_class_names": "None", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400056, "state": "Up", "local_system_ip": "172.16.255.14", "tenant": "default", "entry_time": 1589073792008, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.14", "fec_rx": 0, "src_port": 12380, "jitter": 1, "remote_system_ip": "172.16.255.11", "vdevice_name": "172.16.255.14", "proto": "IPSEC", "vip_idx": 190, "dst_port": 12366, "name": "172.16.255.14:lte-172.16.255.11:3g", "sla_class_list": "0", "tunnel_color": "3g:lte", "host_name": "vm4", "id": "4OBG_HEB_JLsavezVUfr" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "post": { "tags": [ "Monitoring - VNF Interface Statistics" ], "description": "Get stats raw data", "operationId": "getStatsRawData_MonitoringVnfInterfaceStatistics_2504", "parameters": [ { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order", "schema": { "type": "string" } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "field": [ { "property": "name", "sequence": 1 }, { "property": "proto", "sequence": 2 } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" }, "metrics": [ { "property": "latency", "type": "avg" }, { "property": "loss", "type": "avg" }, { "property": "loss_percentage", "type": "avg" }, { "property": "vqoe_score", "type": "avg" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "lte", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.106.1", "local_color": "lte", "src_ip": "10.1.15.15", "sla_class_names": "test_sla_class", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400052, "state": "Up", "local_system_ip": "172.16.255.15", "tenant": "default", "entry_time": 1589073783045, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.15", "fec_rx": 0, "src_port": 12366, "jitter": 1, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.15", "proto": "IPSEC", "vip_idx": 351, "dst_port": 12386, "name": "172.16.255.15:lte-172.16.255.16:lte", "sla_class_list": "0,1", "tunnel_color": "lte:lte", "host_name": "vm5", "id": "IuBG_HEB_JLsavezVkiZ" } ], "pageInfo": { "startTime": "1589073783045", "endTime": "1589072535795", "count": 15 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/vnfstatistics/aggregation": { "get": { "tags": [ "Monitoring - VNF Interface Statistics" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getAggregationDataByQuery_MonitoringVnfInterfaceStatistics_3703", "parameters": [ { "name": "query", "in": "query", "description": "Query filter", "schema": { "type": "string" }, "examples": { "query string": {} } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "post": { "tags": [ "Monitoring - VNF Interface Statistics" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationDataByQuery_MonitoringVnfInterfaceStatistics_3704", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default,dca" } }, "/statistics/vnfstatistics/csv": { "get": { "tags": [ "Monitoring - VNF Interface Statistics" ], "description": "Get raw data with optional query as CSV", "operationId": "getStatDataRawDataAsCSV_MonitoringVnfInterfaceStatistics_2903", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" }, "examples": { "Search result in csv format": { "description": "Search result in csv format", "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/vnfstatistics/doccount": { "get": { "tags": [ "Monitoring - VNF Interface Statistics" ], "description": "Get response count of a query", "operationId": "getCount_MonitoringVnfInterfaceStatistics_3403", "parameters": [ { "name": "query", "in": "query", "description": "Query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 17193 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Monitoring - VNF Interface Statistics" ], "description": "Get response count of a query", "operationId": "getCountPost_MonitoringVnfInterfaceStatistics_3404", "requestBody": { "description": "Query", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query": { "description": "Query", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 9642 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/vnfstatistics/fields": { "get": { "tags": [ "Monitoring - VNF Interface Statistics" ], "description": "Get fields and type", "operationId": "getStatDataFields_MonitoringVnfInterfaceStatistics_3203", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "example": [ { "dataType": "string", "property": "mac" }, { "dataType": "string", "property": "vap" }, { "dataType": "number", "property": "rssi" }, { "dataType": "string", "property": "mode" }, { "dataType": "number", "property": "bandwidth" }, { "dataType": "string", "property": "data_security" }, { "dataType": "number", "property": "rx_rate" }, { "dataType": "string", "property": "assoc_time" }, { "dataType": "date", "property": "entry_time" }, { "dataType": "date", "property": "statcycletime" }, { "dataType": "string", "property": "ssid" }, { "dataType": "number", "property": "vip_idx" }, { "dataType": "date", "property": "vip_time" }, { "dataType": "string", "property": "vdevice_name" }, { "dataType": "string", "property": "host_name" }, { "dataType": "string", "property": "device_model" } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/vnfstatistics/page": { "post": { "tags": [ "Monitoring - VNF Interface Statistics" ], "description": "Get stats raw data", "operationId": "getPostStatsPaginationRawData_MonitoringVnfInterfaceStatistics_3004", "parameters": [ { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" }, "get": { "tags": [ "Monitoring - VNF Interface Statistics" ], "description": "Get stats raw data", "operationId": "getStatsPaginationRawData_MonitoringVnfInterfaceStatistics_3003", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } }, { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/vnfstatistics/query/fields": { "get": { "tags": [ "Monitoring - VNF Interface Statistics" ], "description": "Get query fields", "operationId": "getStatQueryFields_MonitoringVnfInterfaceStatistics_3803", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "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" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/wlanclientinfo": { "get": { "tags": [ "Monitoring - Wlan Client Info" ], "description": "Get stats raw data", "operationId": "getStatDataRawData_MonitoringWlanClientInfo_2603", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "metrics": [ { "property": "latency", "type": "avg" } ] } } }, { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by(emp:entry_time)", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "3g", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.101.2", "local_color": "lte", "src_ip": "10.1.14.14", "sla_class_names": "None", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400056, "state": "Up", "local_system_ip": "172.16.255.14", "tenant": "default", "entry_time": 1589073792008, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.14", "fec_rx": 0, "src_port": 12380, "jitter": 1, "remote_system_ip": "172.16.255.11", "vdevice_name": "172.16.255.14", "proto": "IPSEC", "vip_idx": 190, "dst_port": 12366, "name": "172.16.255.14:lte-172.16.255.11:3g", "sla_class_list": "0", "tunnel_color": "3g:lte", "host_name": "vm4", "id": "4OBG_HEB_JLsavezVUfr" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" }, "post": { "tags": [ "Monitoring - Wlan Client Info" ], "description": "Get stats raw data", "operationId": "getStatsRawData_MonitoringWlanClientInfo_2604", "parameters": [ { "name": "page", "in": "query", "description": "page number", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page size", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "description": "sort by", "schema": { "pattern": "^[a-zA-Z-_]+$", "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "sort order", "schema": { "type": "string" } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] }, "aggregation": { "field": [ { "property": "name", "sequence": 1 }, { "property": "proto", "sequence": 2 } ], "histogram": { "property": "entry_time", "type": "minute", "interval": 30, "order": "asc" }, "metrics": [ { "property": "latency", "type": "avg" }, { "property": "loss", "type": "avg" }, { "property": "loss_percentage", "type": "avg" }, { "property": "vqoe_score", "type": "avg" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "remote_color": "lte", "fec_re": 0, "vqoe_score": 10, "device_model": "vedge-cloud", "latency": 1, "tx_octets": 0, "dst_ip": "10.0.106.1", "local_color": "lte", "src_ip": "10.1.15.15", "sla_class_names": "test_sla_class", "loss": 0, "total": 600, "tx_pkts": 0, "fec_tx": 0, "rx_octets": 0, "statcycletime": 1589075400052, "state": "Up", "local_system_ip": "172.16.255.15", "tenant": "default", "entry_time": 1589073783045, "loss_percentage": 0, "rx_pkts": 0, "vmanage_system_ip": "172.16.255.15", "fec_rx": 0, "src_port": 12366, "jitter": 1, "remote_system_ip": "172.16.255.16", "vdevice_name": "172.16.255.15", "proto": "IPSEC", "vip_idx": 351, "dst_port": 12386, "name": "172.16.255.15:lte-172.16.255.16:lte", "sla_class_list": "0,1", "tunnel_color": "lte:lte", "host_name": "vm5", "id": "IuBG_HEB_JLsavezVkiZ" } ], "pageInfo": { "startTime": "1589073783045", "endTime": "1589072535795", "count": 15 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/wlanclientinfo/aggregation": { "post": { "tags": [ "Monitoring - Wlan Client Info" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getPostAggregationDataByQuery_MonitoringWlanClientInfo_3804", "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default,dca" }, "get": { "tags": [ "Monitoring - Wlan Client Info" ], "description": "Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getAggregationDataByQuery_MonitoringWlanClientInfo_3803", "parameters": [ { "name": "query", "in": "query", "description": "Query filter", "schema": { "type": "string" }, "examples": { "query string": {} } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "query string": {} } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/wlanclientinfo/csv": { "get": { "tags": [ "Monitoring - Wlan Client Info" ], "description": "Get raw data with optional query as CSV", "operationId": "getStatDataRawDataAsCSV_MonitoringWlanClientInfo_3003", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" }, "examples": { "Search result in csv format": { "description": "Search result in csv format", "value": "blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/statistics/wlanclientinfo/doccount": { "get": { "tags": [ "Monitoring - Wlan Client Info" ], "description": "Get response count of a query", "operationId": "getCount_MonitoringWlanClientInfo_3503", "parameters": [ { "name": "query", "in": "query", "description": "Query", "required": true, "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 17193 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Monitoring - Wlan Client Info" ], "description": "Get response count of a query", "operationId": "getCountPost_MonitoringWlanClientInfo_3504", "requestBody": { "description": "Query", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query": { "description": "Query", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "value": { "count": 9642 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/wlanclientinfo/fields": { "get": { "tags": [ "Monitoring - Wlan Client Info" ], "description": "Get fields and type", "operationId": "getStatDataFields_MonitoringWlanClientInfo_3303", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "example": [ { "dataType": "string", "property": "mac" }, { "dataType": "string", "property": "vap" }, { "dataType": "number", "property": "rssi" }, { "dataType": "string", "property": "mode" }, { "dataType": "number", "property": "bandwidth" }, { "dataType": "string", "property": "data_security" }, { "dataType": "number", "property": "rx_rate" }, { "dataType": "string", "property": "assoc_time" }, { "dataType": "date", "property": "entry_time" }, { "dataType": "date", "property": "statcycletime" }, { "dataType": "string", "property": "ssid" }, { "dataType": "number", "property": "vip_idx" }, { "dataType": "date", "property": "vip_time" }, { "dataType": "string", "property": "vdevice_name" }, { "dataType": "string", "property": "host_name" }, { "dataType": "string", "property": "device_model" } ] } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/statistics/wlanclientinfo/page": { "get": { "tags": [ "Monitoring - Wlan Client Info" ], "description": "Get stats raw data", "operationId": "getStatsPaginationRawData_MonitoringWlanClientInfo_3103", "parameters": [ { "name": "query", "in": "query", "description": "Query string", "schema": { "type": "string" }, "example": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } }, { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" }, "post": { "tags": [ "Monitoring - Wlan Client Info" ], "description": "Get stats raw data", "operationId": "getPostStatsPaginationRawData_MonitoringWlanClientInfo_3104", "parameters": [ { "name": "scrollId", "in": "query", "description": "ES scroll Id", "schema": { "type": "string" }, "example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" }, { "name": "count", "in": "query", "description": "Result size", "schema": { "type": "integer", "format": "int64" }, "example": 10 } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query string": { "description": "Stats query string", "value": { "query": { "condition": "AND", "rules": [ { "value": [ "24" ], "field": "entry_time", "type": "date", "operator": "last_n_hours" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Search result": { "description": "Search result", "value": { "data": [ { "mem_used": 19407626240, "disk_avail": 9305948160, "device_model": "vmanage", "mem_cached": 6740430848, "mem_util": 0.59, "min1_avg": 0.92, "disk_used": 5789007872, "statcycletime": 1647394800045, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647393870251, "runningp": 0, "cpu_user": 8.63, "cpu_idle_new": 88.14, "vip_time": 1647393870252, "min15_avg": 1.08, "totalp": 2427, "cpu_idle": 88.14, "mem_buffers": 892911616, "cpu_system": 3.23, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.07, "cpu_min1_avg": 0.115, "mem_free": 5716930560, "vdevice_name": "172.16.255.201", "vip_idx": 82, "cpu_min15_avg": 0.135, "system_ip": "172.16.255.201", "cpu_user_new": 8.63, "cpu_system_new": 3.23, "host_name": "vm201", "cpu_min5_avg": 0.13375, "id": "4YphkH8BPIGvVbrdtzXi" }, { "mem_used": 19534016512, "disk_avail": 9304268800, "device_model": "vmanage", "mem_cached": 6747897856, "mem_util": 0.6, "min1_avg": 1.14, "disk_used": 5790687232, "statcycletime": 1647394800046, "tenant": "57501bad-32a7-4f52-8f54-8547dcd7403e", "entry_time": 1647394110479, "runningp": 0, "cpu_user": 5.53, "cpu_idle_new": 91.49, "vip_time": 1647394110479, "min15_avg": 1.1, "totalp": 2323, "cpu_idle": 91.49, "mem_buffers": 902213632, "cpu_system": 2.97, "vmanage_system_ip": "169.254.10.2", "min5_avg": 1.14, "cpu_min1_avg": 0.1425, "mem_free": 5573771264, "vdevice_name": "172.16.255.201", "vip_idx": 86, "cpu_min15_avg": 0.1375, "system_ip": "172.16.255.201", "cpu_user_new": 5.53, "cpu_system_new": 2.97, "host_name": "vm201", "cpu_min5_avg": 0.1425, "id": "5YphkH8BPIGvVbrdtzXi" } ], "pageInfo": { "startTime": "1647394800045", "endTime": "1647394800047", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==", "hasMoreData": true, "count": 2, "totalCount": 11140 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/statistics/wlanclientinfo/query/fields": { "get": { "tags": [ "Monitoring - Wlan Client Info" ], "description": "Get query fields", "operationId": "getStatQueryFields_MonitoringWlanClientInfo_3903", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query result count": { "description": "Query result count", "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" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/stream/device/capture": { "post": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "description": "Create packet capture session", "operationId": "getSessionInfoCapture", "requestBody": { "description": "Packet Capture Parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "bidirectional": { "type": "boolean", "example": true }, "destination_ip": { "type": "string", "example": "2.2.2.2" }, "destination_port": { "type": "string", "example": "222" }, "deviceUUID": { "type": "string", "example": "C8K-4d204234-4aa1-4311-8913-67beeb8651c0" }, "interface": { "type": "string", "example": "GigabitEthernet5" }, "interfaceIP": { "type": "string", "example": "10.1.14.14" }, "protocol": { "type": "string", "example": "6" }, "source_ip": { "type": "string", "example": "1.1.1.1" }, "source_port": { "type": "string", "example": "111" }, "type": { "type": "string", "example": "control", "enum": [ "control", "data" ] }, "vpn": { "type": "string", "example": "0" } }, "$$ref": "#/components/schemas/CreatePacketCaptureReq" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "@rid": { "type": "integer", "format": "int32", "example": 3765 }, "JSessionId": { "type": "string", "example": "2j1QnIq4iFxEjwoxHfYK_zefKjpB7c3fFl483jac" }, "isNewSession": { "type": "boolean", "example": true }, "isOwner": { "type": "boolean", "example": true }, "renewalTime": { "type": "integer", "format": "int64", "example": 1695089425303 }, "requestStatus": { "type": "string", "enum": [ "START", "STOP", "IN_PROGRESS", "NOT_STARTED" ] }, "sessionId": { "type": "string", "format": "uuid", "example": "a9fd18d5-0303-43d1-b821-2358992e0274" }, "startTime": { "type": "integer", "format": "int64", "example": 1695089425303 }, "status": { "type": "string", "example": "success", "enum": [ "success", "failure" ] }, "statusMessage": { "type": "string", "example": "ok" }, "type": { "type": "string", "example": "pcap" }, "user": { "type": "string", "example": "admin" }, "userIp": { "type": "string", "example": "10.0.1.1" }, "uuid": { "type": "string", "example": "C8K-86adc384-8408-4cec-acdb-8117c40a8a24" } }, "$$ref": "#/components/schemas/PacketCaptureInfo" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tools-read" } }, "/stream/device/capture/disable/{sessionId}": { "get": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "description": "Disable packet capture session", "operationId": "disablePacketCaptureSession", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" } }, "$$ref": "#/components/schemas/DisablePacketCaptureRes" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tools-read" } }, "/stream/device/capture/download/{sessionId}": { "get": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "description": "Download packet capture file", "operationId": "downloadFile", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tools-read" } }, "/stream/device/capture/forcedisbale/{sessionId}": { "get": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "description": "Force stop packet capture session", "operationId": "forceStopPcapSession", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" } }, "$$ref": "#/components/schemas/ForceStopPacketCaptureRes" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tools-read" } }, "/stream/device/capture/start/{sessionId}": { "get": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "description": "Start packet capture session", "operationId": "startPcapSession", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "@rid": { "type": "integer", "format": "int32", "example": 3765 }, "JSessionId": { "type": "string", "example": "2j1QnIq4iFxEjwoxHfYK_zefKjpB7c3fFl483jac" }, "isNewSession": { "type": "boolean", "example": true }, "isOwner": { "type": "boolean", "example": true }, "renewalTime": { "type": "integer", "format": "int64", "example": 1695089425303 }, "requestStatus": { "type": "string", "enum": [ "START", "STOP", "IN_PROGRESS", "NOT_STARTED" ] }, "sessionId": { "type": "string", "format": "uuid", "example": "a9fd18d5-0303-43d1-b821-2358992e0274" }, "startTime": { "type": "integer", "format": "int64", "example": 1695089425303 }, "status": { "type": "string", "example": "success", "enum": [ "success", "failure" ] }, "statusMessage": { "type": "string", "example": "ok" }, "type": { "type": "string", "example": "pcap" }, "user": { "type": "string", "example": "admin" }, "userIp": { "type": "string", "example": "10.0.1.1" }, "uuid": { "type": "string", "example": "C8K-86adc384-8408-4cec-acdb-8117c40a8a24" } }, "$$ref": "#/components/schemas/PacketCaptureInfo" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tools-read" } }, "/stream/device/capture/status/{sessionId}": { "get": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "description": "Get packet capture session status", "operationId": "getFileDownloadStatus", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "fileDownloadStatus": { "type": "string", "example": "NOT_STARTED", "enum": [ "NOT_STARTED", "STARTED", "IN_PROGRESS", "COMPLETED", "ERROR" ] }, "sessionStatus": { "type": "string", "enum": [ "START", "STOP", "IN_PROGRESS", "NOT_STARTED" ] } }, "$$ref": "#/components/schemas/GetFileDownloadStatusRes" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tools-read" } }, "/stream/device/capture/stop/{sessionId}": { "get": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "description": "Stop packet capture session", "operationId": "stopPcapSession", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "@rid": { "type": "integer", "format": "int32", "example": 3765 }, "JSessionId": { "type": "string", "example": "2j1QnIq4iFxEjwoxHfYK_zefKjpB7c3fFl483jac" }, "isNewSession": { "type": "boolean", "example": true }, "isOwner": { "type": "boolean", "example": true }, "renewalTime": { "type": "integer", "format": "int64", "example": 1695089425303 }, "requestStatus": { "type": "string", "enum": [ "START", "STOP", "IN_PROGRESS", "NOT_STARTED" ] }, "sessionId": { "type": "string", "format": "uuid", "example": "a9fd18d5-0303-43d1-b821-2358992e0274" }, "startTime": { "type": "integer", "format": "int64", "example": 1695089425303 }, "status": { "type": "string", "example": "success", "enum": [ "success", "failure" ] }, "statusMessage": { "type": "string", "example": "ok" }, "type": { "type": "string", "example": "pcap" }, "user": { "type": "string", "example": "admin" }, "userIp": { "type": "string", "example": "10.0.1.1" }, "uuid": { "type": "string", "example": "C8K-86adc384-8408-4cec-acdb-8117c40a8a24" } }, "$$ref": "#/components/schemas/PacketCaptureInfo" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tools-read" } }, "/stream/device/capture/vnicsInfo/{vnfId}": { "get": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "description": "Get vnic info by vrfId", "operationId": "getVnicInfoByVnfId", "parameters": [ { "name": "vnfId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "object", "properties": { "deploymentName": { "type": "string" }, "network": { "type": "string" }, "nicId": { "type": "string" }, "vmGroupName": { "type": "string" } }, "$$ref": "#/components/schemas/VnicInfo" }, "$$ref": "#/components/schemas/GetVnicInfoRes" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tools-read" } }, "/stream/device/capture/{deviceUUID}/{sessionId}": { "post": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "description": "Form post packet capture", "operationId": "formPostPacketCapture", "parameters": [ { "name": "deviceUUID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" } }, "$$ref": "#/components/schemas/FormPacketCaptureRes" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "vmanage-http-stream" } }, "/stream/device/log": { "post": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "operationId": "getSessionInfoLog", "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/json": {} } } }, "x-roles-required": "Tools-write" } }, "/stream/device/log/disable/{sessionId}": { "get": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "operationId": "disableDeviceLog", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "object", "properties": { "uuid": { "type": "string" } }, "description": "This is valid uuid", "$$ref": "#/components/schemas/Uuid" } } ], "responses": { "default": { "description": "default response", "content": { "application/json": {} } } }, "x-roles-required": "Tools-write" } }, "/stream/device/log/download/{sessionId}": { "get": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "operationId": "downloadDebugLog", "parameters": [ { "name": "sessionId", "in": "path", "description": "Session Id", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "default response", "content": { "application/octet-stream": {} } } }, "x-roles-required": "Tools-read" } }, "/stream/device/log/renew/{sessionId}": { "get": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "operationId": "renewSessionInfo", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "object", "properties": { "uuid": { "type": "string" } }, "description": "This is valid uuid", "$$ref": "#/components/schemas/Uuid" } } ], "responses": { "default": { "description": "default response", "content": { "application/json": {} } } }, "x-roles-required": "Tools-write" } }, "/stream/device/log/search/{sessionId}": { "post": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "operationId": "searchDeviceLog", "parameters": [ { "name": "sessionId", "in": "path", "description": "Session Id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/json": {} } } }, "x-roles-required": "Tools-read" } }, "/stream/device/log/sessions": { "get": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "operationId": "getSessions", "responses": { "default": { "description": "default response", "content": { "application/json": {} } } }, "x-roles-required": "Tools-read" } }, "/stream/device/log/sessions/clear/{sessionId}": { "get": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "operationId": "clearSession", "parameters": [ { "name": "sessionId", "in": "path", "description": "Session Id", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "default response", "content": { "application/json": {} } } }, "x-roles-required": "Tools-write" } }, "/stream/device/log/type": { "get": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "operationId": "getLogType", "parameters": [ { "name": "uuid", "in": "query", "description": "Device uuid", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "default response", "content": { "application/json": {} } } }, "x-roles-required": "Tools-read" } }, "/stream/device/log/{logType}/{deviceUUID}/{sessionId}": { "post": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "operationId": "streamLog", "parameters": [ { "name": "logType", "in": "path", "description": "Log type", "required": true, "schema": { "type": "string" } }, { "name": "deviceUUID", "in": "path", "description": "Device uuid", "required": true, "schema": { "type": "string" } }, { "name": "sessionId", "in": "path", "description": "Session Id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "type": "string" } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/json": {} } } }, "x-roles-required": "vmanage-http-stream" } }, "/stream/device/log/{sessionId}": { "get": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "operationId": "getDeviceLog", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "object", "properties": { "uuid": { "type": "string" } }, "description": "This is valid uuid", "$$ref": "#/components/schemas/Uuid" } }, { "name": "logId", "in": "query", "schema": { "type": "integer", "format": "int64", "default": -1 } } ], "responses": { "default": { "description": "default response", "content": { "application/json": {} } } }, "x-roles-required": "Tools-read" } }, "/stream/device/nwpi/exportTrace": { "get": { "tags": [ "Troubleshooting Tools - Network Wide Path Insight" ], "description": "Export NWPI Trace Data", "operationId": "exportTrace", "parameters": [ { "name": "traceId", "in": "query", "description": "trace id", "required": true, "schema": { "maximum": 262144, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "timestamp", "in": "query", "description": "start time", "required": true, "schema": { "maximum": 10000000000000, "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "traceModel", "in": "query", "description": "traceModel", "schema": { "pattern": "^(SDWAN_MANUAL|SDWAN_AUTO_ON|SD_ROUTING_MANUAL)$", "type": "string" }, "examples": { "Get manual traces": { "description": "Get manual traces", "value": "SDWAN_MANUAL" }, "Get auto on traces": { "description": "Get auto on traces", "value": "SDWAN_AUTO_ON" }, "Get sd-routing traces": { "description": "Get sd-routing traces", "value": "SD_ROUTING_MANUAL" } } } ], "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "object" }, "examples": { "Nwpi Trace Data File": { "description": "Nwpi Trace Data File", "value": "{binary format response}" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write" } }, "/stream/device/nwpi/importTrace": { "post": { "tags": [ "Troubleshooting Tools - Network Wide Path Insight" ], "description": "Import Trace", "operationId": "importTrace", "parameters": [ { "name": "newTraceName", "in": "query", "schema": { "type": "string" } }, { "name": "mode", "in": "query", "description": "mode", "schema": { "pattern": "^(SD-WAN|SD Routing)$", "type": "string" }, "examples": { "default": { "description": "default" }, "sdwan platform": { "description": "sdwan platform", "value": "SD-WAN" }, "sd-routing platform": { "description": "sd-routing platform", "value": "SD Routing" } } } ], "requestBody": { "description": "Trace Data File", "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } }, "$$ref": "#/components/schemas/ImportTraceRequest" } } }, "required": true }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "msg": { "type": "string" }, "state": { "type": "boolean" } }, "$$ref": "#/components/schemas/ImportTraceResponse" }, "examples": { "Success Response": { "description": "Success Response", "value": { "state": true, "msg": "Trace imported successfully." } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/stream/device/nwpi/tasks/create": { "post": { "tags": [ "Troubleshooting Tools - Network Wide Path Insight" ], "description": "Task Action - Create", "operationId": "taskCreate", "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Create Trace Start Task with empty Duration": { "description": "Create Trace Start Task with empty Duration", "value": { "taskName": "auto-on", "events": [ "sla-violation", "qos-congestion" ], "sites": [ "100", "500" ], "duration": "" } }, "Create Trace Start Task with Duration": { "description": "Create Trace Start Task with Duration", "value": { "taskName": "auto-on", "events": [ "sla-violation", "qos-congestion" ], "sites": [ "100", "500" ], "duration": "1440" } }, "Create Trace Start Task without Duration": { "description": "Create Trace Start Task without Duration", "value": { "taskName": "auto-on", "events": [ "sla-violation", "qos-congestion" ], "sites": [ "100", "500" ] } }, "Create Trace Start Task with Event Extensions": { "description": "Create Trace Start Task with Event Extensions", "value": { "taskName": "auto_on", "events": [ "qos-congestion", "sla-violation", "security-alert", "wan-loss", "tunnel-ipsec-anti-replay-drop" ], "sites": [ "100", "500" ], "duration": 1440, "qosCongestionExtensions": { "applications": [ "google-services" ], "qosCongestionOccurrencesCount": 2, "qosCongestionBurstInterval": 60, "filters": [ "application-in-event" ] }, "slaViolationExtensions": { "applications": [ "rtp-video" ], "slaViolationOccurrencesCount": 2, "filters": [ "application-in-event" ] }, "securityAlertExtensions": { "firewallDropRate": 10, "utdIpsAlertGid": 1, "utdIpsAlertSid": 49043, "utdFileSha": "131f95c51cc819465fa1797f6ccacf9d494aaaff46fa3eac73ae63ffbdfd8267", "utdFileRetrospectiveSha": "131f95c51cc819465fa1797f6ccacf9d494aaaff46fa3eac73ae63ffbdfd8267", "securityAlertSubEvent": [ "utd-ips-alert", "utd-file-reputation-alert", "utd-file-reputation-retrospective-alert", "firewall-drop" ], "filters": [ "source-ip-in-alert-event", "destination-ip-in-alert-event" ] }, "wanLossExtensions": { "wanLossRate": 30 }, "ipsecAntiReplayDropExtensions": { "ipsecAntiReplayDropRate": 30 } } }, "Create Task with Time Scheduled Traces": { "description": "Create Task with Time Scheduled Traces", "value": { "taskName": "auto_on", "duration": 1440, "taskTimeZone": "UTC+08:00", "createdBy": "admin", "timeScheduledTraceExtensions": { "traceSchedule": { "recurDaysList": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "traceActiveTimeList": [ { "traceStartTime": "10:00", "traceDuration": "60" }, { "traceStartTime": "15:00", "traceDuration": "60" } ] }, "tracePayload": { "source-site": "500", "local-drop-rate-threshold": 5, "wan-drop-rate-threshold": 5, "device-list": [ { "local-system-ip": "172.16.255.15", "deviceId": "172.16.255.15", "uuid": "C8K-646ad78f-fee8-41f1-be58-2f9c5b82f2cf", "version": "17.18.01.0.214177" } ], "vpn-list": [ "1", "100" ], "art-vis": "true", "app-vis": "true", "qos-mon": "true", "te-mon": "true", "source-site-version": "17.18", "traceModel": "SDWAN_AUTO_ON" } } } }, "Create Trace Start Task with Task Schedule Extensions": { "description": "Create Trace Start Task with Task Schedule Extensions", "value": { "taskName": "auto_on", "duration": 1440, "events": [ "sla-violation", "qos-congestion" ], "sites": [ "500", "600" ], "taskTimeZone": "UTC+08:00", "taskScheduleExtensions": { "recurDaysList": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "taskActiveTimeList": [ { "taskActiveStartTime": "10:00", "taskActiveDuration": "3" } ] } } }, "Create Task with Time Scheduled Traces and Task Schedule Extensions": { "description": "Create Task with Time Scheduled Traces and Task Schedule Extensions", "value": { "taskName": "auto_on", "duration": 1440, "events": [ "sla-violation", "qos-congestion" ], "sites": [ "500", "600" ], "taskTimeZone": "UTC+08:00", "createdBy": "admin", "taskScheduleExtensions": { "recurDaysList": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "taskActiveTimeList": [ { "taskActiveStartTime": "10:00", "taskActiveDuration": "3" } ] }, "timeScheduledTraceExtensions": { "traceSchedule": { "recurDaysList": [ "Monday", "Friday" ], "traceActiveTimeList": [ { "traceStartTime": "09:00", "traceDuration": "60" } ] }, "tracePayload": { "source-site": "500", "local-drop-rate-threshold": 5, "wan-drop-rate-threshold": 5, "device-list": [ { "local-system-ip": "172.16.255.15", "deviceId": "172.16.255.15", "uuid": "C8K-646ad78f-fee8-41f1-be58-2f9c5b82f2cf", "version": "17.18.01.0.214177" } ], "vpn-list": [ "1", "100" ], "art-vis": "true", "app-vis": "true", "qos-mon": "true", "te-mon": "true", "source-site-version": "17.18", "traceModel": "SDWAN_AUTO_ON" } } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "action": { "type": "string" }, "entry_time": { "type": "integer", "format": "int32" }, "expire-time": { "type": "integer", "format": "int32" }, "sites": { "type": "array", "items": { "type": "string" } }, "state": { "type": "string" }, "taskId": { "type": "integer", "format": "int32" }, "taskName": { "type": "string" } }, "description": "Auto on task create schema for POST response", "$$ref": "#/components/schemas/TasksCreateResponsePayload" }, "examples": { "Create task response": { "description": "Create task response", "value": { "action": "success", "sites": [ "100", "500" ], "taskId": 3, "taskName": "auto_on", "entry_time": 1716795211822, "expire-time": 1716881611822, "state": "active" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-write" } }, "/stream/device/nwpi/tasks/delete/{taskId}": { "delete": { "tags": [ "Troubleshooting Tools - Network Wide Path Insight" ], "description": "Delete Auto On Task", "operationId": "taskDelete", "parameters": [ { "name": "taskId", "in": "path", "description": "taskId", "required": true, "schema": { "pattern": "^[1-9][0-9]{0,5}$", "type": "string", "example": "2" } }, { "name": "taskStartTime", "in": "query", "description": "task start time", "schema": { "maximum": 10000000000000, "minimum": 1, "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "action": { "type": "string" }, "message": { "type": "object", "properties": { "duration": { "type": "string" }, "entry_time": { "type": "integer", "format": "int64" }, "events": { "type": "string" }, "expire-time": { "type": "integer", "format": "int64" }, "message": { "type": "string" }, "sites": { "type": "string" }, "state": { "type": "string" }, "taskId": { "type": "integer", "format": "int32" }, "taskName": { "type": "string" }, "traces": { "type": "boolean" } }, "$$ref": "#/components/schemas/TasksDeleteResponsePayloadMessage" }, "taskId": { "type": "string" } }, "description": "Auto on task schema for DELETE response", "$$ref": "#/components/schemas/TasksDeleteResponsePayload" }, "examples": { "Delete task response": { "description": "Delete task response", "value": { "action": "success", "taskId": "2" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-write" } }, "/stream/device/nwpi/tasks/stop/{taskId}": { "post": { "tags": [ "Troubleshooting Tools - Network Wide Path Insight" ], "description": "Task Action - Stop", "operationId": "taskStop", "parameters": [ { "name": "taskId", "in": "path", "description": "taskId", "required": true, "schema": { "type": "string", "example": "2" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "action": { "type": "string" }, "entry_time": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "state": { "type": "string" }, "taskId": { "type": "string" }, "taskName": { "type": "string" } }, "description": "Auto on task stop schema for POST response", "$$ref": "#/components/schemas/TasksStopResponsePayload" }, "examples": { "Task stop response": { "description": "Task stop response", "value": { "action": "success", "taskId": 2, "taskName": "auto-on", "state": "finished", "message": "Task Stop initiated successfully (user stop)", "startTime": 1716777834490 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-write" } }, "/stream/device/nwpi/tasks/taskHistory": { "get": { "tags": [ "Troubleshooting Tools - Network Wide Path Insight" ], "description": "Get all the auto on tasks", "operationId": "getTaskHistory", "parameters": [ { "name": "startTime", "in": "query", "description": "query start time", "schema": { "maximum": 10000000000000, "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "endTime", "in": "query", "description": "query end time", "schema": { "maximum": 10000000000000, "minimum": 1, "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "duration": { "type": "string" }, "entry_time": { "type": "integer", "format": "int32" }, "events": { "type": "array", "items": { "type": "string" } }, "expire-time": { "type": "integer", "format": "int32" }, "sites": { "type": "array", "items": { "type": "string" } }, "state": { "type": "string" }, "taskId": { "type": "integer", "format": "int32" }, "taskName": { "type": "string" }, "traces": { "type": "boolean" }, "type": { "type": "string" } }, "$$ref": "#/components/schemas/TaskHistoryResponsePayloadData" } } }, "description": "Auto on task schema for GET response", "$$ref": "#/components/schemas/TaskHistoryResponsePayload" }, "examples": { "Response for getting tasks": { "description": "Response for getting tasks", "value": { "header": { "generatedOn": 1716795499234, "viewKeys": { "uniqueKey": [], "preferenceKey": "grid-nwpiTaskData" }, "columns": [ { "title": "Task Name", "property": "taskName", "dataType": "string" }, { "title": "Task ID", "property": "taskId", "dataType": "number" }, { "title": "Event(s)", "property": "events", "dataType": "array" }, { "title": "Site(s)", "property": "sites", "dataType": "array" }, { "title": "State", "property": "state", "dataType": "string" }, { "title": "Start Time", "property": "startTime", "displayFormat": "DD MMM YYYY h:mm:ss A z", "inputFormat": "unix-time", "dataType": "date" }, { "title": "Duration", "property": "duration", "dataType": "string" }, { "title": "Stop Time", "property": "stopTime", "displayFormat": "DD MMM YYYY h:mm:ss A z", "inputFormat": "unix-time", "dataType": "date" } ], "fields": [ { "property": "taskName", "dataType": "string" }, { "property": "taskId", "dataType": "number" }, { "property": "events", "dataType": "array" }, { "property": "sites", "dataType": "array" }, { "property": "state", "dataType": "string" }, { "property": "startTime", "dataType": "date" }, { "property": "duration", "dataType": "string" }, { "property": "stopTime", "dataType": "date" }, { "property": "data", "dataType": "object" } ] }, "data": [ { "taskId": 4, "taskName": "auto_on", "duration": "600", "events": [ "qos-congestion", "sla-violation" ], "sites": [ "100", "500" ], "sitesName": [ "SITE_100", "SITE_500" ], "stopTime": 1716831311226, "traces": false, "startTime": 1716795311226, "entry_time": 1716795311226, "state": "active", "type": "task-history", "insertTime": 1716795499234 }, { "startTime": 1716795211822, "taskId": 3, "taskName": "auto_on", "duration": "1440", "events": [ "qos-congestion", "sla-violation" ], "sites": [ "100", "500" ], "sitesName": [ "SITE_100", "SITE_500" ], "stopTime": 1716795289048, "traces": "false", "state": "finished", "type": "task-history", "tenant": "default" }, { "startTime": 1716443790022, "taskId": 1, "taskName": "auto-on", "duration": "1440", "events": [ "qos-congestion", "sla-violation" ], "sites": [ "100", "400", "500", "600" ], "sitesName": [ "SITE_100", "SITE_400", "SITE_500", "SITE_600" ], "stopTime": 1716530190022, "traces": "true", "state": "finished", "type": "task-history", "tenant": "default" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write" } }, "/stream/device/nwpi/tasks/{taskId}/traces": { "get": { "tags": [ "Troubleshooting Tools - Network Wide Path Insight" ], "description": "Get all traces in one task", "operationId": "getTaskTrace", "parameters": [ { "name": "taskId", "in": "path", "description": "taskId", "required": true, "schema": { "pattern": "^[1-9][0-9]{0,5}$", "type": "string", "example": "119" } }, { "name": "taskStartTime", "in": "query", "description": "task start time", "schema": { "maximum": 10000000000000, "minimum": 1, "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "data": { "type": "object", "properties": { "devices": { "type": "array", "items": { "type": "object", "properties": { "app-vis": { "type": "string" }, "art-vis": { "type": "string" }, "connectedVManages": { "type": "string" }, "device-ip": { "type": "string" }, "device-type": { "type": "string" }, "dia-vis": { "type": "string" }, "domain-mon": { "type": "string" }, "domain_monitor_can_be_started": { "type": "string" }, "dscp-is-valid": { "type": "string" }, "duration": { "type": "string" }, "entry_time": { "type": "integer", "format": "int64" }, "expire-time": { "type": "integer", "format": "int64" }, "local-system-ip": { "type": "string" }, "message": { "type": "string" }, "parent-trace-id": { "type": "integer", "format": "int32" }, "qos-mon": { "type": "string" }, "site-id": { "type": "string" }, "source-site": { "type": "string" }, "state": { "type": "string" }, "trace-id": { "type": "integer", "format": "int32" }, "trace-name": { "type": "string" }, "uuid": { "type": "string" }, "version": { "type": "string" }, "vpn-id": { "type": "string" } }, "$$ref": "#/components/schemas/NwpiDomainMonitorStateRespPayloadDevicelist" } }, "summary": { "type": "object", "properties": { "agg-client-prefix": { "type": "string" }, "agg-src-sgt": { "type": "string" }, "agg-svr-prefix": { "type": "string" }, "agg-user-name": { "type": "string" }, "app": { "type": "string" }, "app-grp": { "type": "string" }, "app-vis": { "type": "string" }, "art-vis": { "type": "string" }, "common_app": { "type": "string" }, "device-ip": { "type": "string" }, "devicesCheckInfo": { "type": "string" }, "dia-vis": { "type": "string" }, "domain-mon": { "type": "string" }, "dscp": { "type": "string" }, "dst-ip": { "type": "string" }, "dst-pfx": { "type": "string" }, "dst-pfx-len": { "type": "string" }, "dst-port": { "type": "string" }, "duration": { "type": "string" }, "health-app-server-mem": { "type": "string" }, "health-cpu-core": { "type": "string" }, "health-cpu-load": { "type": "string" }, "health-cpu-load-average": { "type": "string" }, "health-mem-usage": { "type": "string" }, "health-running-traces": { "type": "integer", "format": "int32" }, "health-server-ip": { "type": "string" }, "hub-wan-vis": { "type": "string" }, "local-drop-rate-threshold": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "protocol": { "type": "string" }, "qos-mon": { "type": "string" }, "sampling": { "type": "string" }, "source-site": { "type": "string" }, "source-site-vmanage-version": { "type": "string" }, "spl-intvl": { "type": "string" }, "src-if": { "type": "string" }, "src-ip": { "type": "string" }, "src-pfx": { "type": "string" }, "src-pfx-len": { "type": "string" }, "src-port": { "type": "string" }, "state": { "type": "string" }, "stop-time": { "type": "integer", "format": "int32" }, "taskId": { "type": "integer", "format": "int32" }, "trace-name": { "type": "string" }, "trace-trigger-event": { "type": "string" }, "trace_stop_type": { "type": "string" }, "username": { "type": "string" }, "vpn-id": { "type": "string" }, "vpn-list": { "type": "string" }, "wan-drop-rate-threshold": { "type": "integer", "format": "int32" }, "warning": { "type": "string" } }, "$$ref": "#/components/schemas/NwpiTraceHistoryRespPayloadDataSummary" } }, "$$ref": "#/components/schemas/NwpiTraceHistoryRespPayloadData" }, "entry_time": { "type": "integer", "format": "int64" }, "tenant": { "type": "string" }, "trace-id": { "type": "integer", "format": "int32" }, "type": { "type": "string" } }, "$$ref": "#/components/schemas/TaskTracesResponsePayloadInner" } } }, "description": "Auto on task schema for GET response", "$$ref": "#/components/schemas/TaskTracesResponsePayload" }, "examples": { "Response for traces of task": { "description": "Response for traces of task", "value": { "header": { "generatedOn": 1716794459431, "viewKeys": { "uniqueKey": [], "preferenceKey": "grid-nwpiTraceData" }, "columns": [ { "title": "Start Time", "property": "entry_time", "displayFormat": "DD MMM YYYY h:mm:ss A z", "inputFormat": "unix-time", "dataType": "date" }, { "title": "Trace Id", "property": "trace-id", "dataType": "number" } ], "fields": [ { "property": "entry_time", "dataType": "date" }, { "property": "trace-id", "dataType": "number" }, { "property": "type", "dataType": "string" }, { "property": "data", "dataType": "object" } ] }, "data": [ { "entry_time": 1716531432110, "trace-id": 39600, "type": "trace-history", "data": { "summary": { "source-site": "3", "device-ip": "4.4.4.103", "vpn-id": "0", "vpn-list": [ "10" ], "src-if": "N/A", "src-ip": "N/A", "src-port": "N/A", "dst-ip": "N/A", "dst-port": "N/A", "src-pfx": "N/A", "src-pfx-len": "N/A", "dst-pfx": "N/A", "dst-pfx-len": "N/A", "app": "N/A", "username": "N/A", "common_app": "N/A", "app-grp": "N/A", "protocol": "N/A", "dscp": "N/A", "duration": "6", "trace-name": "auto_on-yicliu-security-demo1_security_drop_39600", "domain-mon": "disabled", "qos-mon": "true", "art-vis": "true", "app-vis": "true", "dia-vis": "N/A", "hub-wan-vis": "N/A", "sampling": "N/A", "spl-intvl": "N/A", "stop-time": 1716531870136, "source-site-vmanage-version": "20.15.0-12", "taskId": 119, "trace-trigger-event": "N/A", "enable-cmd-header": "N/A", "state": "stopped", "message": "Trace Stop successfully (auto stop)", "warning": "", "wan-drop-rate-threshold": 5, "local-drop-rate-threshold": 5, "agg-client-prefix": "N/A", "agg-svr-prefix": "N/A", "agg-src-sgt": "N/A", "agg-user-name": "N/A", "tenant-id": "default", "auto-on-task-name": "auto_on-yicliu-security-demo1", "area-name": "Global", "event-color": "none", "sla-class": "none", "event-vpn": "10", "event-application": "none", "up-bfd-session": 4, "bfd-session-with-traffic": 0, "peerSitesCount": 0, "health-server-ip": "4.4.4.2", "health-cpu-load": "37.77", "health-mem-usage": "17", "health-device-cpu-load": "16.74", "health-device-mem-usage": "54", "health-cpu-load-average": "0.85", "health-cpu-core": "32", "health-app-server-mem": "0.07", "health-running-traces": 2, "trace_stop_type": "" }, "devices": [ { "device-ip": "4.4.4.103", "local-system-ip": "4.4.4.103", "source-site": "3", "art-vis": "true", "site-id": "3", "uuid": "C8K-53b44a53-9467-481e-b595-2407df133b67", "duration": "6", "@rid": 9135, "trace-id": 39600, "device-type": "src", "model": "AutoOn", "state": "completed", "dscp-is-valid": "false", "qos-mon": "true", "entry_time": 1716531432110, "connectedVManages": "4.4.4.2", "parent-trace-id": 39600, "domain_monitor_can_be_started": "true", "message": "Trace Done", "vpn-id": "0", "version": "17.15.01.6.385", "app-vis": "true", "vpn-list": [ "10" ], "trace-name": "auto_on-yicliu-security-demo1_security_drop_39600", "expire-time": 1716531792110, "tenantId": "default" }, { "device-ip": "4.4.4.130", "traceModel": 1, "health-device-mem-usage": "54", "source-site": "3", "art-vis": "true", "event-vpn": "10", "uuid": "C8K-8d7c2053-93d3-45b9-b13c-5a6c1ea87092", "health-running-traces": 2, "wan-drop-rate-threshold": 5, "trace-id": 39600, "device-type": "notsrc", "warning": "", "model": "AutoOn", "state": "completed", "health-mem-usage": "17", "qos-mon": "true", "entry_time": 1716531432110, "health-cpu-core": "32", "local-drop-rate-threshold": 5, "parent-trace-id": 39600, "targetVmanageMgmtIp": "4.4.4.2", "vpn-id": "0", "version": "17.15.01.3.529", "bfd-session-with-traffic": 0, "vpn-list": [ "10" ], "trace-name": "auto_on-yicliu-security-demo1_security_drop_39600", "source-site-vmanage-version": "20.15.0-12", "expire-time": 1716531432116, "health-device-cpu-load": "16.74", "local-system-ip": "4.4.4.130", "event-application": "none", "site-id": "30", "health-app-server-mem": "0.07", "duration": "6", "@rid": 8510, "dscp-is-valid": "false", "connectedVManages": "4.4.4.2", "health-cpu-load": "37.77", "message": "Trace Done", "health-cpu-load-average": "0.85", "up-bfd-session": 4, "peerSitesCount": 0, "health-server-ip": "4.4.4.2", "app-vis": "true", "trace_stop_type": "", "trace-trigger-event": "N/A", "tenantId": "default" } ], "readout": { "detail": [] }, "flowTimeRange": { "start_time": 1716531342000, "end_time": 1716531711000 } }, "tenant": "default", "traceModel": 1 }, { "entry_time": 1716531295367, "trace-id": 39584, "type": "trace-history", "data": { "summary": { "source-site": "", "device-ip": "N/A", "vpn-id": "0", "vpn-list": [ "1", "996", "10" ], "src-if": "N/A", "src-ip": "N/A", "src-port": "N/A", "dst-ip": "N/A", "dst-port": "N/A", "src-pfx": "N/A", "src-pfx-len": "N/A", "dst-pfx": "N/A", "dst-pfx-len": "N/A", "app": "N/A", "username": "N/A", "common_app": "N/A", "app-grp": "N/A", "protocol": "N/A", "dscp": "N/A", "duration": "1440", "trace-name": "daemon_monitor_trace", "domain-mon": "disabled", "qos-mon": "true", "art-vis": "N/A", "app-vis": "true", "dia-vis": "N/A", "hub-wan-vis": "N/A", "sampling": "N/A", "spl-intvl": "N/A", "stop-time": 1716617842854, "source-site-vmanage-version": "20.15.0-12", "taskId": 119, "trace-trigger-event": "N/A", "enable-cmd-header": "N/A", "state": "stopped-with-exception", "message": "Trace Stop with exception (auto stop)\n * vmanage received 1 trace done message from [4.4.4.130]\n * vmanage hasn't received trace done message from [4.4.4.135, 4.4.4.136, 4.4.4.105, 4.4.4.103, 4.4.4.180, 4.4.4.181, 4.4.4.106, 4.4.4.120, 4.4.4.119, 4.4.4.108, 4.4.4.137]", "warning": "", "wan-drop-rate-threshold": 5, "local-drop-rate-threshold": 5, "agg-client-prefix": "N/A", "agg-svr-prefix": "N/A", "agg-src-sgt": "N/A", "agg-user-name": "N/A", "health-server-ip": "4.4.4.2", "health-cpu-load": "7.18", "health-mem-usage": "19", "health-cpu-load-average": "0", "health-cpu-core": "0", "health-app-server-mem": "0", "health-running-traces": 1, "trace_stop_type": "", "devicesCheckInfo": [ { "bfd-session-with-traffic": 1, "up-bfd-session": 1, "health-device-cpu-load": "18.31", "health-device-mem-usage": "27", "deviceHostName": "-4.4.4.120", "peerSitesCount": 1 }, { "bfd-session-with-traffic": 0, "up-bfd-session": 4, "health-device-cpu-load": "14.21", "health-device-mem-usage": "47", "deviceHostName": "-4.4.4.130", "peerSitesCount": 0 }, { "bfd-session-with-traffic": 0, "up-bfd-session": 0, "health-device-cpu-load": "0", "health-device-mem-usage": "0", "deviceHostName": "-4.4.4.135", "peerSitesCount": 0 }, { "bfd-session-with-traffic": 0, "up-bfd-session": 0, "health-device-cpu-load": "4.57", "health-device-mem-usage": "65", "deviceHostName": "-4.4.4.137", "peerSitesCount": 0 }, { "bfd-session-with-traffic": 2, "up-bfd-session": 4, "health-device-cpu-load": "16.74", "health-device-mem-usage": "54", "deviceHostName": "-4.4.4.103", "peerSitesCount": 1 }, { "bfd-session-with-traffic": 0, "up-bfd-session": 0, "health-device-cpu-load": "0", "health-device-mem-usage": "0", "deviceHostName": "-4.4.4.136", "peerSitesCount": 0 }, { "bfd-session-with-traffic": 0, "up-bfd-session": 0, "health-device-cpu-load": "0", "health-device-mem-usage": "0", "deviceHostName": "-4.4.4.106", "peerSitesCount": 0 }, { "bfd-session-with-traffic": 0, "up-bfd-session": 4, "health-device-cpu-load": "25.41", "health-device-mem-usage": "47", "deviceHostName": "-4.4.4.105", "peerSitesCount": 0 }, { "bfd-session-with-traffic": 0, "up-bfd-session": 0, "health-device-cpu-load": "0", "health-device-mem-usage": "0", "deviceHostName": "-4.4.4.180", "peerSitesCount": 0 }, { "bfd-session-with-traffic": 1, "up-bfd-session": 1, "health-device-cpu-load": "18.26", "health-device-mem-usage": "26", "deviceHostName": "-4.4.4.119", "peerSitesCount": 1 }, { "bfd-session-with-traffic": 0, "up-bfd-session": 0, "health-device-cpu-load": "0", "health-device-mem-usage": "0", "deviceHostName": "Site8-cEdge-1-4.4.4.108", "peerSitesCount": 0 }, { "bfd-session-with-traffic": 0, "up-bfd-session": 0, "health-device-cpu-load": "0", "health-device-mem-usage": "0", "deviceHostName": "-4.4.4.181", "peerSitesCount": 0 } ] }, "devices": [ { "device-ip": "4.4.4.135", "local-system-ip": "4.4.4.135", "log": "device is unreachable", "source-site": "35", "site-id": "35", "uuid": "ASR1001-HX-JAE222202LC", "duration": "1440", "@rid": 9125, "trace-id": 39584, "device-type": "src", "model": "Lite", "state": "start-failed", "dscp-is-valid": "false", "qos-mon": "true", "entry_time": 1716531295367, "parent-trace-id": 39584, "domain_monitor_can_be_started": "true", "message": "device is unreachable", "vpn-id": "0", "version": "17.09.01.0.03211858", "app-vis": "true", "vpn-list": [ "10" ], "trace-name": "daemon_monitor_trace", "expire-time": 1716617695367, "tenantId": "default" }, { "device-ip": "4.4.4.136", "local-system-ip": "4.4.4.136", "log": "device is unreachable", "source-site": "36", "site-id": "36", "uuid": "C1111-8PWE-FGL2149919Y", "duration": "1440", "@rid": 9127, "trace-id": 39584, "device-type": "src", "model": "Lite", "state": "start-failed", "dscp-is-valid": "false", "qos-mon": "true", "entry_time": 1716531295367, "parent-trace-id": 39584, "domain_monitor_can_be_started": "true", "message": "device is unreachable", "vpn-id": "0", "version": "17.09.01.0.03160742", "app-vis": "true", "vpn-list": [ "10" ], "trace-name": "daemon_monitor_trace", "expire-time": 1716617695367, "tenantId": "default" }, { "device-ip": "4.4.4.105", "local-system-ip": "4.4.4.105", "source-site": "5", "site-id": "5", "uuid": "C8K-00c313bc-8e69-4c1e-981e-84197567f8d1", "duration": "1440", "@rid": 9118, "trace-id": 39584, "device-type": "src", "model": "Lite", "state": "running", "dscp-is-valid": "false", "qos-mon": "true", "entry_time": 1716531295367, "connectedVManages": "4.4.4.2", "parent-trace-id": 39584, "domain_monitor_can_be_started": "true", "message": "Trace Start successfully", "vpn-id": "0", "version": "17.14.01.0.03142250", "app-vis": "true", "vpn-list": [ "10" ], "trace-name": "daemon_monitor_trace", "expire-time": 1716617695367, "tenantId": "default" }, { "device-ip": "4.4.4.103", "local-system-ip": "4.4.4.103", "source-site": "3", "site-id": "3", "uuid": "C8K-53b44a53-9467-481e-b595-2407df133b67", "duration": "1440", "@rid": 9120, "trace-id": 39584, "device-type": "src", "model": "Lite", "state": "running", "dscp-is-valid": "false", "qos-mon": "true", "entry_time": 1716531295367, "connectedVManages": "4.4.4.2", "parent-trace-id": 39584, "domain_monitor_can_be_started": "true", "message": "Trace Start successfully", "vpn-id": "0", "version": "17.15.01.6.385", "app-vis": "true", "vpn-list": [ "10" ], "trace-name": "daemon_monitor_trace", "expire-time": 1716617695367, "tenantId": "default" }, { "device-ip": "4.4.4.180", "local-system-ip": "4.4.4.180", "log": "device is unreachable", "source-site": "180", "site-id": "180", "uuid": "C8K-668344fe-842d-4308-ae9b-2fee6f5d213f", "duration": "1440", "@rid": 9121, "trace-id": 39584, "device-type": "src", "model": "Lite", "state": "start-failed", "dscp-is-valid": "false", "qos-mon": "true", "entry_time": 1716531295367, "parent-trace-id": 39584, "domain_monitor_can_be_started": "true", "message": "device is unreachable", "vpn-id": "0", "version": "17.06.01.0.313", "app-vis": "true", "vpn-list": [ "1" ], "trace-name": "daemon_monitor_trace", "expire-time": 1716617695367, "tenantId": "default" }, { "device-ip": "4.4.4.181", "local-system-ip": "4.4.4.181", "log": "device is unreachable", "source-site": "181", "site-id": "181", "uuid": "C8K-7a391403-fe2c-4f14-a5e4-cf93288dceae", "duration": "1440", "@rid": 9122, "trace-id": 39584, "device-type": "src", "model": "Lite", "state": "start-failed", "dscp-is-valid": "false", "qos-mon": "true", "entry_time": 1716531295367, "parent-trace-id": 39584, "domain_monitor_can_be_started": "true", "message": "device is unreachable", "vpn-id": "0", "version": "17.06.01.0.313", "app-vis": "true", "vpn-list": [ "1" ], "trace-name": "daemon_monitor_trace", "expire-time": 1716617695367, "tenantId": "default" }, { "device-ip": "4.4.4.130", "local-system-ip": "4.4.4.130", "source-site": "30", "site-id": "30", "uuid": "C8K-8d7c2053-93d3-45b9-b13c-5a6c1ea87092", "duration": "1440", "@rid": 9119, "trace-id": 39584, "device-type": "src", "model": "Lite", "state": "completed", "dscp-is-valid": "false", "qos-mon": "true", "entry_time": 1716531295367, "connectedVManages": "4.4.4.2", "parent-trace-id": 39584, "domain_monitor_can_be_started": "true", "message": "Trace Done", "vpn-id": "0", "version": "17.15.01.3.529", "app-vis": "true", "vpn-list": [ "10" ], "trace-name": "daemon_monitor_trace", "expire-time": 1716617695367, "tenantId": "default" }, { "device-ip": "4.4.4.106", "local-system-ip": "4.4.4.106", "log": "device is unreachable", "source-site": "6", "site-id": "6", "uuid": "CSR-134623c5-a814-4552-9a75-27e28aae3c06", "duration": "1440", "@rid": 9129, "trace-id": 39584, "device-type": "src", "model": "Lite", "state": "start-failed", "dscp-is-valid": "false", "qos-mon": "true", "entry_time": 1716531295367, "parent-trace-id": 39584, "domain_monitor_can_be_started": "true", "message": "device is unreachable", "vpn-id": "0", "version": "17.06.01.3.135059", "app-vis": "true", "vpn-list": [ "10" ], "trace-name": "daemon_monitor_trace", "expire-time": 1716617695367, "tenantId": "default" }, { "device-ip": "4.4.4.120", "local-system-ip": "4.4.4.120", "source-site": "20", "site-id": "20", "uuid": "CSR-7c9f706c-288e-49da-8f57-9f5a5b3e3333", "duration": "1440", "@rid": 9124, "trace-id": 39584, "device-type": "src", "model": "Lite", "state": "running", "dscp-is-valid": "false", "qos-mon": "true", "entry_time": 1716531295367, "connectedVManages": "4.4.4.2", "parent-trace-id": 39584, "domain_monitor_can_be_started": "true", "message": "Trace Start successfully", "vpn-id": "0", "version": "17.14.01.0.262", "app-vis": "true", "vpn-list": [ "996", "10" ], "trace-name": "daemon_monitor_trace", "expire-time": 1716617695367, "tenantId": "default" }, { "device-ip": "4.4.4.119", "local-system-ip": "4.4.4.119", "source-site": "19", "site-id": "19", "uuid": "CSR-7c9f706c-288e-49da-8f57-9f5a5b3e5555", "duration": "1440", "@rid": 9123, "trace-id": 39584, "device-type": "src", "model": "Lite", "state": "running", "dscp-is-valid": "false", "qos-mon": "true", "entry_time": 1716531295367, "connectedVManages": "4.4.4.2", "parent-trace-id": 39584, "domain_monitor_can_be_started": "true", "message": "Trace Start successfully", "vpn-id": "0", "version": "17.14.01.2.1085", "app-vis": "true", "vpn-list": [ "10" ], "trace-name": "daemon_monitor_trace", "expire-time": 1716617695367, "tenantId": "default" }, { "device-ip": "4.4.4.108", "local-system-ip": "4.4.4.108", "log": "device is unreachable", "source-site": "8", "site-id": "8", "uuid": "CSR-8e3a07d0-6e22-4a85-9397-f86c1e4e4f4d", "duration": "1440", "@rid": 9130, "trace-id": 39584, "device-type": "src", "model": "Lite", "state": "start-failed", "dscp-is-valid": "false", "qos-mon": "true", "entry_time": 1716531295367, "parent-trace-id": 39584, "domain_monitor_can_be_started": "true", "message": "device is unreachable", "vpn-id": "0", "version": "17.06.01.3.135059", "app-vis": "true", "vpn-list": [ "10" ], "trace-name": "daemon_monitor_trace", "expire-time": 1716617695367, "tenantId": "default" }, { "device-ip": "4.4.4.137", "local-system-ip": "4.4.4.137", "log": "Trace Start initiated failed (unknown element: qos-mon in /Cisco-IOS-XE-nwpi-rpc:device-nwpi) ", "source-site": "37", "site-id": "37", "uuid": "ISR4451-X/K9-FOC17042FM3", "duration": "1440", "@rid": 9128, "trace-id": 39584, "device-type": "src", "model": "Lite", "state": "start-failed", "dscp-is-valid": "false", "qos-mon": "true", "entry_time": 1716531295367, "connectedVManages": "4.4.4.2", "parent-trace-id": 39584, "domain_monitor_can_be_started": "true", "message": "Trace Start initiated failed (unknown element: qos-mon in /Cisco-IOS-XE-nwpi-rpc:device-nwpi) ", "vpn-id": "0", "version": "17.09.01.0.03212256", "app-vis": "true", "vpn-list": [ "10" ], "trace-name": "daemon_monitor_trace", "expire-time": 1716617695367, "tenantId": "default" } ], "readout": { "detail": [] }, "flowTimeRange": { "start_time": 0, "end_time": 0 } }, "tenant": "default", "traceModel": 2 } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write" } }, "/stream/device/nwpi/trace/delete": { "delete": { "tags": [ "Troubleshooting Tools - Network Wide Path Insight" ], "description": "Trace Action - Delete", "operationId": "traceDelete", "parameters": [ { "name": "traceId", "in": "query", "description": "trace id", "required": true, "schema": { "pattern": "^[1-9][0-9]{0,5}$", "type": "string", "example": "16" } }, { "name": "timestamp", "in": "query", "description": "start time", "required": true, "schema": { "maximum": 10000000000000, "minimum": 1, "type": "integer", "format": "int64", "example": 1716782661675 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "action": { "type": "string" }, "trace-id": { "type": "string" } }, "description": "Nwpi trace delete response schema", "$$ref": "#/components/schemas/NwpiTraceDeleteRespPayload" }, "examples": { "Trace delete successfully": { "description": "Trace delete successfully", "value": { "action": "success", "trace-id": "16" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-write" } }, "/stream/device/nwpi/trace/start": { "post": { "tags": [ "Troubleshooting Tools - Network Wide Path Insight" ], "description": "Trace Action - Start", "operationId": "traceStart", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "app": { "type": "array", "items": { "type": "string" } }, "app-vis": { "type": "string" }, "art-vis": { "type": "string" }, "dia-vis": { "type": "string" }, "dscp": { "type": "string" }, "dst-pfx": { "type": "string" }, "dst-port": { "type": "string" }, "duration": { "type": "string" }, "hub-wan-vis": { "type": "string" }, "protocol": { "type": "string" }, "sampling": { "type": "string" }, "source-site": { "type": "string" }, "spl-intvl": { "type": "string" }, "src-if": { "type": "string" }, "src-pfx": { "type": "string" }, "src-port": { "type": "string" }, "trace-name": { "type": "string" }, "vpn-id": { "type": "string" } }, "description": "Trace start payload schema", "$$ref": "#/components/schemas/NwpiTraceStartReqPayload" }, "examples": { "Start trace simply": { "description": "Start trace simply", "value": { "source-site": "500", "duration": "60", "vpn-id": "1" } }, "Start trace simply (use vpn-list)": { "description": "Start trace simply (use vpn-list)", "value": { "source-site": "500", "duration": "60", "vpn-list": [ "1" ] } }, "Start trace simply (UI default paramters)": { "description": "Start trace simply (UI default paramters)", "value": { "source-site": "500", "duration": "60", "local-drop-rate-threshold": 5, "wan-drop-rate-threshold": 5, "device-list": [ { "local-system-ip": "172.16.255.15", "deviceId": "172.16.255.15", "uuid": "C8K-4efe30b8-f843-4443-bba3-a8b7a5138492", "version": "17.15.01.0.727", "transport-interface": [] } ], "vpn-id": "1", "art-vis": "true", "app-vis": "true", "qos-mon": "true", "source-site-version": "17.15", "traceModel": "SDWAN_MANUAL", "warning": "" } }, "Start trace with synthetic traffic": { "description": "Start trace with synthetic traffic", "value": { "source-site": "500", "duration": "60", "local-drop-rate-threshold": 5, "wan-drop-rate-threshold": 5, "device-list": [ { "local-system-ip": "172.16.255.15", "deviceId": "172.16.255.15", "uuid": "C8K-4efe30b8-f843-4443-bba3-a8b7a5138492", "version": "17.15.01.0.727", "transport-interface": [] } ], "vpn-id": "1", "test": [ { "target-url": "www.chatgpt.com", "dscp": "0", "test-intvl": "1", "dns-svr": "8.8.8.8", "vpn-id": "1", "username": "", "user_grp": "" } ], "art-vis": "true", "app-vis": "true", "qos-mon": "true", "source-site-version": "17.15", "traceModel": "SDWAN_MANUAL", "warning": "" } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "action": { "type": "string" }, "domain-mon": { "type": "boolean" }, "entry_time": { "type": "integer", "format": "int64" }, "expire-time": { "type": "integer", "format": "int64" }, "local-drop-rate-threshold": { "type": "integer", "format": "int32" }, "qos-mon": { "type": "boolean" }, "source-site": { "type": "string" }, "state": { "type": "string" }, "trace-id": { "type": "integer", "format": "int32" }, "trace-name": { "type": "string" }, "traces": { "type": "array", "items": { "type": "object", "properties": { "device-ip": { "type": "string" }, "entry_time": { "type": "integer", "format": "int64" }, "local-system-ip": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "string" }, "trace-id": { "type": "integer", "format": "int32" }, "uuid": { "type": "string" } }, "$$ref": "#/components/schemas/NwpiTraceStartRespPayloadTraces" } }, "wan-drop-rate-threshold": { "type": "integer", "format": "int32" } }, "description": "Nwpi trace start response payload schema", "$$ref": "#/components/schemas/NwpiTraceStartRespPayload" }, "examples": { "Start trace simply": { "description": "Start trace simply", "value": { "action": "success", "qos-mon": true, "source-site": "500", "trace-id": 80, "trace-name": "trace_80", "traceModel": 0, "entry_time": 1716789542704, "expire-time": 1716793142704, "state": "starting", "traces": [ { "uuid": "C8K-4efe30b8-f843-4443-bba3-a8b7a5138492", "device-ip": "172.16.255.15", "local-system-ip": "172.16.255.15", "trace-id": 80, "entry_time": 1716789542704, "status": "success", "message": "Trace Starting" } ], "domain-mon": false, "local-drop-rate-threshold": 5, "wan-drop-rate-threshold": 5 } }, "Start trace simply (UI default paramters)": { "description": "Start trace simply (UI default paramters)", "value": { "action": "success", "qos-mon": true, "source-site": "500", "trace-id": 96, "trace-name": "trace_96", "traceModel": 0, "entry_time": 1716790090943, "expire-time": 1716793690943, "state": "starting", "traces": [ { "uuid": "C8K-4efe30b8-f843-4443-bba3-a8b7a5138492", "device-ip": "172.16.255.15", "local-system-ip": "172.16.255.15", "trace-id": 96, "entry_time": 1716790090943, "status": "success", "message": "Trace Starting" } ], "domain-mon": false, "local-drop-rate-threshold": 5, "wan-drop-rate-threshold": 5 } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-write" } }, "/stream/device/nwpi/trace/stop/{traceId}": { "post": { "tags": [ "Troubleshooting Tools - Network Wide Path Insight" ], "description": "Trace Action - Stop", "operationId": "traceStop", "parameters": [ { "name": "traceId", "in": "path", "description": "traceId", "required": true, "schema": { "pattern": "^[1-9][0-9]{0,5}$", "type": "string", "example": "48" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "action": { "type": "string" }, "domain-mon": { "type": "boolean" }, "entry_time": { "type": "integer", "format": "int64" }, "message": { "type": "string" }, "qos-mon": { "type": "boolean" }, "state": { "type": "string" }, "trace-id": { "type": "string" }, "trace-name": { "type": "string" }, "traces": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string" }, "device-ip": { "type": "string" }, "entry_time": { "type": "integer", "format": "int64" }, "local-system-ip": { "type": "string" }, "message": { "type": "string" }, "trace-id": { "type": "integer", "format": "int32" }, "uuid": { "type": "string" } }, "$$ref": "#/components/schemas/NwpiTraceStopRespPayloadTraces" } } }, "description": "Nwpi trace stoppayload schema", "$$ref": "#/components/schemas/NwpiTraceStopRespPayload" }, "examples": { "Trace stop successfully": { "description": "Trace stop successfully", "value": { "action": "success", "trace-id": "48", "trace-name": "trace_48", "state": "stopping", "message": "Trace Stop initiated successfully (user stop), ready to notify devices", "qos-mon": true, "entry_time": 1716782691675, "domain-mon": false, "traces": [ { "uuid": "C8K-4efe30b8-f843-4443-bba3-a8b7a5138492", "device-ip": "172.16.255.15", "local-system-ip": "172.16.255.15", "trace-id": 48, "entry_time": 1716782691675, "action": "success", "message": "Device Trace Stop initiated successfully (device is waiting to be notified)" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-write" } }, "/stream/device/nwpi/traceHistory": { "get": { "tags": [ "Troubleshooting Tools - Network Wide Path Insight" ], "description": "Get historical traces", "operationId": "getTraceHistory", "parameters": [ { "name": "traceModel", "in": "query", "description": "traceModel", "schema": { "pattern": "^(SDWAN_MANUAL|SDWAN_AUTO_ON|SD_ROUTING_MANUAL|SDWAN_NWPI_LITE).*", "type": "string" }, "examples": { "Get manual traces": { "description": "Get manual traces", "value": "SDWAN_MANUAL" }, "Get auto on traces": { "description": "Get auto on traces", "value": "SDWAN_AUTO_ON" }, "Get sd-routing traces": { "description": "Get sd-routing traces", "value": "SD_ROUTING_MANUAL" }, "Get multiple types of traces with parameters separated by commas": { "description": "Get multiple types of traces with parameters separated by commas", "value": "SDWAN_MANUAL,SDWAN_AUTO_ON,SD_ROUTING_MANUAL" } } }, { "name": "startTime", "in": "query", "description": "query start time", "schema": { "maximum": 10000000000000, "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "endTime", "in": "query", "description": "query end time", "schema": { "maximum": 10000000000000, "minimum": 1, "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "devices": { "type": "array", "items": { "type": "object", "properties": { "app-vis": { "type": "string" }, "art-vis": { "type": "string" }, "connectedVManages": { "type": "string" }, "device-ip": { "type": "string" }, "device-type": { "type": "string" }, "dia-vis": { "type": "string" }, "domain-mon": { "type": "string" }, "domain_monitor_can_be_started": { "type": "string" }, "dscp-is-valid": { "type": "string" }, "duration": { "type": "string" }, "entry_time": { "type": "integer", "format": "int64" }, "expire-time": { "type": "integer", "format": "int64" }, "local-system-ip": { "type": "string" }, "message": { "type": "string" }, "parent-trace-id": { "type": "integer", "format": "int32" }, "qos-mon": { "type": "string" }, "site-id": { "type": "string" }, "source-site": { "type": "string" }, "state": { "type": "string" }, "trace-id": { "type": "integer", "format": "int32" }, "trace-name": { "type": "string" }, "uuid": { "type": "string" }, "version": { "type": "string" }, "vpn-id": { "type": "string" } }, "$$ref": "#/components/schemas/NwpiDomainMonitorStateRespPayloadDevicelist" } }, "summary": { "type": "object", "properties": { "agg-client-prefix": { "type": "string" }, "agg-src-sgt": { "type": "string" }, "agg-svr-prefix": { "type": "string" }, "agg-user-name": { "type": "string" }, "app": { "type": "string" }, "app-grp": { "type": "string" }, "app-vis": { "type": "string" }, "art-vis": { "type": "string" }, "common_app": { "type": "string" }, "device-ip": { "type": "string" }, "devicesCheckInfo": { "type": "string" }, "dia-vis": { "type": "string" }, "domain-mon": { "type": "string" }, "dscp": { "type": "string" }, "dst-ip": { "type": "string" }, "dst-pfx": { "type": "string" }, "dst-pfx-len": { "type": "string" }, "dst-port": { "type": "string" }, "duration": { "type": "string" }, "health-app-server-mem": { "type": "string" }, "health-cpu-core": { "type": "string" }, "health-cpu-load": { "type": "string" }, "health-cpu-load-average": { "type": "string" }, "health-mem-usage": { "type": "string" }, "health-running-traces": { "type": "integer", "format": "int32" }, "health-server-ip": { "type": "string" }, "hub-wan-vis": { "type": "string" }, "local-drop-rate-threshold": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "protocol": { "type": "string" }, "qos-mon": { "type": "string" }, "sampling": { "type": "string" }, "source-site": { "type": "string" }, "source-site-vmanage-version": { "type": "string" }, "spl-intvl": { "type": "string" }, "src-if": { "type": "string" }, "src-ip": { "type": "string" }, "src-pfx": { "type": "string" }, "src-pfx-len": { "type": "string" }, "src-port": { "type": "string" }, "state": { "type": "string" }, "stop-time": { "type": "integer", "format": "int32" }, "taskId": { "type": "integer", "format": "int32" }, "trace-name": { "type": "string" }, "trace-trigger-event": { "type": "string" }, "trace_stop_type": { "type": "string" }, "username": { "type": "string" }, "vpn-id": { "type": "string" }, "vpn-list": { "type": "string" }, "wan-drop-rate-threshold": { "type": "integer", "format": "int32" }, "warning": { "type": "string" } }, "$$ref": "#/components/schemas/NwpiTraceHistoryRespPayloadDataSummary" } }, "$$ref": "#/components/schemas/NwpiTraceHistoryRespPayloadData" }, "entry_time": { "type": "integer", "format": "int64" }, "trace-id": { "type": "integer", "format": "int32" }, "type": { "type": "string" } }, "description": "Nwpi traceHistory response payload schema", "$$ref": "#/components/schemas/NwpiTraceHistoryRespPayload" }, "examples": { "Response for getting historical traces": { "description": "Response for getting historical traces", "value": { "header": { "generatedOn": 1716888241874, "viewKeys": { "uniqueKey": [], "preferenceKey": "grid-nwpiTraceData" }, "columns": [ { "title": "Start Time", "property": "entry_time", "displayFormat": "DD MMM YYYY h:mm:ss A z", "inputFormat": "unix-time", "dataType": "date" }, { "title": "Trace Id", "property": "trace-id", "dataType": "number" } ], "fields": [ { "property": "entry_time", "dataType": "date" }, { "property": "trace-id", "dataType": "number" }, { "property": "type", "dataType": "string" }, { "property": "data", "dataType": "object" } ] }, "data": [ { "trace-id": 144, "entry_time": 1716885120542, "traceModel": 0, "type": "trace-history", "data": { "summary": { "source-site": "500", "device-ip": "N/A", "vpn-id": "0", "vpn-list": [ "1" ], "src-if": "N/A", "src-ip": "N/A", "src-port": "N/A", "dst-ip": "N/A", "dst-port": "N/A", "src-pfx": "N/A", "src-pfx-len": "N/A", "dst-pfx": "N/A", "dst-pfx-len": "N/A", "app": "N/A", "username": "N/A", "common_app": "N/A", "app-grp": "N/A", "protocol": "N/A", "dscp": "N/A", "duration": "60", "trace-name": "trace_144", "domain-mon": "disabled", "qos-mon": "N/A", "art-vis": "N/A", "app-vis": "N/A", "dia-vis": "N/A", "hub-wan-vis": "N/A", "sampling": "N/A", "spl-intvl": "N/A", "stop-time": -1, "source-site-vmanage-version": "20.15.0-50", "taskId": -1, "trace-trigger-event": "N/A", "enable-cmd-header": "N/A", "state": "stopping", "message": "Trace Stop initiated successfully (user stop), ready to notify devices", "warning": "", "wan-drop-rate-threshold": 5, "local-drop-rate-threshold": 5, "agg-client-prefix": "N/A", "agg-svr-prefix": "N/A", "agg-src-sgt": "N/A", "agg-user-name": "N/A", "health-server-ip": "172.16.255.22", "health-cpu-load": "3.06", "health-mem-usage": "44", "health-cpu-load-average": "0.06", "health-cpu-core": "16", "health-app-server-mem": "0.09", "health-running-traces": 1, "trace_stop_type": "", "devicesCheckInfo": [ { "bfd-session-with-traffic": 0, "up-bfd-session": 18, "health-device-cpu-load": "30.56", "health-device-mem-usage": "83", "deviceHostName": "vm5-172.16.255.15", "peerSitesCount": 0 } ] }, "devices": [ { "entry_time": 1716885120542, "device-ip": "172.16.255.15", "local-system-ip": "172.16.255.15", "connectedVManages": "172.16.255.22", "parent-trace-id": 144, "domain_monitor_can_be_started": "true", "source-site": "500", "site-id": "500", "message": "Device Trace Stop initiated successfully (received device reply ok)", "vpn-id": "0", "uuid": "C8K-4efe30b8-f843-4443-bba3-a8b7a5138492", "version": "17.15.01.0.727", "duration": "60", "vpn-list": [ "1" ], "trace-name": "trace_144", "@rid": 4365, "trace-id": 144, "expire-time": 1716888720542, "tenantId": "default", "device-type": "src", "state": "stopped", "dscp-is-valid": "false" } ] } } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write" } }, "/stream/device/speed": { "post": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "operationId": "getSession", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "destinationColor": { "type": "string", "example": "lte" }, "destinationIfAddr": { "type": "string", "example": "1.1.1.1" }, "destinationInterface": { "type": "string", "example": "GigabitEthernet5" }, "destinationIp": { "type": "string", "example": "10.1.15.13" }, "deviceUUID": { "type": "string" }, "port": { "type": "string", "example": "9999" }, "server-list": { "type": "array", "items": { "type": "object", "properties": { "server-name": { "type": "string" }, "server-ports": { "type": "string" } }, "$$ref": "#/components/schemas/ServerList" } }, "sourceColor": { "type": "string", "example": "lte" }, "sourceIfAddr": { "type": "string", "example": "1.1.1.1" }, "sourceInterface": { "type": "string", "example": "GigabitEthernet4" }, "sourceIp": { "type": "string", "example": "10.1.15.13" } }, "description": "This is valid SpeedTestSession", "$$ref": "#/components/schemas/SpeedTestSession" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "isNewSession": { "type": "boolean", "example": true }, "isOwner": { "type": "boolean", "example": true }, "renewalTime": { "type": "integer", "format": "int64", "example": 1692757301266 }, "sessionId": { "type": "string", "example": "de26406d-21f2-4d3d-bc82-6f36553c45bf" }, "startTime": { "type": "integer", "format": "int64", "example": 1692757301266 }, "type": { "type": "string", "example": "speedTest" }, "userIp": { "type": "string", "example": "172.16.255.15" }, "uuid": { "type": "string", "example": "C8K-63eadff3-fa6d-4779-add0-d712a36c6f73" } }, "description": "This is valid speedTestResponse", "$$ref": "#/components/schemas/SpeedTestResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tools-read" } }, "/stream/device/speed/disable/{sessionId}": { "get": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "operationId": "disableSpeedTestSession", "parameters": [ { "name": "sessionId", "in": "path", "description": "sessionId", "required": true, "schema": { "type": "object", "properties": { "uuid": { "type": "string" } }, "description": "This is valid uuid", "$$ref": "#/components/schemas/Uuid" }, "examples": { "sessionId": { "description": "sessionId", "value": "5be3ee01-e7fb-4d4f-81b4-35dc14f4f50d" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" } }, "description": "This is valid speedTestStatusResponse", "$$ref": "#/components/schemas/SpeedTestStatusResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tools-read" } }, "/stream/device/speed/interface/bandwidth": { "get": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "operationId": "getInterfaceBandwidth", "parameters": [ { "name": "deviceUUID", "in": "query", "required": true, "schema": { "type": "object", "properties": { "deviceUuid": { "type": "string", "example": "C8K-f9f4a977-be6c-47f7-b3b2-10e916bb24db" } }, "description": "This is valid DeviceUuid", "$$ref": "#/components/schemas/DeviceUuid" } }, { "name": "circuit", "in": "query", "schema": { "type": "string" } }, { "name": "sourceInterface", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "down_bw": { "type": "string", "example": "NA" }, "up_bw": { "type": "string", "example": "NA" } }, "description": "This is valid speedTestInterfaceResponse", "$$ref": "#/components/schemas/SpeedTestInterfaceResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read" } }, "/stream/device/speed/start/{sessionId}": { "get": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "operationId": "startSpeedTest", "parameters": [ { "name": "sessionId", "in": "path", "description": "sessionId", "required": true, "schema": { "type": "object", "properties": { "uuid": { "type": "string" } }, "description": "This is valid uuid", "$$ref": "#/components/schemas/Uuid" }, "examples": { "sessionId": { "description": "sessionId", "value": "5be3ee01-e7fb-4d4f-81b4-35dc14f4f50d" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" } }, "description": "This is valid speedTestStatusResponse", "$$ref": "#/components/schemas/SpeedTestStatusResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tools-read" } }, "/stream/device/speed/status/{sessionId}": { "get": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "operationId": "getSpeedTestStatus", "parameters": [ { "name": "sessionId", "in": "path", "description": "sessionId", "required": true, "schema": { "type": "object", "properties": { "uuid": { "type": "string" } }, "description": "This is valid uuid", "$$ref": "#/components/schemas/Uuid" }, "examples": { "sessionId": { "description": "sessionId", "value": "5be3ee01-e7fb-4d4f-81b4-35dc14f4f50d" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" } }, "description": "This is valid speedTestStatusResponse", "$$ref": "#/components/schemas/SpeedTestStatusResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tools-read" } }, "/stream/device/speed/stop/{sessionId}": { "get": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "operationId": "stopSpeedTest", "parameters": [ { "name": "sessionId", "in": "path", "description": "sessionId", "required": true, "schema": { "type": "object", "properties": { "uuid": { "type": "string" } }, "description": "This is valid uuid", "$$ref": "#/components/schemas/Uuid" }, "examples": { "sessionId": { "description": "sessionId", "value": "5be3ee01-e7fb-4d4f-81b4-35dc14f4f50d" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" } }, "description": "This is valid speedTestStatusResponse", "$$ref": "#/components/schemas/SpeedTestStatusResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tools-read" } }, "/stream/device/speed/{deviceUUID}/{sessionId}": { "post": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "operationId": "saveSpeedTestResults", "parameters": [ { "name": "deviceUUID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sessionId", "in": "path", "description": "sessionId", "required": true, "schema": { "type": "object", "properties": { "uuid": { "type": "string" } }, "description": "This is valid uuid", "$$ref": "#/components/schemas/Uuid" }, "examples": { "sessionId": { "description": "sessionId", "value": "5be3ee01-e7fb-4d4f-81b4-35dc14f4f50d" } } } ], "requestBody": { "description": "SpeedTestResult", "content": { "application/json": { "schema": { "type": "object", "properties": { "down-speed": { "type": "number", "format": "double", "example": 9 }, "error": { "type": "string", "example": "NA" }, "location": { "type": "string", "example": "NA" }, "server": { "type": "string", "example": "NA" }, "status": { "type": "string", "example": "NA" }, "up-speed": { "type": "number", "format": "double", "example": 9 } }, "description": "This is valid SpeedTestResult", "$$ref": "#/components/schemas/SpeedTestResult" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" } }, "description": "This is valid speedTestStatusResponse", "$$ref": "#/components/schemas/SpeedTestStatusResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "vmanage-http-stream" } }, "/stream/device/speed/{sessionId}": { "get": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "operationId": "getSpeedTest", "parameters": [ { "name": "sessionId", "in": "path", "description": "sessionId", "required": true, "schema": { "type": "object", "properties": { "uuid": { "type": "string" } }, "description": "This is valid uuid", "$$ref": "#/components/schemas/Uuid" }, "examples": { "sessionId": { "description": "sessionId", "value": "5be3ee01-e7fb-4d4f-81b4-35dc14f4f50d" } } }, { "name": "logId", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 0 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "destination_circuit": { "type": "string", "example": "lte" }, "destination_ip": { "type": "string", "example": "172.16.255.21" }, "destination_local_ip": { "type": "string", "example": "172.16.255.21" }, "device_uuid": { "type": "string", "example": "C8K-63eadff3-fa6d-4779-add0-d712a36c6f73" }, "down_bw": { "type": "string", "example": "NA" }, "down_speed": { "type": "integer", "format": "int64", "example": 0 }, "entry_time": { "type": "integer", "format": "int64", "example": 1692757301266 }, "error": { "type": "string", "example": "None" }, "logid": { "type": "integer", "format": "int64", "example": 0 }, "port": { "type": "string", "example": "80" }, "session_id": { "type": "string", "example": "de26406d-21f2-4d3d-bc82-6f36553c45bf" }, "source_circuit": { "type": "string", "example": "lte" }, "source_ip": { "type": "string", "example": "172.16.255.15" }, "source_local_ip": { "type": "string", "example": "172.16.255.15" }, "status": { "type": "string", "example": "progress" }, "tenant": { "type": "string", "example": "default" }, "up_bw": { "type": "string", "example": "NA" }, "up_speed": { "type": "integer", "format": "int64", "example": 0 } }, "description": "This is valid speedTestData", "$$ref": "#/components/schemas/SpeedTestData" } }, "description": "This is valid speedTestResultResponse", "$$ref": "#/components/schemas/SpeedTestResultResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tools-read" } }, "/stream/device/status/{deviceUUID}": { "post": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "description": "Get device status stream", "operationId": "processDeviceStatus", "parameters": [ { "name": "deviceUUID", "in": "path", "description": "Device uuid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "*/*": {} } } }, "x-roles-required": "vmanage-http-stream" } }, "/stream/device/umts": { "post": { "tags": [ "Troubleshooting Tools - UMTS" ], "summary": "Assign sessionId to client", "description": "assign sessionId to client if there is no conflict ongoing sessions ", "operationId": "enableSession", "requestBody": { "description": "Input query", "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceUUID": { "type": "string", "example": "C8K-21a355e3-fd5b-4d03-9d48-f2845388c07f" }, "localColor": { "type": "string", "example": "lte" }, "remoteColor": { "type": "string", "example": "remote-color-all" }, "remoteSystem": { "type": "string", "example": "172.16.255.16,172.16.255.14" } }, "$$ref": "#/components/schemas/UMTSInput" } } }, "required": true }, "responses": { "200": { "description": "Session info which client can start request", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "download_status": { "type": "string", "example": "success" }, "payload": { "type": "string", "example": "\"{\\\"deviceUUID\\\":\\\"C8K-21a355e3-fd5b-4d03-9d48-f2845388c07f\\\",\\\"localColor\\\":\\\"lte\\\",\\\"remoteSystem\\\":\\\"172.16.255.16\\\",\\\"remoteColor\\\":\\\"lte\\\",\\\"actionType\\\":\\\"ON_DEMANDING\\\",\\\"sessionId\\\":\\\"5596803a-e594-413b-89f2-2acecd1d5f92\\\"}\"" }, "renewalTime": { "type": "number", "example": 1654566270967 }, "requestStatus": { "type": "string", "example": "stop" }, "sessionId": { "type": "string", "example": "5596803a-e594-413b-89f2-2acecd1d5f92" }, "startTime": { "type": "number", "example": 1654566270968 }, "status": { "type": "string", "example": "success" }, "statusMessage": { "type": "string", "example": "device error" }, "type": { "type": "string", "example": "ON_DEMANDING" }, "user": { "type": "string", "example": "admin" }, "userIp": { "type": "string", "example": "100.1.2.3" }, "uuid": { "type": "string", "example": "C8K-21a355e3-fd5b-4d03-9d48-f2845388c07f" } }, "$$ref": "#/components/schemas/UMTSSession" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "conflicts sample": { "description": "conflicts sample", "value": { "error": { "type": "error", "message": "Server Error", "details": "device C8K-6dfe1f7c-7dc5-4891-bdb4-fb74e84882b7 is already have a active umts tunnel session", "code": "TBST1008" } }, "$$ref": "#/components/examples/ComViptelaVmanageServerTroubleshootingUmtsUmtsrestapiResponseExampleUmtsEnableError" } } } } } } } }, "/stream/device/umts/statistics/{deviceUUID}/{eventType}": { "get": { "tags": [ "Troubleshooting Tools - UMTS" ], "summary": "get UMTS Data", "description": "get UMTS result by type, time, and device uuid", "operationId": "getUMTSData", "parameters": [ { "name": "deviceUUID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "eventType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "lastNHours", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 24 } } ], "responses": { "200": { "description": "opertion result", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "get event-driven sample": { "description": "get event-driven sample", "value": { "data": [ { "vip_idx": 496, "vip_time": 16434009013877, "remote_color": "lte", "local_color": "lte", "remote_system_ip": "172.16.255.16", "local_system_ip": "172.16.255.21", "proto": "IPSEC", "sent_qos": 135, "state": "UP", "event_type": "ON_DEMAND", "event_subtype": "NONE111", "hops": { "hop": [ { "idx": 1, "ip": "10.1.15.13", "hostname": "", "rtt": 486, "rtt_min": 480, "rtt_max": 490, "loss": 0, "jitter": 0, "recv_qos": 0, "reply_qos": 0, "lbl_info": 0 }, { "idx": 2, "ip": "10.0.5.21", "hostname": "", "rtt": 487, "rtt_min": 480, "rtt_max": 490, "loss": 0, "jitter": 0, "recv_qos": 0, "reply_qos": 0, "lbl_info": 0 } ] } } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerTroubleshootingUmtsUmtsrestapiResponseExampleUmtsEventdrivenResult" } } } } }, "400": { "description": "Bad Request" } } } }, "/stream/device/umts/{deviceUUID}/save": { "post": { "tags": [ "Troubleshooting Tools - UMTS" ], "summary": "save UMTS result", "description": "Save UMTS Data, this api is called by device side ", "operationId": "saveUMTSData", "parameters": [ { "name": "deviceUUID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Stats query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "on-demand sample": { "description": "on-demand sample", "value": { "record": [ { "vip_idx": 493, "vip_time": 1643400901398, "remote_color": "lte", "local_color": "lte", "remote_system_ip": "172.16.255.21", "local_system_ip": "172.16.255.15", "proto": "IPSEC", "sent_qos": 72, "state": "UP", "event_type": "PERIODIC", "event_subtype": "NONE", "hops": { "hop": [ { "idx": 1, "ip": "10.1.15.13", "hostname": "", "rtt": 486, "rtt_min": 480, "rtt_max": 490, "loss": 0, "jitter": 0, "recv_qos": 0, "reply_qos": 0, "lbl_info": 0 }, { "idx": 2, "ip": "10.0.5.21", "hostname": "", "rtt": 487, "rtt_min": 480, "rtt_max": 490, "loss": 0, "jitter": 0, "recv_qos": 0, "reply_qos": 0, "lbl_info": 0 } ] } } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerTroubleshootingUmtsUmtsrestapiParameterExampleUmtssaverequest" } } } }, "required": true }, "responses": { "200": { "description": "save result", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "save result sample": { "description": "save result sample", "value": "{status: success}" } } } } }, "400": { "description": "Bad Request" } }, "x-roles-required": "vmanage-http-stream" } }, "/stream/device/umts/{operation}/{sessionId}": { "get": { "tags": [ "Troubleshooting Tools - UMTS" ], "summary": "start/stop/disable/status/download session", "description": "start, stop,status,download or disable session ", "operationId": "updateUmtsSessionStatus", "parameters": [ { "name": "operation", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "opertion result", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "start/stop/disable/status/download sample": { "description": "start/stop/disable/status/download sample", "value": "{status: success}" }, "status ok sample": { "description": "status ok sample", "value": { "JSessionId": "mRs3gc7GFhUcR1RDOBYpEW9YyLTx6JWxJRbZb852", "sessionId": "dbd6e729-d071-4024-a42c-f55b88fa034b", "type": "ON_DEMANDING", "uuid": "C8K-6dfe1f7c-7dc5-4891-bdb4-fb74e84882b7", "statusMessage": "ok", "renewalTime": 1655641163457, "@rid": 1173, "payload": "{\"deviceUUID\":\"C8K-6dfe1f7c-7dc5-4891-bdb4-fb74e84882b7\",\"localColor\":\"local-color-all\",\"remoteSystem\":\"172.16.255.16\",\"remoteColor\":\"remote-color-all\",\"actionType\":\"ON_DEMANDING\",\"sessionId\":\"dbd6e729-d071-4024-a42c-f55b88fa034b\"}", "download_status": "success", "userIp": "10.0.1.1", "startTime": 1655641163457, "user": "kkk", "requestStatus": "START", "status": "success" }, "$$ref": "#/components/examples/ComViptelaVmanageServerTroubleshootingUmtsUmtsrestapiResponseExampleUmtsStatusResult" }, "status fail sample": { "description": "status fail sample", "value": { "JSessionId": "FuQnNel_IR7i_KoTyjH84Ud0SdOWh1g545IR9LuI", "sessionId": "3fb76734-2fcd-44ef-b69e-77536ab5d413", "type": "ON_DEMANDING", "uuid": "C8K-21a355e3-fd5b-4d03-9d48-f2845388c07f", "statusMessage": "this is error message", "renewalTime": 1656285116463, "@rid": 21692, "payload": "{\"deviceUUID\":\"C8K-21a355e3-fd5b-4d03-9d48-f2845388c07f\",\"localColor\":\"local-color-all\",\"remoteSystem\":\"172.16.255.16\",\"remoteColor\":\"lte\",\"actionType\":\"ON_DEMANDING\",\"sessionId\":\"3fb76734-2fcd-44ef-b69e-77536ab5d413\"}", "userIp": "10.0.1.1", "startTime": 1656285116464, "user": "kkk", "requestStatus": "STOP", "status": "failure" }, "$$ref": "#/components/examples/ComViptelaVmanageServerTroubleshootingUmtsUmtsrestapiResponseExampleUmtsStatusFailResult" }, "status downloadable sample": { "description": "status downloadable sample", "value": { "JSessionId": "FuQnNel_IR7i_KoTyjH84Ud0SdOWh1g545IR9LuI", "sessionId": "3fb76734-2fcd-44ef-b69e-77536ab5d413", "type": "ON_DEMANDING", "uuid": "C8K-21a355e3-fd5b-4d03-9d48-f2845388c07f", "statusMessage": "ok", "renewalTime": 1656285116463, "@rid": 21692, "payload": "{\"deviceUUID\":\"C8K-21a355e3-fd5b-4d03-9d48-f2845388c07f\",\"localColor\":\"local-color-all\",\"remoteSystem\":\"172.16.255.16\",\"remoteColor\":\"lte\",\"actionType\":\"ON_DEMANDING\",\"sessionId\":\"3fb76734-2fcd-44ef-b69e-77536ab5d413\"}", "download_status": "success", "userIp": "10.0.1.1", "startTime": 1656285116464, "user": "kkk", "requestStatus": "STOP", "status": "success" }, "$$ref": "#/components/examples/ComViptelaVmanageServerTroubleshootingUmtsUmtsrestapiResponseExampleUmtsStatusDownloadableResult" }, "download sample": { "description": "download sample", "value": { "data": [ { "vip_idx": 496, "vip_time": 16434009013877, "remote_color": "lte", "local_color": "lte", "remote_system_ip": "172.16.255.16", "local_system_ip": "172.16.255.21", "proto": "IPSEC", "sent_qos": 139, "state": "UP", "event_type": "ON_DEMAND", "event_subtype": "NONE111", "hops": { "hop": [ { "idx": 1, "ip": "10.1.15.13", "hostname": "", "rtt": 486, "rtt_min": 480, "rtt_max": 490, "loss": 0, "jitter": 0, "recv_qos": 0, "reply_qos": 0, "lbl_info": 0 }, { "idx": 2, "ip": "10.0.5.21", "hostname": "", "rtt": 487, "rtt_min": 480, "rtt_max": 490, "loss": 0, "jitter": 0, "recv_qos": 0, "reply_qos": 0, "lbl_info": 0 } ] } }, { "vip_idx": 497, "vip_time": 16434009013877, "remote_color": "lte", "local_color": "lte", "remote_system_ip": "172.16.255.16", "local_system_ip": "172.16.255.21", "proto": "IPSEC", "sent_qos": 188, "state": "down", "event_type": "ON_DEMAND", "event_subtype": "NONE111", "hops": { "hop": [ { "idx": 1, "ip": "10.1.15.13", "hostname": "", "rtt": 486, "rtt_min": 480, "rtt_max": 490, "loss": 0, "jitter": 0, "recv_qos": 0, "reply_qos": 0, "lbl_info": 0 }, { "idx": 2, "ip": "10.0.5.21", "hostname": "", "rtt": 487, "rtt_min": 480, "rtt_max": 490, "loss": 0, "jitter": 0, "recv_qos": 0, "reply_qos": 0, "lbl_info": 0 } ] } } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerTroubleshootingUmtsUmtsrestapiResponseExampleUmtsDownloadSample" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "error sample": { "description": "error sample", "value": { "error": { "type": "error", "message": "Invalid Session", "details": "Session 3fb76734-2fcd-44ef-b69e-77536ab5d41322 doesn't exist for Tenant default.", "code": "TBST1005" } }, "$$ref": "#/components/examples/ComViptelaVmanageServerTroubleshootingUmtsUmtsrestapiResponseExampleUmtsStatusError" } } } } } } } }, "/stream/dmlog": { "post": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "description": "Create DMLog session", "operationId": "enableDMLog", "requestBody": { "description": "DMLog Parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceUUID": { "type": "string", "example": "C8K-942126aa-964b-4f49-bb37-45fede1a8f45" }, "enableRotation": { "type": "boolean", "example": false }, "enableTimer": { "type": "boolean", "example": true }, "interfaceName": { "type": "string", "example": "GigabitEthernet5" }, "modem": { "type": "boolean", "example": true }, "stopTime": { "type": "string", "example": "12:34" }, "vpn": { "type": "string", "example": "0" } }, "$$ref": "#/components/schemas/CreateDMLogReq" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "@rid": { "type": "integer", "format": "int32", "example": 3765 }, "JSessionId": { "type": "string", "example": "2j1QnIq4iFxEjwoxHfYK_zefKjpB7c3fFl483jac" }, "isNewSession": { "type": "boolean", "example": true }, "isOwner": { "type": "boolean", "example": true }, "renewalTime": { "type": "integer", "format": "int64", "example": 1695089425303 }, "requestStatus": { "type": "string", "enum": [ "START", "STOP", "IN_PROGRESS", "NOT_STARTED" ] }, "sessionId": { "type": "string", "format": "uuid", "example": "a9fd18d5-0303-43d1-b821-2358992e0274" }, "startTime": { "type": "integer", "format": "int64", "example": 1695089425303 }, "status": { "type": "string", "example": "success", "enum": [ "success", "failure" ] }, "statusMessage": { "type": "string", "example": "ok" }, "type": { "type": "string", "example": "pcap" }, "user": { "type": "string", "example": "admin" }, "userIp": { "type": "string", "example": "10.0.1.1" }, "uuid": { "type": "string", "example": "C8K-86adc384-8408-4cec-acdb-8117c40a8a24" } }, "$$ref": "#/components/schemas/DmlogInfo" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/stream/dmlog/client/uploadFF/{sessionId}": { "post": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "description": "upload filter file", "operationId": "clientUploadFilterFile", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" } }, "$$ref": "#/components/schemas/FormDMLogRes" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tools-read" } }, "/stream/dmlog/disable/{sessionId}": { "get": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "description": "Disable dmlog session", "operationId": "disableDMLogSession", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" } }, "$$ref": "#/components/schemas/ForceStopDMLogRes" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/stream/dmlog/download/{sessionId}": { "get": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "description": "Download dmlog file", "operationId": "downloadDMLog", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/stream/dmlog/start/{sessionId}": { "get": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "description": "Start dmlog session", "operationId": "startDMLogSession", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "@rid": { "type": "integer", "format": "int32", "example": 3765 }, "JSessionId": { "type": "string", "example": "2j1QnIq4iFxEjwoxHfYK_zefKjpB7c3fFl483jac" }, "isNewSession": { "type": "boolean", "example": true }, "isOwner": { "type": "boolean", "example": true }, "renewalTime": { "type": "integer", "format": "int64", "example": 1695089425303 }, "requestStatus": { "type": "string", "enum": [ "START", "STOP", "IN_PROGRESS", "NOT_STARTED" ] }, "sessionId": { "type": "string", "format": "uuid", "example": "a9fd18d5-0303-43d1-b821-2358992e0274" }, "startTime": { "type": "integer", "format": "int64", "example": 1695089425303 }, "status": { "type": "string", "example": "success", "enum": [ "success", "failure" ] }, "statusMessage": { "type": "string", "example": "ok" }, "type": { "type": "string", "example": "pcap" }, "user": { "type": "string", "example": "admin" }, "userIp": { "type": "string", "example": "10.0.1.1" }, "uuid": { "type": "string", "example": "C8K-86adc384-8408-4cec-acdb-8117c40a8a24" } }, "$$ref": "#/components/schemas/DmlogInfo" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/stream/dmlog/status/{sessionId}": { "get": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "description": "Get dmlog session status", "operationId": "getDMLogStatus", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "fileDownloadStatus": { "type": "string", "example": "NOT_STARTED", "enum": [ "NOT_STARTED", "STARTED", "IN_PROGRESS", "COMPLETED", "ERROR" ] }, "sessionStatus": { "type": "string", "enum": [ "START", "STOP", "IN_PROGRESS", "NOT_STARTED" ] } }, "$$ref": "#/components/schemas/GetDMLogStatusRes" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/stream/dmlog/stop/{sessionId}": { "get": { "tags": [ "Troubleshooting Tools - Diagnostics" ], "description": "Stop DMLog session", "operationId": "stopDMLogSession", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "@rid": { "type": "integer", "format": "int32", "example": 3765 }, "JSessionId": { "type": "string", "example": "2j1QnIq4iFxEjwoxHfYK_zefKjpB7c3fFl483jac" }, "isNewSession": { "type": "boolean", "example": true }, "isOwner": { "type": "boolean", "example": true }, "renewalTime": { "type": "integer", "format": "int64", "example": 1695089425303 }, "requestStatus": { "type": "string", "enum": [ "START", "STOP", "IN_PROGRESS", "NOT_STARTED" ] }, "sessionId": { "type": "string", "format": "uuid", "example": "a9fd18d5-0303-43d1-b821-2358992e0274" }, "startTime": { "type": "integer", "format": "int64", "example": 1695089425303 }, "status": { "type": "string", "example": "success", "enum": [ "success", "failure" ] }, "statusMessage": { "type": "string", "example": "ok" }, "type": { "type": "string", "example": "pcap" }, "user": { "type": "string", "example": "admin" }, "userIp": { "type": "string", "example": "10.0.1.1" }, "uuid": { "type": "string", "example": "C8K-86adc384-8408-4cec-acdb-8117c40a8a24" } }, "$$ref": "#/components/schemas/DmlogInfo" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/token/{regionBaseUri}/{clientId}": { "post": { "tags": [ "Monitoring - SecureX Integration" ], "description": "Get Access Token and Refresh Token for authorized user", "operationId": "token", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "regionBaseUri", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_token": { "type": "string" }, "expires_in": { "type": "integer", "format": "int32" }, "refresh_token": { "type": "string" }, "scope": { "type": "string" }, "token_type": { "type": "string" } }, "description": "Response from Cisco SecureX token API", "$$ref": "#/components/schemas/Tokens" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/troubleshooting/control/{uuid}": { "get": { "tags": [ "Troubleshooting Tools - Device Connectivity" ], "description": "Troubleshoot control connections", "operationId": "getControlConnections", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "pattern": "^[a-zA-Z0-9\\/\\\\-]*$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "actualControlConnectionsToVsmart": { "type": "integer", "format": "int32", "example": 0 }, "data": { "type": "array", "items": { "type": "object", "properties": { "actual-connections": { "type": "integer", "format": "int32", "example": 2 }, "color": { "type": "string", "example": "LTE" }, "control": { "type": "array", "items": { "type": "object", "properties": { "host-name": { "type": "string", "example": "vm9" }, "is-preferred": { "type": "boolean", "example": true }, "local-status": { "type": "string", "enum": [ "green", "red" ] }, "local-status-info": { "type": "string" }, "peer-type": { "type": "string", "example": "vsmart", "enum": [ "vbond", "vedge", "vsmart", "vmanage", "vedge-vbond", "nonSDWAN" ] }, "remote-status": { "type": "string", "enum": [ "green", "red" ] }, "remote-status-info": { "type": "string" }, "state": { "type": "string", "example": "up", "enum": [ "up", "down" ] }, "system-ip": { "type": "string", "example": "172.16.255.19" } }, "$$ref": "#/components/schemas/TlocControl" } }, "expected-connections": { "type": "integer", "format": "int32", "example": 2 }, "interface": { "type": "string", "example": "GigabitEthernet1" }, "nat-type": { "type": "string", "example": "Not learned" }, "private-ip": { "type": "string", "example": "10.1.15.15" }, "private-port": { "type": "string", "example": "12366" }, "public-ip": { "type": "string", "example": "10.1.15.15" }, "public-port": { "type": "string", "example": "12366" }, "tloc-status": { "type": "string", "enum": [ "green", "red" ] }, "tloc-type": { "type": "string" } }, "$$ref": "#/components/schemas/ControlConnectionInfo" } }, "expectedControlConnectionsToVsmart": { "type": "integer", "format": "int32", "example": 2 } }, "$$ref": "#/components/schemas/GetControlConnections" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tools-read" } }, "/troubleshooting/devicebringup": { "get": { "tags": [ "Troubleshooting Tools - Device Connectivity" ], "description": "Debug device bring up", "operationId": "getDeviceConfiguration", "parameters": [ { "name": "uuid", "in": "query", "required": true, "schema": { "pattern": "^[a-zA-Z0-9\\/\\\\-]*$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string", "example": "Data plane connectivity established" }, "operation": { "type": "string", "example": "DataPlane", "enum": [ "DataPlane", "ControlPlane", "RouterConfiguration", "SoftwareImageUpdate", "vBondAuth" ] }, "status": { "type": "string", "enum": [ "Success", "NA", "Error", "Unknown" ] }, "timestamp": { "type": "integer", "format": "int64", "example": 1695272160000 } }, "$$ref": "#/components/schemas/BringupInfo" } } }, "$$ref": "#/components/schemas/GetDeviceConfiguration" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Tools-read" } }, "/troubleshooting/mre/workflow/{operation}/{executionId}": { "get": { "tags": [ "Troubleshooting MRE - Workflow" ], "summary": "disable/status workflow status", "operationId": "getMreWorkflowStatus", "parameters": [ { "name": "operation", "in": "path", "description": "Mre workflowId operation", "required": true, "schema": { "type": "string", "enum": [ "status", "disable" ] } }, { "name": "executionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "category": { "type": "string" }, "commandContext": { "type": "array", "items": { "type": "string" } }, "description": { "type": "string" }, "dynamicCommandContext": { "type": "array", "items": { "type": "string" } }, "label": { "type": "string" }, "message": { "type": "string" }, "ontologyIri": { "type": "string", "example": "http://www.cisco.com/CNSR/TunnelTroubleshooting/1.0.0" }, "status": { "type": "string", "example": "SUCCESS" }, "suggestedActions": { "type": "string" }, "targetCommand": { "type": "string" }, "timestamp": { "type": "integer", "format": "int64", "example": 1714588524225 }, "title": { "type": "string" }, "type": { "type": "string", "example": "INIT" }, "workflowExecutionId": { "type": "string", "example": "18557693-860c-49bd-aee9-9de4e82d24be" } }, "$$ref": "#/components/schemas/MreEvent" } }, "terminate_status": { "type": "boolean", "example": true } }, "$$ref": "#/components/schemas/MreEventStatusResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/troubleshooting/mre/workflow/{workflowType}": { "post": { "tags": [ "Troubleshooting MRE - Workflow" ], "description": "Launch MRE workflow", "operationId": "getMreExecutionId", "parameters": [ { "name": "workflowType", "in": "path", "description": "Mre workflow type", "required": true, "schema": { "type": "string", "enum": [ "tunnelTroubleshoot" ] } }, { "name": "isMre", "in": "query", "schema": { "type": "boolean", "default": true } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "deviceUUID", "parameters" ], "type": "object", "properties": { "deviceUUID": { "type": "string", "example": "C8K-e456a1c9-5000-4d2b-b8b4-52fd41e55a4b" }, "parameters": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "localDevice" }, "value": { "type": "string", "example": "111.111.111.111" } }, "$$ref": "#/components/schemas/LaunchRequestParameter" } } }, "$$ref": "#/components/schemas/LaunchRequestBody" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "url": { "type": "string", "example": "/api/v1/task/018f3570-9e70-7cf1-aaea-e448f9b6ec66" }, "workflowExecutionId": { "type": "string", "example": "018f3570-9e70-7cf1-aaea-e448f9b6ec66" } }, "$$ref": "#/components/schemas/LaunchResponseResponse" }, "version": { "type": "string", "example": "1.0" } }, "$$ref": "#/components/schemas/LaunchResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v1/device/analyzeCliConfig": { "post": { "tags": [ "Monitoring - Device Details" ], "description": "Analyze CLI Config for device", "operationId": "analyzeCliConfig", "requestBody": { "description": "CLI Configs for device", "content": { "application/json": { "schema": { "required": [ "deviceUuid" ], "type": "object", "properties": { "cli": { "type": "string", "description": "modeled cli config", "example": "interface GigabitEthernet3\\n no shutdown\\n negotiation auto\\nexit\\n" }, "deviceUuid": { "type": "string", "description": "device UUID", "example": "d8ac4576-7085-4d51-a6a1-f09600755677" }, "ioscli": { "type": "string", "description": "unmodeled cli config", "example": "vrf definition Mgmt-intf\\n address-family ipv4\\n exit-address-family\\n !\\n!" } }, "description": "Payload/body schema for analyze cli config ", "$$ref": "#/components/schemas/AnalyzeCliConfig" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "CLI Configs example": { "description": "CLI Configs example", "value": { "cliOutput": "interface GigabitEthernet3\n no shutdown\n negotiation auto\nexit", "iosCliOutput": "rf definition Mgmt-intf\n address-family ipv4\n exit-address-family\n !\n!" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Inventory-read,Device Inventory-write,Template Deploy-read,Template Deploy-write,Device Inventory > Edge-read,Device Inventory > Controller-read,Device Inventory > Edge-write" } }, "/v1/device/runningIosCliConfig/{deviceUUID}": { "get": { "tags": [ "Monitoring - Device Details" ], "description": "Get Running iOS CLI Config for device", "operationId": "getRunningIosCliConfig", "parameters": [ { "name": "deviceUUID", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "iOS Running iOs CLI Config example": { "description": "iOS Running iOs CLI Config example", "value": { "runningIosCliConfig": "ip host vbond 10.0.12.26 2001:A0:C::1A\npae\nip ssh pubkey-chain\n username admin\n key-hash ssh-rsa 97DECCBC0021386299C5806E2C18BFFA vtest@sdwan-laas-vt43\nipv6 route ::/0 2001:A0:C::C\nline con 0\n exec-timeout 0 0\nline vty 0 4\n exec-timeout 0 0" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Inventory-read,Device Inventory-write,Template Deploy-read,Template Deploy-write,Device Inventory > Edge-read,Device Inventory > Controller-read,Device Inventory > Edge-write" } }, "/v1/device/unsupportedCliConfig/{deviceUUID}": { "get": { "tags": [ "Monitoring - Device Details" ], "description": "Get Unsupported CLI Config for device", "operationId": "getUnsupportedCliConfig", "parameters": [ { "name": "deviceUUID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "highlightUnsupportedClis", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Unsupported CLI Config example": { "description": "Unsupported CLI Config example", "value": { "unsupportedCliConfig": "ip host vbond 10.0.12.26 2001:A0:C::1A\npae\nip ssh pubkey-chain\n username admin\n key-hash ssh-rsa 97DECCBC0021386299C5806E2C18BFFA vtest@sdwan-laas-vt43\nipv6 route ::/0 2001:A0:C::C\nline con 0\n exec-timeout 0 0\nline vty 0 4\n exec-timeout 0 0" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Inventory-read,Device Inventory-write,Template Deploy-read,Template Deploy-write,Device Inventory > Edge-read,Device Inventory > Controller-read,Device Inventory > Edge-write" } }, "/v1/search": { "get": { "tags": [ "Monitoring - Search" ], "summary": "Search a text", "description": "Search a text", "operationId": "search", "parameters": [ { "name": "q", "in": "query", "description": "Search text", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limit number of results", "schema": { "type": "integer", "format": "int32", "default": 5 } }, { "name": "category", "in": "query", "description": "Categories", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "required": [ "category", "results" ], "type": "object", "properties": { "category": { "required": [ "description", "displayName", "name" ], "type": "object", "properties": { "description": { "type": "string", "example": "Search in config groups names" }, "displayName": { "type": "string", "example": "Config groups" }, "name": { "type": "string", "example": "ConfigGroup" } }, "description": "This is used to return the search categories.", "$$ref": "#/components/schemas/SearchCategory" }, "results": { "type": "array", "description": "search results for the category", "items": { "required": [ "value" ], "type": "object", "properties": { "details": { "type": "array", "description": "Name-Value pair to shown as details", "items": { "required": [ "name", "value" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the property" }, "value": { "type": "object", "description": "Value of the property" } }, "description": "Links to cross launch on UI", "$$ref": "#/components/schemas/SearchKeyValuePair" } }, "identifier": { "type": "string", "description": "Identifier for record" }, "links": { "type": "array", "description": "Links to cross launch on UI", "items": { "required": [ "name", "value" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the property" }, "value": { "type": "object", "description": "Value of the property" } }, "description": "Links to cross launch on UI", "$$ref": "#/components/schemas/SearchKeyValuePair" } }, "value": { "type": "string", "description": "This is the text vManage has searched" } }, "description": "search results for the category", "$$ref": "#/components/schemas/SearchCategoryResult" } } }, "description": "This is used to return the search results.", "$$ref": "#/components/schemas/SearchResponse" } }, "examples": { "Search": { "description": "Search", "value": [ { "category": { "name": "Device", "displayName": "Devices", "description": "Search in system-ip, host-name of devices" }, "results": [ { "value": "vm1", "identifier": "vm1", "details": [ { "name": "System IP", "value": "172.16.255.11" }, { "name": "Host name", "value": "vm1" } ], "links": [ { "name": "View details", "value": "/app/monitor/devices/dashboard/health?systemIp=172.16.255.11&localSystemIp=172.16.255.11&deviceModel=vedge-C8000V&deviceType=vedge&personality=vedge&uuid=C8K-a2742205-61ea-454c-ad02-c4a05382840c" } ] } ] }, { "category": { "name": "Help", "displayName": "Help", "description": "Search in Help/Documentation" }, "results": [ { "value": "click vManage SLA", "identifier": null, "details": [ { "name": "Details", "value": "For each of the traffic profiles, click vManage SLA Classes and choose an SLA class to map the application to." } ], "links": [ { "name": "View details", "value": "/docs/htmls/ios-xe/config-policies-centralized-define-lists-cloud-discovered.html" } ] } ] } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/v1/search/categories": { "get": { "tags": [ "Monitoring - Search" ], "summary": "List search categories", "description": "List search categories", "operationId": "listCategories", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "required": [ "description", "displayName", "name" ], "type": "object", "properties": { "description": { "type": "string", "example": "Search in config groups names" }, "displayName": { "type": "string", "example": "Config groups" }, "name": { "type": "string", "example": "ConfigGroup" } }, "description": "This is used to return the search categories.", "$$ref": "#/components/schemas/SearchCategory" } }, "examples": { "Categories": { "description": "Categories", "value": [ { "name": "", "displayName": "All", "description": "Search in all categories" }, { "name": "Application", "displayName": "Applications", "description": "Search in application names" }, { "name": "Device", "displayName": "Devices", "description": "Search in system-ip, host-name of devices" } ] } } } } }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "default" } }, "/v2/data/device/statistics/interfacestatistics": { "get": { "tags": [ "Monitoring - Device Statistics Details V2" ], "description": "Get device statistics data", "operationId": "generateDeviceInterfaceStatisticsData", "parameters": [ { "name": "startDate", "in": "query", "description": "Start date (example:2023-1-1T00:00:00)", "schema": { "pattern": "^\\d{4}-(0?[1-9]|1[0-2])-(0?[1-9]|[12][0-9]|3[01])T\\d{2}:\\d{2}:\\d{2}$", "type": "string" } }, { "name": "endDate", "in": "query", "description": "End date (example:2023-1-1T00:00:00)", "schema": { "pattern": "^\\d{4}-(0?[1-9]|1[0-2])-(0?[1-9]|[12][0-9]|3[01])T\\d{2}:\\d{2}:\\d{2}$", "type": "string" } }, { "name": "scrollId", "in": "query", "description": "Scroll Id", "schema": { "type": "string" } }, { "name": "count", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "timeZone", "in": "query", "description": "Time zone", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "admin_status": { "type": "string", "example": "Up" }, "af_type": { "type": "string", "example": "IPv4" }, "bw_down": { "type": "number", "example": 1000000 }, "bw_up": { "type": "number", "example": 1000000 }, "device_model": { "type": "string", "example": "vedge-C8000V" }, "down_capacity_percentage": { "type": "number", "example": 0.0015 }, "entry_time": { "type": "integer", "format": "int32", "example": 1687177528 }, "host_name": { "type": "string", "example": "vm6" }, "id": { "type": "string", "example": "ZmOr04gBUJf8VowqUaIl" }, "interface": { "type": "string", "example": "GigabitEthernet1" }, "interface_type": { "type": "string", "example": "physical" }, "oper_status": { "type": "string", "example": "Up" }, "platform_type": { "type": "string" }, "rx_drops": { "type": "number", "example": 0 }, "rx_errors": { "type": "number", "example": 0 }, "rx_kbps": { "type": "number", "example": 15 }, "rx_octets": { "type": "number", "example": 679091 }, "rx_pkts": { "type": "number", "example": 3876 }, "rx_pps": { "type": "number", "example": 0 }, "statcycletime": { "type": "integer", "format": "int32", "example": 168717840 }, "stats_data_id": { "type": "string" }, "system-ip": { "type": "string" }, "tenant": { "type": "string", "example": "default" }, "total_mbps": { "type": "number", "example": 0 }, "tx_drops": { "type": "number", "example": 0 }, "tx_errors": { "type": "number", "example": 0 }, "tx_kbps": { "type": "number", "example": 14 }, "tx_octets": { "type": "number", "example": 769358 }, "tx_pkts": { "type": "number", "example": 3757 }, "tx_pps": { "type": "number", "example": 11 }, "up_capacity_percentage": { "type": "number", "example": 0.0014 }, "vdevice_name": { "type": "string", "example": "172.16.255.16" }, "vip_idx": { "type": "number", "example": 7 }, "vip_time": { "type": "integer", "format": "int32" }, "vmanage_system_ip": { "type": "string", "example": "172.16.255.16" }, "vnf_name": { "type": "string" }, "vnic_id": { "type": "string" }, "vpn_id": { "type": "number", "example": 0 } }, "$$ref": "#/components/schemas/InterfaceStatisticsRes" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write,dca" } }, "/v2/data/device/statistics/interfacestatistics/doccount": { "get": { "tags": [ "Monitoring - Device Statistics Details V2" ], "description": "Get response count of a query", "operationId": "getCountWithInterfaceStatistics", "parameters": [ { "name": "startDate", "in": "query", "description": "Start date (example:2023-1-1T00:00:00)", "required": true, "schema": { "pattern": "^\\d{4}-(0?[1-9]|1[0-2])-(0?[1-9]|[12][0-9]|3[01])T\\d{2}:\\d{2}:\\d{2}$", "type": "string" } }, { "name": "endDate", "in": "query", "description": "End date (example:2023-1-1T00:00:00)", "required": true, "schema": { "pattern": "^\\d{4}-(0?[1-9]|1[0-2])-(0?[1-9]|[12][0-9]|3[01])T\\d{2}:\\d{2}:\\d{2}$", "type": "string" } }, { "name": "timeZone", "in": "query", "description": "Time zone (example:UTC)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "format": "int64", "example": 35174 } }, "$$ref": "#/components/schemas/DocCountRes" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write,dca" } }, "/v2/data/device/statistics/interfacestatistics/fields": { "get": { "tags": [ "Monitoring - Device Statistics Details V2" ], "description": "Get statistics fields and types", "operationId": "getStatDataFieldsByInterfaceStatistics", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "dataType": { "type": "string", "example": "number" }, "display": { "type": "string", "example": "keyvalue" }, "property": { "type": "string", "example": "vip_idx" } }, "$$ref": "#/components/schemas/Field" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Device Monitoring-read,Device Monitoring-write,dca" } } } }