topic Re: SDWAN VManager Moving a device to an existing Template in Network Platform API

SDWAN VManager Moving a device to an existing Template

wolfcaptain2002 — Thu, 14 Nov 2024 19:12:27 GMT

Hello Everyone,

I need assistance with the Vmanager API, I need to reattach a device that in CLI mode to an existing template. I have used multiple API calls such as https://vmanage-ip-address/dataservice/template/device/config/attachfeature and /attachcli. These calls are being processed by the vmanager but is not moving the device to said template. Can anyone assist with the proper process or calls needed to reattach a device to an existing template?

Thank you!

Re: SDWAN VManager Moving a device to an existing Template

wolfcaptain2002 — Thu, 14 Nov 2024 19:13:49 GMT

If possible, can someone provide the API calls needed/script example to reattach a device to a template.

Re: SDWAN VManager Moving a device to an existing Template

Torbjørn — Fri, 15 Nov 2024 11:04:51 GMT

/dataservice/template/device/config/attachfeature is the correct endpoint and should work. What response are you getting, and what is the result of the "attach action"? If you can post vManage version, example requests and/or code it would help a lot in assisting you with this.

Re: SDWAN VManager Moving a device to an existing Template

bigevilbeard — Fri, 15 Nov 2024 10:42:22 GMT

@wolfcaptain2002 can you share the code, do you get any error messages in the UI?

Re: SDWAN VManager Moving a device to an existing Template

wolfcaptain2002 — Mon, 18 Nov 2024 23:07:51 GMT

Hello, sorry for the late reply; I did not see the email response. My code may be messy since I'm only testing to see if it works, but here are the code snippets, as requested. I used the examples provided on the SDWAN API Documentation. I have received no errors, just a status response.

Thank you again!

def Attach_Template(Template_ID):


    URL = f'https://{vmanage}/dataservice/template/device/config/attachcli'

    headers = {
        'Content-Type': 'application/json',
        'X-XSRF-TOKEN': f'{Token}',
        'Cookie': f'JSESSIONID={Cookie}'
    }

    data = {"deviceTemplateList":[
  {
    "templateId":f"{Template_ID}",
    "cliType": "device",
    "device":[
    {
      "csv-status":f"{INPUT_VARS['data'][0]['csv-status']}",
      "csv-deviceId":f"{INPUT_VARS['data'][0]['csv-deviceId']}",
      "csv-deviceIP":f"{INPUT_VARS['data'][0]['csv-deviceIP']}",
      "csv-host-name":f"{INPUT_VARS['data'][0]['csv-host-name']}",
      "//system/host-name":f"{INPUT_VARS['data'][0]['//system/host-name']}",
      "//system/system-ip":f"{INPUT_VARS['data'][0]['//system/system-ip']}",
      "//system/site-id":f"{INPUT_VARS['data'][0]['//system/site-id']}",
      "csv-templateId":"41f6a440-c5cc-4cc6-9ca1-af18e332a781",
      "selected":"true"
    }
    ],
    "isEdited":'false',
    "isMasterEdited":'false'
       }
          ]
            }

    response = requests.post(URL, headers=headers, verify=False,data=json.dumps(data))
    response = json.loads(response.text)
    print(response)

    Monitor_URL = f'https://{vmanage}/dataservice/device/action/status/{response["id"]}'
    Monitor_Response = requests.get(Monitor_URL,headers=headers,verify=False)
    Monitor_Response = json.loads(Monitor_Response.text)

    Feature_URL = f'https://{vmanage}/dataservice/template/device/config/attachfeature'

    FEATURE_response = requests.post(Feature_URL, headers=headers, verify=False,data=json.dumps(data))
    FEATURE_response = json.loads(FEATURE_response.text)
    print(FEATURE_response)

Re: SDWAN VManager Moving a device to an existing Template

bigevilbeard — Tue, 19 Nov 2024 10:21:26 GMT

@wolfcaptain2002 try this version, it has some of the things removed to make this simple and it follow the API document. Let me know if you see any difference in behavior. Also, could you share what response you get from this too.

I would expect to see 'failed' in the UI if this wasnt correct.

def attach_template(template_id, device_id): URL = f'https://{vmanage}/dataservice/template/device/config/attachcli' headers = { 'Content-Type': 'application/json', 'X-XSRF-TOKEN': f'{Token}', 'Cookie': f'JSESSIONID={Cookie}' } # Simplified data structure matching API documentation data = { "deviceTemplateList": [{ "templateId": template_id, "device": [{ "csv-status": "complete", "csv-deviceId": device_id, "csv-deviceIP": "-", "csv-host-name": "-", "csv-templateId": template_id }], "isEdited": False }] } # Make the attachment request response = requests.post(URL, headers=headers, verify=False, data=json.dumps(data)) response_data = response.json() print("Attachment response:", response_data) if 'id' in response_data: # Monitor the task status monitor_url = f'https://{vmanage}/dataservice/device/action/status/{response_data["id"]}' for _ in range(30): # Check status for up to 5 minutes monitor_response = requests.get(monitor_url, headers=headers, verify=False) status = monitor_response.json() print("Status:", status) if status.get('status') == 'Success': return True elif status.get('status') in ['Failure', 'Failed']: print("Failed:", status.get('message', 'No error message')) return False time.sleep(10) return False

Re: SDWAN VManager Moving a device to an existing Template

wolfcaptain2002 — Wed, 27 Nov 2024 06:22:36 GMT

Hello @bigevilbeard,

Thank you for the code snippet. I have also used the structure mentioned in the API Documentation before. Sorry for the long delay in responses here is the output that you wanted and sadly the template is still not attaching. Looks like it is just repeating.

Thank you!

Re: SDWAN VManager Moving a device to an existing Template

bigevilbeard — Wed, 27 Nov 2024 10:00:08 GMT

Interesting. Your logs indicate a failure in the configuration push process, despite the validation being successful and it seems template passes the test, that suggests the issue is not with the template.
The null entry is interesting but does show much I would expect something here maybe showing an error.

Re: SDWAN VManager Moving a device to an existing Template

wolfcaptain2002 — Wed, 27 Nov 2024 16:46:05 GMT

The environment I’m using is the Sandbox I wonder if this is the reason… could be a bug?

Re: SDWAN VManager Moving a device to an existing Template

bigevilbeard — Wed, 27 Nov 2024 16:56:29 GMT

@wolfcaptain2002 can you share your entire script and template, would like to try this - Please correct me here, you have downloaded template from one of the devices and are attempting to upload this to another device and this is on the reservation sandbox?

Thanks!

Re: SDWAN VManager Moving a device to an existing Template

wolfcaptain2002 — Wed, 27 Nov 2024 17:38:50 GMT

Hello @bigevilbeard,

Currently all the script does is detaching and trying to re-attach a template I have not edited the template on a configuration stand point. The Sandbox that I'm using SD-WAN 20.12. I will provide the template configurations here shortly. Thank you for your help so far.

Template ID = 2c30ea87-42d8-40b4-b2ae-5ba8c33005ce

Re: SDWAN VManager Moving a device to an existing Template

wolfcaptain2002 — Thu, 28 Nov 2024 01:22:01 GMT

Hello @bigevilbeard,

This is the full script that im using you can find the template and the feature templates in the Cisco SD-WAN 20.12 Sandbox Im looking forward to your response.

Thanks

Re: SDWAN VManager Moving a device to an existing Template

bigevilbeard — Thu, 28 Nov 2024 10:19:20 GMT

Thanks, i will reserve the sandbox and give this a try

Re: SDWAN VManager Moving a device to an existing Template

bigevilbeard — Thu, 28 Nov 2024 17:09:27 GMT

@wolfcaptain2002 i spent a few hours on this, and even with the whole csv template in json this fails, the UI does not show why. I am looking to see if i can use a log/tail on the cli to see why, it is very odd. I captured the raw json via developer tools attached as working.text file.

The python code will output the entire steps and re-try after 10 seconds, max attempts is 30. I am checking with a few folks on this as it is very odd indeed.

Re: SDWAN VManager Moving a device to an existing Template

Torbjørn — Fri, 29 Nov 2024 00:19:12 GMT

Hello @wolfcaptain2002, @bigevilbeard,

I have attached a working version of the script. The issue was that this required the use of the /attachfeature endpoint instead of the /attachcli endpoint as this is a feature template based device template. What I find weird is that this didn't throw a 400 error, it got through validation and that there were no useful error messages in the UI. The only useful log entry I was able to find is the following line in the vmanage-server-deviceconfig-template.log file:

28-Nov-2024 23:20:59,697 UTC ERROR [] [] [TemplateRollbackManager] (Process device action - Push CLI Template Configuration) || ConfigTemplateType is null. Returning without finalizing..

Re: SDWAN VManager Moving a device to an existing Template

wolfcaptain2002 — Fri, 29 Nov 2024 07:04:36 GMT

Hello @Torbjørn,

Thank you for providing this answer, I do see the "/attachfeature" call is working a lot more smoothly. Once it runs through the checks it gives me the error.

Failed to update configuration - com.viptela.vmanage.server.deviceconfig.template.TemplateException: com.viptela.vmanage.server.deviceconfig.template.TemplateException: java.lang.NullPointerException']

Nullpointer mentions it cant find a variable if im not mistaken.

Thank you!

Re: SDWAN VManager Moving a device to an existing Template

Torbjørn — Fri, 29 Nov 2024 07:22:52 GMT

You are correct. The device template already has feature templates attached and we are just reattaching the device template. The SD-WAN manager requires that you use separate endpoints when handling feature template based device templates(/attachfeature) and cli based device templates(/attachcli).

If want to alter the feature template based device template(attach/remove feature templates you have to use the /template/device/feature endpoint instead.

Re: SDWAN VManager Moving a device to an existing Template

Torbjørn — Fri, 29 Nov 2024 07:31:21 GMT

Ouch, that's not ideal! I will reserve the sandbox and have another look.

Re: SDWAN VManager Moving a device to an existing Template

wolfcaptain2002 — Fri, 29 Nov 2024 07:38:18 GMT

Hello @Torbjørn I appreciate your help. All I want is to reattach the feature template back onto a device. Here is function I was using. Thank you again!

def attach_template(template_id, device_id😞
    URL = f'https://{vmanage}/dataservice/template/device/config/attachfeature'

    headers = {
        'Content-Type': 'application/json',
        'X-XSRF-TOKEN': f'{Token}',
        'Cookie': f'JSESSIONID={Cookie}'
    }

    # Simplified data structure matching API documentation
    data = {
        "deviceTemplateList": [
            {
                "templateId": "c9ef3b34-a096-4744-9e37-866276deb2a0",
                "device": [
                    {
                        "csv-status": "complete",
                        "csv-deviceId": "C8K-C9DF615F-ABE7-1573-2BB1-288797F1B78B",
                        "csv-deviceIP": "10.10.1.17",
                        "csv-host-name": "Site3-cEdge01",
                        "//system/host-name": "Site3-cEdge01",
                        "//system/system-ip": "10.10.1.17",
                        "//system/site-id": "1003",
                        "csv-templateId": "c9ef3b34-a096-4744-9e37-866276deb2a0",
                        "selected": "true"
                    }
                ],
                "isEdited": False,
                "isMasterEdited": False
            }
        ]
    }

    # Make the attachment request
    response = requests.post(URL, headers=headers, verify=False, data=json.dumps(data))
    response_data = response.json()
    print("Attachment response:", response_data)

    if 'id' in response_data:
        # Monitor the task status
        monitor_url = f'https://{vmanage}/dataservice/device/action/status/{response_data["id"]}'
        for _ in range(30😞  # Check status for up to 5 minutes
            monitor_response = requests.get(monitor_url, headers=headers, verify=False)
            status = monitor_response.json()
            print("Status:", status)

            if status.get('status') == 'Success':
                return True
            elif status.get('status') in ['Failure', 'Failed']:
                print("Failed:", status.get('message', 'No error message'))
                return False

            time.sleep(10)

    return False

Re: SDWAN VManager Moving a device to an existing Template

Torbjørn — Fri, 29 Nov 2024 09:52:32 GMT

No problem!

Just to ensure that we are on the same page: a feature template is a small template describing configuration of a given feature. A device template is what you apply to a network device and can either be a CLI based device template or a feature template based device template. The latter consists of a collection of feature templates that makes up a full device config and is what this API endpoint handles.

Here is a new version of your function:

def attach_template(template_id, device_id, token, cookie ): url = f'https://10.10.20.90/dataservice/template/device/config/attachfeature' headers = { 'Content-Type': 'application/json', 'X-XSRF-TOKEN': token, 'Cookie': f"JSESSIONID={cookie}" } data = { "deviceTemplateList": [{ "templateId": template_id, "device": [ { "selected": "true", "csv-deviceId": "C8K-C9DF615F-ABE7-1573-2BB1-288797F1B78B", "csv-deviceIP": "10.10.1.18", "csv-host-name": "Site3-cEdge02", "/1/vpn-instance/ip/route/vpn_1_ip_route/prefix": "TEMPLATE_IGNORE", "/1/vpn-instance/ip/route/vpn_1_ip_route/next-hop/vpn_1_next_hop_ip_address/address": "TEMPLATE_IGNORE", "/1/vpn_1_if_name/interface/if-name": "GigabitEthernet3", "/1/vpn_1_if_name/interface/description": "port.site3-sw01", "/1/vpn_1_if_name/interface/ip/address": "10.10.25.1/24", "/512/vpn-instance/ip/route/0.0.0.0/0/next-hop/vpn_512_next_hop_ip_address/address": "10.10.20.254", "/512/vpn_512_if_name/interface/if-name": "GigabitEthernet1", "/512/vpn_512_if_name/interface/description": "port.sbx-mgmt", "/512/vpn_512_if_name/interface/ip/address": "10.10.10.1/24", "/0/vpn-instance/ip/route/0.0.0.0/0/next-hop/vpn_0_mpls_next_hop_ip_add/address": "10.10.23.49", "/0/vpn-instance/ip/route/0.0.0.0/0/next-hop/vpn_0_internet_next_hop_ip_add/address": "10.10.23.49", "/0/vpn_0_internet_int_name/interface/if-name": "GigabitEthernet2", "/0/vpn_0_internet_int_name/interface/description": "internet-link", "/0/vpn_0_internet_int_name/interface/ip/address": "10.10.23.50/30", "//system/host-name": "Site3-cEdge02", "//system/system-ip": "10.10.1.18", "//system/site-id": "1003" } ], "isEdited": False, "isMasterEdited": False }] } response = requests.post(url, headers=headers, verify=False, data=json.dumps(data)) response_data = response.json() print("Attachment response:", response_data) if 'id' in response_data: # Monitor the task status monitor_url = f'https://10.10.20.90/dataservice/device/action/status/{response_data["id"]}' for _ in range(30): monitor_response = requests.get(monitor_url, headers=headers, verify=False) status = monitor_response.json() print("Status:", status) if status["summary"]["status"] == 'done': return True elif status["summary"]["status"] in ['Failure', 'Failed']: print("Failed:", status.get('message', 'No error message')) return False time.sleep(10) return False

A few changes I've made:

Device IP, ID and hostname all refer to cEdge02 as this previously was a mix of cEdge02 and cEdge01 values
All required parameters have now been set, I copied the ones in @bigevilbeards script.
I corrected the value used for verification of status to ["summary"]["status"].

This is functionally the same as the previous script but simplified for demonstration purposes. I would look at the previous script to see a better example of how this could be implemented.

Let me know if this works for you.