Verify APIs Used by vManage to Gather Statistics

Introduction

This document describes how to get a specific API call used by vManage to gather statistics from the overlay.

Prerequisites

• Cisco SD-WAN Overlay must be up.
• No additional configuration is needed

Components Used

This document is based on these software and hardware versions:

• SD-WAN controllers version 20.9.3

The information in this document was created from the devices in a specific lab environment. All of the devices used in this document started with a cleared (default) configuration. If your network is live, ensure that you understand the potential impact of any command.

Background Information

Application Programming Interface (API) calls are useful to gather session and node-specific information by using monitoring nodes, and sometimes have the exact API that vManage is using to gather the information that is needed to use it in remote monitoring nodes.

Problem

Need to know the specific API used by vManage to gather information to be used by a remote monitoring node.

Solution

How to get the API call ID that vManage is using to gather information about a device?

Step 1: Enable Web Developer Tools in web browser and click Network tab. Depending on the browser, these tools can be called by different names like Deveolper Tools or Web Inspector.

Step 2: Open vManage and go to any menu. In this case, Monitor > Overview menu is being checked, and search in Network tab for the registered entries. Click it and check Response tab on the right side (also called Review depending on the browser) to confirm that the entry belongs to the section needed . In this example, WAN Edge Inventory section is being inspected, and API name appears in the Response tab tagged as /device/vedgeinventory/detail.

Step 3: To confirm the API name and the response, click the Headers tab in the same event.

Conclusion

Through the web browser developer tools in a browser, it is possible to know the APIs used by the UI vManage. This helps to know what APIs are used to collect information using remote monitoring nodes from different vendors.

Note: For further API information refer to Cisco SD-WAN vManage API Document.