ManageEngine® Applications Manager


Chapter 10.7.11 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]

 

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.
displayname The display name of the monitor.
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

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

Top

Microsoft Hyper-V Server

Syntax:


http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]
&host=[HOST]&port=[PORT]&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.
port The port number where the Hyper-V server is running.
displayname The display name of the monitor.
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&port=8080&displayname=displayname&password=Vembu123app2
&addvms=yes&username=administrator

Top


<< Prev

Home

Next >>

AddMonitor API - Custom Monitors

AddMonitor API - Cloud Apps