ManageEngine® Applications Manager


AddMonitor API - Middleware/Portal

<< Prev

Home

Next >>

AddMonitor API - Middleware/Portal

 

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

MS Office SharePoint

 

Versions Supported: 2007, 2010 and 2013

 

Syntax:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]
&displayname=[DISPLAYNAME]&host=[HOST]&username=[USERNAME]&password=[PASSWORD]Version=[SHAREPOINT VERSION]&SPType=[SHAREPOINT TYPE]&Powershell=[IS POWERSHELL ENABLED]& Services=[SHAREPOINT SERVICES]

 

Request Parameters:

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


Field Description        
type The type of the monitor you want to add. Value should be MSOfficeSharePointServer.
host The name of the host where the Office SharePoint server is running.
username The user name of the SharePoint server .
password The password of the SharePoint server.t
SPType

The SharePoint server type. Possible Values are:

  • Farm -If the server has a Farm setup.
  • SPServer-If the server has a Stand Alone setup.
Powershell (optional):

Specifies if Powershell is enabled. Possible values are:

  • True - If powershell is enabled.
  • False - If powershell is not enabled.
Service (optional):

The service details. Possible Values are:

  • For Version 2007 - ExcelServices / DocumentConversions / OfficeSearchGatherer
  • For Version 2010 & 2013 - SharepointServices / ContentDB / WebApplication / TimerJobs / AccessServices / InfoPathServices / VisioWebAccess Services / ExcelServices / OfficeSearchGatherer

Sample Request:

http://prod-server5:9090/AppManager/xml/AddMonitor?apikey=4df5040d6db873dcdaf4359b259fd494&type=MSOfficeSharePointServer&displayname=ms&host=app-server&username=administrator&password=admin123&Version=2010&SPType=SPServer&Powershell=True& Services=SharepointServices,ContentDB,WebApplication,TimerJobs,AccessServices,InfoPathServices,VisioWebAccess Services,ExcelServices,OfficeSearchGatherer

Top

WebLogic Integration

Syntax:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]
&host=[HOST]&port=[PORT]&username=[USERNAME]&password=[PASSWORD]&version=[VERSION]

 

Request Parameters:

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


Field Description        
type The type of the monitor you want to add. Value should be WebLogic Integration.
host The name of the host where the WebLogic Integration server is running.
port The port number where the WebLogic Integration server is running.
username The user name of the WebLogic Integration server .
password The password of the WebLogic Integration server.
version The WebLogic Integration server version. Value is 8.1

Sample Request:

http://prod-server3:9090/AppManager/xml/AddMonitor?apikey=136edbeb3ccb83c6cc71df03ef273313
&type=WebLogic Integration&displayname=apm&host=app-server&port=7001&username=weblogics&password=weblogic&version=8.1

Top

IBM WebSphere MQ

Syntax:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]
&host=[HOST]&listenerport=[PORT]&displayname=[USERNAME]&serverconnectionchannel=[SERVERCONNECTIONCHANNEL]&QueueManager=[QUEUEMANAGER]

 

Request Parameters:

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


Field Description        
type The type of the monitor you want to add. Value should be IBM WebSphere MQ.
host The name of the host where the WebSphere MQ server is running.
listenerport The listener port number of the IBM WebSphere MQ server.
displayname The display name of the monitor.
serverconnectionchannel The server connection channel through which the WebSphere MQ clients communicate.

Sample Request:

http://prod-server8:9090/AppManager/xml/AddMonitor?apikey=bc76b1abb8e9b209824a39d84578a194&type=IBM%20Websphere%20MQ&host=app-server&listenerport=1416&displayname=mqws&serverconnectionchannel=SCCHANEL1&QueueManager=QMANAGER_QA1

Top


Microsoft Message Queue (MSMQ)

Syntax:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]
&host=[HOST]&username=[USERNAME]&password=[PASSWORD]

 

Request Parameters:

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


Field Description        
type The type of the monitor you want to add. Value should be Microsoft MQ.
host The name of the host where the Microsoft MQ server is running.
username The username of the MSMQ server
password The password of the MSMQ server

Sample Request:

http://prod-server8:9090/AppManager/xml/AddMonitor?apikey=256d041620d0aee9901558b44706dc84
&type=Microsoft MQ&displayname=msmq&host=app-server&username=administrator&password=password

Top


 

RabbitMQ

 

Syntax:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST] &port=[PORT]&username=[USERNAME]&password=[PASSWORD]

 

Request Parameters:

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


Field Description        
type Denotes the category type of the monitor you want to add. The value should be as 'RabbitMQ'.
host The name of the host where the RabbitMQ server is running.
port The port number where RabbitMQ server is running.
username The username of the RabbitMQ server server.
password The password of the RabbitMQ server server.

 

Sample Request:

http://app-xp5:9090/AppManager/xml/AddMonitor?apikey=bc76b1abb8e9b209824a39d84578a194&type=VMware vFabric tc Server&displayname=vFabric&host=app-server&port=6969&username=admin&password=admin123&JNDIPath=/jmxrmi

 

Top

 

 

Microsoft BizTalk

 

Syntax:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST] &port=[PORT]&username=[USERNAME]&password=[PASSWORD]&PowerShell=[True/False]&DBServer=[DB Server Name]&DBName=[DB Name]

Request Parameters:

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


Field Description        
type The category type of the monitor you want to add. The value should be BizTalkServer.
host The name of the host where where BizTalk is installed.
username The username of the BizTalk server host machine.
password The password of the BizTalk server host machine.

PowerShell

Is powershell enabled? Values are:

  • True - powershell is enabled
  • False - powershell is disabled
DBServer The name of the server where the configuration database is stored (required only if PowerShell is enabled).
DBName The name of the configuration database (required only if PowerShell is enabled).

Sample Request:

http://app-xp5:9090/AppManager/xml/AddMonitor?apikey=a169e7aa3b4656d0db29532fd4347&type=BizTalkServer&displayname=BizTalk2010&host=it360-k8r2s-2&UserName=it360-k8r2s-2\administrator&Password=pass123&PowerShell=True&DBServer=k8r2s-2&DBName=BizTalkdb

 

Top


Oracle Tuxedo

 

Syntax:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST] &SNMPPORT=[PORT]&snmpCommunityString=[COMMUNITYSTRING]&timeout=[TIMEOUT]

 

Request Parameters:

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


Field Description        
type The category type of the monitor you want to add. The value should be Oracle Tuxedo.
host The name of the host where where Tuxedo is installed.
displayname The Display Name of the monitor.
SNMPPORT The SNMP port number , on which the Tuxedo SNMP agent is running. The default port number is 161.

snmpCommunityString

The SNMP community string of Tuxedo SNMP agent. The default value is 'public'. Make sure you use a community string, that has at least 'Read-only' privileges.

timeout The timeout in seconds.

Sample Request:

http://app-xp5:9090/AppManager/xml/AddMonitor?apikey=a169e7aa3b4656d0db29532fd4347&type=Oracle Tuxedo&displayname=Tuxedo&host=172.31.10.1&SNMPPORT=161&snmpCommunityString=public&timeout=40

 

Top

 

<< Prev

Home

Next >>

AddMonitor API - Mail Servers

AddMonitor API - Servers