ManageEngine® Applications Manager AddMonitor API - Database Servers | ||
This section explains how to use the AddMonitor API to add monitors of the category type 'Database Servers''. The following databases are supported:
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 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. |
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 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. |
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 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 |
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 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. |
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 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 |
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 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. |
The parameters involved in the API request are described below. Also, refer 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 |
Sample Request:
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
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 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. |
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 database you want to add. Value should be sybase. |
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. |
SYNTAX:
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]
Request Parameters Description:
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 |
SAMPLE:
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.
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 |
Sample Request:
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
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 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. |
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 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://[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 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://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]
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 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
AddMonitor API - Custom Monitors |
AddMonitor API - ERP |