SD-WAN Viptela Collector Prerequisites & Common Questions

SevOne Documentation

All documentation is available from the IBM SevOne Support customer portal.

© Copyright International Business Machines Corporation 2023.

All right, title, and interest in and to the software and documentation are and shall remain the exclusive property of IBM and its respective licensors. No part of this document may be reproduced by any means nor modified, decompiled, disassembled, published or distributed, in whole or in part, or translated to any electronic medium or other means without the written consent of IBM.

IN NO EVENT SHALL IBM, ITS SUPPLIERS, NOR ITS LICENSORS BE LIABLE FOR ANY DAMAGES, WHETHER ARISING IN TORT, CONTRACT OR ANY OTHER LEGAL THEORY EVEN IF IBM HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, AND IBM DISCLAIMS ALL WARRANTIES, CONDITIONS OR OTHER TERMS, EXPRESS OR IMPLIED, STATUTORY OR OTHERWISE, ON SOFTWARE AND DOCUMENTATION FURNISHED HEREUNDER INCLUDING WITHOUT LIMITATION THE WARRANTIES OF DESIGN, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT.

IBM, the IBM logo, and SevOne are trademarks or registered trademarks of International Business Machines Corporation, in the United States and/or other countries. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on ibm.com/trademark.

About

This document provides a list of questions that SevOne requires the user to respond to prior to a fresh install or an upgrade. For details on compatibility, please refer to Release Notes SD-WAN Collector > Resources & Requirements > section Compatibility Matrix.

Network Requirements

  • Port exposed on Collector Server
    Inbound Port Description
    9995 Flow Augmentor input
  • Collector Outbound Connections
    Address Outbound Port Description
    vManage server 443 Viptela vManage API
    NMS server 443 NMS API
    NMS DNC server 9996 Flow Augmentor output

for Fresh Installs only

Prerequisites for Viptela Fresh Installs Only Response
1 Please provide the output of Viptela sizing script to confirm the license capacity of SevOne NMS. <enter results here>
2 Have you verified the checksum of the installer file?

Note: If you do not know how to verify the checksum, please refer to SD-WAN Viptela Upgrade Process Guide > section Upgrade Viptela Collector using Graphical User Interface > bullet 4. If you are still not able to verify the checksum, please contact IBM SevOne Support.		 Yes / No
3 Please provide the following information.
  1. NMS appliance IP address (NOTE: NMS cluster or appliance must be running.)
  2. Username for an administrator-level account
  3. Is password for NMS ready to share during the installation/upgrade session? (NOTE: Please ensure the graphical user interface (GUI) for API access and ssh passwords are available prior to the session.)
  4. IP address of SevOne DNC where the flows need to be sent.
  5. Port number for DNC where the flows are being sent. (NOTE: The default port number is 9996.)
  1. IP address:
  2. Username:
  3. Yes / No:
  4. DNC IP address:
  5. DNC port:
4 Please provide the following details related to vManage.
  1. IP address of targeted vManage
  2. Username for vManage (vManage credentials with admin-level read privileges)
  3. Is password for vManage ready to share during the session? (NOTE: Please ensure all 3 passwords are available prior to the session.)
  4. API port number of targeted vManage (NOTE: The default port number is 8443.)
  5. Protocol of targeted vManage (NOTE: The default protocol is https.)
  1. IP address:
  2. Username:
  3. Yes / No:
  4. API port:
  5. http / https:
5 Please provide the collector node IP address(es). <enter IP address(es)>
6 Does ICMP connectivity exist between the collector and the nameserver? Yes / No
7 Have you performed the health check on your SevOne NMS cluster to ensure that all critical services are up and running with no potential issues? If Yes, please share the results in the Response column.

NOTE: Execute SevOne-act check checkout --full-cluster command to perform the health check.
If you do not have access to shell prompt, please contact IBM SevOne support.		 <enter results here>
8 Have you checked the reachability of vManage from the collector PAS? Please circle one option in the Response column.

NOTE: Please check the reachability by running the following command: curl -u <vmanage_user>:<vmanage_password>--url "https:// vmanage_ip>:<vmanage_port>/dataservice/device" -k

If you do not have access to shell prompt, please contact IBM SevOne support.		 Yes / No
9 Please provide the Managed Service Provider (MSP) name for the configured vManage.

NOTE: MSP name is used to create a device group containing all devices which are created by the collector.		 <enter details here>
10 Please provide the Tenant / Enterprise Name available in vManage for the collection of data.

NOTE: To check the Tenant Name on vManage, go to Administration -> Settings -> Organization Name.		 <enter details here>
11 Do you want to distribute devices created by the collector among all or some peers of the NMS cluster?

NOTE: If you want to distribute devices to some peers only then, please provide the IP addresses / peer names of those selected peers in the Response column.		 <All / Some>

<If Some, please enter IP addresses / peer names of selected peers>
12 Do you want to monitor flow? Please circle one option in the Response column. Yes / No
13 Do you want to enable custom site grouping? Please circle one option in the Response column.

NOTE: Once enabled, you can create a custom site grouping using the device metadata. If the two devices have the same name (matching of name is case-insensitive), collector will create the site with the name from the REST API response.		 Yes / No
14 Do you want to prevent suffixing the device names (created by collector) with the tenant name? Please circle one option in the Response column. If yes, please ensure that all device hostnames are unique across all tenants.

NOTE: This setting cannot be changed in subsequent upgrades.		 Yes / No
15 Is NTP synchronization enabled on the PAS, collector/augmentor, and vManage? Please circle one option in the Response column. Yes / No
16 Please highlight any detail that must be addressed during the fresh installation session. <enter details>

for Upgrades only

Prerequisites for Viptela Upgrades Only Response
1 Please provide the output of Viptela sizing script to confirm the license capacity of SevOne NMS. <enter results here>
2 Please provide NPM version being installed. <enter version here>
3 Have you verified the checksum of the installer file?

Note: If you do not know how to verify the checksum, please refer to SD-WAN Viptela Upgrade Process Guide > section Upgrade Viptela Collector using Graphical User Interface > bullet 4. If you are still not able to verify the checksum, please contact IBM SevOne Support.		 Yes / No
4 Please provide the following information.
  1. NMS appliance IP address (NOTE: NMS cluster or appliance must be running.)
  2. IP address of SevOne DNC where the flows need to be sent.
  3. Port number for DNC where the flows are being sent. (NOTE: The default port number is 9996.)
  1. IP address:
  2. DNC IP address:
  3. DNC port:
5 Please provide the collector node IP address(es). <enter IP address(es)>
6 Does ICMP connectivity exist between the collector and the nameserver? Yes / No
7 Have you performed the health check on your SevOne NMS cluster to ensure that all critical services are up and running with no potential issues? If Yes, please share the results in the Response column.

NOTE: Execute SevOne-act check checkout --full-cluster command to perform the health check.
If you do not have access to shell prompt, please contact IBM SevOne support.		 <enter results here>
8 Is there any port available for GUI Installer and API?

NOTE:
  • The default port number for GUI Installer is 3000.
  • The default port number for API is 3001.
 <Yes / No>

<If Yes, please provide the port number for GUI Installer and API>
9 Please highlight any detail that must be addressed during the upgrade session. <enter details>