|
ManageEngine® Applications Manager 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:
Versions Supported: 2007, 2010 and 2013
Syntax:
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]
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:
|
| Powershell (optional): | Specifies if Powershell is enabled. Possible values are:
|
| Service (optional): | The service details. Possible Values are:
|
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
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 |
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. |
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 |
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST] &port=[PORT]&username=[USERNAME]&password=[PASSWORD]
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. |
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]
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:
|
| 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). |
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST] &SNMPPORT=[PORT]&snmpCommunityString=[COMMUNITYSTRING]&timeout=[TIMEOUT]
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. |
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
Syntax:
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[LyncServer]&displayname=[DISPLAYNAME]&host=[HOST]&username=[USERNAME]&password=[PASSWORD]&Roles=[Roles]
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 LyncServer. |
| host | The Host Name or IP Address of the host where the Lync Server runs. |
| displayname | The Display Name of the monitor. |
| UserName | The UserName of the Lync Account used to monitor the Lync Server. The ,account should have administrator privileges to access Lync Server. |
| password | The password of the above user who has administrator privileges to access Lync Server. |
| Roles | Provide the role(s) that you wish to monitor as comma separated values :
|
http://app-xp5:9090/AppManager/xml/AddMonitor?apikey=4787dvds8941bc5a7b0db85d43a5b789&type=LyncServer&displayname=LyncAPI&host=172.31.10.1&UserName=APM\administrator&Password=pass&Roles=FrontEndServer,A/V Conferencing Server,MediationServer
AddMonitor API - Mail Servers |
AddMonitor API - Servers |