Omnissa Horizon REST api throttling maximums

Some people who read release notes will have noticed that the last few version of Horizon have a api limit these days for the rest api’s. With soap being depracated and the q3 release of this year probably being the last that will have soap api in it these maximums have become very relevant. As I was working on moving The ControlUp for VDI api implementation to rest api I asked Omnissa support for what the actual maximums are.

In the picture below you can find the default maximums per 60 seconds and keep in mind that every page counts as an api call so it’s important to keep page sizes as big as possible.

If you want to change the maximums this is the documentation that I received for it courtesy of the great support from Omnissa

Create an object of type pae-APIThrottlingRules under OU=Properties,OU=APIThrottlingRules with the cn name in the format <category><resource><httpMethod> eg for Inventory/v*/desktop-pools , cn can be InventoryDesktopPoolsList, for inventory/v*/desktop-pools/{id}, cn can be InventoryDesktopPoolsGet

In the object populate the following attributes:

  • pae-Enabled – by default the rule will be enabled. Set to 0 to disable the rule.
     
  • pae-APIEndpoint – endpoint on which API throttling needs to be applied, replace V1,V2 with v* and any path param with {id}. keep everything in lowercase.
  • Few examples – config/v*/gateways, config/v*/gateways/{id}, federation/v*/pods/{id}/endpoints/{id}
  • pae-HttpMethod – REST HTTP method for the API denoted by number as follows
    • 0 – GET
    • 1 – DELETE
    • 2 – POST
    • 3 – PUT
  • pae-ThrottlingRules – no of request allowed in time duration (in seconds).
    • MaxRequests=<no of requests allowed>,TimePeriodSecs=<time in seconds>

Add all the rules under OU=Properties,OU=APIThrottlingRules. Once done, Notify the server to take up the latest rules from LDAP.

  1. Set pae-APIThrottlingRefresh to 1 under OU=Properties,OU=Global,CN=Common
  2. Server will set pae-APIThrottlingRefresh to 0 once rules are updated in the server.

    to connect to ldap see this kb article: https://kb.omnissa.com/s/article/2012377?lang=en_US&queryTerm=connect%20to%20ADAM

    Bookmark the permalink.

    Comments are closed.