# AddMonitor APIs - Converged Infrastructure This section explains how to use the AddMonitor API to add monitors of the category type **Converged Infrastructure**. The following converged infrastructures are supported: - [Nutanix](https://www.manageengine.com/products/applications_manager/help/converged-infrastucture-api.html#nutanix) - [Nutanix Multi Cluster](https://www.manageengine.com/products/applications_manager/help/converged-infrastucture-api.html#nutanixmulticluster) - [CISCO UCS](https://www.manageengine.com/products/applications_manager/help/converged-infrastucture-api.html#ucs) ## Nutanix ### Syntax ```text https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&UserName=[USERNAME]&Password=[PASSWORD]&addtoGroup=[ADDTOGROUP]&groupID=[GROUPID]&AddVMS=[MONITORVMS]&discoverInterval=[INTERVAL] ``` **Supported HTTP methods:** POST **Allowed roles:** Administrator ### Request Parameters The parameters involved in the API request are described below. Also, refer the [list of common Request Parameters.](https://www.manageengine.com/products/applications_manager/help/addmonitor-api.html#requestparameters) | Field | Description | |---|---| | type | The type of monitor you want to add. Value should be ***Nutanix***. | | host | The name of the host on which Nutanix is running. | | port | The port number where Nutanix is running. | | password | The password of the user who has permission to access the Nutanix deployment. | | addtoGroup | The name of the monitor group you want to associate the Nutanix monitor with. Not Mandatory. | | groupID | The group ID of the monitor group you want to associate the Nutanix monitor with. Not Mandatory. | | AddVMS | You can specify whether you want to monitor the VMs present in the Nutanix instance or not. Possible values are:

- ***0*** - Do not discover VMs
- ***1*** - Discover VM but do not monitor metrics
- ***2*** - Discover and monitor VM metrics. | | discoverInterval | The time interval for automatically discovering and monitoring child monitors in minutes. | ### Sample Request **Rest-API with Password:** ```text https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Nutanix&displayname=nutanixmon&host=apm-host&port=9440&UserName=admin&Password=appman&AddVMS=2 ``` **Rest-API with Credentials:** ```text https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Nutanix&displayname=nutanixmon&host=apm-host&port=9440&credentialID=1&AddVMS=2&DiscoverNode=yes&discoverInterval=10 ``` ## Nutanix Multi-Cluster ### Syntax ```text https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=NutanixMultiCluster&displayname=[DISPLAYNAME]&monitoringMode=[v2/v4]&host=[HOST]&port=[PORT]&UserName=[USERNAME]&Password=[PASSWORD]&credentialID=[CREDENTIALID]&discoveryFilter=[REGEX]&deleteAction=[RETAIN/UNMANAGE/DELETE]&discoverInterval=[DISCOVERY_INTERVAL]&pollInterval=[POLL_INTERVAL]&addToGroup=[GROUPNAME]&groupID=[GROUPID] ``` **Supported HTTP methods:** POST **Allowed roles:** Administrator ### Request Parameters The parameters involved in the API request are described below. Also, refer to the [list of common Request Parameters.](https://www.manageengine.com/products/applications_manager/help/addmonitor-api.html#requestparameters) | Field | Description | |---|---| | type | The type of the monitor you want to add. Value should be ***NutanixMultiCluster***. | | displayname | The display name for the Nutanix Multi-Cluster monitor. | | monitoringMode | The monitoring mode to use for the Nutanix Multi-Cluster monitor. Possible values:

- **Prism Central** — Uses the Prism Central v4 APIs. This is the primary monitoring mode.
- **Prism Element** — Uses the existing Prism Element v2 APIs. This is the default monitoring mode. | | host | The hostname or IP address of the Prism Central or Prism Element instance, based on the selected *monitoringMode*. | | port | The port of the Prism Central or Prism Element instance. Default is **9440**. | | UserName | Username with permission to access the selected Nutanix instance. | | Password | Password for the above user. Not required if *credentialID* is used. | | credentialID | ID of the stored credential to be used for authentication. Optional. | | discoveryFilter | Optional discovery regex filter to include only matching Nutanix clusters. | | deleteAction | Action to perform when a previously discovered cluster is no longer found. Possible values:

- **Retain**
- **Unmanage**
- **Delete** | | discoverInterval | The periodic interval (in minutes) for cluster discovery. | | pollInterval | The polling interval (in minutes) for Nutanix operations. | | addToGroup | Name of the monitor group to which this monitor must be added (optional). | | groupID | ID of the monitor group (optional). | ### Sample Request **REST API with Username/Password:** ```text https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=NutanixMultiCluster&displayname=multiCluster01&monitoringMode=v2&host=pc-host&port=9440&UserName=admin&Password=admin123&discoverInterval=10&pollInterval=5&deleteAction=Unmanage ``` **REST API with Credential ID:** ```text https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=NutanixMultiCluster&displayname=multiCluster01&monitoringMode=v4&host=pe-host&port=9440&credentialID=2&discoveryFilter=cluster.*&discoverInterval=10&pollInterval=5&deleteAction=Retain ``` ## Monitored Parameters The Nutanix Multi-Cluster monitor currently performs **cluster discovery only**. No performance metrics are available at this level. All metrics are available under each discovered Nutanix (Prism Element) child monitor. ## CISCO UCS ### Syntax ```text https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&host=[HOSTNAME]&port=[PORT]&isSSLEnabled=[IS SSL ENABLED]&username=[USERNAME]&password=[PASSWORD]&timeout=[TIMEOUT]&displayname=[DISPLAYNAME] ``` ### Request Parameters The parameters involved in the API request are described below. Also, refer the [list of common Request Parameters.](https://www.manageengine.com/products/applications_manager/help/addmonitor-api.html#requestparameters) | Field | Description | |---|---| | type | The type of monitor you want to add. Value should be ***CiscoUCS***. | | host | The name of the host on which the CISCO UCS server is running. | | port | The port number where the CISCO UCS server is running. | | username | The username of the Cisco UCS server. | | password | The password of the Cisco UCS server. | | isSSLEnabled | Denotes if SSL is enabled or not. Possible values are either *true* or *false*. | | timeout | The timeout value in seconds. | ### Sample Request ```text https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=CiscoUCS&host=apm-host&port=80&username=admin&password=appman&timeout=40&displayname=RestAPI&isSSLEnabled=true ```