ManageEngine® Applications Manager


AddMonitor API - EUM Monitors

<< Prev

Home

Next >>

AddMonitor API - EUM Monitors

 

This section explains how to use the AddMonitor API to add monitors of the category type End User Monitoring (EUM). The following monitors are supported:

The following parameters are common in API requests for EUM monitors:

 

Field Description        
eumAgents The display name(s) of the EUM agent(s). If there are multiple entries, they can be comma separated.
eumAgentsId The unique ID of the EUM agents configured. These can be specified as comma separated.
runOnServer Specifies if the monitor has to be created in Applications Manager. Possible values are 'True' or 'False'

Note:
1) It is not mandatory to use both 'eumAgents' and 'eumAgentsId' parameters in the same API request. You can use either one of these.

2) The runOnServer parameter is not applicable for Real Browser Monitor (RBM)

Ping

Syntax:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]
&host=[HOST]&timeout=[TIMEOUT]&eumAgents=[EUMAGENTS]&eumAgentsId=[EUMAGENTID]&runOnServer=[RUNONSERVER]

 

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 service you want to add. Value should be 'Ping Monitor'.
host The host in which the monitor is running.
timeout The timeout value in seconds.

Sample Request:

http://prod-server5:9090/AppManager/xml/AddMonitor?apikey=40648ef160f4786b20ed89ea51aa3f98
&type=Ping Monitor&displayname=apmping&host=smrithil&timeout=5&eumAgents=eumflorida&
runOnServer=True

Top


DNS

Syntax:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]
&displayname=[DISPLAYNAME]&timeout=[TIMEOUT]&SearchField=[SEARCHFIELD]
&TargetAddress=[TARGETADDRESS]&LookupAddress=[LOOKUPADDRESS]&RecordType=[RECORDTYPE]
&eumAgents=[EUMAGENTS]&eumAgentsId=[EUMAGENTID]&runOnServer=[RUNONSERVER]

 

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 service you want to add. Value should be 'DNSMonitor'.
displayname The display name of the host in which the monitor is running.
timeout The timeout value in seconds.
SearchField The value of SearchField. Options include None, Record Name, Address, Additional Name, Target, Admin, Host, Alias, Port and Priority.
TargetAddress Host Name / IP Address to connect to the service
LookupAddress The address you want to check in the DNS Server.
RecordType The expected record type returned for the lookup address. The options include A, AAAA, CNAME, MX, NS, PTR, SOA, SPF, SRV and TXT.

Sample Request:

http://prod-server8:9090/AppManager/xml/AddMonitor?apikey=40648ef160f4786b20ed89ea51aa3f98
&type=DNSMonitor&displayname=dnstttttt&timeout=15&SearchField=Record Name
&TargetAddress=192.168.4.121&LookupAddress=appmanager.com&RecordType=A&eumAgents=eumbe1
&runOnServer=True

Top


LDAP Server

Syntax:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]
&displayname=[DISPLAYNAME]&username=[USERNAME]&timeout=[TIMEOUT]&LDAPServer=[LDAPSERVER]
&LDAPServerPort=[LDAPSERVERPORT]&MatchingAttribute=[MATCHINGATTRIBUTE]&FilterCondition=[FILTERCONDITION]
&IsSecured=[ISSECURED]&SearchFilter=[SEARCHFILTER]&SearchResult=[SEARCHRESULT]&SearchBase=[SEARCHBASE]&password=[PASSWORD]
&eumAgents=[EUMAGENTS]&eumAgentsId=[EUMAGENTID]&runOnServer=[RUNONSERVER]

 

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 service you want to add. Value should be 'LDAP Server'.
username The user name of the LDAP server.
timeout The timeout value in seconds.
LDAPServer The name of the LDAP Server.
LDAPServerPort The port at which the LDAP server is running.
MatchingAttribute The matching attribute value. Values include cn, uid, sn, displayname, givenname, objectclass, dc and ou
FilterCondition The value of filter condition. Values include equals, contains and notequals
IsSecured Specifies if the connection is secure or not. Value is either yes or no.
SearchFilter The value of Search Filter. This field is optional.
SearchResult The string value that matches with search results.
SearchBase The value of SearchBase. This is mandatory field when adding a LDAP monitor.
password The password of the LDAP server.

Sample Request:

http://operations-server9:9090/AppManager/xml/AddMonitor?apikey=40648ef160f4786b20ed89ea51aa3f98
&type=LDAP Server&displayname=ldap_serverqqqq&username=cn=administrator,cn=users,dc=pmp,dc=com
&timeout=10&LDAPServer=pmp-2k8s&LDAPServerPort=389&MatchingAttribute=cn&FilterCondition=equals&IsSecured=no
&SearchFilter=&SearchResult=&SearchBase=&Password=Vembu123
&eumAgents=eumbe1&runOnServer=True

Top


Mail Server

Syntax:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&host=[HOST]&port=[PORT]
&displayname=[DISPLAYNAME]&emailid=[EMAILID]&timeout=[TIMEOUT]&authRequired=[AUTHREQUIRED]
&sslEnabled=[SSLENABLED]&username=[USERNAME]&password=[PASSWORD]&tlsEnabled=[TLSENABLED]
&pollinterval=[POLLINTERVAL]&mailsubject=[MAILSUBJECT]&fetchEnabled=[FETCHENABLED]&fetchType=[FETCHTYPE]
&fsHost=[FSHOST]&fsport=[FSPORT]&fsSSLEnabled=[FSSSLENABLED]&fsTLSEnabled=[FSTLSENABLED]
&fsUserName=[FSUSERNAME]&fsPassword=[FSPASSWORD]&eumAgents=[EUMAGENTS]&eumAgentsId=[EUMAGENTID]&runOnServer=[RUNONSERVER]

 

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 service you want to add. Value should be 'Mail Server'.
host The SMTP host name
port The port at which SMTP is running.
emailid The email address to which the mail will be sent.
timeout The timeout value in seconds.
authRequired Indicates if the SMTP requires authentication. Values are 'Yes' or 'No'
sslEnabled Indicates if the SMTP host should be accessed through SSL. Values are 'Yes' or 'No'
username The username of the SMTP host
password The password of the SMTP host
tlsEnabled Denotes whether TLS should be used for SMTP
pollinterval The polling interval of the monitor in seconds.
mailSubject The message to appear in the subject of the email.
fetchEnabled Indicates if the POP/IMAP server should be monitored. Values are 'Yes' or 'No'.
fetchType Indicates the service that is monitored. If you want to add POP type, specify the value as 1. If you want to monitor IMAP server, specify the value as 2.
fsHost The host name of the POP/IMAP server
fsport The port at which the POP/IMAP server is running.
fsSSLEnabled Indicates whether the POP/IMAP server is SSL enabled or not. Values are 'Yes' or 'No'.
fsTLSEnabled Indicates whether TLS should be used for POP/IMAP. Values are 'Yes' or 'No'.
fsUserName The user name of the POP/IMAP server.
fsPassword The password of the POP/IMAP server

Sample Request:

http://operations-server9:9090/AppManager/xml/AddMonitor?apikey=40648ef160f4786b20ed89ea51aa3f98
&type=Mail Server&host=smtp1&port=23&displayname=apmsmtp&emailid=admin@yourdomain.com&timeout=5&authRequired=Yes
&sslEnabled=Yes&username=guest&password=guest&tlsEnabled=Yes&pollinterval=60&mailsubject=Testing Mail Server
&fetchEnabled=Yes&fetchType=1&fsHost=POP1&fsport=110&fsSSLEnabled=Yes&fsTLSEnabled=Yes&fsUserName=admin&fsPassword=Vembu123
&eumAgents=eum1&runOnServer=True

Top


Real Browser Monitor

Syntax:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]
&displayname=[DISPLAYNAME]&scriptname=[SCRIPTNAME]&pollinterval=[POLLINTERVAL]&timeout=[TIMEOUT]
&eumAgents=[EUMAGENTS]&eumAgentsId=[EUMAGENTID]

 

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 'RBM'.
scriptname The script name for RBM
pollinterval The polling interval for the monitor in seconds
timeout The time out value in seconds.

Sample Request:

http://operations-server9:9090/AppManager/xml/AddMonitor?apikey=40648ef160f4786b20ed89ea51aa3f98
&type=RBM&displayname=rbm1&scriptname=script1&pollinterval=60&timeout=30&eumAgents=eum1

Top

 

 

<< Prev

Home

Next >>

AddMonitor API - ERP

AddMonitor API - Java/Transaction