Introduction
To help manage VeloCloud API rate limits—especially in environments with large data volumes, a new Use Optimized API Version (Recommended) option is available on the integration page.
When this option is enabled and a polling frequency is configured, the listed metrics are collected once at the integration level for all resources, based on the selected frequency. This occurs regardless of:
- Resource-level polling frequencies, and
- Whether templates containing these metrics are assigned to individual resources.
This optimization uses VeloCloud Enterprise-level APIs to retrieve data for all resources in a single request, dramatically reducing overall API usage and helping avoid 429 Rate Limit errors.
Below metrics are collected by default when this option is enabled:
vmware_sdwan_Edge_Statusvmware_sdwan_Edge_HA_Statusvmware_sdwan_Link_Statusvmware_sdwan_Link_VPN_Statevmware_sdwan_Link_Effective_Statevmware_sdwan_Link_Jittervmware_sdwan_Link_Latencyvmware_sdwan_Link_Bandwidthvmware_sdwan_Link_BandwidthPercentagevmware_sdwan_Link_Bytes_Sentvmware_sdwan_Link_Packet_Lossvmware_sdwan_Link_Packets_Sentvmware_sdwan_Link_Bytes_Receivedvmware_sdwan_Link_Packets_Receivedvmware_sdwan_Link_SignalStrengthvmware_sdwan_Link_Throughput
For alerting to work on this metrics, template should be applied for the particular resource and alert thresolds should be configured.
Note
- The existing VeloCloud integration will continue to operate exactly as it does today. Nothing will change for currently installed integrations unless the user explicitly chooses to enable the new option. If they do not want the new option, they can disable it at any time. It is entirely up to the user whether they want to use it or not; if they decide against it, they can always revert to the previous API version. This flexibility will remain available for all customers.
- The new capability—using Enterprise-level APIs—applies only when the user selects this option during the installation of the integration or edits an existing integration to enable it. Users must also choose the frequency at which these metrics are collected. One frequency applies to the entire set of metrics.
- Since existing customers may or may not want this new behaviour, the decision is left entirely to them. Any customer who already has the Velocloud integration installed and wants to use this feature must update their integration, enable the option, select the desired collection frequency, and save the configuration. Once updated, the new settings will take effect.