{"type":"api","title":"start/stop/disable/status/download session","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 - 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 input parameter","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"}}}}}},"method":"get","path":"/stream/device/umts/{operation}/{sessionId}"}}