List Reachable Devices - Cisco Catalyst SD-WAN Manager API, Release 20.18 - Cisco DevNet

{"type":"api","title":"List Reachable Devices","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":["Monitoring - Device Details"],"description":"Get list of reachable devices","operationId":"listReachableDevices","parameters":[{"name":"personality","in":"query","description":"personality","schema":{"type":"string"},"examples":{"vbond personality":{"description":"vbond personality","value":"vbond"},"vedge personality":{"description":"vedge personality","value":"vedge"},"vsmart personality":{"description":"vsmart personality","value":"vsmart"}}},{"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"}},"method":"get","path":"/device/reachable"}}