vManage NMS Product Help

Last updated
Save as PDF

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
Dashboard	Monitor, at a glance, the health of the Viptela overlay network.
Monitor
Geography	A map view of the entire network and displays the geographic location of the devices in the network.
Network	An inventory of all Viptela devices in the network along with detailed information on each device.
Alarms	Details on alarms generated by all Viptela devices in the network.
Events	Details on events generated by all Viptela devices in the network.
Audit Log	An audit log of all activities on Viptela devices.
Configuration
Devices	Add or delete devices from the overlay network.
Certificates	Manage certificates and authenticate Viptela devices in the overlay network.
Templates	Create configuration templates for a set of Viptela devices.
Policy	Create common policies for a set of vSmart controllers.
Tools
SSH Terminal	Establish an SSH session to a Viptela device.
Rediscover Network	Locate new devices in the overlay network and synchronize them with the vManage NMS.
Operational Commands	Run two or more operational commands as a single command.
Maintenance
Software Upgrade	Download new software images and upgrade the software image running on Viptela devices.
Device Reboot	Reboot one or more Viptela devices.
Administration
Settings	Configure organization name and certificate authorization settings.
Manage Users	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	On the hypervisor, create a VM instance. Boot the vManage NMS server, start the VM, and enter login information. In vManage ► Administration ► Settings, configure certificate authorization settings. Select Automated to allow the certificate-generation process to occur automatically when a CSR is generated for a controller device. In vManage ► Certificates, generate the CSR. Check for a confirmation email from Symantec that your request has been received. Check for an email from Symantec that Viptela has approved your request and the certificate is signed. In vManage ► Configuration ► Devices, check that the certificate has been installed.
Step 2: Start the vBond orchestrator	On the hypervisor, create a VM instance. Boot the vBond server and start the VM. In vManage ► Configuration ► Devices ► Controller, add the vBond orchestrator and generate the CSR. Check for a confirmation email from Symantec that your request has been received. Check for an email from Symantec that Viptela has approved your request and the certificate is signed. In vManage ► Configuration ► Devices, check that the certificate has been installed. In vManage ► Configuration ► Templates: Create a configuration template for the vBond orchestrator. Attach the template to the vBond orchestrator. In vManage ► Dashboard, verify that the vBond orchestrator is operational.
Step 3: Start the vSmart controller	On the hypervisor, create a VM instance. Boot the vSmart server and start the VM. In vManage ► Configuration ► Devices ► Controller, add the vSmart controller and generate the CSR. Check for a confirmation email from Symantec that your request has been received. Check for an email from Symantec that Viptela has approved your request and the certificate is signed. In vManage ► Configuration ► Devices, check that the certificate has been installed. In vManage ► Configuration ► Templates: Create a configuration template for the vSmart controller. Attach the template to the vSmart controller. In vManage ► Dashboard, verify that the vSmart controller is operational.
Step 4: Configure the vEdge router	In vManage ► Configuration ► Devices ► vEdge List, upload the vEdge authorized serial number file. In vManage ► Configuration ► Certificates ► vEdge List, check that the router's chassis and serial number are in the vEdge list. In vManage ► Configuration ► Certificates ► vEdge List, authorize each router by marking it Valid in the Validity column. In vManage ► Configuration ► Certificates ► vEdge List, send the vEdge list to the controller devices. In vManage ► Configuration ► Templates: Create a configuration template for the vEdge router. Attach the template to the vEdge router.
Step 5: Connect AC power and boot the vEdge router	Connect AC power to the vEdge router. If needed, flip the On/Off switch on the rear of the router to the ON position. In vManage ► Dashboard or in vManage ► Monitor ► Network ► Device Dashboard, verify that the vEdge router is operational.

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