Get Devices Details - Cisco Catalyst SD-WAN Manager API, Release 20.18

{"type":"api","title":"Get Devices Details","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/744a8207-9965-344e-aed3-d3ef846a4950","info":{"title":"Others","description":"Other APIs\n- Include APIs that do not belong to other categories\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Configuration - Device Inventory"],"description":"Get devices details. When {deviceCategory = controllers}, it returns vEdge sync status, vBond, vManage and vSmart. When {deviceCategory = vedges}, it returns all available vEdge routers","operationId":"getDevicesDetails","parameters":[{"name":"deviceCategory","in":"path","description":"Device category","required":true,"schema":{"type":"string"},"example":"vedges"},{"name":"model","in":"query","description":"Device model","schema":{"type":"string","enum":["vedge-cloud","vedge-1000","vedge-2000","vedge-100","vedge-ISR1100-4G","vedge-ISR1100-4GLTE","vedge-ISR1100X-4G","vedge-ISR1100-6G","vedge-ISR1100X-6G","vedge-100-B","vedge-100-WM","vedge-100-M","vEdge-5000","vedge-CSR-1000v","vedge-IR-1101","vedge-IR-1821","vedge-IR-1831","vedge-IR-1833","vedge-IR-1835","vedge-IR-8140H","vedge-IR8140H-P","vedge-IR-8340","vedge-ESR-6300","vedge-ISR-4331","vedge-ISR-4321","vedge-ISR-4351","vedge-ISR-4221","vedge-ISR-4221X","vedge-ISR-4431","vedge-ISR-4451-X","vedge-ASR-1001-HX","vedge-ASR-1002-X","vedge-ASR-1002-HX","vedge-ASR-1006-X","vedge-C1111-8P","vedge-C1121X-8P","vedge-C1111X-8P","vedge-C1111-8PLTELAW","vedge-C1111-8PLTEEA","vedge-C1121-8PLTEPW","vedge-C1111-8PLTELA","vedge-C1117-4PLTEEA","vedge-C1126X-8PLTEP","vedge-C1127X-8PLTEP","vedge-C1127X-8PMLTEP","vedge-C1127-8PMLTEP","vedge-C1117-4PLTELA","vedge-ISRv","vedge-C8000V","vedge-ASR-1001-X","vedge-C1111-4P","vedge-C1101-4P","vedge-C1101-4PLTEP","vedge-C8500-12X4QC","vedge-C8530-12X4QC","vedge-C8570-G2","vedge-C8500-12X","vedge-C8530-12X","vedge-C8550-G2","vedge-C8530L-8S8X4Y","vedge-C8475-G2","vedge-C8530L-8S2X2Y","vedge-C8455-G2","vedge-C8330-1N1S-4M2X","vedge-C8375-E-G2","vedge-C8330-6TM4SX","vedge-C8330-6TM4X","vedge-C8351-G2","vedge-C8330X-6TM4SX","vedge-C8330X-6TM4X","vedge-C8355-G2","vedge-C8500L-8S4X","vedge-C1111-8PW","vedge-C1111-8PLTEEAW","vedge-C1111-4PLTEEA","vedge-C1101-4PLTEPW","vedge-C1109-4PLTE2PW","vedge-C1109-4PLTE2P","vedge-C1121X-8PLTEP","vedge-C1161X-8PLTEP","vedge-C1113-8PMLTEEA","vedge-C1111-4PLTELA,vedge-C1116-4P","vedge-C1116-4PLTEEA","vedge-C1117-4P","vedge-C1117-4PM","vedge-C1117-4PMLTEEA","vsmart","vmanage","vbond","vedge-ISR-4461","vedge-C8300-1N1S-4T2X","vedge-C8300-1N1S-6T","vedge-C1100TG-1N24P32A","vedge-C1100TGX-1N24P32A","vedge-C1161X-8P","vedge-C8300-2N2S-4T2X","vedge-C8300-2N2S-6T","vedge-C8200-1N-4T","vedge-C8200L-1N-4T","vedge-C1161-8P","vedge-C8230X-1N-2M2X","vedge-C8235-E-G2","vedge-C8230-1N-2M2X","vedge-C8231-E-G2","vedge-C8230E-8TM2X","vedge-C8231-G2","vedge-C8230X-8M2X","vedge-C8235-G2","vedge-C1126-8PLTEP","vedge-C1127-8PLTEP","vedge-C1121-4P","vedge-C1121-4PLTEP","vedge-C1128-8PLTEP","vedge-C1121X-8PLTEPW","vedge-C1121-8PLTEP","vedge-C1121-8P","vedge-C1161-8PLTEP","vedge-C1113-8PLTEEA","vedge-C1131-8PW","vedge-C1131X-8PW","vedge-C1131-8PLTEPW","vedge-C1131X-8PLTEPW","vedge-C1113-8PLTEW","vedge-C1111-4PW","vedge-C1112-8P","vedge-C1112-8PLTEEA","vedge-C1112-8PLTEEAWE","vedge-C1112-8PWE","vedge-C1113-8P","vedge-C1113-8PLTEEAW","vedge-C1113-8PLTELA","vedge-C1113-8PLTELAWZ","vedge-C1113-8PM","vedge-C1113-8PMWE","vedge-C1113-8PW","vedge-C1116-4PLTEEAWE","vedge-C1116-4PWE","vedge-C1117-4PLTEEAW","vedge-C1117-4PLTELAWZ","vedge-C1117-4PMLTEEAWE","vedge-C1117-4PMWE","vedge-C1117-4PW","vedge-C1118-8P","vedge-C1109-2PLTEGB","vedge-C1109-2PLTEUS","vedge-C1109-2PLTEVZ"]},"example":"vedge-cloud"},{"name":"state","in":"query","description":"List of states","schema":{"type":"array","items":{"type":"object","properties":{"certificateTypes":{"type":"string","enum":["tokengenerated","bootstrapconfiggenerated","csrgenerated","csrfailed","certinstalled","certinstallfailed"]}},"description":"This is valid Certificate States ","$$ref":"#/components/schemas/CertificateStates"}},"example":["certinstalled"]},{"name":"uuid","in":"query","description":"List of device uuid","schema":{"type":"array","items":{"type":"object","properties":{"deviceUuid":{"type":"string","example":"C8K-f9f4a977-be6c-47f7-b3b2-10e916bb24db"}},"description":"This is valid DeviceUuid","$$ref":"#/components/schemas/DeviceUuid"}},"example":["C8K-5e87e5c3-0923-4364-a729-d65d40298d76"]},{"name":"deviceIP","in":"query","description":"List of device system IP","schema":{"type":"array","items":{"type":"object","properties":{"deviceIp":{"type":"string"}},"description":"This is the valid DeviceIP","$$ref":"#/components/schemas/DeviceIP"}},"example":["172.16.255.21"]},{"name":"validity","in":"query","description":"List of device validity","schema":{"type":"array","items":{"type":"object","properties":{"certificateValidity":{"type":"string","enum":["valid","invalid","staging"]}},"description":"This is Certificate Validity ","$$ref":"#/components/schemas/CertificateValidity"}},"example":["valid","invalid","staging"]},{"name":"family","in":"query","description":"The platform family to filter for","schema":{"type":"string","enum":["aon","cedge"]}},{"name":"siteId","in":"query","description":"The Site Id to filter for","schema":{"type":"integer","format":"int64"},"example":400},{"name":"topology","in":"query","description":"The device topology to filter for","schema":{"type":"string","enum":["hub","spoke"]}},{"name":"tag","in":"query","description":"The tag name to filter for","schema":{"type":"string"},"example":"Tag1"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example":{"description":"Example","value":{"header":{"generatedOn":1719777080038,"viewKeys":{"uniqueKey":[],"preferenceKey":"grid-vEdgeList"},"columns":[{"title":"Chassis Number","property":"chasisNumber","hideable":false,"visible":true,"width":250,"dataType":"string"},{"title":"Site Name","property":"site-name","visible":true,"width":80,"dataType":"string"},{"title":"Hostname","property":"host-name","hideable":true,"visible":true,"width":150,"dataType":"string"},{"title":"Tags","property":"tags","display":"toggle","actionColumn":true,"visible":true,"minWidth":100,"dataType":"string"},{"title":"Config Locked","property":"device-lock","visible":true,"width":80,"dataType":"boolean"},{"title":"Managed By","property":"managed-by","visible":true,"headerTooltip":"This field indicates whether device is being managed by a Configuration-Group, Template, or it is Unmanaged i.e. not managed by either of them. Note: A device that is Unlocked but, managed by a Configuration-Group will become locked again when the Configuration-Group is deployed back to the device.","width":160,"dataType":"string"},{"title":"Device Status","property":"configStatusMessage","display":"syncDiffChecker","visible":true,"minWidth":150,"dataType":"string"},{"title":"Version","property":"version","visible":true,"width":150,"dataType":"string"},{"title":"Reachability","property":"reachability","hideable":true,"visible":true,"dataType":"string"},{"title":"Site ID","property":"site-id","visible":false,"width":70,"dataType":"numberStr"},{"title":"Region ID","property":"region-id","visible":false,"width":120,"dataType":"string"},{"title":"Region Name","property":"region-name","visible":false,"width":120,"dataType":"string"},{"title":"Mode","property":"configOperationMode","display":"keyvalue","keyvalueProperty":"configOperationMode","visible":false,"keyvalue":[{"key":"cli","value":"CLI"},{"key":"vmanage","value":"vManage"}],"width":80,"dataType":"string"},{"title":"view.certificate.clientViewVedgeList.assignedConfigGroup","property":"name","visible":false,"width":150,"dataType":"string"},{"title":"Assigned Template","property":"template","visible":false,"width":150,"dataType":"string"},{"title":"Device Model","property":"deviceModel","display":"keyvalue","keyvalueProperty":"deviceModel","visible":false,"minWidth":120,"dataType":"string"},{"title":"Draft Mode","property":"draftMode","visible":false,"width":80,"dataType":"string"},{"title":"Serial No./Token","property":"serialNumber","visible":false,"width":150,"dataType":"string"},{"title":"State","property":"vedgeCertificateState","display":"iconAndToolTip","iconProperty":"vedgeCertificateState","toolTipProperty":"vedgeCertificateState","visible":false,"icon":[{"key":"tokengenerated","value":"images/certStates/token-generated.png","displayKey":"Token Generated"},{"key":"bootstrapconfiggenerated","value":"images/certStates/bootstrap-config-generated.png","displayKey":"Bootstrap Configuration Generated"},{"key":"csrgenerated","value":"images/certStates/csr-generated.png","displayKey":"CSR Generated"},{"key":"csrfailed","value":"images/certStates/csr-failed.png","displayKey":"CSR Failed"},{"key":"certinstallfailed","value":"images/certStates/cert-install-failed.png","displayKey":"Certificate Installation Failed"},{"key":"certinstalled","value":"images/certStates/cert-installed.png","displayKey":"Certificate Installed"}],"width":40,"dataType":"string"},{"title":"Enterprise Cert Serial No","property":"hardwareCertSerialNumber","visible":false,"width":100,"dataType":"string"},{"title":"Certificate Expiration Date","property":"expirationDate","visible":false,"width":100,"dataType":"string"},{"title":"Subject SUDI serial #","property":"subjectSerialNumber","visible":false,"width":100,"dataType":"string"},{"title":"Validity","property":"validity","display":"toggle","actionColumn":true,"visible":false,"minWidth":100,"dataType":"string"},{"title":"System IP ","property":"local-system-ip","hideable":true,"visible":false,"minWidth":120,"dataType":"ipv4"},{"title":"Configured System IP","property":"configuredSystemIP","hideable":true,"visible":false,"minWidth":120,"dataType":"ipv4"},{"title":"Upload Source","property":"uploadSource","display":"toggle","actionColumn":true,"visible":false,"minWidth":150,"dataType":"string"},{"title":"Solution","property":"solution","visible":false,"minWidth":150,"dataType":"string"}],"fields":[{"property":"chasisNumber","dataType":"string"},{"property":"site-name","dataType":"string"},{"property":"host-name","dataType":"string"},{"property":"tags","dataType":"string","display":"toggle"},{"property":"device-lock","dataType":"boolean"},{"property":"managed-by","dataType":"string"},{"property":"configStatusMessage","dataType":"string","display":"syncDiffChecker"},{"property":"version","dataType":"string"},{"property":"reachability","dataType":"string"},{"property":"deviceIP","dataType":"ipv4"},{"property":"site-id","dataType":"numberStr"},{"property":"region-id","dataType":"string"},{"property":"region-name","dataType":"string"},{"property":"configOperationMode","dataType":"string","display":"keyvalue"},{"property":"name","dataType":"string"},{"property":"template","dataType":"string"},{"property":"deviceModel","dataType":"string","display":"keyvalue"},{"property":"draftMode","dataType":"string"},{"property":"serialNumber","dataType":"string"},{"property":"vedgeCertificateState","dataType":"string","display":"iconAndToolTip"},{"property":"hardwareCertSerialNumber","dataType":"string"},{"property":"expirationDate","dataType":"string"},{"property":"subjectSerialNumber","dataType":"string"},{"property":"validity","dataType":"string","display":"toggle"},{"property":"local-system-ip","dataType":"ipv4"},{"property":"configuredSystemIP","dataType":"ipv4"},{"property":"vbond","dataType":"ipv4"},{"property":"uploadSource","dataType":"string","display":"toggle"},{"property":"solution","dataType":"string"}]},"data":[{"configuredHostname":"vm11","configuredSiteId":"100","configuredSystemIP":"172.16.255.21","deviceType":"vedge","serialNumber":"12345712","ncsDeviceName":"vedge-C8K-7676a621-a5e9-41ef-a9dd-d01782ff5834","configStatusMessage":"In Sync","templateApplyLog":["[14-Jun-2024 9:19:47 UTC] Deploying device with Config Group vm11_ConfigGroup","[14-Jun-2024 9:19:47 UTC] Generating configuration","[14-Jun-2024 9:19:49 UTC] Checking and creating device in Manager","[14-Jun-2024 9:19:56 UTC] Device is online","[14-Jun-2024 9:19:56 UTC] Updating device configuration in Manager","[14-Jun-2024 9:19:56 UTC] Sending configuration to device","[14-Jun-2024 9:20:01 UTC] Successfully notified device to pull configuration","[14-Jun-2024 9:20:02 UTC] Device has pulled the configuration","[14-Jun-2024 9:20:17 UTC] Device: Config applied successfully","[14-Jun-2024 9:20:17 UTC] Config Group successfully deployed to device"],"uuid":"C8K-7676a621-a5e9-41ef-a9dd-d01782ff5834","managementSystemIP":"172.16.255.21","templateStatus":"Success","chasisNumber":"C8K-7676a621-a5e9-41ef-a9dd-d01782ff5834","configStatusMessageDetails":"","configOperationMode":"vmanage","deviceModel":"vedge-C8000V","deviceState":"READY","validity":"valid","platformFamily":"c8000v","hardwareVedge":false,"username":"--","rootCertHash":"4b31480c781ebc512ac3a3b6fd671f44d5b1f087","deviceIP":"172.16.255.21","personality":"vedge","uploadSource":"Auto Discovered","region-id":[],"addedByRule":false,"solution":"sdwan","site-id":"100","host-name":"vm11","system-ip":"172.16.255.21","vbond":"10.0.12.26","vmanageConnectionState":"connected","local-system-ip":"172.16.255.21","availableVersions":[],"defaultVersion":"17.16.01.0.202649","reachability":"reachable","version":"17.16.01.0.202649","uptime-date":1718354640000,"model_sku":"None","lastupdated":1719751312724,"vmanage-system-ip":"172.16.255.21","domain-id":"1","sp-organization-name":"vIPtela Inc Regression","organization-name":"vIPtela Inc Regression","id":"9b7c6a63-e659-4192-a2a7-8a743cb3b878","name":"vm11_ConfigGroup","lifeCycleRequired":true,"vedgeCertificateState":"certinstalled","expirationDate":"NA","hardwareCertSerialNumber":"NA","subjectSerialNumber":"NA","resourceGroup":"global","tags":[],"draftMode":"Disabled","site-name":"SITE_100","device-lock":"Yes","managed-by":"Config-Group vm11_ConfigGroup"}]},"$$ref":"#/components/examples/ComViptelaVmanageServerDeviceconfigSystemDeviceSystemdeviceapiResponseExampleDevicecategoryresp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default,dca,Device Inventory \u003e Edge-read,Device Inventory \u003e Controller-read","method":"get","path":"/system/device/{deviceCategory}"}}