{"type":"api","title":"Generate DCA Device State Data","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/36693899-8b64-31bd-aa1c-b67fb5b6463c","info":{"title":"SD-WAN Services","description":"Includes API operations for managing SD-WAN services such as Cloud OnRamp for SaaS and MultiCloud\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Data Collection Agent"],"description":"Get device state data","operationId":"generateDCADeviceStateData","parameters":[{"name":"state_data_type","in":"path","description":"Device state data","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query string":{"description":"Query string","value":{"tenantId":["84706b7c-6a71-4423-a55f-9bc069139e87"],"count":10000},"$$ref":"#/components/examples/ComViptelaVmanageServerDcaRequestExampleDeviceDataState"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device state":{"description":"Device state","value":{"header":{"generatedOn":1717159047358,"viewKeys":{"uniqueKey":["vdevice-dataKey"],"preferenceKey":"grid-ControlWanInterface"},"columns":[{"title":"Instance","property":"instance","width":100,"dataType":"number"},{"title":"Index","property":"index","width":100,"dataType":"number"},{"title":"Interface","property":"interface","width":120,"dataType":"string"},{"title":"Public IP","property":"public-ip","width":100,"dataType":"ip"},{"title":"Public Port","property":"public-port","width":100,"dataType":"number"},{"title":"Private IP","property":"private-ip","width":100,"dataType":"ip"},{"title":"Private Port","property":"private-port","width":100,"dataType":"number"},{"title":"Num vSmarts","property":"num-vsmarts","width":150,"dataType":"number"},{"title":"Num vManages","property":"num-vmanages","width":150,"dataType":"number"},{"title":"Weight","property":"weight","width":100,"dataType":"number"},{"title":"Color","property":"color","width":100,"dataType":"string"},{"title":"Carrier","property":"carrier","width":100,"dataType":"string"},{"title":"Preference","property":"preference","width":100,"dataType":"string"},{"title":"Max Controllers","property":"per-wan-max-controllers","width":100,"dataType":"number"},{"title":"Admin State","property":"admin-state","width":100,"dataType":"string"},{"title":"Operation State","property":"operation-state","width":150,"dataType":"string"},{"title":"Last Connection","property":"last-conn-time-date","displayFormat":"DD MMM YYYY h:mm:ss A z","inputFormat":"unix-time","width":150,"dataType":"date"},{"title":"Restrict","property":"restrict-str","width":50,"dataType":"string"},{"title":"Control Conn Rqd","property":"control-str","width":50,"dataType":"string"},{"title":"Vbond As Stun Server","property":"vbond-as-stun-server","width":150,"dataType":"string"},{"title":"vManage Preference","property":"vmanage-connection-preference","width":150,"dataType":"string"},{"title":"Private IPv6","property":"private-ipv6","width":150,"dataType":"string"},{"title":"SPI Time Remaining","property":"spi-change","width":150,"dataType":"string"},{"title":"Last Resort Interface","property":"last-resort","width":150,"dataType":"string"},{"title":"Interface Changed Port","property":"wan-port-hopped","width":150,"dataType":"string"},{"title":"Time Since Last Port Hop","property":"wan-time-since-port-hop","width":150,"dataType":"string"},{"title":"Low Bandwidth Interface","property":"low-bandwidth-link","width":150,"dataType":"string"},{"title":"NAT Type","property":"nat-type","width":150,"dataType":"string"},{"title":"Region ID","property":"region-id","width":100,"dataType":"string"},{"title":"Bind Interface","property":"bind-interface","width":100,"dataType":"string"},{"title":"Last Updated","property":"lastupdated","displayFormat":"DD MMM YYYY h:mm:ss A z","inputFormat":"unix-time","hideable":false,"minWidth":220,"dataType":"date"}],"fields":[{"property":"vdevice-name","dataType":"string"},{"property":"vdevice-host-name","dataType":"string"},{"property":"instance","dataType":"number"},{"property":"index","dataType":"number"},{"property":"interface","dataType":"string"},{"property":"public-ip","dataType":"ip"},{"property":"public-port","dataType":"number"},{"property":"private-ip","dataType":"ip"},{"property":"private-port","dataType":"number"},{"property":"num-vsmarts","dataType":"number"},{"property":"num-vmanages","dataType":"number"},{"property":"weight","dataType":"number"},{"property":"color","dataType":"string"},{"property":"carrier","dataType":"string"},{"property":"preference","dataType":"string"},{"property":"per-wan-max-controllers","dataType":"number"},{"property":"admin-state","dataType":"string"},{"property":"operation-state","dataType":"string"},{"property":"last-conn-time","dataType":"uptime"},{"property":"last-conn-time-date","dataType":"date"},{"property":"restrict-str","dataType":"string"},{"property":"control-str","dataType":"string"},{"property":"vbond-as-stun-server","dataType":"string"},{"property":"vmanage-connection-preference","dataType":"string"},{"property":"private-ipv6","dataType":"string"},{"property":"spi-change","dataType":"string"},{"property":"last-resort","dataType":"string"},{"property":"wan-port-hopped","dataType":"string"},{"property":"wan-time-since-port-hop","dataType":"string"},{"property":"low-bandwidth-link","dataType":"string"},{"property":"nat-type","dataType":"string"},{"property":"region-id","dataType":"string"},{"property":"bind-interface","dataType":"string"},{"property":"service-provider","dataType":"string"},{"property":"bandwidth-upstream","dataType":"number"},{"property":"bandwidth-downstream","dataType":"number"},{"property":"createTimeStamp","dataType":"date"},{"property":"lastupdated","dataType":"date"}],"chart":{}},"data":[{"recordId":"0:ControlWanInterfaceNode:1717138766789:7619","instance":0,"low-bandwidth-link":"No","vdevice-name":"172.16.254.1","color":"3g","nat-type":"E","admin-state":"up","interface":"ge0/1","restrict-str":"no","@rid":11469,"private-ipv6":"::","private-ip":"10.101.2.2","per-wan-max-controllers":2,"num-vsmarts":2,"num-vmanages":0,"preference":"0","createTimeStamp":1717138766789,"weight":1,"index":0,"private-port":12366,"vdevice-host-name":"vm2","vbond-as-stun-server":"no","control-str":"yes","carrier":"default","last-resort":"No","vdevice-dataKey":"172.16.254.1-0-0","vmanage-connection-preference":"5","vmanage-system-ip":"169.254.10.9","operation-state":"up","public-ip":"10.101.2.2","tenantId":"84706b7c-6a71-4423-a55f-9bc069139e87","public-port":12366,"region-id":"Default","lastupdated":1717138787774,"wan-port-hopped":"TRUE"}],"pageInfo":{"startId":"11469","endId":"11469","moreEntries":false,"count":1}},"$$ref":"#/components/examples/ComViptelaVmanageServerDcaResponseExampleDeviceDataState"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"method":"post","path":"/dca/data/device/state/{state_data_type}"}}