SD-WAN VeloCloud Solution Deployment / Configuration Guide

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

1. Using ssh, login to SevOne NMS appliance as support.

   $ ssh support@<SevOne NMS appliance IP address>

2. Change directory to /config/collectors/sdwan/velocloud/on the NMS appliance host.

   $ cd /config/collectors/sdwan/velocloud/

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 /config/collectors/sdwan/velocloud directory.
   1. sdwan-velocloud-installation-v7.0.0-build.<###>.tgz
   2. sdwan-velocloud-installation-v7.0.0-build.<###>.tgz.sha256.txt
   3. signature-tools-<latest-version>-build.<latest>.tgz
   4. signature-tools-<latest-version>-build.<latest>.tgz.sha256.txt
4. Execute the following commands to verify the checksum of the code signing tool before extracting it.

   $ (cd /config/collectors/sdwan/velocloud && cat $(ls -Art signature-tools-*.tgz.sha256.txt | \
   tail -n 1) | sha256sum --check)
   
   $ sudo tar xvfz $(ls -Art /config/collectors/sdwan/velocloud/signature-tools-*.tgz | \
   tail -n 1) -C /

5. Go to SevOne NMS container.

   $ sudo podman exec -it <nms_container_id_or_name> /bin/bash

6. Change directory /config/collectors/sdwan/velocloud/on the NMS pod.

   $ cd /config/collectors/sdwan/velocloud/

7. Verify the signature of Solutions .tgz. files.

   $ sh /usr/local/scripts/SevOne-validate-image -i $(ls -Art /config/collectors/sdwan/velocloud/sdwan-*.tgz | \
   tail -n 1) -s $(ls -Art /config/collectors/sdwan/velocloud/sdwan-*.tgz.sha256.txt | tail -n 1)

8. Extract the latest build.

   $ tar -xvf $(ls -Art /config/collectors/sdwan/velocloud/sdwan-*.tgz | tail -n 1) -C /config/collectors/sdwan/velocloud

   You will see the following files in the folder.

   • VeloCloudSDWAN.Certification.spk - it creates one device type VeloCloudSDWAN and 5 object types suffixed with (VeloCloud).
9. Replace the file VeloCloudSDWAN.Certification.spk in the spk directory /config/collectors/sdwan/velocloud/spk.

   $ cp VeloCloudSDWAN.Certification.spk /config/collectors/sdwan/velocloud/spk

10. Change directory to /config/collectors/sdwan/velocloud/spk.

    $ cd /config/collectors/sdwan/velocloud/spk

    You will see the following files in the directory.

    • VeloCloudSDWAN.MIBs.spk - it imports two VeloCloudSDWAN MIB files (VELOCLOUD-EDGE-MIB.mib and VELOCLOUD-MIB.mib).
    • VeloCloudSDWAN.Certification.spk - it creates one device type VeloCloud SDWAN and 5 object types suffixed with (VeloCloud).
    • VeloCloudSDWAN.DeviceGroups.spk - it creates 1 device group.
    • VeloCloudSDWAN.ObjectGroups.spk - it creates 3 object group class (VeloCloud SDWAN) and 3 Object Groups underneath it.
    • VeloCloudSDWAN.MetadataSchema.spk - it imports the metadata schema for VeloCloud SDWAN devices.
    • VeloCloudSDWAN.Alert.Policies.spk - it imports 5 alert policies. All policies are imported as disabled by default.
    • VeloCloudSDWAN.TopNViews.spk - it imports 22 TopN Report views.
    • VeloCloudSDWAN-DI-OOTB-Reports.tar - it imports 1 SevOne Data Insight report and 3 Templates.
11. Import the following .spk files in sequence.
    1. VeloCloudSDWAN MIBs

       $ SevOne-import --allow-overwrite --file VeloCloudSDWAN.MIBs.spk

    2. Device Type and Object Types

       $ SevOne-import --allow-overwrite --file VeloCloudSDWAN.Certification.spk

    3. Metadata Schema

       $ SevOne-import --allow-overwrite --file VeloCloudSDWAN.MetadataSchema.spk

    4. Device Groups

       $ SevOne-import --allow-overwrite --file VeloCloudSDWAN.DeviceGroups.spk

    5. Object Groups

       $ SevOne-import --allow-overwrite --file VeloCloudSDWAN.ObjectGroups.spk

    6. Alert Policies

       $ SevOne-import --allow-overwrite --file VeloCloudSDWAN.Alert.Policies.spk

       The following is the list of alerts imported.

       • VeloCloud SDWAN - WAN Link - Packet Loss
       • VeloCloud SDWAN - WAN Link - Latency
       • VeloCloud SDWAN - WAN Link - Jitter
       • VeloCloud SDWAN - VCG Path - Latency
       • VeloCloud SDWAN - VCG Path - Packet Loss
       Important: All alerts are disabled by default.

To onboard VeloCloud 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.
2. From the navigation bar, click the Devices menu and select Device Manager.
3. Click Add Device to display the New Device page.
4. On the New Device page, please add the following details.
   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.
         
      2. Click the Vendor drop-down and select the VeloCloud option.
      3. In the VCO URL field, enter the URL for SDWAN vendor, VeloCloud.
      4. In the Username field, enter the username for SDWAN vendor, VeloCloud.
      5. In the Password field, enter the password for SDWAN vendor, VeloCloud.
      6. In the Poll Frequency field, enter how often to poll the device. The default value is 10 minutes.
      7. Enable field Auto-discover and monitor associated VeloCloud Edges - Use SNMP Plugin to automatically discover and monitor VeloCloud 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.
   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 VeloCloud devices. (Make sure to have same SNMP credentials for all VeloCloud 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, VeloCloud devices will be visible on the Device Manager screen.
   14. To retrieve the metadata of a VeloCloud SDWAN device, follow these steps.
       1. From the list, select a device to view its metadata.
       2. Click in the Actions column to open the Edit Metadata pop-up.
       3. In the Edit Metadata pop-up, locate the section VeloCloud SDWAN DEVICE to find the metadata fields.
          Important: Value for the following metadata attributes might differ in VeloCloud and SevOne NMS.

          • Authentication
          • Service Up Since
          • Software Updated
          • System Up Since

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

If QoE data fails to generate post upgrade, then execute the steps below.

1. Check VeloCloud logs.

   $ /var/log/VeloCloud1/7.0.0-build.6/QoeAgent/VeloCloud1_QoeAgent_7.0.0-build.6.log

2. Check for the error mentioned below.

   {"name":"Orchestrator (VCO)","type":"Generic","old_ts":1716901953,"new_ts":1716901953,"ip":"0.0.0.0","automatic_creation":true,"objec2024-05-28T13!https://emoji.slack-edge.com/T27SFGS2W/12/9885a4ebae28a36a.png!33Z ERR SOA request error in /sevone.api.v3.Devices/Data error="rpc error: code = Unauthenticated desc = failed to a2024-05-28T13!https://emoji.slack-edge.com/T27SFGS2W/12/9885a4ebae28a36a.png!33Z ERR Error in objectTransport.CreateDeviceData error="rpc error: code = Unauthenticated desc = failed to authenti2024-05-28T13:23:33Z INF Sending SOA request... agent=QoeAgent endpoint=/sevone.api.v3.Metadata/ObjectTypes requestId=1

3. Restart SOA container.

   $ podman restart nms-nms-soa

4. RetrieveVeloCloud API key from Redis.
   • To Retrieve VeloCloud API Key.

     $ podman exec -it nms-nms-redis redis-cli keys "velocloudapiKeyV3*"

   • Access Redis Container.

     $ podman exec -it nms-nms-redis redis-cli

   • Delete VeloCloud API key from Redis (refer to step :To retrieve VeloCloud API key from Redis).

     $ DEL<VeloCloud key retrieved from previous step>