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:
Supported HTTP methods: POST
Allowed roles: Administrator
Apache Geronimo
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=ApacheGeronimo&HostName=[HostName]&Port=[JMX PORT]&UserName=[Username]&Password=[password]&displayname=[Display Name]&JNDIPath=[JNDIPATH]
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 is generated from the Generate API Key option in the 'Admin' tab. |
| type | The type of monitor you want to add. Value should be 'ApacheGeronimo'. |
| displayname | The display name of the Apache Geronimo monitor. |
| HostName | The name of the host on which the Apache Geronimo server is running. |
| port | The port number where the Apache Geronimo server is running. |
| Port | The JMX Port of the Apache Geronimo server. |
| Username | The Username of the Apache Geronimo instance. |
| Password | The password of the Apache Geronimo instance. |
| JNDI Path | The JNDI Path of the server. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=ApacheGeronimo&host=app-xp2&port=8989&username=admin&password=appman&displayname=Apache Geronimo Server&JNDIPath=/jmxrmi
GlassFish
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&host=[HOST]&port=[PORT]&username=[USERNAME]&password=[PASSWORD]&displayname=[DISPLAYNAME]&JNDIPath=[JNDIPATH]
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 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 the 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. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=glassfish&host=app-xp2&port=8686&username=admin&password=appman&displayname=glfish&JNDIPath=/jmxrmi
JBoss Server
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&version=[VERSION]&authEnabled=[AUTHENABLED]&username=[USERNAME]&password=[PASSWORD]&LaunchType=[LAUNCHTYPE]&filterEnabled=[FILTER ENABLED/DISABLED]&filterCondition=[FILTER CONDITION]&AppServers=[APP 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 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 the 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 the authEnabled value is 'on'. |
| password | The password of the JBoss server. This should be specified only if the authEnabled value is 'on'. |
| LaunchType | Specifies the launch type of the JBoss server. Allowed values are DOMAIN and False (case-sensitive). Use DOMAIN when the server is running in domain mode. Use False for non-domain deployments. |
| filterEnabled | Specifies whether the filter is enabled while discovering and adding the monitor. Possible values are either true or false. |
| filterCondition | Specifies whether the servers are to be included or excluded while discovering and adding the monitor. Possible values are either include or exclude. |
| AppServers | The list of servers to be included or excluded based on the condition specified in the filterCondition parameter. It should be specified in the format "hostName1:serverName1,serverName2,serverName3....;hostName2:serverName1,serverName2,serverName3....". |
Sample Request
http://prod-server2:9090/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=JBoss server&displayname=AppmanagerJBoss4&host=app-xp2&port=8080&version=Wildfly_8.x&authEnabled=on&username=admin&password=appman&LaunchType=Falsehttp://prod-server2:9090/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=JBoss server&displayname=AppmanagerJBoss7_domain&host=app-win7-64-2&port=9990&version=7.x&authEnabled=on&username=admin&password=appman&LaunchType=DOMAIN&filterEnabled=true&filterCondition=include&AppServers=host1:Server11,Server12;host2:Server21,Server22,Server23
Jetty Server
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Jetty Server&host=[HostName]&port=[JMX PORT]&UserName=[Username]&Password=[password]&displayname=Jetty&JNDIPath=[JNDIPATH]
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 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 the 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. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Jetty Server&host=app-xp2&port=8686&username=admin&password=appman&displayname=jettymonitor&JNDIPath=/jmxrmi
Microsoft .NET
Syntax
https://[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 to 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. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=.Net&displayname=AppmanagerDotNet&host=app-xp3&username=admin&password=appman
Oracle Application Server
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&version=[VERSION]
Request Parameters
The parameters involved in the API request are described below. Also, refer to 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 the Oracle application server is running. |
| version | The version of the Oracle application server. Supported version is 10.1.3 |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=oracle application server&displayname=appmanageroracle&host=app-xp5&port=7200&version=10.1.3
Resin Server
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Resin&host=[HostName]&port=[JMX PORT]&UserName=[Username]&Password=[password]&displayname=Resin&JNDIPath=[JNDIPATH]
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 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 the 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. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=resin&host=app-xp2&port=8686&username=admin&password=appman&displayname=resinmonitor&JNDIPath=/jmxrmi
SilverStream
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST] &port=[PORT]
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 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. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=SilverStream&displayname=sl&host=myesuraj&port=8080
TongWeb Server
Syntax
http://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=TongWeb&displayname=[DISPLAYNAME]&host=[TARGET_HOST]&port=[TARGET_PORT]&jndiurl=[JNDI_URL]&sslenabled=[true|false]&username=[USERNAME]&password=[PASSWORD]
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 category type of the monitor you want to add. The value should be 'TongWeb'. |
| host | The name of the host where the TongWeb server is running. |
| port | The port number where TongWeb is running. |
| jndiurl | The JNDI path is used for connection purposes. Default value: '/jmxrmi'. |
| sslenabled | Specifies whether SSL is enabled. Accepts 'true' or 'false'. |
| username | The username used for authentication (required if authentication is enabled). |
| password | The password used for authentication (required if authentication is enabled). |
Sample Request
http://localhost:9001/AppManager/xml/AddMonitor?apikey=ca89d2e0bbb88390079d1e0fbb1c64d7&type=TongWeb&displayname=Test&host=Machine1&port=1099&jndiurl=/jmxrmi&sslenabled=false
Tomcat Server
Syntax
https://[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 to 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. |
| sslenabled | True if the SSL is enabled. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=tomcat server&displayname=appmanagertomcat&host=host&port=8080&username=admin&password=appman&version=5
VMware vFabric tc Server
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[ API Key ]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[ PORT ]&username=[USERNAME] &password=[PASSWORD]&JNDIPath=[JNDI Path]
Request Parameters
The parameters involved in the API request are described below. Also, refer to the list of common Request Parameters.
| Field | Description |
|---|
| type | Denotes the category type of the monitor you want to add. The value should be '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 VMware server. |
| JNDIpath | The JNDI path name. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=VMware vFabric tc Server&displayname=vFabric&host=app-centos32-2&port=6969&username=admin&password=appman&JNDIPath=/jmxrmi
WebLogic Server
Syntax
https://[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 to the list of common Request Parameters.
| Field | Description |
|---|
| type | Denotes the category type of the monitor you want to add. The value should be 'WEBLOGIC SERVER'. |
| host | The name of the host where 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, 10.x, 12.x, and 14.x (Versions 14 and above) |
| discoverOption | Indicates the way how the clusters and servers of WebLogic are to be monitored. Possible values are: - 0 - Clusters and servers will not be discovered.
- 1 - Clusters and servers will be discovered, but the metrics will not be monitored. (Will not count for licensing)
- 2 - Clusters and servers will be discovered and monitored.
|
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=WEBLOGIC SERVER&displayname=Appmanagerweblogic&host=app-linux1&port=7001&username=admin&password=appman&version=8.1&discoverOption=2
For SSL support over WebLogic:
Syntax:
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&username=[USERNAME]&password=[PASSWORD]&version=[VERSION]&sslenabled=[ISSSLENABLED]
Example:
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=WEBLOGIC SERVER&displayname=Appmanagerweblogic&host=app-linux1&port=7001&username=admin&password=appman&version=12.x&sslenabled=true
WebSphere Server
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&version=[VERSION]&mode=[MODE]&soapport=[SOAPPORT]
Request Parameters
The parameters involved in the API request are described below. Also, refer to the list of common Request Parameters.
| 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 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 5.x, 6.x, 7.x, 8.x, and 9.x |
| mode | The deployment mode of the server. Value is BASE (for Base Deployment) or ND (for Network Deployment). |
| ndhost | The name of the host where WebSphere is running for the Network Deployment mode. Applicable only when the value for mode parameter is ND. |
| ndport | The port number where WebSphere is running for Network Deployment mode. Applicable only when the value for mode parameter is ND. |
| soapport | The SOAP connector port. |
Sample Request
Base Deployment
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=websphere server&displayname=AppmanagerwebsphereBASE&host=app-w2k8r2-64ee&port=9082&version=9.x&mode=BASE&soapport=8880
Base Deployment With Global Security Enabled
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=websphere server&displayname=AppmanagerwebsphereBASE&host=app-w2k8r2-64ee&port=9082&version=9.x&mode=BASE&soapport=8880&authEnabled=true&username=admin&password=appman
Base Deployment With SSL Enabled
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=websphere server&displayname=AppmanagerwebsphereBASE&host=app-w2k8r2-64ee&port=9444&version=9.x&mode=BASE&soapport=8880&sslenabled=true
Network Deployment
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=websphere server&displayname=AppmanagerwebsphereND&host=app-w2k8r2-64ee&port=9081&version=9.x&mode=ND&soapport=8880&ndhost=app-w2k8r2-64ee&ndport=9082
