{"type":"api","title":"Generate Device List","meta":{"id":"/apps/pubhub/media/sd-wan-api-20-16/58fb893fa751949ea20a40274e9ab219a20e19fa/e77267b5-7b4b-3f93-807c-c6d1c6b41343","info":{"title":"Cisco Catalyst SD-WAN Manager API","description":"The vManage API exposes the functionality of operations maintaining devices and the overlay network","contact":{"email":"vmanage@cisco.com"},"license":{"name":"Commercial License","url":"https://www.cisco.com/c/en/us/solutions/enterprise-networks/sd-wan/index.html"},"version":"2.0.0"},"openapi":"3.0.1","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Configuration - Device Actions"],"description":"Get list of installed devices","operationId":"generateDeviceList","parameters":[{"name":"deviceType","in":"path","description":"Device type","required":true,"schema":{"type":"string"},"example":"vmanage"},{"name":"groupId","in":"query","description":"groupId","schema":{"type":"string"},"example":"all"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","example":{"device-model":"vmanage","device-os":"next","local-system-ip":"172.16.255.22","system-ip":"172.16.255.22","site-id":"200","uuid":"b642c56f-c899-4ca4-a3d6-d915e0660f9a","platform":"x86_64","isScheduleUpgradeSupported":false,"personality":"vmanage","device-type":"vmanage","reachability":"reachable","availableVersions":[],"host-name":"vm12","version":"20.13.999-2846","layoutLevel":1,"uptime-date":1683523320000,"isMultiStepUpgradeSupported":false,"defaultVersion":"20.13.999-2846","platformFamily":"vmanage","current-partition":"20.13.999-2846"},"items":{"type":"object","properties":{"availableVersions":{"type":"array","items":{"type":"string"}},"current-partition":{"type":"string"},"defaultVersion":{"type":"string"},"device-model":{"type":"string"},"device-os":{"type":"string"},"device-type":{"type":"string"},"host-name":{"type":"string"},"isMultiStepUpgradeSupported":{"type":"boolean"},"isScheduleUpgradeSupported":{"type":"boolean"},"layoutLevel":{"type":"integer","format":"int32"},"local-system-ip":{"type":"string"},"personality":{"type":"string"},"platform":{"type":"string"},"platformFamily":{"type":"string"},"reachability":{"type":"string"},"site-id":{"type":"string"},"system-ip":{"type":"string"},"uptime-date":{"type":"integer","format":"int32"},"uuid":{"type":"string"},"version":{"type":"string"}},"example":{"device-model":"vmanage","device-os":"next","local-system-ip":"172.16.255.22","system-ip":"172.16.255.22","site-id":"200","uuid":"b642c56f-c899-4ca4-a3d6-d915e0660f9a","platform":"x86_64","isScheduleUpgradeSupported":false,"personality":"vmanage","device-type":"vmanage","reachability":"reachable","availableVersions":[],"host-name":"vm12","version":"20.13.999-2846","layoutLevel":1,"uptime-date":1683523320000,"isMultiStepUpgradeSupported":false,"defaultVersion":"20.13.999-2846","platformFamily":"vmanage","current-partition":"20.13.999-2846"},"$$ref":"#/components/schemas/GenerateDeviceListData"}}},"$$ref":"#/components/schemas/GenerateDeviceList"},"examples":{"Example":{"description":"Example","value":{"data":{"device-model":"vmanage","device-os":"next","local-system-ip":"172.16.255.22","system-ip":"172.16.255.22","site-id":"200","uuid":"b642c56f-c899-4ca4-a3d6-d915e0660f9a","platform":"x86_64","isScheduleUpgradeSupported":false,"personality":"vmanage","device-type":"vmanage","reachability":"reachable","availableVersions":[],"host-name":"vm12","version":"20.13.999-2846","layoutLevel":1,"uptime-date":1683523320000,"isMultiStepUpgradeSupported":false,"defaultVersion":"20.13.999-2846","platformFamily":"vmanage","current-partition":"20.13.999-2846"}},"$$ref":"#/components/examples/GetInstallDevicesResp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-read,Software Upgrade-write,Settings-read,vmanage-http-stream,Software Upgrade \u003e Edge-write,Software Upgrade \u003e Edge-read,Software Upgrade \u003e Controller-write,Software Upgrade \u003e Controller-read","__originalOperationId":"generateDeviceList","method":"get","path":"/device/action/install/devices/{deviceType}"}}