Advantages of API based Template over CLI

Advantages of API based Template over CLI

This article is based on the experience in regards to storage module with OpManager 

S.No
CLI
API
1
SSH is used
REST (http/https) is sued
2
End devices may have maximum connections limit in a specific time. Session idle timeout will affect OpManager's polling time and sometimes poll(s) will be missed.
Only session timeout which can be identified and a new session can be created/used
3
CLI Response will have character limit, if it exceeds the limit, we may need to execute multiple commands for a single entity. 
No such limitations
4
A separate parser needs to be written for parsing the CLI commands which increases memory usage and time for a single poll.
Well-framed response will be returned from the end device,(JSON/XML) which can be easily parsed by inbuilt parser in JAVA


On a larger scale, APIs are:

  • Faster by order of magnitude
  • Less prone to breakage
  • Return data in easily parsed format (usually JSON)

By considering all the above, we are introducing API Templates for the available devices and will deprecate CLI Templates in the future course. Any new enhancements/features will be introduced to API Templates only and not for deprecated CLI Templates. Hope this helps. 

                  New to ADSelfService Plus?

                    • Related Articles

                    • Creating custom script template in OpManager

                    • Notification Profile Migration

                      Once the upgrade is successfully done from 11600 to 12200, you would be seeing more notification profiles than you have actually created. Don't get panic. It is not a bug. It is one of the design changes we have been trying to do it in the past. ...
                    • Compatible modems for Modem based SMS in OpManager

                      We have announced End-of-Support for this feature on Oct 31 st 2018.  Please refer this forum post for details and other alternatives. https://pitstop.manageengine.com/portal/community/topic/end-of-support-for-modem-based-sms-and-appsms-notifications ...
                    • Discover a complete network (CIDR/Subnet based discovery)

                      To discover a complete network (CIDR/Subnet based discovery): For OpManager versions 125174 and above: Go to Settings - > Network Discovery -> New Discovery. Select the Subnet tab. Network IP: Specify the Network IP to be discovered. Select the ...
                    • Adding devices using SSH Key based authentication in OpManager

                      A SSH key is an access credential used in SSH protocol. It provides the same functionality as the user name & password except that it is much more reliable and cant be easily cracked. OpManager supports SSH key based authentication. To use a SSH key, ...