AddMonitor APIs - 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 to the list of common Request Parameters

FieldDescription
type The category type of monitor you want to add. The 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 should be either TELNET or SSH.
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 '$'
forceadd This parameter is used to force Applications Manager to bypass availability and other authentication-related checks and add the monitor. Possible values are:
  • True - Force-adds the monitor
  • False - Does not force-add the monitor.
addgivenname Specifies if you want to set the host name of the monitor as the Host Name / IP Address that you have configured in the API.
passphrase Specify a Passphrase if the private key is protected with one for SSH Authentication.

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

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 to the list of common Request Parameters

FieldDescription
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.
forceadd This parameter is used to force Applications Manager to bypass availability and other authentication-related checks and add the monitor. Possible values are:
  • True - Force-adds the monitor
  • False - Does not force-add the monitor.
addgivenname Specifies if you want to set the host name of the monitor as the Host Name / IP Address that you have configured in the API.
passphrase Specify a Passphrase if the private key is protected with one for SSH Authentication.

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

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 to the list of common Request Parameters

FieldDescription
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 should be either SNMP, TELNET or SSH.
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 $.
forceadd This parameter is used to force Applications Manager to bypass availability and other authentication-related checks and add the monitor. Possible values are:
  • True - Force-adds the monitor
  • False - Does not force-add the monitor.
addgivenname Specifies if you want to set the host name of the monitor as the Host Name / IP Address that you have configured in the API.
passphrase Specify a Passphrase if the private key is protected with one for SSH Authentication.

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

HP-UX/Tru64

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 to the list of common Request Parameters

FieldDescription
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.
forceadd This parameter is used to force Applications Manager to bypass availability and other authentication-related checks and add the monitor. Possible values are:
  • True - Force-adds the monitor
  • False - Does not force-add the monitor.
addgivenname Specifies if you want to set the host name of the monitor as the Host Name / IP Address that you have configured in the API.
passphrase Specify a Passphrase if the private key is protected with one for SSH Authentication.

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

Linux

Syntax:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&snmptelnetport=[SNMPTELNETPORT]&os=[OS]&mode=[MODE]&timeout=[TIMEOUT]&username=test&password=Zoho123

Request Parameters:

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

FieldDescription
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. (For SNMP mode, the community string has to be added in the API request parameter.)
forceadd This parameter is used to force Applications Manager to bypass availability and other authentication-related checks and add the monitor. Possible values are:
  • True - Force-adds the monitor
  • False - Does not force-add the monitor.
addgivenname Specifies if you want to set the host name of the monitor as the Host Name / IP Address that you have configured in the API.
passphrase Specify a Passphrase if the private key is protected with one for SSH Authentication.
username The username to use the Telnet/ssh mode of monitoring.
password The password to use the Telnet/ssh mode of monitoring.

Sample Requests:

SSH Mode:

http://prod-server:9090/AppManager/xml/AddMonitor?apikey=cfb48066f523d94c18fd0a99bc4faa10&type=servers&displayname=APILINUX &host=app-centos32-1&snmptelnetport=22&os=Linux&mode=SSH&timeout=10&username=test&password=Zoho123

SNMP Mode:

http://prod-server:9090/AppManager/xml/AddMonitor?apikey=cfb48066f5fdvgf94c18fd0a99bc4faa10&type=servers&displayname=APILINUX &host=app-centos32-1&snmptelnetport=161&os=Linux&mode=SNMP&timeout=10&username=test&password=Zoho123&SNMPCommunityString=Public

Sample Response:

<?xml version="1.0" encoding="UTF-8"?>
<AppManager-response uri="/AppManager/xml/AddMonitor">
<result>
<response resourceid="10005717" response-code="4000">
<message>Monitor added successfully.</message>
</response>
</result></AppManager-response>

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 to the list of common Request Parameters

FieldDescription
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.
forceadd This parameter is used to force Applications Manager to bypass availability and other authentication-related checks and add the monitor. Possible values are:
  • True - Force-adds the monitor
  • False - Does not force-add the monitor.
addgivenname Specifies if you want to set the host name of the monitor as the Host Name / IP Address that you have configured in the API.
passphrase Specify a Passphrase if the private key is protected with one for SSH Authentication.

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=admin123&timeout=2

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 to the list of common Request Parameters

FieldDescription
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'.
forceadd This parameter is used to force Applications Manager to bypass availability and other authentication-related checks and add the monitor. Possible values are:
  • True - Force-adds the monitor
  • False - Does not force-add the monitor.
addgivenname Specifies if you want to set the host name of the monitor as the Host Name / IP Address that you have configured in the API.
passphrase Specify a Passphrase if the private key is protected with one for SSH Authentication.

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

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 to the list of common Request Parameters

FieldDescription
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.
forceadd This parameter is used to force Applications Manager to bypass availability and other authentication-related checks and add the monitor. Possible values are:
  • True - Force-adds the monitor
  • False - Does not force-add the monitor.
addgivenname Specifies if you want to set the host name of the monitor as the Host Name / IP Address that you have configured in the API.
passphrase Specify a Passphrase if the private key is protected with one for SSH Authentication.

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

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]&kerberos_status=[ KERBEROS STATUS ]

Request Parameters:

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

FieldDescription
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 2008, Windows 2012, Windows 7, Windows 8, Windows XP, WindowsNT or Windows Vista
mode The mode of monitoring specified for the server. Value should be either SNMP or WMI.
username The user name of the Windows server.
password The password of the Windows server.
timeout The time out value in seconds.
eventlog_status Specifies if Event Log Monitoring is enabled. Parameter values are true/false.
snmpCommunityString A string of characters for user authentication.
forceadd This parameter is used to force Applications Manager to bypass availability and other authentication-related checks and add the monitor. Possible values are:
  • True - Force-adds the monitor
  • False - Does not force-add the monitor.
addgivenname Specifies if you want to set the host name of the monitor as the Host Name / IP Address that you have configured in the API.
passphrase Specify a Passphrase if the private key is protected with one for SSH Authentication.
kerberos_status Specifies if Kerberos authentication is enabled. Possible values are either true / false.

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&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&os=Windows XP&mode=WMI&username=administrator&password=pass&timeout=300&kerberos_status=true

Windows Clusters

Syntax:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST NAME]&Version=[VERSION NO]&username=[USERNAME]&password=[PASSWORD]&DiscoverNodes=[NO OF NODES]&EventLog=[YES/NO]&pollinterval=[INTERVAL]

Request Parameters:

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

FieldDescription
type The category type of the monitor you want to add. Value should be Windows Cluster
host The name of the host where the Windows server clusters are running.
version The Version of the Windows Server Clusters. Possible Values are:
  • 2008 (Default)
  • 2008 R2
DiscoverNodes Specify if you need to discover nodes. Possible Values are:
  • 0 - No(Default)
  • 1 - Yes
EventLog Specify if you need to display Event Logs.Possible Values are:
  • Yes
  • No(Default)
pollInterval The interval at which the server needs to be polled. This variable is optional. If no value is mentioned, the default value of 5 minutes will be taken.
forceadd This parameter is used to force Applications Manager to bypass availability and other authentication-related checks and add the monitor. Possible values are:
  • True - Force-adds the monitor
  • False - Does not force-add the monitor.
addgivenname Specifies if you want to set the host name of the monitor as the Host Name / IP Address that you have configured in the API.
passphrase Specify a Passphrase if the private key is protected with one for SSH Authentication.

Sample Request:

https://prod-server6:8080/AppManager/xml/AddMonitor?apikey=5bc6a8e9a30d5bf894586d4db90282f5&type=Windows Cluster&displayname=clusterApi&host=apmcluster&Version=2008 R2&username=apmcluster2012\administrator&password=12345&DiscoverNodes=1&EventLog=No&pollinterval=5