Reducing API calls sent from Aria Operations for Networks to NSX Managers

Products

• VMware Aria Operations for Networks

Issue/Introduction

Potential Issues with NSX Managers:

While working with NSX Managers, you may encounter the following issues:

1. API Rate Limiting: When making API calls against the NSX Managers, you might receive the following response:
   
   

   Response code '429 - Too Many Requests'.

   This indicates that the system has exceeded its maximum number of allowable API requests within a defined period.

2. Log Warnings: Upon reviewing the NSX Manager /var/log/syslog, you may notice a warning message similar to the following:
   
   

   "A new maximum of client API rate has exceeded 80% of the allowed limit. Max = 111, client = <NSX-T account credentials>, limit = 100".

   This log entry highlights that the client has reached or exceeded 80% of the allowed API rate limit, indicating a potential risk of hitting the maximum threshold.

Environment

VMware vRealize Network Insight 6.9
Aria Operations for Networks 6.10.0
Aria Operations for Networks 6.11.0
Aria Operations for Networks 6.12.0
Aria Operations for Networks 6.12.1
Aria Operations for Networks 6.13.0
Aria Operations for Networks 6.14.0

Resolution

In scenarios where the NSX Manager API rate limit is exceeded, it is typically due to an excessive number of API requests being made within a short time frame.

By default, NSX Manager supports up to 100 API calls per second for each manager node.

When NSX is configured as a data source within Aria Operations for Networks (AON), the system is optimized to make a maximum of 20 API calls per second per NSX Manager node. This ensures that AON consumes only 20% of the total NSX API rate bandwidth, allowing the system to operate efficiently without overloading the manager node's API capacity.

Important Considerations:

1. It is critical to note that Aria Operations for Networks is specifically configured to utilize no more than 20% of the total NSX API rate bandwidth by making 20 API calls per second per NSX manager node.
   
   
2. 20 API calls per second per NSX manager node is the optimal rate for AON to function efficiently and maintain key features such as below mentioned:
   
   Flow Monitoring
   Application Discovery
   Metrics Collection
   
   
3. Reducing the API rate from Aria Operations for Networks will impact above features, causing delays in data collection, which could affect the performance and accuracy of these functionalities.
   
   
4. Aria Operations for Networks recommend making any rate adjustments carefully, considering the trade-offs in system performance.
   
   
5. By maintaining the default configuration(20 API Calls), you ensure that Aria Operations for Networks operates within the ideal API call threshold for NSX, balancing performance and API bandwidth efficiently.
   
   
6. Keep in mind that this should only be done if absolutely necessary, as it may impact the system's functionality.

If you need to reduce the number of API calls from Aria Operations for Networks for any reason, this can be done via Aria Operations for Networks database.

Open a support case with Broadcom Support and refer to this KB article. For more information, see Creating and managing Broadcom support cases.