1. 5.0 SDWAN API
Now we are in section five, where we have to learn APIs and programming related to Sdvan. What are the topics we have? We should understand, first of all, the API inside SDWAN, how it uses and how we are going to use those API to build each and everything. So for that reason and what I have done that I have two follow up videos related to the Cvan API means what is the Sdvan API and what are the things we can do with those APIs, each and everything as per description, perspective that is covered. Now, once you understand what is API, what’s the use of API and how we can use those APIs to retrieve the information inside the SDWAN, then I’ll go in and start, say for example, 5152 and so on. Now, if you go and see five one, it is simply telling that use the API related to certificate management.
Five two, implement Python script using the API to retrieve the device information. So here we have to perform the lab task where we can retrieve the information about the devices and not only about the estimated devices, but we can get whatever information that we have in the API. We can get those information with the programming, with the Python script or program as well. Correct. Then five three construct API request for we manage administration, then check the we manage configuration APIs construct request for we manage monitoring APIs. And then finally the troubleshooting. Okay, so the thing is that with API, whatever features we have in the sqvan and the file act is that with Steve and API, you can do everything. So you can do monitoring, configuration, troubleshooting, certificate management, each and everything we can do. And you can find this information in the follow up videos. So watch two videos after this related to API, and then we’ll go and start section five one.
2. SDWAN API 01
Next topic we have related to application programming interface APIs. Now APIs, now they are getting the popularity. Why? Because if you see the evolution of networking domain, we started with CLI command line interface. Then we have the GUI, that is graphical user interface. And finally we have the application programming interface as well. Now, the CLI is also good and fast. But with respect to GUI and the API, we can do things very fast. Even with API. If we do some bulk API call and all this will become very accurate. There is less chance of female error and it will be very faster. So to provide a speed up, we are using the API. Here we have the restful API for we manage. We can use third party integration for API, use cases or use even inside we manage also we have the Swagger API interface from where we can do multiple tasks.
Here you can see important thing that we are using the restful API. That is the representational state transfer API that we are going to use. Now here you can see that we can do things with help of CLI SSH syslog SNMP NETCONF. But we can go and connect my we manage with the restful API. Once you are connected with the restful API, what are the things you can do? Actually, you can do each and everything. So you can go and use certificate management, configuration device and inventory monitoring, real time monitoring and troubleshooting. Everything is possible. Now, important thing here that you can see that while you’re using these APIs, we have four different type of methods. So what are those methods we have? So we have method called put. If you want to update the object or an object. To update an object, you have put method. Then you have get method. That is something very much related to show command. If you want to retrieve the info of that object, you can use the git. Then you have post method if you want to create new object. So, creation of an object put this post. And then finally you have delete. If you want to delete an object. So, these are the four methods that all the APIs are using to do the things inside. With help of API you can see get, put, post and delete. Now we have the resources. And if you collect those resources, you can think resource as a group of object or collection with a group of resources like that.
So here we know that what type of task we can do with help of API. And here on top you can see in the chart that you have resource collection. And this resource collection for what? So for example, administration. So all the administration tasks, you can group all the related object for administration. And with help of API you can do this. So administration related to groups, viewing audit, log, managing the local vanish server, et cetera. Then certificate management, configuration, device inventory monitoring, real time monitoring and the troubleshooting. Now these objects that we are seeing here. Because if you go and check behind the scene, these are the object.
And then you are collecting same type of object. So these object, they should have their format. And here you can see that the VIP teller rest API uses the JSON data model to represent. We’ll see later on that while we are getting the output, we are getting the output in JSON format. In JSON format they have three type of data as scalar array and object. That’s very much programming related that you can go and check. Now once you log into the Swagger interface, you’ll find that color coding for these operations. So Delete will be red, get will be blue, post will be green, put will be brown like that. You can see now how I can go and log into the Swagger interface.
So for that you have to go and use this URL, your V manage IP and then the API talks. So let me do one thing. Let me go and log in to the Swagger interface. So here I have my we manage dashboard. And what I can do that we can go and check API docs. So now it will redirect towards on top you can see this API document. Fetching the resources for API doc. And then you’ll get the long list of things that we can do. So give him some chance to come. And meanwhile we’ll go and check the slides. So you can go and log in there. Then you have API calls. You can go and use the data store and services and call different different type of things. So for example, if you want to see the Omppering, how we can do so let me quickly show you here that how you can go and build your own query, built your own API calls. So let me open the note pad here. And. OMP. Peering. What I can do here you can see that API is data service. And then the device OMP peer.
And then you have to give the device ID that is the system IP. So for example, ten, 40, one. I want to check the Ompp here for this particular device. So let me go in four. So you can see this. So like that you can go and create. I think we have our dashboard open, API dock page open. So let me quickly go and log in there. So here you can see, you can see the API doc. Now if you want to search OMP, you can go and search real time monitoring and OMP. You want to check the OMP pair. Here you can see you have the OMP pair. And as per our slide, you can see the gate is blue color. But you have different different color. Delete will be red like that. So what you want, you want to check the OMP pair for ten 40 one you can go and query this if you do the query here you can see 200 means success and then you have 400 bad requests 4034 bitten 500 is the internal error. Now here you can see that we got the request URL and here you can see the output correct? So this is the output who are the Ompp peer?
My OMP peer always will be the Vsmart so here you can see the peer and peer tov Smarts are my Omppier. Now we are also making or building our API call so here we can see we have this API call for OMP peer and here we can see what other the things needed only you have to add the URL and port number and that’s it. So what I will do, I will copy this and we’ll go ahead and put here. Once you go and put, you can see that you’re getting the result and if you want to get the result in the JSON format so let me use the other browser for the same and let me show you the result in the other browser, same output. I ran inside this mozilla and here you can see that we are getting the JSON format. Inside that you have the header so if you minimize the header then you have the data value in data value you can see that your peer is Vsmart and whose IP is this? This is the peer. And then again you can see that your other peer is other Vs smart. And whose IP is this? So you’re getting the result. Likewise, you can go and use any type of these API calls. Suppose if you want to check the DTLs or TLS connection, you can go and use this. So let me quickly build this one more time. So here we are. And now we can copy and paste as well. So what you want, you want. You can see the DTLs and TLS connection API call you want. And here you can see you can go to the devices and then and control and then connections. Correct. So I can go and copy this. And this will be one of my API call related.
3. SDWAN API 02
So now we have built our API call to check the control connections. You can copy and paste and we are getting some error. So let me quickly go and fix this error. What we can do at this point of time that we can go and check our V manage and from where we can get this particular API. So I’m logging back to my API. Once I’ll get my screen, I’ll go and search the DTLs connection API. So here we have the search option. We can go and check say for example API for DTLs.
So what we can do, we can go and check the control. And next you have this real time monitoring control. And then if you go scroll down somewhere you’ll find that you want to see the number of control connection. And here if you go and give the system ID and if you try it out, you will get the exact API you are looking for. And you can see that there is a small change in the API. So that’s why you are not getting the correct result. Now I can go back here we can go and put that correct API. And then you can see we are getting the result. So the control connection related to this particular device, you can see who are the controllers means one is the V manage. This IP can see let me see the IP public IP. And this is the Vsmart. Here you can see the peer type as well. So one vs. Smart, then vs.
Smart, number two, then vsmart. With other. So this is other Vsmart with other transport. This is again the other vs. Smart. Means we have two vs. Smart. And then finally you should have V manage as well. So here you can see the V manage over the MPLS. All right. So this is the way that you can go and further check all types of APIs. So that means you can check the connection BGP. Then if you want to check the orchestrator connections, those we can see what is the API call, what is the GUI equivalence, what is the CLI equivalent? Even we can compare all three as well.
So for example show orchestrated local properties is the CLI even in the GUI. Also we can go and check and even the URL means the API call. Also we can go and verify. So in this manner, in this way you can have a list that what CLI, what GUI and what API. And later on you can use only the GUI and the API calls. Even if you want to go and verify the Ospfrelated things like database interface, Naples processes, etc. Etc. You can go and run these API’s call that we have built for two, you can build for the rest of them. And then it will work as it is.
