Release Notes SD-WAN 7.0.0 Collector
Below please find the Release Notes for SD-WAN 7.0.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.
In SD-WAN guides if there is,
- [any reference to master] OR
- [[if a CLI command (for NMS or Kubernetes or Redis) contains master] AND/OR
- [its output contains master]], it means leader or control plane.
And, if there is any reference to slave or worker, it means follower or agent.
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) 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 | >= 7.0.0 |
||||||||||||||||||||||||||||||
| Kernel | 4.18.0-513.9.1.el8_9.x86_64 | ||||||||||||||||||||||||||||||
| 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 7.0.0, 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 >= 7.0.0 otherwise, the pre-checks will fail. SD-WAN 7.0.0 package contains (SOA 7.0.0) .rpm file. Execute the following command to upgrade the SOA version on SevOne NMS.
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.
$ sevone-cli soa upgrade \
/opt/SevOne/upgrade/utilities/SevOne-soa-*.rpm
$ 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 | REST API | ||||
| 7.0 |
7.0.0 (T & S) |
2.1.47 |
>= 7.0.0 | 7.0 (T & S) | 7.0.0 |
CONTROLLERS
| Versa | Viptela | Fortinet | VeloCloud |
|---|---|---|---|
|
|
vManage: |
v7.4.2 FortiManager (T & S) |
VMware SASE 5.4.0.1 (T & S) |
|
Minimum resource needed on NMS: |
Minimum resource needed on NMS: |
Fortinet Plugin comes integrated with SevOne NMS. If there are specific NMS hardware sizing requirements, please contact IBM SevOne Support. | VeloCloud 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.
- An administrator-level account in SevOne NMS.
- User name and password for the administrator-level account.
- IP address of the PAS.
- 20k (vPAS_20K) appliance (minimum requirement).
Useful Guides
From IBM's Documentation Portal (https://www.ibm.com/docs/en/sevone-npm), please refer to SD-WAN / SevOne Data Insight guides for this release for details.
Resolved Issues
| Component/s | Key | Release Notes |
|---|---|---|
| SDWAN VeloCloud | S1NPM-77453 |
VeloCloud: The following object has been added along with its associated indicators. Object: QoE - After Indicators:
|
| SDWAN-Versa | S1NPM-77523 | Versa Collector: When installing or upgrading the collector using Graphical User Interface (GUI), a check box Show advanced config is added in the Configure stage, to display advanced configuration settings, along with default basic configuration fields . |
| SDWAN-Versa | S1NPM-77597 | Versa Collector: collector_name variable has been removed from the example configuration file and replaced with deployment_name in the logging path for both the collector and augmenter. |
| SDWAN Cisco Catalyst | S1NPM-77636 | Viptela Collector: A new configurable variable collectorConfig.vendor.vmanage_api.proxy has been added that defines the proxy URL for vManage. The default value is " ". |
| SDWAN Cisco Catalyst | S1NPM-77665 | Viptela Collector: In addition to WAN interfaces, the new IOS-XE also includes support for tunnelxxx interfaces, sharing the same configurations with WAN interfaces. Also, the interface type iana-type-tunnel, associated with interfaces named Tunnelxxx, has been eliminated from the tunnel object creation, as these interfaces were generating unnecessary tunnels on SevOne NMS. |
| SDWAN VeloCloud | S1NPM-77676 |
VeloCloud: The following object has been added along with its associated indicators. Object: QoE - {Link Name}. The field Link Name dynamically appears based on the values returned from API calls to individual devices. Indicators:
|
| SDWAN Cisco Catalyst | S1NPM-100849 |
Viptela Collector: A new variable prechecks.dnc.enabled has been added to enable/disable DNC-related prechecks. The default value is true.
|
| SDWAN Solution, SDWAN Versa | S1NPM-100851 |
Versa 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-versa/<deployment_name>/<build_version>/FlowAugmentor/ |
| SDWAN Data Insight, SDWAN Solution | S1NPM-100883 | SD-WAN Widgets: Run the following command to delete old widgets.
|
| SDWAN Versa | S1NPM-100884 |
Versa Collector: The following metadata fields have been added to store the source and destination access circuits for tunnels.
|
| SDWAN VeloCloud | S1NPM-100902 | VeloCloud: Added support for displaying object-level metadata for link objects. |
| SDWAN Cisco Catalyst | S1NPM-100921 | Viptela Collector: A new configurable variable collectorConfig.vendor.vmanage_api.follow_redirects has been added to enable automatic following of HTTP redirects for vManage API calls. The default value is false. |
| SDWAN Cisco Catalyst | S1NPM-100922 | Viptela Collector: Site name is now mapped correctly to location-based device groups. After completing the mapping process, kindly remove any incorrectly created sites manually. |
| SDWAN Cisco Catalyst, SDWAN Versa | S1NPM-100943 | Versa / Viptela Collector: Added support for gathering evidence for troubleshooting purposes. |
| SDWAN Cisco Catalyst | S1NPM-100959 |
Viptela Collector: A new variable prechecks.dnc.enabled has been added to enable/disable DNC-related prechecks. The default value is true.
|
| SDWAN Viptela | S1NPM-102967 | Viptela Collector: DeviceDescriptionAgent runs automatically after all devices are discovered. |
| SDWAN Cisco Catalyst | S1NPM-103046 | Viptela Collector: PolicyParserAgent can now parse and remove inline comments when parsing data-prefix-list. |
| SDWAN Cisco Catalyst | S1NPM-108748 | Viptela Collector: collector_name variable has been removed from the example configuration file and replaced with deployment_name in the logging path for both the collector and augmenter. |
| SDWAN VeloCloud | S1NPM-108793 | VeloCloud: VMware is now using the name VeloCloud for its SD-WAN solution, previously called VMware SD-WAN. |
| SDWAN Versa | S1NPM-108844 | Versa Collector: Flow Object mapping will be created for all interfaces regardless of their state. |
| SDWAN Cisco Catalyst | S1NPM-109338 | Viptela Collector: Flow Object mapping will be created for all interfaces regardless of their state. |
21 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 Versa | S1NPM-77542 | 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 Cisco Analyst | S1NPM-77627 | Viptela / Versa Collectors: When installing / upgrading the collector via GUI, you can proceed to the Upgrade SOA stage in the following scenarios:
|
| SDWAN Solution, SDWAN Versa, SDWAN Cisco Catalyst | S1NPM-100519 | 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 Solution, SDWAN Versa | S1NPM-100816 | 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 Solution, SDWAN Versa | S1NPM-101078 |
Versa Collector: When upgrading the SD-WAN Versa Collector from version 2.15 or later to 7.0.0, you may encounter the following error. msg": "Timeout when waiting... To resolve this issue, perform the following steps:
|
| 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 Solution | S1NPM-110248 | Platform: In a multi-node, multi-vDirector setup, the Collector and Augmenter Evidence Framework is currently unable to collect evidence information or generate the .tar.gz file. However, the must-gather functionality continues to work as expected. |
| 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 Flow Interface Manager. |
| SDWAN Solution | S1NPM-112216 | Platform: 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 with the an error in the post-check output under the Execute script to load OOTB report task as shown. below.
Error: Type Error: "None Type" object is not subscriptable. 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. |
| SDWAN Versa | S1NPM-112339 | Versa Collector: When upgrading a single-node or multi-node Versa setup from version 6.8.x or later to 7.1.x, executing the command below may trigger an error, which is an expected behavior.
Workaround: Run the commands as shown below and proceed with the upgrade process.
Please refer to SD-WAN Versa Collector Upgrade Process Guide for details. |
| SDWAN Cisco Catalyst | S1NPM-112561 | Viptela Collector: When upgrading a multi-node Viptela setup from version 6.8.x or later to 7.1.x, executing the command below may trigger an error, which is an expected behavior.
Workaround: Rerun the command above and proceed with the upgrade process. Refer to SD-WAN Viptela Collector Upgrade Process Guide. |
| SDWAN Solution | S1NPM-113717 |
Platform: The MetadataAgent fails to complete metadata updates for devices/objects because its runtime exceeds the default 1hour timeout limit. As a result, the metadata is not accurately reflected in the device/object with the following error.
Workaround:
|
| SDWAN Solution | S1NPM-117472 | Device and object metadata may appear incomplete in SevOne NMS, with the Viptela / Versa Metadata Agent reporting the following message: 2024-06-24T16:49:37Z ERR agent run canceled error="context deadline exceeded" agent=MetadataAgent. |
14 issues