cancel
Showing results for 
Search instead for 
Did you mean: 
cancel
Announcements

Choose one of the topics below for SD-WAN Resources to help you on your journey with SD-WAN

This community is for technical, feature, configuration and deployment questions.
For production deployment issues, please contact the TAC!
We will not comment or assist with your TAC case in these forums.

248
Views
0
Helpful
3
Replies
Highlighted
Beginner

What functions and benefits does the API in SD-WAN have?

In SD-WAN there is vmanage to configure. But there is an additional API, so what is that APi for and what are its benefits?

3 REPLIES 3
Highlighted

The way I plan to use the API is to pull data from my vManage instance and have router information graphed in MS PowerBi. I'm sure you can do much more with it but that depends on your Python skills and such.

See the below documentation:

https://sdwan-docs.cisco.com/Product_Documentation/Command_Reference/Command_Reference/vManage_REST_APIs

https://www.ciscolive.com/c/dam/r/ciscolive/apjc/docs/2019/pdf/DEVWKS-1417.pdf

https://developer.cisco.com/network-automation/detail/7073831078127492/

 

 

Highlighted
Cisco Employee

Hi,

The purpose of the API is to allow you to programmatically pull information from vManage (statistics, device status, device info, etc.) or manipulate vManage (change templates, delete, create new templates, etc.). Some use cases are:

  • Network management systems (NMS) that pull vManage for data
  • Backup and Recovery of vManage configuration templates, policies, etc.

Please note that if you controllers are Cisco-hosted, snapshots are taken of vManage often to help you restore everything in case of a disaster, but it never hurts to have another backup. There is a free tool provided by Cisco which "hides" the actual API calls and does them in the background while completing tasks like backup, restore, template creation, etc. for you. The tool is called Sastre and it is located here:

https://developer.cisco.com/codeexchange/github/repo/reismarcelo/sastre/


Here is the snippet from the site describing the tool:

"Sastre provides functions to assist with managing configuration elements and visualize information from Cisco SD-WAN deployments.

Some of the use-cases include:

  • Transfer configuration from one vManage to another. E.g. Lab/POC to production, on-prem to cloud, etc.
  • Backup, restore and delete configuration items. Tags and regular expressions can be used to select all or a subset of items.
  • Visualize state across multiple devices. For instance, display status of control connections from multiple devices in a single table."

Hope it helps!

Steve

Highlighted
Beginner

Viptela software provides a REST API, which is a programmatic interface for controlling, configuring, and monitoring the Viptela devices in an overlay network. You access the REST API through the vManage web server.

Available API Calls Managing users and user groups, viewing audit logs, and managing the local vManage server. Managing certificates and security keys. Creating feature and device configuration templates, retrieving the configurations in existing templates, and creating and configuring vManage clusters.

The other benefit is third party integration like Optimize operation workflows by integrating the network with CRM and ticketing systems

 

Regards

Inderdeep Singh

www.thenetworkdna.com