ManageEngine® Applications Manager


AddMonitor API - Virtualization

<< Prev

Home

Next >>

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

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:9098/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

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]

 

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.

Sample Request:


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

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

 


<< Prev

Home

Next >>

AddMonitor API - Services

AddMonitor API - Web Server/Services