This section explains how to use the AddMonitor API to add monitors of the category type 'Database Servers'. The following databases are supported:
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]
&username=[USERNAME]&host=[HOST]&password=[PASSWORD]&port=[PORT]&instance=[INSTANCE]&useSSL=[true/false]
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 database you want to add. Value should be db2. |
| username | The user name of the user who has permission to access the DB2 database. |
| host | The name of the host in which DB2 is running. |
| password | The password of the user who has permission to access the DB2 database. |
| port | The port number where DB2 is running. |
| instance | The database/instance name. |
| useSSL | Indicates whether SSL is enabled for the DB2 server. (true or false) |
http://prod-server1:9090/AppManager/xml/AddMonitor?apikey=5bc6a8e9a30d5bf894586d4db90282f5
&type=db2&displayname=appmanagerdb2&username=db2admin&host=app-xp4&password=admin&port=50000&instance=SAMPLEDB&useSSL=true
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=type&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&informixserver=[DATABASE SERVER NAME]&username=[USERNAME]&password=[PASSWORD]
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 database you want to add. Value should be Informix. |
| username | The user name of the user who has permission to access the Informix database. |
| host | The name of the host in which the Informix database is running. |
| password | The password of the user who has permission to access the Informix database.. |
| port | The port number where the Informix database is running. |
| instance | The database/instance name. |
| informixserver | The name of your Informix server. By default, the name will be ol_machinename. |
http://prod-server1:9090/AppManager/xml/AddMonitor?apikey=f5297a51be2f6f962a5cdbd68521ee61&type=Informix&displayname=test&hostname=app-win7-64-1&port=9088&username=informix&password=informix&informixserver=ol_informix1210
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]
&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&Transaction=[TRANSACTION]
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 database you want to add. Value should be Memcached. |
| host | The name of the host in which Memcached server is running. |
| port | The port number where Memcached server is running. |
| Transaction | Denotes if transaction test is enabled or not. Value should be either yes or no |
http://prod-server4:9090/AppManager/xml/AddMonitor?apikey=40648ef160f4786b20ed89ea51aa3f98
&type=Memcached&displayname=mem_test&host=app-linux2&port=11211&Transaction=yes
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME] &username=[USERNAME]&host=[HOST]&password=[PASSWORD]&port=[PORT]&namedInstance=[true/false]&instance=[INSTANCE]&authentication=[AUTHENTICATION]&encryption=[true/false]&kerberos=[true/false]
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 database you want to add. Value should be ms sql. |
| username | The name of the user who has permission to access the MS SQL server. |
| host | The name of the host in which MS SQL is running. |
| password | The password of the user who has permission to access the MS SQL server. |
| port | The port number where MS SQL is running. |
| instance | The database/instance name. This is optional field. |
| authentication | The authentication type. Value should be either SQL or Windows. |
| namedIntance | If the SQL server is a named instance, this value will be true. |
| encryption | If 'Force Encryption' is enabled in the server, this value will be true. |
| kerberos | Indicates whether Kerberos Authentication is enabled in the server. (True or False) |
http://prod-server7:9090/AppManager/xml/AddMonitor?apikey=5bc6a8e9a30d5bf894586d4db90282f5&type=MS SQL&displayname=appmanagermssql&username=sa&host=app-xp2&password=Advent1&port=1433&namedInstance=true&instance=MSSQLSERVER&authentication=SQL&encryption=true&kerberos=true
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&username=[USERNAME]&host=[HOST]&password=[PASSWORD]&port=[PORT]&instance=[INSTANCE]&authentication=[AUTHENTICATION]&useSSL=[true/false]
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 database you want to add. Value should be mysql. |
| username | The name of the user who has permission to access the MySQL server. |
| host | The name of the host in which MySQL is running. |
| password | The password of the user who has permission to access the MySQL server. |
| port | The port number where MySQL is running. |
| instance | The database/instance name. This is optional field. |
| authentication | The authentication type. Value should be SQL |
| useSSL | Enabling this option will force the server to authenticate in both ways (i.e client-auth and server-auth). This is optional. |
http://prod-server3:9090/AppManager/xml/AddMonitor?apikey=5bc6a8e9a30d5bf894586d4db90282f5&type=mysql&displayname=appmanagermysql&username=root&host=
shakthiprian&password=appmanager&port=13329&instance=mysql&authentication=SQL&useSSL=true
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&username=[USERNAME]&host=[HOST]&password=[PASSWORD]&port=[PORT]&instance=[INSTANCE]&SSLEnabled=[isSSLEnabled]&discoverPDB=[DiscoverPDB]&oracleSocketTimeout=[SocketReadTimeout]&oracleQueryTimeout=[QueryExecutionTimeout]
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 database you want to add. Value should be oracle. |
| username | The name of the user who has permission to access the Oracle database. |
| host | The name of the host in which Oracle is running. |
| password | The password of the user who has permission to access the Oracle database. |
| port | The port number where Oracle is running. |
| instance | The database/instance name. This is optional field. |
| SSLEnabled | True if the SSL is enabled otherwise the value is false. |
| discoverPDB | Option to enable discovery and monitoring of Pluggable Database(s). (yes or no) |
| oracleSocketTimeout | Socket Read Timeout value for database connection. Default value is 300 seconds. |
| oracleQueryTimeout | Query Execution Timeout value during data collection query execution. Default value is 60 seconds. |
http://prod-server7:9090/AppManager/xml/AddMonitor?apikey=5bc6a8e9a30d5bf894586d4db90282f5&type=oracle&displayname=appmanageroracle&username=rajesh&host=swissql-xp1&password=rajesh&port=1521&instance=orcl&SSLEnabled=false&discoverPDB=yes&oracleSocketTimeout=300&oracleQueryTimeout=60
http://[hostname]:[port]/AppManager/xml/AddMonitor?apikey=[apikey]&type=OracleNoSQL&displayname=[Displayname]&HostName=[HostName]&Port=[Port]&UserName=[UserName]&Password=[Password]&JNDIPath=/jmxrmi
The parameters involved in the API request are described below. Also, refer to the list of common request parameters.
| Field | Description |
|---|---|
| apikey | API key to create the Oracle coherence monitor |
| type | The type of the database you want to add. Value should be coherence. |
| displayname | Display name of the Oracle coherence monitor |
| hostname | The name of the host in which Oracle coherence is running. |
| port | The port number where Oracle is running. |
| username | The name of the user who has permission to access the Oracle coherence database. |
| password | The password of the user who has permission to access the Oracle coherence database. |
| JNDIPath | JNDI path to be used |
http://Prod-server7:9010/AppManager/xml/AddMonitor?apikey=0b719d6a4a564c8be86fbc60d3f0b996&type=OracleNoSQL&displayname=OracleNoSQL&HostName=APP-W8-AIO-5&Port=5000&UserName=admin&Password=Abc@123&JNDIPath=/jmxrmi
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]
&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&username=[USERNAME]&password=[PASSWORD]&instance=[INSTANCE]
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 database you want to add. Value should be PostgreSQL. |
| host | The name of the host in which PostgreSQL is running. |
| port | The port number where PostgreSQL is running. |
| username | The name of the user who has permission to access the PostgreSQL database. |
| password | The password of the user who has permission to access the PostgreSQL database. |
| instance | The database/instance name. This is optional field. |
|
SSLEnabled |
True if the SSL is enabled otherwise the value is false. |
http://prod-server8:9090/AppManager/xml/AddMonitor?apikey=40648ef160f4786b20ed89ea51aa3f98
&type=PostgreSQL&displayname=postSQL&host=app-xp2&port=5432&username=postgres&password=postgres&instance=postgres&SSLEnabled=false
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]
&username=[USERNAME]&host=[HOST]&password=[PASSWORD]&port=[PORT]&instance=[INSTANCE]&jconnect=[JCONNECT]
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 database you want to add. Value should be SYBASE-DB-server. |
| host | The name of the host in which Sybase is running. |
| port | The port number where Sybase is running. |
| username | The name of the user who has permission to access the Sybase database. |
| password | The password of the user who has permission to access the Sybase database. |
| instance | The database/instance name. This is optional field. |
| jconnect | Option to connect using JConnect to collect data. (true or false) |
http://prod-server3:9090/AppManager/xml/AddMonitor?apikey=5bc6a8e9a30d5bf894586d4db90282f5
&type=SYBASE-DB-server&displayname=appmanagersybase&username=sa&host=app-xp3&password=&port=5000&instance=master&jconnect=true
To Monitor OnPremise System:
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=SapHana&displayname=[DISPLAYNAME]&host=[HOST]&isOndemand=false&port=[PORT]&dbuser=[DB_USERNAME]&dbPassword=[DB_PASSWORD]&instance=[INSTANCE]
To Monitor OnDemand System:
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=SapHana&displayname=[DISPLAYNAME]&host=[HOST]&isOndemand=true&accountName=[ACCOUNT_NAME]&username=[USER_NAME]&password=[ACCOUNT_PASSWORD]&dbuser=[DB_USERNAME]&dbPassword=[DB_PASSWORD]&instance=[INSTANCE]
| Field | Description |
|---|---|
| Host | Hostname/ Landscape Host as given in https://help.hana.ondemand.com/help/frameset.htm?350356d1dc314d3199dca15bd2ab9b0e.html |
| Port | IndexServer SQL Port. Default 30015. [Required only for On Premise Setup] |
| isOndemand | Value is true for On Demand setup, false for On Premise setup. |
| accountName | On demand CLoud Account Name. [Required only for On demand Setup] |
| username | UserName for the cloud account. [Required only for On demand Setup] |
| password | Password for the cloud account. [Required only for On demand Setup] |
| dbUser | Database User Name |
| dbPassword | Database Password |
| nstance | Instance Name |
http://app-support-w7:9090/AppManager/xml/AddMonitor?apikey=151c7e98b0f2a3cbc44fbd56ec66a6c9&displayname=RestHana&type=SapHana&host=hanatrial.ondemand.com&
isOndemand=true&accountName=s0004447540trial&username=s0004447540&password=Zoho@123&dbUser=SYSTEM&
dbPassword=Zoho@1234&instance=mdchana
http://[hostname]:[port]/AppManager/xml/AddMonitor?apikey=[apikey]&type=HBase&displayname=[Displayname]&HostName=[HostName]&Port=[Port]&UserName=[UserName]&Password=[Password]&JNDIPath=/jmxrmi
The parameters involved in the API request are described below.Also, refer to the list of common request parameters.
| Field | Description |
|---|---|
| apikey | API key to create the HBase monitor |
| type | The type of the database you want to add. Value should be HBase |
| displayname | Display name of the HBase monitor |
| hostname | The name of the host in which HBase is running. |
| port | The port number where HBase is running. |
| username | The name of the user who has permission to access the HBase database. |
| password | The password of the user who has permission to access the HBase database. |
| JNDIPath | JNDI path to be used |
http://Prod-server7:9010/AppManager/xml/AddMonitor?apikey=0b719d6a4a564c8be86fbc60d3f0b996&type=HBase&displayname=HBase&HostName=APP-W8-AIO-5&Port=5000&UserName=admin&Password=Abc@123&JNDIPath=/jmxrmi
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Cassandra&displayname=Cassandra&host=[Host Name]&port=[Port Number]&discoverclusternodes=[non mandatory column, if given the value should be 'Yes']&authRequired=[non mandatory column, if given the value should be 'true']&username=[username]&password=[password]
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 database you want to add. Value should be Cassandra. |
| host | The name of the host in which Cassandra database is running. |
| port | The port number where Cassandra database is running. |
| username | The name of the user who has permission to access the Cassandra database. |
| password | The password of the user who has permission to access the Cassandra database. |
| discoverclusternodes | Specify if the Cluster Nodes must be discovered. Value can be YES/NO. This column is not mandatory. |
| authRequired | Specify if authentication is required. Value can be True/False. |
http://prod-server3:9090/AppManager/xml/AddMonitor?apikey=849c51ce33436587873a08d69d5447fc&type=Cassandra&displayname=Cassandra&host=172.20.7.36&port=7199&
username=&password=123
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Redis&displayname=Redis&host=[Host Name]&port=[Port Number]&discoverclusternodes=[non mandatory column, if given the value should be 'Yes']&authRequired=[non mandatory column, if given the value should be 'true']&password=[password]
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 database you want to add. Value should be Redis. |
| host | The name of the host in which Redis is running. |
| port | The port number where Redis is running. |
| username | The name of the user who has permission to access the Redis database. |
| password | The password of the user who has permission to access the Redis database. |
| discoverclusternodes | Specify if the Cluster Nodes must be discovered. Value can be YES/NO. This column is not mandatory. |
| authRequired | Specify if authentication is required. Value can be True/False. |
http://prod-server3:9090/AppManager/xml/AddMonitor?apikey=849c51ce33436587873a08d69d5447fc&type=Redis&displayname=Redis&host=172.20.6.200&port=6379&password=123
http://[Host]:[Port]/http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=MongoDB&displayname=MongoDB&host=[Host Name]&port=[Port Number]&discoverchildren=[non mandatory column, if given the value should be 'Yes']&authRequired=[non mandatory column, if given the value should be 'true']&username=[username]&password=[password]
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 database you want to add. Value should be MongoDB. |
| host | The name of the host in which MongoDB is running. |
| port | The port number where MongoDB is running. |
| username | The name of the user who has permission to access the Mongo database. |
| password | The password of the user who has permission to access the Mongo database. |
| discoverclusternodes | Specify if the Cluster Nodes must be discovered. Value can be YES/NO. This column is not mandatory. |
| authRequired | Specify if authentication is required. Value can be True/False. |
| discoverchildren | Values can be true/false. |
http://prod-server3:9090/AppManager/xml/AddMonitor?apikey=849c51ce33436587873a08d69d5447fc&type=MongoDB&displayname=MongoDB&host=172.20.6.200&port=6379&password=123
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]
&host=[HOST]&port=[PORT]
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 database you want to add. Value should be CouchBase. |
| displayname | The display name of the Couchbase database. |
| host | The name of the host in which CouchBase is running. |
| port | The port number where CouchBase is running. |
http://prod-server8:9090/AppManager/xml/AddMonitor?apikey=3a45dc93b4eb6d7fbefe550e4a2a7c6c&type=Couchbase&displayname=Couchmonitoring&host=app-win7-64-4.csez.zohocorpin.com&port=8091">http://prod-server8:9090/AppManager/xml/AddMonitor?apikey=3a45dc93b4eb6d7fbefe550e4a2a7c6c&type=Couchbase&displayname=Couchmonitoring&host=app-win7-64-4.csez.zohocorpin.com&port=8091
http://[Host]:[PORT]/AppManager/xml/AddMonitor?apikey=[ API KEY ]&type=Neo4j&displayname=[DISPLAYNAME]&HostName=[Host]&Port=[Port]&UserName=[UserName]&Password=[Password]&DiscoverNode=yes/no
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 database you want to add. Value should be Neo4j. |
| HostName | The name of the host in which Neo4j is running. |
| Port | The bolt port number where Neo4j is running. |
| UserName | The name of the user who has permission to access the Neo4j database. |
| Password | The password of the user who has permission to access the Neo4j database. |
| DiscoverNode | Specify if the Cluster Nodes must be discovered. Value can be YES/NO. This column is not mandatory. |
http://localhost:9090/AppManager/xml/AddMonitor?apikey=21ca68ece3dfc1bab0fa100b2c4f90cb&type=Neo4j&displayname=DISPLAYNAME&HostName=app-w8-aio-5&Port=7687&UserName=neo4j&Password=admin&DiscoverNode=yes
http://[Host]:[port]/AppManager/xml/AddMonitor?apikey=[Key]&type=[type]&displayname=[DisplayName]&username=[userid]&host=[Host]&Password=[password]&port=[port]
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 database you want to add. Value should be SQLAnywhere-DB-server. |
| displayname | Display name of the monitor. |
| username | The name of the user who has permission to access the SQL Anywhere database. |
| host | The name of the host in which SQL Anywhere server is running. |
| Password | The password of the user who has permission to access the SQL Anywhere database. |
| port | The port number where SQL Anywhere is running. Default port is 2638. |
http://localhost:9096/AppManager/xml/AddMonitor?apikey=94e214da57134e2c57ce7c7ec4b523a8&type=SQLAnywhere-DB-server&displayname=sqlanywhere-demo&username=dba&host=hostname&Password=sql&port=2638
