vManage NMS Product Help
The vManage NMS is a centralized network management system that provides a GUI interface to easily monitor, configure, and maintain all Viptela devices and links in the overlay network. The vManage NMS software runs on a server in the network.
Browser Support
You can access the vManage NMS using the Chrome and Firefox browsers.
You can access the vManage NMS from VPN 0 (the WAN transport VPN) and from VPN 512 (the management VPN).
vManage Dashboard
When you log into the vManage NMS, the dashboard provides a quick summary of the network.
Here, at a glance, you can view the health of the entire network including the operational state of any device, total number of reboots and crashes, and the state of all controller certificates. This visibility into the network eases the task of managing the Viptela devices.
vManage Menu
As shown in the above figure, the menu is located to the left of the Dashboard screen. The following table lists each menu and sub-menu item and provides a brief description.
Menu Item | Description |
---|---|
Dashboard | |
Monitor, at a glance, the health of the Viptela overlay network. | |
Monitor | |
A map view of the entire network and displays the geographic location of the devices in the network. | |
An inventory of all Viptela devices in the network along with detailed information on each device. | |
Details on alarms generated by all Viptela devices in the network. | |
Details on events generated by all Viptela devices in the network. | |
An audit log of all activities on Viptela devices. | |
Configuration | |
Add or delete devices from the overlay network. | |
Manage certificates and authenticate Viptela devices in the overlay network. | |
Create configuration templates for a set of Viptela devices. | |
Create common policies for a set of vSmart controllers. | |
Tools | |
Establish an SSH session to a Viptela device. | |
Locate new devices in the overlay network and synchronize them with the vManage NMS. | |
Run two or more operational commands as a single command. | |
Maintenance | |
Download new software images and upgrade the software image running on Viptela devices. | |
Reboot one or more Viptela devices. | |
Administration | |
Configure organization name and certificate authorization settings. | |
Add, edit, or delete users and user groups from the vManage NMS. |
Bringing Up the Viptela Overlay Network
The following table lists the tasks for bringing up the Viptela overlay network using the vManage NMS.
Bringup Task | Step-by-Step Procedure |
---|---|
Step 1: Start the vManage NMS |
|
Step 2: Start the vBond orchestrator |
|
Step 3: Start the vSmart controller |
|
Step 4: Configure the vEdge router |
|
Step 5: Connect AC power and boot the vEdge router |
|
RESTful API for vManage NMS
The vManage NMS supports a RESTful (Representational State Transfer) API, which provides calls for retrieving real-time and static information about the Viptela 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 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 vManage 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:
Requested Information | API Call |
---|---|
List all network devices | dataservice/device |
Health status of hardware device components, such as CPU, memory, fan, and power | dataservice/device/hardware/environment?deviceId=system-ip-address |
Status of a device's transport interfaces | dataservice/device/interface?deviceId=system-ip-address&port-type=transport |
Interface statistics, errors, and packet drops | dataservice/device/interface?deviceId=system-ip-address |
DTLS/TLS control connection status | dataservice/device/control/connections?deviceId=system-ip-address |
OMP peering | dataservice/device/omp/peers?deviceId=system-ip-address |
BGP peering on the service side | dataservice/device/bgp/neighbors?deviceId=system-ip-address |