Release Notes SD-WAN 6.7.0 Collector
Below please find the Release Notes for SD-WAN 6.7.0 collector. Please contact your Technical Account Manager (if applicable) or Systems Engineering Team or Support Team to discuss and plan the installation. Thank you for being a customer.
Browser Requirements
Minimum Resolution:1200x768 Browsers:
- Modern, standards-compliant browser
- JavaScript enabled
- Pop-up blocker disabled for hostname/IP
The following browsers are supported in the current versions of SevOne.
Browser
Vendor | Family |
---|---|
Chrome | |
Mozilla | Firefox |
Resources and Requirements
Resource | Requirement | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
SevOne NMS | Please refer to Compatibility Matrix below for SevOne NMS versions supported. | ||||||||||||||||||||||||||||||||||||||||||||||||
Helm | 3.11.3 | ||||||||||||||||||||||||||||||||||||||||||||||||
Kubernetes | 1.27.1 (for upgrades) 1.27.1 (for new provisioning) Important: If
the installed Kubernetes version in your setup is not supported by SD-WAN collector you are
provisioning, you will get an error message. Kubernetes must be upgraded prior to upgrading
SD-WAN collector.
|
||||||||||||||||||||||||||||||||||||||||||||||||
SOA | >= 6.7.0 |
||||||||||||||||||||||||||||||||||||||||||||||||
Kernel | 3.10.0-1160.95.1.el7.x86_64 | ||||||||||||||||||||||||||||||||||||||||||||||||
Operating System | CentOS 7 | ||||||||||||||||||||||||||||||||||||||||||||||||
Ports Required | Please refer to SevOne NMS Port Number Requirements Guide > section Solutions Deployment. | ||||||||||||||||||||||||||||||||||||||||||||||||
VMware vSphere Client | >= 6.5 |
||||||||||||||||||||||||||||||||||||||||||||||||
Signature Tools |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Other |
|
Facts and Limitations
The following notes are some facts and limitations that you must be aware of.
The vManage overall rate limit is 450 requests per second. Currently, it has an API route related to device statistics which has a much lower rate limit of 43 requests per minute (or 0.72 requests per second). These rate limits are used as default rates in the Viptela collector configuration.
For the Viptela collector, each Agent has a vManage session.
Please refer to https://developer.cisco.com/docs/sdwan/#!browsing-returned-results-sorting-results-filtering-results-and-rate-limits/understanding-pagination for details.
Collector handles the case change scenario for vManage data. Migration script removes the device / object group rules and adds new case-insensitive rules in the next run of deviceDescription / objectDescription agent.
Limitations:
- Collector handles the case change only and not a complete name change.
- In case of device name changes, collector does not change the actual device name in SevOne NMS. However, it keeps pushing data in the existing device.
- In case of site / tenant name changes, collector does not update the device / object group name in SevOne NMS. However, it holds all the devices / objects available in the group.
- In case of interface name changes, collector does not update the interface, interface queue, or tunnel name. However, it keeps pushing data for that object.
- Collector does not support a scenario in which the device / interface name is same with a case difference in vManage. For example, device names, abc and ABC are not allowed.
When upgrading the collector from a newly deployed SD-WAN 2.9 or SD-WAN 2.10 OVA to SD-WAN 6.7, please perform the steps mentioned in SD-WAN Viptela Collector Troubleshooting Guide or SD-WAN Versa Collector Troubleshooting Guide > section Upgrade Collector.
Tunnel data is coming from two different sources (sdwanB2BSlamLog and monStatsLog). Hence, the data gap might be visible in SevOne NMS.
The SOA version on SevOne NMS must be >= 6.7.0 otherwise, the pre-checks will fail. SD-WAN 6.7 package contains (SOA 6.7.0) .rpm file. Execute the following command to upgrade the SOA version on SevOne NMS.
SOA Version
SOA must be on the latest version on all appliances in SevOne NMS cluster. Command Line Interface (CLI) must be used to upgrade SOA on all peers as the graphical user interface (GUI) only upgrades SOA for the NMS appliance you are connected to.
Execute the command to install / upgrade SOA only on NMS' Cluster Master and HSA
$ sevone-cli soa upgrade \
/opt/SevOne/upgrade/utilities/SevOne-soa-*.rpm
Execute the command to install / upgrade SOA on ALL peers in the NMS cluster
$ sevone-cli soa upgrade \
/opt/SevOne/upgrade/utilities/SevOne-soa-*.rpm \
--all-peers
Compatibility Matrix
Collector / Augmenter | SevOne NMS / NMS REST API | SOA Version | SevOne Data Insight | Widget Version | |
---|---|---|---|---|---|
NMS (CentOS) | REST API | ||||
6.7 |
6.7.0 (T & S) 6.5.0 - 6.6.0 (T & S) 6.4.0 (S) 6.3.1 (T & S) 6.1.0 (S) |
2.1.46 2.1.44 - 2.1.45 2.1.43 2.1.42 2.1.40 |
>= 6.7.0 |
6.7 (T & S) 6.6 (T & S) 6.5 (S) 3.13 - 3.14 (S) |
6.7.0 |
CONTROLLERS
Nuage | Versa | Viptela | Fortinet | VMware |
---|---|---|---|---|
- VSD 20.10.6 / API v5, v6 (T & S) - VSD 20.10.1 - .5 / API v5, v6 (S) - VSD 20.5.1 - .3 / API v5, v6 (S) - VSD 6.0.14 / API v5, v6 (S) - VSD 6.0.11 / API v5, v6 (S) - VSD 6.0.9 / API v5, v6 (S) - VSD 6.0.8 / API v5, v6 (S) - VSD 6.0.5 / API v5, v6 (S) - VSD 5.4.1 / API v5 (S) - VSD 5.2.3 / API v5 (S) - VSD 5.2.2 / API v5 (S) |
- 21.1.4 (T & S) - 20.2.3 (S) - 20.2.2 (S) - 16.1 R2 S11 (S) - 16.1 R2 S10.1 (S) - 16.1 R2 S9 (S) |
vManage:
- 20.11.1.1 (T & S) - 20.9.1 (S) - 20.6.4 (T & S) - 20.6.2.1 (S) - 20.5.1.2 (S) - 20.5.1 (S) - 20.4.1.1 (S) - 20.3.6 (S) - 20.3.5 (T & S) - 20.3.4.1 (S) - 20.3.4 (S) - 20.3.3.1 (S) - 20.3.1 (S) - 20.1.1 (S) - 19.2.2 (S) - 18.3.4 (S) vEdge: - 20.9.1 (T & S) - 20.6.1 - .2 (T & S) - 18.3.4 (S) cEdge: - 17.9.1 (T & S) - 17.6.02 (T & S) - 16.9.2 (S) |
v7.4.1 FortiManager | VMware SASE 5.4.0.0 |
Minimum resource needed on NMS: CPU: 4 or more RAM: 8GB or more HDD: 20GB or more |
Minimum resource needed on NMS: CPU: 4 or more RAM: 8GB or more HDD: 20GB or more |
Minimum resource needed on NMS: CPU: 4 or more RAM: 8GB or more HDD: 20GB or more |
Fortinet Plugin comes integrated with SevOne NMS. If there are specific NMS hardware sizing requirements, please contact IBM SevOne Support. | VMWare Plugin comes integrated with SevOne NMS. If there are specific NMS hardware sizing requirements, please contact IBM SevOne Support. |
- T & S - Tested & Supported
- S - Supported
- Please refer to Release Notes SevOne Data Insight for details.
SevOne NMS
- An administrator-level account in SevOne NMS. This is necessary in order for the SD-WAN Nokia-Nuage Networks Collector to communicate with SevOne NMS REST API.
- User name and password for the administrator-level account.
- IP address of the PAS.
- 20k (vPAS_20K_CentOS) appliance (minimum requirement).
Useful Guides
From IBM's Documentation Portal (https://www.ibm.com/docs/en/sevone-npm), please refer to the following SD-WAN / SevOne Data Insight guides for details.
SD-WAN Guides
General
- SD-WAN Collector Widgets for Data Insight Installation / Upgrade Guide
- SD-WAN Data Insight Widgets User Guide
- SD-WAN Variables & Report Linking Usage Guide
Fortinet
- SD-WAN Fortinet Solution Deployment / Configuration Guide
Nokia-Nudge Collector
- SD-WAN Nokia-Nuage Collector ES / VSD Mandatory Fields Guide
- SD-WAN Nokia-Nuage Collector Prerequisites & Common Questions
- SD-WAN Nokia-Nuage Collector Syntax & Semantics / Variable Mappings Guide
- SD-WAN Nokia-Nuage Networks Collector AMQP Alarms
- SD-WAN Nokia-Nuage Networks Collector Architecture & Technical Insights / Features Guide
- SD-WAN Nokia-Nuage Networks Collector Installation Guide
Versa Collector
- Deployment
- SD-WAN Versa Collector Prerequisites & Common Questions
- SD-WAN Versa Collector Pre-Deployment Guide
- SD-WAN Versa Collector Deployment / Configuration Guide
- SD-WAN Versa Collector Upgrade Process Guide
- Troubleshooting
- Automated Build / Rebuild (Customer) Instructions - SD-WAN Versa Collector
- SD-WAN Versa Collector Troubleshooting Guide
- SD-WAN Versa Collector Use-Cases Guide
- Others
- SD-WAN Versa Collector Advanced Use-Case Guide
- SD-WAN Versa Collector Agents Guide
- SD-WAN Versa Collector Syntax & Semantics / Variable Mappings Guide
Viptela Collector
- Deployment
- SD-WAN Viptela Collector Prerequisites & Common Questions
- SD-WAN Viptela Collector Pre-Deployment Guide
- SD-WAN Viptela Collector Deployment / Configuration Guide
- SD-WAN Viptela Collector Upgrade Process Guide
- Troubleshooting
- Automated Build / Rebuild (Customer) Instructions - SD-WAN Viptela Collector
- SD-WAN Viptela Collector Troubleshooting Guide
- SD-WAN Viptela Collector Use-Cases Guide
- Others
- SD-WAN Viptela Collector Advanced Use-Case Guide
- SD-WAN Viptela Collector Agents Guide
- SD-WAN Viptela Collector Syntax & Semantics / Variable Mappings Guide
- SD-WAN Viptela Collector vManage Mandatory Fields Guide
VMware
- SD-WAN VMware SDWAN Solution Deployment / Configuration Guide
SevOne Data Insight Guides
- Automated Rebuild (Customer) Instructions
- SevOne Data Insight Pre-Installation Guide
- SevOne Data Insight Installation Guide
- SevOne Data Insight Migrate Operating System & Data Guide
- SevOne Data Insight Upgrade Process Guide
- SevOne Data Insight Administration Guide
- SevOne Data Insight Troubleshooting / Debug / Tools Guide
- SevOne Data Insight User Guide
- SevOne Data Insight Appliance Insert
- SevOne Data Insight GraphQL Guide
- SevOne Data Insight Report Linking URL Specification Guide
New Features and Enhancements
- Implemented Self-Service Upgrade (SSU) support to facilitate fresh collector installations.
- Collector now creates a separate log file for each agent and a separate folder for each version.
- The following variables have been added.
- collectorConfig.vendor.disable_device_ip_update
- prechecks.dnc.enabled
- collectorConfig.collector_name
- When installing or upgrading the collector via Graphical User Interface (GUI), you now have the capability to access and modify advanced configuration settings alongside the default basic configuration fields within the Config stage. A new check box Show advanced config has been added to display advanced configuration settings.
- Collector now creates a separate log file for each agent and a separate folder for each version.
- A new configurable variable collectorConfig.collector_name has been added.
VMware
- SDWAN plugin now includes a new vendor VMware that creates an integration with VMware to create automated onboarding and metadata enrichment of VMware SDWAN devices.
Component/s | Key | Release Notes |
---|---|---|
SDWAN Solution, SDWAN-Viptela | SC-11180 | Viptela Collector: When installing or upgrading the collector via Graphical User Interface (GUI), you now have the capability to access and modify advanced configuration settings alongside the default basic configuration fields within the Config stage. A new check box Show advanced config has been added to display advanced configuration settings. |
SDWAN Solution, SDWAN-Viptela | SC-13357 | Viptela Collector: Collector now creates a separate log file for each agent and a separate folder for each version. To review the logs, log into the node IP (via SSH) where the collector pod is running, and then navigate to the directory /var/log/sdwan-viptela/<collector_name>/<build_version>. Here, you will find the main folder that contains all common logs, while agent-specific logs are located within their respective folders. Also, a new configurable variable collectorConfig.collector_name has been added to define collector name for this instance. |
SDWAN-Viptela | SC-14451 | Viptela Collector: Viptela Device Summary report (section Interface Statistics) now shows rx_kbps and tx_kbps instead of rx_octets and tx_octets indicators by default in the Out of the Box reports to match the data shown in vManage. |
SDWAN-Versa | SC-14566 | Versa Collector: The following changes have been made.
|
SDWAN-Versa | SC-14567 | Versa Collector: Device groups are now created during the first installation run by the DeviceDescriptionAgent, while Object groups are created an hour later, following a predefined schedule, by the ObjectDescriptionAgent. |
SDWAN-Nokia | SC-14669 | Nokia-Nuage Collector: Implemented Self-Service Upgrade (SSU) support to facilitate fresh collector installations. |
SDWAN Solution, SDWAN-Versa | SC-14708 | Versa Collector: A new configurable variable
collectorConfig.vendor.disable_device_ip_update has been added. The default value is
false.
|
SDWAN Solution, SDWAN-Versa | SC-14726 | Versa Collector: A new configurable variable
collectorConfig.vendor.disable_device_ip_update has been added. The default value is
false.
|
SDWAN Solution, SDWAN-Versa | SC-14736 | Versa Collector: Collector now creates a separate log file for each agent and a separate folder for each version. To review the logs, log into the node IP (via SSH) where the collector pod is running, and then navigate to the directory /var/log/sdwan-versa/<collector_name>/<build_version>. Here, you will find the main folder that contains all common logs, while agent-specific logs are located within their respective folders. Also, a new configurable variable collectorConfig.collector_name has been added to define collector name for this instance. |
SDWAN-Versa | SC-14751 | Versa Collector: Selfmon devices will now be pinned under the SDWAN device group. |
SDWAN Solution, SDWAN-Collection, SDWAN-Versa | SC-14799 | Versa Collector: A new variable prechecks.dnc.enabled has been added to enable/disable
DNC-related prechecks. The default value is true.
|
SDWAN Solution, SDWAN-Viptela | SC-14800 | Viptela Collector: Flow augmentor now creates a separate log folder for each version. To review the augmentor logs, log into the node IP (via SSH) where the augmentor pod is running, and then navigate to the directory /var/log/sdwan-viptela/<collector_name>/<build_version>/FlowAugmentor. |
SDWAN Solution, SDWAN-Viptela | SC-14823 | Viptela Collector: Added a precheck to validate the collector_name variable in the configuration file. It must be defined in the configuration file, cannot be left empty, and must be unique for each tenant. |
13 issues
Resolved Issues
Component/s | Key | Release Notes |
---|---|---|
SDWAN-Viptela | SC-12546 | Versa / Viptela Collectors: In case of an upgrade, the user-specified port numbers for both the Client and API are now functioning as intended. |
SDWAN Solution, SDWAN-Viptela | SC-13033 | Viptela Collector: Collector now does not create duplicate alerts in SevOne NMS even if it receives duplicate data from vManage APIs. |
SDWAN Solution, SDWAN-Viptela | SC-14059 | Viptela Collector: Collector deployment now supports worker node failures to prevent data loss in case of failover. |
SDWAN Solution, SDWAN-Viptela | SC-14235 | Viptela Collector: Value for cpu_utilization indicator now aligns with the values from vManage for versions > 20.6.2 and uses both cpu_user and cpu_system to calculate cpu_utilization. This was impacted by Cisco bug CSCwb42305, which was fixed as of Cisco SDWAN 20.6.4; however, versions older than 20.6.2 will still be using the older calculation of cpu_user_new to align with vManage. |
SDWAN Solution, SDWAN-Versa | SC-14618 | Viptela / Versa Collectors: During a fresh installation, the user-specified port numbers for both the Client and API are now functioning as intended. |
SDWAN-Versa | SC-14640 | Versa Collector: Versa OOTB report, Versa Summary Report, now displays data related to solution::selfmon objects as expected in the section Self Monitoring. |
SDWAN-Viptela | SC-14769 | Viptela Collector: Viptela OOTB report, Viptela Summary Report, now displays data related to solution::selfmon objects as expected in the section Selfmon. |
SDWAN-Fortinet | SC-14814 | Fortinet: The change to enable the ICMP plugin applies to newly created devices only. For existing FortiGate devices, the ICMP plugin is not enabled by default and must be enabled manually. |
SDWAN Solution, SDWAN-Versa | SC-15023 | Versa Collector: If collector encounters an error from vDirector while fetching WAN interfaces for one appliance, that error is logged in the error record, and data population for other appliances will continue without any interruption. |
9 issues
Known Issues
- The default interval for the updation of the augmenter cache is 24 hours. If a policy is changed
or added on vManage, it is necessary to update the cache forcefully to augment the flows correctly.
Please run the PolicyParserAgent to update the cache forcefully.Note: Applicable to Viptela Collector only.
-
$ kubectl exec <COLLECTOR_POD_ID> -- ./collector-viptela -run PolicyParserAgent
- To find the <COLLECTOR_POD_ID>, execute the following
command.
$ kubectl get pods
-
- Data gaps might be seen on the graphs in SevOne NMS for indicators of the objects of type SD-WAN
Device Health as they are being polled at different timestamps. For example, SevOne NMS shows the
data for the following indicators related to SD-WAN Device Health object.
- memory_utilization
- disk_utilization
- cpu_utilization
When querying data for these indicators from vManage, if the data is missing for any of the indicators, then the data gap might be visible in SevOne NMS. - If you are using SevOne NMS version < 5.7.2.23 (without the NMS-75375 hotfix), you may experience an impact on the performance of the collector. At a same time, collectors will not support tunnels > 10k.
- Widgets
- When the alternate name is enabled in SevOne Data Insight, Network Topology Widget 2.8.x / 2.9 does not show any tunnels for SD-WAN 2.6 collectors.
Component/s | Key | Known Issues |
---|---|---|
SDWAN Solution, SDWAN-Versa, SDWAN-Viptela | SC-10410 | Platform: Depending on the scale of the environment, Jaeger may quickly consume its allotted memory and in turn, restart. The maximum allotted memory can be adjusted when Jaeger is enabled. |
SDWAN-Versa | SC-14485 | Versa / Viptela Collectors: After deleting a deployment using the command sevone-cli
solutions stop_collector and attempting to reinstall the collector using the sevone-cli
solutions reload command, an error is encountered stating provided port is already
allocated. Workaround: Please try to deploy the collector after ~ 10 minutes, as Kubernetes requires some time to clean up stale ports. |
SDWAN Solution, SDWAN-Versa | SC-14565 | Versa Collector: Tunnel objects will be pinned to their respective object groups either after 24 hours or according to the discovery schedule in SevOne NMS. |
SDWAN-Viptela | SC-14941 | Viptela Collector: DeviceDescriptionAgent log displays the following error from SevOne
NMS device update API. Cannot update the device. Device is locked by SevOne-discover-devices. Workaround: Run DeviceDescriptionAgent on demand after all devices are discovered. |
SDWAN-Viptela | SC-14992 | Viptela / Versa Collectors: When installing / upgrading the collector via GUI, you can
proceed to the Upgrade SOA stage in the following scenarios:
|
SDWAN Cisco Catalyst | S1NPM-109664 | Viptela Collector: When the NEXT_HOP_IP field is not present in a flow, the following
fields will be set to Unknown.
|
SDWAN Cisco Catalyst | S1NPM-109666 | Platform: Flow data loss due to DeviceDescriptionAgent failure resulting in
PolicyParserAgent and NextHopTableAgent stop running as well.
Workaround:
|
SDWAN Cisco Catalyst | S1NPM-110676 | Viptela Collector: Upgrading the collector from version 6.7.5 or above to Red Hat Enterprise
Linux (RHEL) versions 6.8 or above fails with the error No package matching 'convert2rhel' found
because the yum metadata still refers to the previously installed CentOS
package. Workaround: Run the following command and repeat the upgrade process. For more details, please refer to SD-WAN Viptela Collector Upgrade Process Guide.
|
SDWAN Solution | S1NPM-112181 |
Interface statistics are not generated for the sub-interfaces; an expected behavior from Cisco. sdwan::device-interface objects for interfaces are created to provide interface statistics datapoints. Since the mapping is performed for interface objects available in SevOne NMS, the ifIndex is not renamed to interface name for the sub-interfaces in SevOne NMS > Administration > Flow Configuration > Flow Interface Manager. |
SDWAN Solution | S1NPM-112216 | The requester ID's data source is used to load the OOTB report during the post-check process.
However, if multiple users are present in SevOne Data Insight, the post-check task that loads OOTB
reports is expected to fail. Workaround: By following these steps, you should be able to retrieve the requester's user datasource, update the post-checks, and complete the post-check process without any errors.
The task Execute script to load the OOTB report has now completed successfully. |
10 issues