AddMonitor APIs - ERP


This section explains how to use the AddMonitor API to add monitors of the 'ERP' category type. The following monitors are supported:

Oracle EBS

Syntax for versions R11i and R12.0:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&SSL=[SSL]&Version=[version]

Syntax for versions R12.2.0 (Username and Password Mandatory):

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&SSL=[SSL]&Version=[version]&Username=[username]&Password=[pwd]

Request Parameters:

The parameters involved in the API request are described below. Also, refer to the list of common request parameters.

Field Description
type The type of the ERP server you want to add. Value should be OracleEBS.
host The name of the host in which Oracle EBS is running.
port The port number where the Oracle EBS is running.
SSL Indicates if SSL option is enabled. The value should be either yes or no.
Version The running version of the Oracle EBS (R11i, R12.0 or R12.2.0).
Username and Password Weblogic admin server credentials.

Sample Request:

http://prod-server5:9090/AppManager/xml/AddMonitor?apikey=4df5040d6db873dcdaf4359b259fd494&type=OracleEBS&displayname=oebs&host=app-xp2&port=80&SSL=no

SAP Server

Syntax:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&username=[USERNAME]&password=[PASSWORD]&systemnumber=[SYSTEMNUMBER]&logonClient=[LOGONCLIENT]&language=[LANGUAGE]&routerString=[ROUTERSTRING]

Request Parameters:

The parameters involved in the API request are described below. Also, refer to the list of common request parameters.

Field Description        
type The type of the ERP server you want to add. Value should be sap server.
host The name of the host in which SAP server is running.
username The user name used for accessing the SAP server.
password The password of the SAP server.
systemnumber The SAP system number.
logonClient The SAP logon client.
language The SAP logon language. Default value is en.
routerString The SAP Router String through which SAP Server is connected.(Optional)

Sample Request:

http://prod-server1:9090/AppManager/xml/AddMonitor?apikey=136edbeb3ccb83c6cc71df03ef273313&type=sap server&displayname=appmanagersap&host=app-xp1&username=BCUSER&password=minisap&systemnumber=00&logonClient=000&language=en&routerString=/H/it360-m4600-1

SAP CCMS

Syntax:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME] &host=[HOST]&username=[USERNAME]&password=[PASSWORD]&systemnumber=[SYSTEMNUMBER]&logonClient=[LOGONCLIENT]&language=[LANGUAGE]&monitorset=[MONITOR SET NAME]routerString=[ROUTERSTRING]

Request Parameters:

The parameters involved in the API request are described below. Also, refer to the list of common request parameters.

Field Description        
type The type of the ERP server you want to add. Value should be sap server.
host The name of the host in which SAP server is running.
username The user name used for accessing the SAP server.
password The password of the SAP server.
systemnumber The SAP system number.
logonClient The SAP logon client.
language The SAP logon language. Default value is en.
monitorset The CCMS Monitor Set name.
routerString The SAP Router String through which SAP Server is connected.(Optional)

Sample Request:

http://prod-server1:9090/AppManager/xml/AddMonitor?apikey=86f7324e6e1651f704da21f6c119d8a4&type=SAP CCMS&displayname=appmanagersapccms&host=amp-2k8r2-2&username=BCUSER&password=minisap1&systemnumber=00&logonClient=001&language=en&monitorset=SAP CCMS Technical Expert Monitors&routerString=/H/it360-m4600-1

Siebel Enterprise Server

Syntax:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE] &displayname=[DISPLAYNAME]&host=[HOST]os=[Windows=1,Linux=2,Solaris=3,AIX=4,HP-UX=5]&userName=[Host user name]&password=[password]&GatewayServer=[Siebel gateway server name]&EnterpriseServer=[Enterprise server]&SUserName=[siebel admin user]&SPassword=[]&InsDirectory=[siebel installation directory absolute path]&prompt=[bash prompt for unix based servers]

Request Parameters:

The parameters involved in the API request are described below. Also, refer to the list of common request parameters.

Field Description        
type The type of the ERP server you want to add. Value should be SiebelEnterpriseServer.
displayname The display name of the Siebel Server.
hostname The name of the host in which Siebel server is installed.
os The operating system on which the server is installed. Possible values are:
  • 1 - Windows
  • 2 - Linux
  • 3 - Solaris
  • 4 - AIX
  • 5 - HP-UX
username Siebel installed server username (user role with executable permission).
password Siebel installed server password.
GatewayServer The Siebel gateway server name.
EnterpriseServer The Siebel enterprise server.
SUserName The Siebel administrator user.
SPassword The Siebel Administrator Password
InsDirectory : The directory where Siebel is installed.

Sample Request:

http://prod-server5:9090/AppManager/xml/AddMonitor?apikey=817f0d4d4ae2edc2e3ee6b9aa27d0601&type=SiebelEnterpriseServer&displayname=test&HostName=aixserver&os=4&userName=root&password=a1X6Bm&GatewayServer=gate&EnterpriseServer=ent&SUserName=sadmin&SPassword=sadmin&InsDirectory=/home/guest/ramac&prompt=#

Microsoft Dynamics CRM / 365 (On-Premise)

Syntax:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOSTNAME]&Version=[VERSION NO]&username=[USERNAME]&password=[PASSWORD]&eventlog=[YES/NO]&pollinterval=[INTERVAL]

Request Parameters:

The parameters involved in the API request are described below. Also, refer to the list of common request parameters.

Field Description
apikey The key generated from the Generate API Key option in the 'Admin' tab.
type The type of the monitor you want to add. The value should be Microsoft Dynamics CRM.
host The Host Name or IP Address of the host where the Dynamics CRM/365 application runs.
displayname The Display Name of the Dynamics CRM/365 monitor.
UserName The UserName of the Host Machine. To monitor a Microsoft Dynamics CRM/365 application, use Administrator user account which has the permission to excute WMI queries on 'root\CIMV2' namespace of the Dynamics CRM/365 Server.
password The password of the above user who has the permissions to execute WMI Queries.
Version The version of the Dynamics CRM/365 Application. Possible values are: 2011, 2013, 2016 or Dynamics365

Sample Request:

http://prod-server6:9090/AppManager/xml/AddMonitor?apikey=1f9323d96809a1ff38c941e575b9507a8a&type=Microsoft Dynamics CRM&displayname=API CRM&host=192.18.3.75&Version=2013&username=apmcluster2012\administrator&password=pass&eventlog=NO&pollinterval=5

Microsoft Dynamics AX Monitor

Syntax

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST NAME]&Version=[VERSION NO]&UserName=[USERNAME]&Password=[PASSWORD]&AXServices=[AX SERVICES]&remoteSQL=[True/False]&SQLhostname=[SQL HOSTNAME]&SQLcredentialdetails=[SQL CREDENTIAL DETAILS]&SQLusername=[SQL USERNAME]&SQLpassword=[SQL PASSWORD]&pollinterval=[INTERVAL]

Request Parameters

The parameters involved in the API request are described below. Also, refer to the list of common request parameters.

Field Description
apikey The key generated from the Generate API Key option in the 'Admin' tab.
type The type of the monitor you want to add. The value should be MSDynamicsAX.
displayname .The display name of the AX application.
host The hostname or IP address of the host where the AX server runs.
Version The version of the Dynamics AX Application.
UserName The UserName of the AX server machine.
Password The password of the AX Server Machine.
AXServices The services to be monitored. (AOS, MSSQLSERVER, RpcSs, IISADMIN)
remoteSQL Denotes whether MSSQL is in remote server. (True/False)
SQLhostname The hostname of the remote SQL server.
SQLcredentialdetails Choose whether to use the credentials of AX server or to enter new credentials for SQL server. (AXcred/SQLcred)
SQLusername The username of the remote SQL server.
SQLpassword The password of the remote SQL server.

Sample Request

http://prod-4409:9210/AppManager/xml/AddMonitor?apikey=aca1b8f2f109e319f46733675983e847&type=MSDynamicsAX&displayname=AXTest&host=user-4409&Version=2012&UserName=user-4409&Password=Qwerty@123&AXServices=AOS,MSSQLSERVER,RpcSs,IISADMIN&remoteSQL=True&SQLhostname=user-4016&SQLcredentialdetails=SQLcred&SQLusername=user-4016\administrator&SQLpassword=Abcd@123&pollinterval=5