|
ManageEngine® Applications Manager AddMonitor API - Application Servers | ||
This section explains how to use the AddMonitor API to add monitors of the 'Application Servers' category. The following application servers are supported:
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. Value should be '.Net'. |
| host | The name of the host where the .Net server is running. |
| username | The username of the .Net server. |
| password | The password of the .Net server. |
http://prod-server5:9090/AppManager/xml/AddMonitor?apikey=4df5040d6db873dcdaf4359b259fd494&type=.Net&displayname=AppmanagerDotNet&host=app-xp3&username=administrator&password=vembu
Adding a new monitor from an Admin server in the Enterprise Edition When adding a new monitor from an admin server in the Enterprise Edition, the user can select the Managed server of his preference. Know more about the mandatory parameters to be appended. |
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. Value should be 'glassfish'. |
| host | The name of the host where the GlassFish server is running. |
| port | The port number where GlassFish server is running. |
| username | The username of the GlassFish server. |
| password | The password of the GlassFish server. |
| JNDIPath | The JNDI path name. For example, the JNDIPATH for default installations of GlassFish is /jmxrmi. |
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. Value should be 'JBoss server'. |
| host | The name of the host where the JBoss server is running. |
| port | The port number where JBoss server is running. |
| version | The version of the JBoss server. Supported versions include 3.2.x, 4.x, 4.0.1, 4.0.2, 5.x, 6.x , 7.x and Wildfly_8.x . |
| authEnabled | Denotes whether authentication is enabled in the JBoss server. Value should be either 'on' or 'off' |
| username | The username of the JBoss server. This should be specified only if authEnabled value is 'on'. |
| password | The password of the JBoss server. This should be specified only if authEnabled value is 'on' |
| LaunchType | The launch type of the JBoss server. Value should be 'DOMAIN', if JBoss server is started as domain. This is applicable for version 7.x and above, else value can be 'STANDALONE' or optional. |
| HostController | The host controller name of the JBoss server, eg., master/slave. This should be specified only if LaunchType is 'DOMAIN'. |
| ServerName | The server name specified for the JBoss server running under the host controller, eg, server-one/server-two. This should be specified only if LaunchType is 'DOMAIN'. |
2.http://prod-server2:9090/AppManager/xml/AddMonitor?apikey=136edbeb3ccb83c6cc71df03ef273313
&type=JBoss server&displayname=AppmanagerJBoss7_domain&host=app-win7-64-2&port=9990&version=7.x&authEnabled=on&username=domain&password=appman&LaunchType=Domain&HostController=master&ServerName=server-one
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. If you want to add an Oracle application server monitor, specify the value as 'oracle application server'. |
| host | The name of the host where the Oracle application server is running. |
| port | The port number where Oracle application server is running. |
| version | The version of the Oracle application server. Supported version is 10.1.3 |
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. Value should be Resin. |
| host | The name of the host where the Resin server is running. |
| port | The port number where Resin server is running. |
| username | The username of the Resin server. |
| password | The password of the Resin server. |
| JNDIPath | The JNDI path name. For example, the JNDIPATH for default installations of Resin is /jmxrmi. |
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. Value should be 'SilverStream' |
| host | The name of the host where the SilverStream server is running. |
| port | The port number where the SilverStream server is running. |
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 'tomcat server'. |
| host | The name of the host where the Tomcat server is running. |
| port | The port number where Tomcat is running. |
| username | The username of the Tomcat server. |
| password | The password of the Tomcat server. |
| version | The version of the Tomcat server. Supported version is 5 and above. |
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 VMware vFabric TC Server. |
| host | The name of the host where VMware is running. |
| port | The port number where VMware is running. |
| username | The username of the VMware server. |
| password | The password of the WebLogic server. |
| JNDIpath | The JNDI path name. |
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 'WEBLOGIC SERVER'. |
| host | The name of the host where the WebLogic is running. |
| SSL enabled | Option to enable SSL (applicable for version 9 and above). |
| port | The port number where WebLogic is running. |
| username | The username of the WebLogic server. |
| password | The password of the WebLogic server. |
| version | The version of the WebLogic server. Supported versions include 6.1, 7.0, 8.1, 9.x and 10.x |
Rest API:
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]
Example:
http://app-windows:9090/AppManager/xml/AddMonitor?apikey=136edbeb3ccb83c6cc71df03ef273313&type=WEBLOGIC SERVER&displayname=Appmanagerweblogic&host=app-linux1&port=7001&username=weblogic
&password=weblogic&version=10.x&sslenabled=true
| Field | Description |
|---|---|
| type | Denotes the category type of the monitor you want to add. The value should be 'websphere server'. |
| host | The name of the host where the WebSphere is running. |
| port | The port number where WebSphere is running. |
| username | The username of the WebSphere server. |
| password | The password of the WebSphere server. |
| version | The version of the WebSphere server. Supported versions include 6.x |
| mode | The deployment mode of the server. Value is 'BASE' |
| soapport | The SOAP connector port. |
Base Deployment
http://prod-server4:9090/AppManager/xml/AddMonitor?apikey=136edbeb3ccb83c6cc71df03ef273313&type=websphere server&displayname=AppmanagerwebsphereBASE&host=app-w2k8r2-64ee&port=9082&version=8.x&mode=BASE&soapport=8880
Base Deployment With Global Security Enabled
http://prod-server4:9090/AppManager/xml/AddMonitor?apikey=136edbeb3ccb83c6cc71df03ef273313&type=websphere server&displayname=AppmanagerwebsphereBASE&host=app-w2k8r2-64ee&port=9082&version=8.x&mode=BASE&soapport=8880&authEnabled=true&username=admin&password=123
Base Deployment With SSL Enabled
http://prod-server4:9090/AppManager/xml/AddMonitor?apikey=136edbeb3ccb83c6cc71df03ef273313&type=websphere server&displayname=AppmanagerwebsphereBASE&host=app-w2k8r2-64ee&port=9444&version=8.x&mode=BASE&soapport=8880&sslenabled=true
Network Deployment
http://prod-server4:9090/AppManager/xml/AddMonitor?apikey=136edbeb3ccb83c6cc71df03ef273313&type=websphere server&displayname=AppmanagerwebsphereND&host=app-w2k8r2-64ee&port=9081&version=8.x&mode=ND&soapport=8880&ndhost=app-w2k8r2-64ee&ndport=9082
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. Value should be Jetty Server. |
| host | The name of the host where the Jetty server is running. |
| port | The port number where Jetty server is running. |
| username | The username of the Jetty server. |
| password | The password of the Jetty server. |
| JNDIPath | The JNDI path name. For example, the JNDIPATH for default installations of Jetty is /jmxrmi. |
AddMonitor API |
AddMonitor API - Cloud Apps |