topic Re: Prime Infrastructure ReST API Calls in Controllers

Prime Infrastructure ReST API Calls

arunav.12 — Mon, 13 Jun 2016 16:02:28 GMT

Hi,

I have a query regarding the Cisco Prime Infrastructure API documentation hosted under URL: https://developer.cisco.com/site/prime-infrastructure/documents/api-reference/rest-api-v3-0/. I am using ReST apis mentioned in the above stated url to fetch inventory data from the Prime Infrastructure (PI) without using the GUI provided from the PI. Similarly I want to create VLAN on a switch using ReST api calls without using GUI.

My query is that can we create VLAN from ReST api calls? If so, is it through Cli templates?

According to the documentation mentioned above, it is said that we can download Cli templates for Configure vlan from the URL mentioned under "Get Cli Templates" section of the documentation and it is also said that we can deploy templates through jobs. Therefore, I followed the documentation and downloaded Cli template for Configure vlan and deployed it through job using the urls mentioned in the documentation, I am getting an error message saying "Invalid variable values" and the vlan is not being created.

Am I missing something here? Any advice for me ?

Thanks in advance

Re: Prime Infrastructure ReST API Calls

aradford — Mon, 13 Jun 2016 18:31:46 GMT

Hi Arun,

let me post an example. will do this later this morning

Re: Prime Infrastructure ReST API Calls

andy.dickinson — Tue, 14 Jun 2016 07:15:38 GMT

Hi Arun,

I have found that you need to post all variables in a template (even if they're not used) when you submit the job.

Also if you look in the "pnp_tempate.log" file you'll see which variable is causing the error.

Andy

Re: Prime Infrastructure ReST API Calls

arunav.12 — Tue, 14 Jun 2016 11:44:50 GMT

Thanks a lot for your reply. I thought, only those fields/variables which are marked "Required" were supposed to be given in the request body while submitting the job. Anyways, I will try this workaround and definitely get back to you on this.

And as suggested, I downloaded log files from Administration -> Logging, but it doesn't contain any file name "pnp_template.log".

Re: Prime Infrastructure ReST API Calls

andy.dickinson — Tue, 14 Jun 2016 12:05:11 GMT

The log can be accessed from the console shell (/opt/CSCOlumos/logs/ifm_template.log)

Re: Prime Infrastructure ReST API Calls

arunav.12 — Tue, 14 Jun 2016 15:24:41 GMT

This is the error line I am able to see in the log file ifm_template.log .

[2016-06-07 10:30:55,008] [seqtaskexecutor-1] [service] [ERROR] - Thread Id : [213,330] : IFM_TEMPLATE_ERROR_DETAILS: [Unable to find value for variable: option] : IFM_TEMPLATE_ERROR: [Method getVarValue: Variable name- option does not exist!]

Run history of job returns the following response

<job>

<description>Cli Template Deploy for IOS devices</description>

<jobId>49695693</jobId>

<jobName>JobCliTemplateDeployIOSDevices01_07_39_575_PM_06_14_2016</jobName>

<jobStatus>COMPLETED</jobStatus>

<jobType>CliTemplateDeployIOSDevices</jobType>

<runInstances>

<runInstance>

<completionTime>2016-06-14T13:08:10.741Z</completionTime>

<lastStartTime>2016-06-14T13:08:09.710Z</lastStartTime>

<resultStatus>FAILURE</resultStatus>

<results>

<result>

<property>1074074</property>

<value>Invalid var Values for given template's variables</value>

</result>

</results>

<runId>55253918</runId>

<runStatus>COMPLETED</runStatus>

</runInstance>

</runInstances>

</job>

Request body for configure vlan Cli template is as given in the following snippet

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<cliTemplateCommand>

<targetDevices>

<targetDevice>

<targetDeviceID>1074074</targetDeviceID>

<variableValues>

<variableValue>

<name>vlanid</name>

<value>200</value>

</variableValue>

<variableValue>

<name>vlanName</name>

<value>vlan2</value>

</variableValue>

</variableValues>

</targetDevice>

</targetDevices>

<templateName>Configure VLAN</templateName>

</cliTemplateCommand>

Re: Prime Infrastructure ReST API Calls

aradford — Wed, 15 Jun 2016 06:53:51 GMT

Hi Arun,

here are some examples for you.

cisco-prime-infrastructure-examples/auto_templates at master · aradford123/cisco-prime-infrastructure-examples · GitHub

There is also a little utility to create (JSON) schema for the template you want to use

Re: Prime Infrastructure ReST API Calls

arunav.12 — Thu, 16 Jun 2016 09:24:37 GMT

Thanks aradford. Appreciate your help. But following is the error I am getting when I try to execute "get_template.py" script you had shared in GitHub.

$ python get_template.py -t 445464 -s

Traceback (most recent call last):

File "get_template.py", line 69, in <module>

show_template(args.t, args.s)

File "get_template.py", line 59, in show_template

show_a_template(template, schema)

File "get_template.py", line 47, in show_a_template

result = requests.get(BASE + "data/CliTemplate/%s.json?.full=true" % template, verify=False)

File "/usr/lib/python2.7/dist-packages/requests/api.py", line 55, in get

return request('get', url, **kwargs)

File "/usr/lib/python2.7/dist-packages/requests/api.py", line 44, in request

return session.request(method=method, url=url, **kwargs)

File "/usr/lib/python2.7/dist-packages/requests/sessions.py", line 421, in request

prep = self.prepare_request(req)

File "/usr/lib/python2.7/dist-packages/requests/sessions.py", line 359, in prepare_request

hooks=merge_hooks(request.hooks, self.hooks),

File "/usr/lib/python2.7/dist-packages/requests/models.py", line 287, in prepare

self.prepare_url(url, params)

File "/usr/lib/python2.7/dist-packages/requests/models.py", line 334, in prepare_url

scheme, auth, host, port, path, query, fragment = parse_url(url)

File "/usr/lib/python2.7/dist-packages/urllib3/util.py", line 390, in parse_url

raise LocationParseError("Failed to parse: %s" % url)

urllib3.exceptions.LocationParseError: Failed to parse: Failed to parse: root:win

Thanks in advance.

Re: Prime Infrastructure ReST API Calls

arunav.12 — Thu, 16 Jun 2016 09:28:35 GMT

Hi Andy, as suggested I have included all variables available in the body even if it is not mandatory. But still I am facing the same issue. It says invalid variable values.

Thanks in advance for your help.

Re: Prime Infrastructure ReST API Calls

aradford — Thu, 16 Jun 2016 09:33:51 GMT

Hi Arun,

are you using JSON or XML?

If you are using JSON, if you goto the REPO I mentioned earlier I wrote a little utility to generate a JSON schema from the CLI_template. You just need to fill in the blanks. Make sure you add a valid DEVICEID

python get_template.py -n "Configure Interface" -s

{

"cliTemplateCommand" : {

"targetDevices" : {

"targetDevice" : {

"targetDeviceID" : "<DEVICEID>",

"variableValues" : {

"variableValue": [

{ "name": "Description", "value" : NONE }

#required

{ "name": "InterfaceName", "value" : NONE }

{ "name": "NativeVLan", "value" : NONE }

{ "name": "StaticAccessVLan", "value" : NONE }

{ "name": "TrunkAllowedVLan", "value" : NONE }

{ "name": "VoiceVlan", "value" : NONE }

{ "name": "spd", "value" : NONE }

{ "name": "A1", "value" : NONE }

{ "name": "duplexField", "value" : NONE }

{ "name": "PortFast", "value" : NONE }

]

}

"templateName" : "Configure Interface"

}

Re: Prime Infrastructure ReST API Calls

arunav.12 — Fri, 17 Jun 2016 14:08:55 GMT

Hi Aradford,

I have tried both JSON and XML formats. For XML format I have used, you can refer to my previous replies to this question. Here I am posting you the JSON format that I have used.

Firstly, I downloaded the CLI template for Configure vlan from the Prime using the python script shared by you.

$python get_template.py -t 445464 -s

{

"cliTemplateCommand" : {

"targetDevices" : {

"targetDevice" : {

"targetDeviceID" : "<DEVICEID>",

"variableValues" : {

"variableValue": [

{ "name": "encapsulation", "value" : NONE }

{ "name": "interfaceName", "value" : NONE }

{ "name": "mtu", "value" : NONE }

#required

{ "name": "vlanid", "value" : NONE }

{ "name": "vlanName", "value" : NONE }

{ "name": "mode", "value" : NONE }

{ "name": "option", "value" : NONE }

]

}

"templateName" : "Configure VLAN"

}

Then I modified this JSON format according to my requirement, i.e I just supplied values for vlanid as follows

{

"cliTemplateCommand" : {

"targetDevices" : {

"targetDevice" : {

"targetDeviceID" : "1074084",

"variableValues" : {

"variableValue": [

{ "name": "encapsulation", "value" : NONE }

{ "name": "interfaceName", "value" : NONE }

{ "name": "mtu", "value" : NONE }

{ "name": "vlanid", "value" : 200 }

{ "name": "vlanName", "value" : NONE }

{ "name": "mode", "value" : NONE }

{ "name": "option", "value" : NONE }

]

}

"templateName" : "Configure VLAN"

}

But when I deploy this data to prime, and check the run history, it gives me the following response

<job>

<description>Cli Template Deploy for IOS devices</description>

<jobId>49695709</jobId>

<jobName>

JobCliTemplateDeployIOSDevices12_04_13_021_PM_06_17_2016

</jobName>

<jobStatus>COMPLETED</jobStatus>

<jobType>CliTemplateDeployIOSDevices</jobType>

<runInstances>

<runInstance>

<completionTime>2016-06-17T12:04:44.132Z</completionTime>

<lastStartTime>2016-06-17T12:04:43.107Z</lastStartTime>

<resultStatus>FAILURE</resultStatus>

<results>

<result>

<property>1074084</property>

<value>Invalid var Values for given template's variables</value>

</result>

</results>

<runId>56445468</runId>

<runStatus>COMPLETED</runStatus>

</runInstance>

</runInstances>

</job>undefined</mgmtResponse>

Any workaround suggested here? Thanks in advance

Re: Prime Infrastructure ReST API Calls

aradford — Fri, 17 Jun 2016 19:06:41 GMT

oh sorry... my mistake...

NONE should be None

I will fix this

Re: Prime Infrastructure ReST API Calls

aradford — Sun, 19 Jun 2016 09:42:14 GMT

I have changed the script to just include "" for the vars that are not required.

It displays "required" as the value for the variables that are mandatory.

I am also posting a fully worked example.

Re: Prime Infrastructure ReST API Calls

aradford — Tue, 21 Jun 2016 11:05:19 GMT

Any update on this? I have updated my scripts on github.

Adam

Re: Prime Infrastructure ReST API Calls

arunav.12 — Tue, 21 Jun 2016 12:13:30 GMT

Hi Aradford,

Thanks for the update. I have issues with accessing Cisco Prime Server. I will definitely keep you posted. I really appreciate your help. Thanks a lot.

Regards,

Arun

Re: Prime Infrastructure ReST API Calls

arunav.12 — Mon, 27 Jun 2016 05:38:51 GMT

Hi Aradford,

I have solved the access issue. Now Job is not throwing any error, Job's run history says success, but how to check whether the vlan is created or not?. Following is the JSON body I am using.

Am I missing something here?

{

"cliTemplateCommand": {

"targetDevices": {

"targetDevice": {

"targetDeviceID": "074084",

"variableValues": {

"variableValue": [

{

"name": "encapsulation",

"value": ""

{

"name": "interfaceName",

"value": ""

{

"name": "mtu",

"value": ""

{

"name": "vlanid",

"value": "244"

{

"name": "vlanName",

"value": "vlan199"

{

"name": "mode",

"value": ""

{

"name": "option",

"value": ""

}

]

}

"templateName": "Configure VLAN"

}

Re: Prime Infrastructure ReST API Calls

aradford — Mon, 27 Jun 2016 05:48:58 GMT

Hi Arun,

almost there..

This particular template is to apply an VLAN to an interface. You need to specify an "name": "interfaceName", on the device.

For example "gig1/0/3" would apply vlan #244 to int gig1/0/3.

{ "name": "interfaceName",

"value" : "gig1/0/3"

}

If you just want to create a vlan on a device, there is another template for that. You can get a list of templates using the tools in the github repo i mentioned earlier.

Here is the schema for "create_vlan"

$ python get_template.py -n Add_Vlan -s

{

"cliTemplateCommand": {

"targetDevices": {

"targetDevice": {

"targetDeviceID": "<DEVICEID>",

"variableValues": {

"variableValue": [

{

"name": "vlanId",

"value": "required"

{

"name": "vlanName",

"value": "required"

}

]

}

"templateName": "Add_Vlan"

}

Re: Prime Infrastructure ReST API Calls

arunav.12 — Mon, 27 Jun 2016 07:45:44 GMT

Hi Aradford,

I have tried the above specified JSON but I am sorry to say that "Add_Vlan" template does not exist in my instance of Cisco Prime.

Correct me If I am wrong. We can apply VLAN to an interface, only if that VLAN is already created and exists isn't it ? . Will configure VLAN template creates VLAN and add it to the interface?

Re: Prime Infrastructure ReST API Calls

aradford — Mon, 27 Jun 2016 07:58:45 GMT

sorry, that may be the case. I am using PI 3.1

However, if you want to assign the vlan to a switch port and the VLAN does not exist, the switch will create it for you.

3650-dns(config-if)#switchport access vlan 222

% Access VLAN does not exist. Creating vlan 222

3650-dns#show vlan

VLAN Name Status Ports

---- -------------------------------- --------- -------------------------------

222 VLAN0222 active Gi1/0/10

Adam

Re: Prime Infrastructure ReST API Calls

arunav.12 — Mon, 27 Jun 2016 09:05:41 GMT

Hi Aradford,

I am using Cisco Prime Infrastructure 3.0 instance. Should we give any option like "Create" for the "options" variable in the template to create VLAN from ReST APIs.

Thanks