SD-WAN VMware Solution Deployment / Configuration Guide

About

This document describes the steps to deploy and configure the VMwareSDWAN solution.

Prerequisites

  • An administrator-level account in SevOne NMS.
  • SSH password for the root account.
  • IP address of the PAS.

Installation Steps

SevOne NMS

The following steps apply to perform an installation from scratch of the VMware solution on SevOne NMS.

  1. Using ssh, login to SevOne NMS appliance as root.
    $ ssh root@<SevOne NMS appliance IP address>
  2. Create a directory, for example, VMwareSDWAN, in /root directory.

    Example

    $ cd /root
    
    $ mkdir VMwareSDWAN
  3. Download the following (latest) files from IBM Passport Advantage (https://www.ibm.com/software/passportadvantage/pao_download_software.html) via Passport Advantage Online. However, if you are on a legacy / flexible SevOne contract and do not have access to IBM Passport Advantage but have an active Support contract, please contact IBM SevOne Support for the latest files.You must place <tar/zip> files in /root/VMwareSDWAN directory.
    1. sdwan-velocloud-installation-v6.7.0-build.2.tgz
    2. dwan-velocloud-installation-v6.7.0-build.2.tgz.sha256.txt

    3. signature-tools-latest-version-build.<###>.tgz. For example, signature-tools-2.0.1-build.1.tgz
    4. signature-tools-latest-version-build.<###>.tgz.sha256.txt. For example, signature-tools-2.0.1-build.1.tgz.sha256.txt
  4. Execute the following commands to verify the checksum of the code signing tool before extracting it.
    $ (cd /root/VMwareSDWAN && cat $(ls -Art signature-tools-*.tgz.sha256.txt | \
    tail -n 1) | sha256sum --check)
    
    $ sudo tar xvfz $(ls -Art /root/VMwareSDWAN/signature-tools-*.tgz | \
    tail -n 1) -C /
  5. Verify the signature of Solutions .tgz files.
    $ /usr/local/sbin/SevOne-validate-image \
    -i $(ls -Art /root/VMwareSDWAN/sdwan-*.tgz | tail -n 1) \
    -s $(ls -Art /root/VMwareSDWAN/sdwan-*.tgz.sha256.txt | tail -n 1)
  6. Make a directory. For example, sdwan-vmware-installation.
    $ mkdir /root/VMwareSDWAN/sdwan-vmware-installation
  7. Extract the latest build.
    $ tar -xvfz $(ls -Art /root/VMwareSDWAN/sdwan-*.tgz | tail -n 1) -C /root/VMwareSDWAN/sdwan-vmware-installation

    You will see the following files in the folder.

    • VMwareSDWAN.MIBs.spk - It imports two VMwareSDWAN MIB files (VELOCLOUD-EDGE-MIB.mib and VELOCLOUD-MIB.mib).
    • VMwareSDWAN.Certification.spk - It creates one device type VMware SDWAN and 5 object types suffixed with (VeloCloud).
    • VMwareSDWAN.DeviceGroups.spk - It creates 1 device group.
    • VMwareSDWAN.ObjectGroups.spk - It creates 3 object group class (VMware SDWAN) and 3 Object Groups underneath it.
    • VMwareSDWAN.MetadataSchema.spk - It imports the metadata schema for VMware SDWAN devices.
    • VMwareSDWAN.Alert.Policies.spk - It imports 5 alert policies. All policies are imported as disabled by default.
    • VMwareSDWAN.TopNViews.spk - It imports 18 TopN Report views.
    • VMwareSDWAN-DI-OOTB-Reports.tar - It imports 1 SevOne Data Insight report and 3 Templates.
  8. Change directory to /root/VMwareSDWAN/sdwan-vmware-installation.
    $ cd /root/VMwareSDWAN/sdwan-vmware-installation
  9. Import the following .spk files in sequence.
    1. VMwareSDWAN MIBs
      $ SevOne-import --allow-overwrite --file VMwareSDWAN.MIBs.spk
    2. Device Type and Object Types
      $ SevOne-import --allow-overwrite --file VMwareSDWAN.Certification.spk
    3. Metadata Schema
      $ SevOne-import --allow-overwrite --file VMwareSDWAN.MetadataSchema.spk
    4. Device Groups
      $ SevOne-import --allow-overwrite --file VMwareSDWAN.DeviceGroups.spk
    5. Object Groups
      $ SevOne-import --allow-overwrite --file VMwareSDWAN.ObjectGroups.spk
    6. Alert Policies
      $ SevOne-import --allow-overwrite --file VMwareSDWAN.Alert.Policies.spk

      The following is the list of alerts imported.

      • VMware SDWAN - WAN Link - Packet Loss
      • VMware SDWAN - WAN Link - Latency
      • VMware SDWAN - WAN Link - Jitter
      • VMware SDWAN - VCG Path - Latency
      • VMware SDWAN - VCG Path - Packet Loss
      Important: All alerts are disabled by default.
    7. TopN Report Views

      Import on SevOne NMS

      $ SevOne-import --allow-overwrite --file VMwareSDWAN.TopNViews.spk

      The following is the list of TopN reports imported.

      • VMware SDWAN CPU Utilization
      • VMware SDWAN CPU Utilization - HostRes mib
      • VMware SDWAN HA Peer State
      • VMware SDWAN Link Jitter
      • VMware SDWAN Link Latency
      • VMware SDWAN Link Packet Loss
      • VMware SDWAN Link Packet Loss Pct
      • VMware SDWAN Link State
      • VMware SDWAN Link Utilization
      • VMware SDWAN Links
      • VMware SDWAN Memory Utilization
      • VMware SDWAN Memory Utilization - HostRes mib
      • VMWare SDWAN Path State
      • VMware SDWAN Path Utilization
      • VMware SDWAN Paths Jitter
      • VMware SDWAN Paths Latency
      • VMware SDWAN Paths Packet Loss
      • Device ICMP Reachability

SevOne Data Insight

OOTB Reports on SevOne Data Insight

Method #1 - Import via CLI

$ sevone-cli sdi reports load <REPORTS-TAR-FILE-PATH>

OR

Method #2 - Import via Data Insight

  1. Log in to your SevOne Data Insight machine by navigating to the appropriate URL in your browser.
  2. On the Report Manager screen, click Import button.
    VMware SD-WAN Import Button
  3. Click or drag file to upload. For example, VMwareSDWAN-DI-OOTB-Reports.tar.
    1. Select an apt datasource from the Datasource drop-down.
    2. Select the Assign each report to its original owner's username check box to assign the reports imported to its original owner's username.
    3. Click Upload.
      VMware SD-WAN Import OOTB
      Note:
      • Reports can only be imported from a .tar file. Other file extensions are not acceptable. If the file extension is not a .tar file then it will simply ignore the action.
      • Reports can be imported to the same or newer version of SevOne Data Insight as the one they were exported from, by drag and drop into Reports.
      • SevOne does not support the importing of reports from a newer to older version.

The following is the list of reports imported.

  • VMware SDWAN Dashboard
  • VMware SDWAN Path Summary
  • VMware SDWAN Link Summary
  • VMware SDWAN Site Summary

Device Onboarding

To onboard VMware devices in SevOne NMS, follow these steps:

  1. Enter the URL for the SevOne NMS appliance into your web browser to display the Login page. Enter your credentials on the login page and click Login.VMmware NMS Login Page
    VMware NMS Home Page
  2. From the navigation bar, click the Devices menu and select Device Manager .
    VMware Device Manager
  3. Click Add Device to display the New Device page.
    VMware Add Device
  4. On the New Device page, please add the following details.
    VMware New Device
    1. In the Name field, enter the device name.
    2. In the Alternate Name field, enter an alternate device name. You can search for a device by its alternate name.
    3. In the Description field, enter the device description. You can use this to provide additional information about the function, location, or any other pertinent information about the device.
    4. In the IP Address field, enter the device IP address.
    5. Click the plugin drop-down. By default, it is set to SNMP . Select SDWAN .
      1. Select the Enable SDWAN API Integration check box.
        VMware SDWAN Plugin
      2. Click the Vendor drop-down and select the VMWare option.
      3. In the VCO URL field, enter the URL for SDWAN vendor, VMWare.
      4. In the Username field, enter the username for SDWAN vendor, VMWare.
      5. In the Password field, enter the password for SDWAN vendor, VMWare.
      6. Enable field Auto-discover and monitor associated VMWare Edges - Use SNMP Plugin to automatically discover and monitor VMware devices.
    6. Click Save As New to save the current changes as a New Device.
    7. Once the SDWAN plugin is configured, from the plugin drop-down, select plugin SNMP.
      VMware SNMP Plugin
    8. Ensure that the field SNMP Capable check box is selected to enable the discovery of SNMP object types and to poll SNMP data on the device.
    9. Enter credentials (Username & Password) for VMware devices. (Make sure to have same SNMP credentials for all VMware Devices)
    10. Select other options and click Save As New to save the current changes as a New Device. This device is then queued for discovery.
    11. A new device has been added to the Device Manager screen.
    12. click the Devices menu and select Discovery Manager . Here, you will see the device is in the discovery queue.
    13. After the discovery process is completed, VMware devices will be visible on the Device Manager screen.
      VMware Devices
    14. To retrieve the metadata of a VMware SDWAN device, follow these steps:
      1. Choose a device from the list that you wish to view metadata for.
      2. Click Edit metadata in the Actions column to open the Edit Metadata pop-up.
      3. In the Edit Metadata pop-up, locate the section VMWare SDWAN DEVICE to find the metadata fields.
        VMware Metadata
        Important: Value for the following metadata attributes might differ in VMware and SevOne NMS.
        1. Authentication
        2. Service Up Since
        3. Software Updated
        4. System Up Since

Upgrade

To upgrade your VMware solution on SevOne NMS, follow these steps:

  1. If your SevOne NMS is not already on version 6.7, proceed to upgrade it to 6.7.
  2. Download the following (latest) files from IBM Passport Advantage (https://www.ibm.com/software/passportadvantage/pao_download_software.html) via Passport Advantage Online. However, if you are on a legacy / flexible SevOne contract and do not have access to IBM Passport Advantage but have an active Support contract, please contact IBM SevOne Support for the latest files.You must place <tar/zip> files in /root/VMwareSDWAN directory.
    1. sdwan-velocloud-installation-v6.7.0-build.2.tgz
    2. sdwan-velocloud-installation-v6.7.0-build.2.tgz.sha256.txt
    3. signature-tools-latest-version-build.<###>.tgz. For example, signature-tools-2.0.1-build.1.tgz
    4. signature-tools-latest-version-build.<###>.tgz.sha256.txt. For example, signature-tools-2.0.1-build.1.tgz.sha256.txt
  3. Execute the following commands to verify the checksum of the code signing tool before extracting it.
    $ (cd /root/VMwareSDWAN && cat $(ls -Art signature-tools-*.tgz.sha256.txt | \
    tail -n 1) | sha256sum --check)
    
    $ sudo tar xvfz $(ls -Art /root/VMwareSDWAN/signature-tools-*.tgz | \
    tail -n 1) -C /
  4. Verify the signature of Solutions .tgz files.
    $ /usr/local/sbin/SevOne-validate-image \
    -i $(ls -Art /root/VMwareSDWAN/sdwan-*.tgz | tail -n 1) \
    -s $(ls -Art /root/VMwareSDWAN/sdwan-*.tgz.sha256.txt | tail -n 1)
  5. Change directory to /root/VMwareSDWAN/sdwan-vmware-installation.
    $ cd /root/VMwareSDWAN/sdwan-vmware-installation
  6. Extract the latest build.
    $ tar -xvfz $(ls -Art /root/VMwareSDWAN/sdwan-*.tgz | tail -n 1) -C /root/VMwareSDWAN/sdwan-vmware-installation

    You will see the following files in the folder.

    • VMwareSDWAN.MIBs.spk - It imports two VMwareSDWAN MIB files (VELOCLOUD-EDGE-MIB.mib and VELOCLOUD-MIB.mib).
    • VMwareSDWAN.Certification.spk - It creates one device type VMware SDWAN and 5 object types suffixed with (VeloCloud).
    • VMwareSDWAN.DeviceGroups.spk - It creates 1 device group.
    • VMwareSDWAN.ObjectGroups.spk - It creates 3 object group class (VMware SDWAN) and 3 Object Groups underneath it.
    • VMwareSDWAN.MetadataSchema.spk - It imports the metadata schema for VMware SDWAN devices.
    • VMwareSDWAN.Alert.Policies.spk - It imports 5 alert policies. All policies are imported as disabled by default.
    • VMwareSDWAN.TopNViews.spk - It imports 18 TopN Report views.
    • VMwareSDWAN-DI-OOTB-Reports.tar - It imports 1 SevOne Data Insight report and 3 Templates.
  7. Import the VMwareSDWAN.MetadataSchema.spk file to import the metadata schema for VMware SDWAN devices .
    $ SevOne-import --allow-overwrite --file VMwareSDWAN.MetadataSchema.spk
  8. Perform the steps provided in the section Device Onboarding.
    Important:
    • Devices that were added manually in the past are not currently linked to the orchestrator. Any devices that were absent previously but are now present in the orchestrator will be automatically discovered and linked to the orchestrator during the discovery process.
    • After the VCO device discovery process is completed, it populates the value for metadata attribute Orchestrator name for VMware devices that were previously onboarded. Run the device discovery process for all existing devices to populate values for all metadata attributes associated with those devices. For the newly added devices by VCO, the metadata population happens once the discovery process is completed for them.

Solution Verification and Customization

Perform the following steps to log onto your SevOne NMS appliance. For more details, please refer to SevOne NMS System Administration Guide or SevOne NMS User Guide > section Login.

  1. Enter the URL for the SevOne NMS appliance into your web browser to display the Login page.
  2. Enter the credentials and click Login. For example, Username: admin and Password: SevOne
  3. To check MIB files imported, click the Administration menu, select Monitoring Configuration, and then select MIB Manager. For more details on MIB Manager, please refer to SevOne NMS System Administration Guide > section MIB Manager.
    VMware SD-WAN MIB Manager
  4. To check device groups imported, click the Devices menu and select Grouping, then Device Groups. For more details on Device Groups, SevOne NMS User Guide > section Device Groups.
    VMware SD-WAN Device Groups
  5. To check object groups imported, click the Devices menu, select Grouping , and then select Object Groups. For more details on Object Groups, SevOne NMS System Administration Guide > section Object Groups.
    VMware SD-WAN Object Groups
    Important: You can change the Object Group Membership Rules based on your network environment.
  6. Check VMware SDWAN OOTB reports imported on SevOne Data machine.
    VMware SD-WAN OOTB Reports

    The following is the list of reports imported.

    • VMware SDWAN Dashboard
    • VMware SDWAN Path Summary
    • VMware SDWAN Link Summary
    • VMware SDWAN Site Summary