{"type":"api","title":"Get Partner Devices","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":["Partner - Registration"],"description":"List mapped devices for the partner","operationId":"getPartnerDevices","parameters":[{"name":"partnerType","in":"path","required":true,"schema":{"type":"string"}},{"name":"nmsId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"devices":{"type":"array","items":{"type":"object","properties":{"chassis-serial-number":{"type":"string","example":"SSI130300YK"},"configuredAaaUser":{"type":"array","items":{"type":"string"}},"device-model":{"type":"string","example":"C8000v"},"device-os":{"type":"string","example":"next"},"device-type":{"type":"string","example":"vedge"},"deviceId":{"type":"string","example":"C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f"},"devicesAttached":{"type":"integer","format":"int32","example":0},"discoveredDeviceInterfaces":{"type":"array","items":{"type":"string"}},"host-name":{"type":"string","example":"vm5"},"loopback":{"type":"array","items":{"type":"object","properties":{"interfaceIP":{"type":"string","example":"127.0.0.1"},"interfaceName":{"type":"string","example":"Loopback0"}},"$$ref":"#/components/schemas/Loopback"}},"personality":{"type":"string","example":"vedge"},"platform":{"type":"string","example":"x86_64"},"reachability":{"type":"string","example":"reachable","enum":["reachable","unreachable"]},"registrationDate":{"type":"integer","format":"int64","example":1590186370340},"serialNumber":{"type":"string","example":"12345712"},"site-id":{"type":"string","example":"500"},"state":{"type":"string","example":"green"},"status":{"type":"string","example":"normal","enum":["error","warning","normal","new"]},"system-ip":{"type":"string","example":"172.16.255.15"},"templateStatus":{"type":"string","example":"Success"},"uuid":{"type":"string","example":"C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f"},"validity":{"type":"string","example":"valid","enum":["invalid","staging","valid","prestaging"]},"version":{"type":"string","example":"17.06.01.0.1422"},"wanInterfaces":{"type":"array","items":{"type":"string"}}},"$$ref":"#/components/schemas/PartnerDevice"}}},"$$ref":"#/components/schemas/PartnerDevicesRes"},"examples":{"Devices":{"description":"Devices","value":"{\"devices\": [{ \"uuid\": \"C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f\", \"deviceId\": \"C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f\", \"reachability\": \"reachable\", \"status\": \"normal\", \"personality\": \"vedge\", \"device-type\": \"normal\", \"device-model\": \"C8000v\", \"version\": \"17.06.01.0.1422\", \"site-id\": \"500\", \"platform\": \"x86_64\", \"device-os\": \"next\", \"state\": \"green\", \"chassis-serial-number\": \"SSI130300YK\", \"host-name\": \"vm5\", \"system-ip\": \"172.16.255.15\", \"serialNumber\": \"12345712\", \"templateStatus\": \"Success\", \"validity\": \"valid\", \"configuredAaaUser\": [\"admin\"], \"wanInterfaces\": [\"GigabitEthernet1\"], \"discoveredDeviceInterfaces\": [\"GigabitEthernet8\",\"GigabitEthernet1\"\"GigabitEthernet2\"], \"registrationDate\": \"1632900123277\", \"devicesAttached\": 0, \"loopback\": []}]}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Integration Management-read,Integration Management-write,Policy Configuration-write","__originalOperationId":"getPartnerDevices","method":"get","path":"/partner/{partnerType}/map/{nmsId}"}}