ManageEngine® Applications Manager


AddMonitor API - Servers

<< Prev

Home

Next >>

AddMonitor API - Servers

 

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

AIX

Syntax:


http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]
&os=[OS]&username=[USERNAME]&mode=[MODE]&snmptelnetport=[SNMPTELNETPORT]&password=[PASSWORD]&prompt=[PROMPT]
&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 category type of the monitor you want to add. Value should be 'servers'.
host The name of the host where the AIX server is running.
os The operating system of the server. Value is 'AIX'.
username The username of the AIX server.
mode The mode of monitoring the AIX server. Value is 'TELNET'.
snmptelnetport The port number where Telnet service is running. Default value is 23.
password The password of the AIX server.
timeout The time out value in seconds.
prompt The command prompt value. Value is '$'

 

Sample Request:


http://prod-server1:9098/AppManager/xml/AddMonitor?apikey=624436f73f9fda2109cc916c8c8be5c1&type=servers
&displayname=apmaix&host=adventaix&os=AIX&username=root&mode=TELNET&snmptelnetport=23&password=sankho&prompt=#
&timeout=2

Top

AS400

Syntax:


http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]
&subnet=[SUBNET]&pollInterval=[POLLINTERVAL]&os=[OS]&username=[USERNAME]&password=[PASSWORD]&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 category type of the monitor you want to add. Value should be 'servers'.
host The name of the host where the AS400 server is running.
subnet The subnet mask value
pollInterval The polling interval for the monitor.
os The operating system of the server. Value is 'AS400/iSeries'.
username The username of the AS400/iSeries server.
timeout The time out value in seconds.
password The password of the AS400/iSeries server.

 

Sample Request:


http://prod-server2:9090/AppManager/xml/AddMonitor?apikey=5bc6a8e9a30d5bf894586d4db90282f5&type=servers
&displayname=apmas400&host=pub1.rzkh.de&subnet=255.255.255.0&pollInterval=5&os=AS400/iSeries&username=nimda&password=admin&timeout=3

Top

FreeBSD

Syntax:


http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]
&subnet=[SUBNET]&pollInterval=[POLLINTERVAL]&os=[OS]&username=[USERNAME]&password=[PASSWORD]
&mode=[MODE]&snmptelnetport=[SNMPTELNETPORT]&prompt=[PROMPT]&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 category type of the monitor you want to add. Value should be 'servers'.
host The name of the host where the FreeBSD server is running.
subnet The subnet mask value
pollInterval The polling interval for the monitor.
os The operating system of the server. Value is 'FreeBSD'.
username The username of the FreeBSD server.
password The password of the FreeBSD server.
mode The mode of monitoring. Value is TELNET
snmptelnetport The port where Telnet service is running. Default value is 23.
timeout The time out value in seconds.
prompt The command prompt value. Value is $.

 

Sample Request:


http://prod-server4:9090/AppManager/xml/AddMonitor?apikey=5bc6a8e9a30d5bf894586d4db90282f5
&type=servers
&displayname=apmfreebsd&host=cm-bsd&subnet=255.255.255.0&pollInterval=5&os=FreeBSD&username=test&password=test
&mode=TELNET&snmptelnetport=23&prompt=$
&timeout=4

Top

HP-UX

Syntax:


http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]
&username=[USERNAME]&password=[PASSWORD]&os=[OS]
&mode=[MODE]&snmptelnetport=[SNMPTELNETPORT]&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 category type of the monitor you want to add. Value should be 'servers'.
username The username of the HP-UX server.
password The password of the HP-UX server.
os The operating system of the server. Value is 'HP-UX'.
mode The mode of monitoring. Values are SSH or TELNET
snmptelnetport The port where SSH/Telnet service is running. Default values are 23 (for Telnet) and 22 (for SSH).
timeout The time out value in seconds.
host The name of the host where the HP-UX server is running.

 

Sample Request:


http://prod-server5:9090/AppManager/xml/AddMonitor?apikey=5bc6a8e9a30d5bf894586d4db90282f5&type=servers
&displayname=apmhpux&username=test&password=test&os=HP-UX&mode=SSH&snmptelnetport=22&host=hpuxtests
&timeout=5

Top

Linux

Syntax:


http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]
&host=[HOST]&snmptelnetport=[SNMPTELNETPORT]&os=[OS]&mode=[MODE]&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 category type of the monitor you want to add. Value should be 'servers'.
host The name of the host where the Linux server is running.
snmptelnetport The port where SSH/Telnet/SNMP is running. Default values are 23 (for Telnet), 22 (for SSH) and 161 (for SNMP).
os The operating system of the server. Value is 'Linux'.
timeout The time out value in seconds.
mode The mode of monitoring. Value is either SNMP, SSH or TELNET.

 

Sample Request:


http://prod-server5:9090/AppManager/xml/AddMonitor?apikey=5bc6a8e9a30d5bf894586d4db90282f5&type=servers
&displayname=apmlinux&host=shakthiprian&snmptelnetport=161&os=Linux&mode=SNMP
&timeout=2

Top

Mac OS

Syntax:


http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]
&host=[HOST]&snmptelnetport=[SNMPTELNETPORT]&os=[OS]&mode=[MODE]&username=[USERNAME]&password=[PASSWORD]&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 category type of the monitor you want to add. Value should be 'servers'.
host The name of the host where the Mac OS is running.
snmptelnetport The port where SSH/Telnet/SNMP is running. Default values are 23 (for Telnet), 22 (for SSH) and 161 (for SNMP).
os The operating system of the server. Value is 'Mac OS'.
mode The mode of monitoring. Value is either SNMP, SSH or TELNET.
username The user name of the Mac OS server.
timeout The time out value in seconds.
password The password of the Mac OS server.

 

Sample Request:


http://prod-server3:9090/AppManager/xml/AddMonitor?apikey=5bc6a8e9a30d5bf894586d4db90282f5
&type=servers&displayname=apmmac&host=apptest-mac&snmptelnetport=23&os=Mac OS&mode=TELNET
&username=administrator&password=vembu
&timeout=2

Top

Novell

Syntax:


http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]
&host=[HOST]&snmptelnetport=[SNMPTELNETPORT]&os=[OS]&mode=[MODE]&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 category type of the monitor you want to add. Value should be 'servers'.
host The name of the host where the Novell server is running.
snmptelnetport The port where SNMP is running. Default value is 161.
os The operating system of the server. Value is 'Novell'.
timeout The time out value in seconds.
mode The mode of monitoring specified for the server. Value is 'SNMP'.

 

Sample Request:


http://production-server2:9090/AppManager/xml/AddMonitor?apikey=5bc6a8e9a30d5bf894586d4db90282f5
&type=servers&displayname=apmnovell&host=smrithil&snmptelnetport=161&os=Novell&mode=SNMP&timeout=2

Top

Sun Solaris

Syntax:


http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]
&host=[HOST]&snmptelnetport=[SNMPTELNETPORT]&os=[OS]&mode=[MODE]&username=[USERNAME]&password=[PASSWORD]&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 category type of the monitor you want to add. Value should be 'servers'.
host The name of the host where the Sun Solaris server is running.
snmptelnetport The port where SSH/Telnet/SNMP is running. Default values are 23 (for Telnet), 22 (for SSH) and 161 (for SNMP).
os The operating system of the server. Value is 'SUN'.
mode The mode of monitoring specified for the server. Value should be either SNMP, TELNET or SSH.
username The user name of the Sun Solaris server.
timeout The time out value in seconds.
password The password of the Sun Solaris server.

 

Sample Request:


http://prod-server7:9090/AppManager/xml/AddMonitor?apikey=5bc6a8e9a30d5bf894586d4db90282f5
&type=servers&displayname=apmsolaris&host=cagent-solaris2&snmptelnetport=23&os=SUN&mode=TELNET&username=guest&password=guest
&timeout=3

Top

Windows

Syntax:


http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]
&host=[HOST]&snmptelnetport=[SNMPTELNETPORT]&os=[OS]&mode=[MODE]&username=[USERNAME]&password=[PASSWORD]&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 category type of the monitor you want to add. Value should be 'servers'.
host The name of the host where the Windows server is running.
snmptelnetport The port where SNMP is running. Default value is 161.
os The operating system of the server. Values can be Windows 2000, Windows 2003, Windows XP, WindowsNT, Windows Vista or Windows 2008.
mode The mode of monitoring specified for the server. Value is 'SNMP'.
username The user name of the Windows server.
password The password of the Windows server.
timeout The time out value in seconds.

 

Sample Request:

To add Windows server in SNMP mode:


http://prod-server6:8080/AppManager/xml/AddMonitor?apikey=5bc6a8e9a30d5bf894586d4db90282f5
&type=servers&displayname=apmwindows&host=app-xp5&os=Windows XP&mode=SNMP&snmptelnetport=161&snmpCommunityString=public
&timeout=2

 

To add Windows server in WMI mode:

 

http://prod-server6:8080/AppManager/xml/AddMonitor?apikey=5bc6a8e9a30d5bf894586d4db90282f5
&type=servers&displayname=apmwindows&host=app-xp5&snmptelnetport=161&os=Windows XP&mode=SNMP&username=administrator&password=vembu
&timeout=2

Top

 

<< Prev

Home

Next >>

AddMonitor API - Middleware/Portal

AddMonitor API - Services