{"type":"api","title":"Get Task Trace","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/d2f02ba2-fd0d-3a26-bcc5-feafc8f24d17","info":{"title":"Monitoring and Troubleshooting","description":"Includes API operations for the following:\n- Real-time monitoring\n- Accessing statistics APIs and statistics bulk APIs\n- Retrieving device state\n- Managing alarms and events\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"tags":["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":{"type":"string","example":"119"}},{"name":"taskStartTime","in":"query","description":"task start time","schema":{"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","method":"get","path":"/stream/device/nwpi/tasks/{taskId}/traces"}}