topic vManage API - Get Template Values in Network Platform API

vManage API - Get Template Values

_Dustin_ — Thu, 05 Dec 2024 14:29:38 GMT

Can someone please help me identify the correct endpoint/logic to use?

Let's say I have a device template named 'My_Device' and it contains two fields 'Interface' and 'Bandwidth'. What endpoints would I use to query the vManage API for the values of variables when the template was attached to a device?

Currently, I'm doing a GET to the endpoint below but that endpoint takes about a minute to return the data. I'm looking for something faster so that when I iterate over the devices in inventory it doesn't take hours to complete.

https://<vmanage>/dataservice/template/device/config/attachedconfig?deviceId={{this_item.uuid}}

Re: vManage API - Get Template Values

bigevilbeard — Thu, 05 Dec 2024 14:40:43 GMT

Could you use the Bulk API for this? https://developer.cisco.com/docs/sdwan/bulk-api/

Re: vManage API - Get Template Values

_Dustin_ — Thu, 05 Dec 2024 15:39:48 GMT

That bulk API appears to be more aimed at State and Statistics. I don't see a Data Type Parameter listed that would give me the configured bandwidth on an interface, the running config for manual parsing, or values used in the attached template.

Re: vManage API - Get Template Values

bigevilbeard — Thu, 05 Dec 2024 17:03:19 GMT

I think i got it - You want to parse all devices which have your two items 'Interface' and 'Bandwidth' from a given template/configuration? Are you looking for any sort of information from these like types?

Re: vManage API - Get Template Values

_Dustin_ — Thu, 05 Dec 2024 18:21:55 GMT

What I'm doing now:
1. Hit the device endpoint to get a list of devices

2. For each device pull the entire config (this is the slow part)

3. Extract the settings from the device's running config

What I was hoping was to be able to hit an API endpoint, specify the device ID (and template ID if necessary), and have access to values used in the templates.

Re: vManage API - Get Template Values

Torbjørn — Thu, 05 Dec 2024 20:58:15 GMT

I unfortunately don't think there is any more elegant way to do this. I haven't been able to find any other endpoints that return this data.

Re: vManage API - Get Template Values

bigevilbeard — Fri, 06 Dec 2024 08:35:42 GMT

@_Dustin_ as @Torbjørn noted and I checked the API docs, I don’t think there is a single way to do this in an API call and you would need to either batch your API calls or try parallel processing to speed up retrieval across the multiple devices.

Re: vManage API - Get Template Values

_Dustin_ — Mon, 09 Dec 2024 14:14:20 GMT

Thank you, @torbjorn , I feared that was the case. I was hoping for an endpoint that would return a key value pair of all the device template values, but I guess that was hoping for too much.