The Cisco vManage supports RESTful (Representational State Transfer) API, which provides calls for retrieving real-time and static information about the Cisco SD-WAN overlay network and the devices in the network and for uploading device configuration templates and other configuration-related information. Using the RESTful API, you can design a custom portal for interacting with the vManage NMS.

The Cisco vManage API documentation is provided as part of the vManage software, at the URL https://vmanage-ip-address/apidocs. (More accurately, the full URL includes the Cisco vManagee port number, https://vmanage-ip-address:8443/apidocs.) vmanage-ip-address is the IP address of the vManage server.

API calls are provided for the following categories of operations:

• Certificate Management

• Configuration

• Device and Device Inventory

• Monitoring

• Real-Time Monitoring

• Troubleshooting Tools

For each group of API calls, click Show/Hide to list the individual calls and the URL for each call. Each call shows its response class, required parameters, and response messages (status codes).

To display the request URL for each API call and the format of the response body, click the Try It Out button. The request URL consists of the vManage NMS's URL, followed by /dataservice. For example, https://10.0.1.32:8443/dataservice/device/interface/statistics/ge0/0?deviceId=172.16.255.11

Below are a few examples of the URLs to use for API calls:

This article describes how to replace a vEdge router at a particular location. You might do this when a vEdge router has failed completely or when a component in a router, such as one of the power supplies, has failed, and you want to replace the entire router. 

At a high level, to replace one vEdge router with another, you simply copy the configuration from the router you are removing to the new router and then put the new router into the network.

Before you can replace the vEdge router in the vManage NMS, the NMS must have learned the chassis number and serial number of the replacement vEdge router.

• If the replacement vEdge router is a router that you have previously received, such as a router that part of your spares inventory, the vManage NMS will have already learned the router's chassis and serial number when you previously uploaded the serial number file to the NMS.

• If you initiated an RMA process and have received a new router as a replacement, you need to upload the updated version of the authorized vEdge serial number file to the NMS.

You perform the procedure for replacing the failed router from the vManage NMS, by doing the following:

1. Copy the configuration from the failed router to the replacement router.

2. Invalidate the failed router. Invalidating a router deactivates its certificate and thus removes it from the overlay network.

3. Validate the replacement router, to activate its certificate.

Because the new router is a complete replacement for the failed router, its configuration is identical to that of the failed router. (Remember, though, that each router has a unique chassis number and a unique serial number in its certificate.) After you copy the configuration from the failed router to the replacement, both routers have the same configurations, including the same IP address. Because two routers with the same IP address cannot be present in the network at the same time, one router must be in valid state on the vManage NMS and the other must be in invalid state—or both routers must be in invalid state.

Before You Begin

Ensure that you have uploaded the vEdge serial number file to the vManage NMS .

Copy the Configuration from the Failed to the Replacement Router

From the vManage NMS, you copy the configuration from the failed vEdge router to the replacement router.

The vEdge router that you are copying the configuration from can be a device that is active in the overlay network (that is, it is in a valid state) or it can be one that is inactive (that is, it is in invalid state). For example, if you are replacing a router in which one of the two power supplies has failed, the router might still be active in the network, but if you are replacing one that has failed completely, you might have already marked it as invalid to remove it from the network.

The vEdge router that you are copying the configuration to must be in invalid state.

To view the state of a vEdge router or to change the validity state, see Validate or Invalidate a vEdge Router .

To copy the configuration from the failed router to the replacement router:

1. In vManage NMS, select the Configuration ► Devices screen.

2. From the list of vEdge routers, locate the failed router.

3. Click the More Actions icon to the right of the row and click Copy Configuration.

4. In the Copy Configuration window, select the replacement router.

5. Click Update.

Remove the Failed Router

To remove the failed vEdge router from the overlay network:

1. In vManage NMS, select the Configuration ► Certificates screen.

2. From the list of vEdge routers, locate the failed router.

3. In the Validate column, click Invalid.

4. Click OK to confirm invalidation of the device.

5. Click Send to Controllers.

Add the Replacement Router

To add the replacement vEdge router into the overlay network:

1. In vManage NMS, select the Configuration ► Certificates screen.

2. From the list of vEdge routers, locate the replacement router.

3. In the Validate column, click Valid.

4. Click OK to confirm validation of the device.

5. Click Send to Controllers.

If you attempt to validate a router that has the same IP address as another router in the network, an error message is displayed, and the validation process is terminated.

Release Information

Introduced in vManage NMS in Release 15.4.

. You can perform the following operations in parallel from one or more Cisco vManage servers:

• Upgrade the software image on a device (Maintenance ► Software Upgrade screen)

• Activate a software image on a device (Maintenance ► Software Upgrade screen)

• Delete a software image from a device (Maintenance ► Software Upgrade screen)

• Set a software image to be the default image on a device (Maintenance ► Software Upgrade screen)

• Reboot a device (Maintenance ► Device Reboot screen)

• Manage templates (Configuration ► Templates screen):

  • Attach devices to a device template

  • Detach devices from a device template

  • Change the variable values for a device template that has devices attached to it

For template operations, the following rules apply:

• When a device template is already attached to a device, you can modify one of its feature templates. Then when you click Update ► Configure Devices, all other template operations—including attach devices, detach devices, and edit device values—are locked on all vManage servers until the update operation completes. This means that a user on another vManage server cannot perform any template operations until the update completes.

• You can perform the attach and detach device template operations on different devices, from one or more vManage servers, at the same time. However, if any one of these operations is in progress on one vManage server, you cannot edit any feature templates on any of the servers until the attach or detach operation completes.