AddMonitor APIs - Services

---

This section explains how to use the AddMonitor API to add monitors of the category type 'Services'. The following services are supported:

• Active Directory
• Ceph Storage
• DNS Monitor
• FTP/SFTP Monitor
• Hadoop Monitor
• JMX Applications
• LDAP Server
• Ping Monitor/Ping Monitor(EUM)
• Service Monitoring
• SNMP/Network Device
• Telnet
• Oracle Coherence
• Apache Zookeeper

Active Directory

Syntax:

http://[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 the list of common Request Parameters.

Field	Description
type	The type of the service you want to add. Value should be 'ActiveDirectory'.
host	The name of the host in which the Active Directory service is running.
username	The Active Directory username.
password	The Active Directory password.

 

Sample Request:

http://operation-server3:9099/AppManager/xml/AddMonitor?apikey=123b7328e4b41d1efe64aa7980d83d77&type=ActiveDirectory&displayname=active_mon&host=app-xp4&username=administrator&password=admin123

Ceph Storage

Syntax:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Ceph Storage&displayname=[DISPLAYNAME]&host=[HOST]&prompt=[Prompt]&userName=[UserName]&password=[Password]

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 'Ceph Storage'.
host	The name of the host in which the Ceph service is running.
username	The Ceph Storage service username.
password	The Ceph Storage service password.
prompt	The command prompt value - '$'

 

Sample Request:

http://operation-server3:9099/AppManager/xml/AddMonitor?apikey=5e403cfde0653d142fac29b18863923b&type=Ceph Storage&displayname=ceph&host=ctl-cephadmin&prompt=$&userName=appmgr&password=appmgr%123

DNS Monitor

Syntax:

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

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

FTP/SFTP Monitor

Syntax:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&port=[PORT]&username=[USERNAME]&password=[PASSWORD]&TargetAddress=[TARGETADDRESS]&DownloadFile=[DOWNLOADFILE]&IsSecured=[ISSECURED]&UploadFile=[UPLOADFILE]&RemoteSourceFileName=[REMOTESOURCEFILENAME]&RemoteDestinationFileName=[REMOTEDESTINATIONFILENAME]&LocalSourceFileName=[LOCALSOURCEFILENAME]&LocalDestinationFileName=[LOCALDESTINATIONFILENAME]&timeout=[TIMEOUT]

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 'FTPMonitor'.
port	The port number where the FTP/SFTP service is running.
username	The FTP/SFTP user name.
password	The FTP/SFTP password.
TargetAddress	Host Name / IP Address to connect to the service.
DownloadFile	Indicates if download is enabled. Possible values include yes and no. If you would like to monitor the downloads (mget) through FTP/SFTP while simulateneously downloading the file, specify yes.
IsSecured	Specifies if the connection is secure or not. Value is either yes or no.
UploadFile	Indicates if upload file option is enabled. Values include yes and no. If you would like to upload a file to target address, specify yes.
RemoteSourceFileName	The Remote Source FileName located in the target address. This is applicable only if the value of 'DownloadFile' option is specified as yes.
RemoteDestinationFileName	The Remote Destination FileName located in the target address. This is applicable only if the value of 'UploadFile' option is specified as yes.
LocalSourceFileName	The name of the local source file with full path. The file must be available where Applications Manager instance is running. This is applicable only if the value of 'UploadFile' option is specified as yes.
LocalDestinationFileName	The local destination FileName with full path. The file will download in the given path where Applications Manager instance is running. This field is applicable only if the value of 'DownloadFile' option is specified as yes
timeout	The timeout value in seconds.

 

Sample Request:

http://prod-server8:9090/AppManager/xml/AddMonitor?apikey=40648ef160f4786b20ed89ea51aa3f98&type=FTPMonitor&displayname=ladpapitestooooo&port=22&username=sprasadh&password=sprasadh&TargetAddress=sprasadh&DownloadFile=no&IsSecured=yes&UploadFile=no&RemoteSourceFileName=&RemoteDestinationFileName=&LocalSourceFileName=&LocalDestinationFileName=&timeout=15

Hadoop Monitor

Note : NameNode and JobTracker/ ResourceManager must be added using same Mode (JMX or RESTAPI).

Syntax:

1. Add Hadoop monitor through REST API mode of monitoring:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Hadoop&displayname=[DISPLAYNAME]&ModeOfMonitoring=RESTAPI&Version=[1.x/2.x]&NameNodeHost=[NAMENODE HOST]&NameNodeWebPort=[NAMENODE WEBPORT]&NameNodeSSLEnabled=[yes/no]&NameNodeWebAuthType=[SimpleAuth/NoAuth]&NameNodeUserName=[NAMENODE USERNAME]&JobTrackerHost=[JOBTRACKER HOSTNAME]&JobTrackerWebPort=[JOBTRACKER WEBPORT]&JobTrackerSSLEnabled=[yes/no}&JobTrackerWebAuthType=[SimpleAuth/NoAuth]&JobTrackerUserName=[JOBTRACKER USERNAME]

2. Add Hadoop monitor through JMX mode of monitoring:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Hadoop&displayname=[DISPLAYNAME]&ModeOfMonitoring=JMX&Version=[1.x/2.x]&NameNodeHost=[NAMENODE HOST]&NameNodeJMXPort=[NAMENODE JMXPORT]&NameNodeUserName=[NAMENODE JMX USERNAME]&NameNodePassWord=[NAMENODE JMX PASSWORD]&NameNodeJNDIPath=[NAMENODE JNDIPATH]&JobTrackereHost=[JOBTRACKER HOSTNAME]&JobTrackerJMXPort=[JOBTRACKER JMXPORT]&JobTrackerUserName=[JOBTRACKER JMX USERNAME]&JObTrackerPassWord=[JOBTRACKER JMX PASSWORD]&JobTrackerJNDIPath=[JOBTRACKER JNDIPATH] 

Request Parameters:

The parameters involved in the API request are described below. Also, refer the list of common Request Parameters.

Field	Description
ModeOfMonitoring	The mode in which datacollection for Hadoop monitor will happen. Possible values: RESTAPI JMX
Version	Version of Hadoop. Possible values: 1.x 2.x
NameNodeHost	HostName of Namenode.
NameNodeWebPort	Web port of Namenode.
NameNodeJMXPort	JMX Port of Namenode
NameNodeSSLEnabled	Is SSL is enabled for Namenode webport? Possible values: yes no
NameNodeWebAuthType	Type authentication used by namenode web. Possible values: NoAuth SimpleAuth
NameNodeUserName	Username of web access, if simple authentication is used in namenode. Username of JMX access, if JMX mode of monitoring is chosen in namenode.
NameNodePassWord	Password for JMX access, if it is necessary for JMX access in namenode.
NameNodeJNDIPath	JNDI path of the Namenode.
JobTrackerHost	HostName of Jobtracker.
JobTrackerWebPort	Web port of Jobtracker.
JobTrackerJMXPort	JMX Port of Jobtracker.
JobTrackerSSLEnabled	Is SSL is enabled for Jobtracker webport? Possible values: yes no
JobTrackerWebAuthType	Type authentication used by Jobtracker web. Possible values: NoAuth SimpleAuth
JobTrackerUserName	Username of web access, if simple authentication is used in Jobtracker. Username of JMX access, if JMX mode of monitoring is chosen in Jobtracker.
JObTrackerPassWord	Password for JMX access, if it is necessary for JMX access in Jobtracker.
JobTrackerJNDIPath	JNDI path of the Jobtracker.

 

Sample Request:

1. Add Hadoop monitor through REST API mode of monitoring:

http://app-test-vm:9090/AppManager/xml/AddMonitor?apikey=90b71e0866f0f92488fbb4a2ab8d1195&type=Hadoop&displayname=Hadoop&ModeOfMonitoring=RESTAPI&Version=1.x&NameNodeHost=naga-2385&NameNodeWebPort=50070&NameNodeSSLEnabled=no&NameNodeWebAuthType=SimpleAuth&NameNodeUserName=hduser&JobTrackerHost=naga-2385&JobTrackerWebPort=50030&JobTrackerSSLEnabled=no&JobTrackerWebAuthType=SimpleAuth&JobTrackerUserName=hduser

2. Add Hadoop monitor through JMX mode of monitoring:

http://app-test-vm:9090/AppManager/xml/AddMonitor?apikey=90b71e0866f0f92488fbb4a2ab8d1195&type=Hadoop&displayname=Hadoop&ModeOfMonitoring=JMX&Version=1.x&NameNodeHost=naga-2385&NameNodeJMXPort=8004&NameNodeUserName=&NameNodePassWord=&NameNodeJNDIPath=/jmxrmi&JobTrackerHost=naga-2385&JobTrackerJMXPort=8004&JobTrackerUserName=&JobTrackerPassWord=&JobTrackerJNDIPath=/jmxrmi

JMX Applications

Syntax:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&jndiurl=[JNDIURL]

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 'JMX Applications'.
host	The name of the host in which the monitor is running.
port	The port number where the RMI adapter is running.
jndiurl	The JNDI name. Example:/jmxrmi

 

Sample Request:

http://prod-server1:9090/AppManager/xml/AddMonitor?apikey=40648ef160f4786b20ed89ea51aa3f98&type=JMX Applications&displayname=apmjmxapp&host=app-xp2&port=1099&jndiurl=/jmxrmi

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]

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=admin123123

 

Ping Monitor/Ping Monitor(EUM)

Syntax:

Ping Monitor:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&timeout=[TIMEOUT]

Ping Monitor (EUM):

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&timeout=[TIMEOUT]

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 or Ping Monitor (EUM)'.
displayname	Display name of the 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

Service Monitoring

Syntax:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&timeout=[TIMEOUT]

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 service monitoring.
host	The host in which the monitor is running.
timeout	The timeout value in seconds.
port	The port number in which the service is running.

 

Sample Request:

http://prod-server3:9090/AppManager/xml/AddMonitor?apikey=40648ef160f4786b20ed89ea51aa3f98&type=Service Monitoring&displayname=apmservice&host=smrithil&port=9090&timeout=3

SNMP/Network Device

Syntax:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&snmpCommunityString=[SNMPCOMMUNITYSTRING]&timeout=[TIMEOUT]

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 SNMP / Network Device.
host	The host in which the monitor is running.
port	The port number in which SNMP is running.
snmpCommunityString	The SNMP community string value. Default value is public.
timeout	The timeout value in seconds.

 

Sample Request:

http://prod-server4:9099/AppManager/xml/AddMonitor?apikey=c9684ec1361be61f48cd1bd2221ac3fc&type=SNMP/Network Device&displayname=apmsnmp&host=sprasadh&port=161&snmpCommunityString=public&timeout=5

Telnet

Syntax:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&timeout=[TIMEOUT]

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 telnet.
host	The host name in which the monitor is running.
timeout	The time out value in seconds.
port	The port number in which Telnet is running.

 

Sample Request:

http://operation-server2:9090/AppManager/xml/AddMonitor?apikey=40648ef160f4786b20ed89ea51aa3f98&type=telnet&displayname=apmtelnet&host=smrithil&port=23&timeout=2

Oracle Coherence

Syntax:

http://[hostname]:[port]/AppManager/xml/AddMonitor?apikey=[apikey]&type=Coherence&displayname=[Displayname]&HostName=[HostName]&Port=[Port]&UserName=[UserName]&Password=[Password]&JNDIPath=/jmxrmi

Request Parameters:

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:9090/AppManager/xml/AddMonitor?apikey=27d484c4527d4f0911daef26e131a260&type=Coherence&displayname=Coherence_API&HostName=it360-m4600-1&Port=1099&PortAdd=1095&UserName=admin&Password=Abc@123&JNDIPath=/jmxrmi

Apache Zookeeper

Syntax:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Zookeeper&displayname=Zookeeper&host=[Host Name]&port=[Port Number]&discoverclusternodes=[non mandatory column, if given the value should be 'Yes']&authReq=[non mandatory column, if given the value should be 'true']&username=[username]&password=[password]

Request Parameters:

The parameters involved in the API request are described below.

Field	Description
type	The type of the Service you want to add. Value should be Zookeeper.
host	The name of the host in which Zookeeper is running.
port	The port number where Zookeeper is running.
username	The name of the user who has permission to access the Zookeeper.
password	The password of the user who has permission to access the Zookeeper.
discoverclusternodes	Specifies if the Cluster Nodes must be discovered. Value can be YES/NO. This column is not mandatory.
authReq	Specifies if authentication is required. Value can be true/false.

 

Sample Request:

http://prod-server3:9090/AppManager/xml/AddMonitor?apikey=849c51ce33436587873a08d69d5447fc&type=Zookeeper&displayname=Zookeeper&host=172.20.7.36&port=7199&username=&password=123