ManageEngine® Applications Manager

AddMonitor API - Virtualization

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

VMware ESX/ESXi Server
VMware Horizon View Connection Broker
Microsoft Hyper-V Server
Citrix Xenserver
Citrix XenApp
VCenter
Docker

VMware ESX/ESXi Server

Syntax:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]
&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&username=[USERNAME]&password=[PASSWORD]
&addtoGroup=[ADDTOGROUP]&groupID=[GROUPID]&monitorvms=[MONITORVMS]

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 VMware ESX/ESXi.
host	The name of the host where the VMWare ESX/ESXi server is running.
port	The port number where the VMware ESX/ESXi server is running.
username	The user name of the VMware ESX/ESXi server.
password	The password of the VMware ESX/ESXi server.
addtoGroup	Denotes if the monitor should be added to monitor group. Value is either true or false
groupID	The monitor group ID
monitorvms	Indicates the way the virtual machines of the ESX server are to be monitored. Possible values are no, yes and onlyavailability. The value no means the VMs will not be discovered. The value yes indicates that the VMs will be discovered and monitored. The value onlyavailability indicates that the VMs will be discovered but the metrics will not be monitored (will not count for licensing).

Sample Request:

http://prod-server5:9090/AppManager/xml/AddMonitor?apikey=e249ce592ad1052c4ea605bcf3125ad9
&type=VMWare ESX/ESXi&displayname=vnwgroup&host=esx-2&port=443&username=root&password=password&addToGroup=true
&groupID=10000024&monitorvms=onlyavailability

Top

VMware Horizon View Connection Broker

You can add the VMware Horizon View Connection Broker monitor in the following two ways:

Add VMware Horizon View as a new monitor group (New Monitor Group --> VMware Horizon View).This will discover all the components in the Horizon View Set up including View Connection Broker.

Syntax:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=VMwareView&displayname=[DISPLAYNAME]&host=[HOST]&username=[USERNAME]&password=[PASSWORD]&pollInterval=[POLL INTERVAL]

Sample Request:

http://prod-server5:9090/AppManager/xml/AddMonitor?apikey=f6ad2a431bb2cd5aa85c195262daef7f&type=VMwareView&displayname=HorizonView&host=172.18.144.52&username=vmwarehzview\user-test&password=APM@13&pollInterval=5
Add VMware Horizon View Connection Broker as a new monitor (New Monitor --> VMware Horizon View Connection Broker). This will discover View Connection Broker alone.

Syntax:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=ViewConnectionBroker&displayname=[DISPLAYNAME]&host=[HOST]&username=[USERNAME]&password=[PASSWORD]&pollInterval=[POLL INTERVAL]&addtoGroup=[TRUE/FALSE]&groupID=[GROUPID]

Sample Request:

http://prod-server5:9090/AppManager/xml/AddMonitor?apikey=f6ad2a431bb2cd5aa85c195262daef7f&type=ViewConnectionBroker&displayname=ViewBroker&host=172.18.144.52&username=vmwarehzview\maran-test&password=Zoho@13&pollInterval=5&addtoGroup=true&groupID=10000028

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 VMwareView or ViewConnectionBroker.
host	The name of the host where the VMware Horizon View server is running.
username	The user name of your VMware server.
password	The password of your VMware server.

Microsoft Hyper-V Server

Syntax:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]
&host=[HOST]&displayname=[DISPLAYNAME]&password=[PASSWORD]
&addvms=[ADDVMS]&username=[USERNAME]&Version=[2008/2012]

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 Hyper-V Server.
host	The name of the host where the Hyper-V server is running.
password	The password of the Hyper-V server.
addvms	Denotes whether the performance metrics of VMs should be collected. Value is either yes or no
username	The user name of the Hyper-V server.
Version	The version of your Microsoft Hyper-V Server. Values are 2008 or 2012.

Sample Request:

http://prod-server6:9090/AppManager/xml/AddMonitor?apikey=256d041620d0aee9901558b44706dc84
&type=Hyper-V Server&host=amp-w2k8-64&displayname=apmhyperv&password=admin123app2
&addvms=yes&username=administrator&Version=2008

Top

Citrix Xenserver

Syntax:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE] &host=[HOST]&displayname=[DISPLAYNAME]&username=[USERNAME]&password=[PASSWORD]&port=[PORT] &addvms=[ADDVMS]&addToGroup=[TRUE/FALSE]&groupID=[GROUPID]&monitorvms=[AVAILABILITY]

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 XenServerHost.
host	The name of the host where the XenServerHost is running.
password	The password of the XenServerHost
addvms	Denotes whether the performance metrics of VMs should be collected. Value is either yes or no
username	The user name of the XenServerHost
addToGroup	Denotes if the monitor should be added to monitor group. Value is either true or false
groupID	The monitor group ID
monitorvms	Indicates the way the virtual machines are to be monitored. Possible values are no, yes and onlyavailability. The value no means the VMs will not be discovered. The value yes indicates that the VMs will be discovered and monitored. The value onlyavailability indicates that the VMs will be discovered but the metrics will not be monitored (will not count for licensing).

Sample Request:

http://prod-server6:9090/AppManager/xml/AddMonitor?apikey=bc76b1abb8e9b209824a39d84578a194 &type=XenServerHost&host=192.18.3.75&displayname=newxen&password=sankho &addvms=yes&username=root

Citrix XenApp

Syntax:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE] &host=[HOST]&displayname=[DISPLAYNAME]&UserName =[USERNAME]&Password=[PASSWORD]&Version=[VERSION]

Request Parameters:

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

Field	Description
apikey	The key generated from the Generate API Key option in the 'Admin' tab.
type	The type of the monitor you want to add. The value should be XenApp.
host	The name of the host where the XenApp Server is running.
displayname	The display name of the monitor.
UserName	The user name of the XenApp Server Host Machine.
password	The password of the XenApp Server Host Machine.
version	The version of XenApp.

Sample Request:

http://prod-server6:9090/AppManager/xml/AddMonitor?apikey=bc76b1abb8e9b209824a39d84578a194&type=XenApp&host=192.18.3.75&displayname=XenAppServer&UserName =administrator&Password=pass&Version=7.6

VCenter

Syntax:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]
&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&username=[USERNAME]&password=[PASSWORD]&addtoGroup=[ADDTOGROUP]&groupID=[GROUPID]&monitorvms=[MONITORVMS]

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 vCenter.
vcHost	The name of the host where vCenter is running.
vcPort	The port number where the vCenter is running.
username	The user name of the vCenter server.
password	The password of the vCenter server.
addtoGroup	Denotes if the monitor should be added to monitor group. Value is either true or false

Sample Request:

http://[host]:[port]/AppManager/xml/AddMonitor?apikey=[apikey]&type=vCenter&displayname=vctest&vcHost=vcenter&vcPort=443&username=test&password=test&pollInterval=5

Docker

Syntax:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]
&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&username=[USERNAME]&password=[PASSWORD]&sslenabled=[isSSLEnabled]

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 Docker.
host	The name of the host where Docker is running.
port	The port number where Docker is running.
username	The user name of the Docker server.
password	The password of the Docker server.
SSL enabled	Option to enable SSL.

Sample Request:

http://Host:port/AppManager/xml/AddMonitor?apikey=[API KEY]&type=Docker&displayname=docker&host=apm-u12-temp&port=4243&username=&password=&isSSLEnabled=false

Top

<< Prev	Home	Next >>
AddMonitor API - Services		AddMonitor API - Web Server/Services