This section explains how to use the AddMonitor API to add monitors of the category type 'Converged Infrastructure'. The following converged infrastructures are supported:
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
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 Nutanix. |
| host | The name of the host in 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 Nutanix monitor to. Not Mandatory. |
| groupID | The group ID of the monitor group you want to associate Nutanix monitor to. Not Mandatory. |
| AddVMS | You can specify whether you want to monitor the VMs present in the Nutanix instance or not. Possible values are:
|
| discoverInterval | The time interval for automatically discovering and monitoring child monitors in minutes. |
Rest-API with Password:
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:
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
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=NutanixMultiCluster&displayname=[DISPLAYNAME]&host=[PRISM_CENTRAL_HOST]&port=[PRISM_CENTRAL_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
The parameters involved in the API request are described below. Also, refer to the list of common Request Parameters.
| 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. |
| host | The Prism Central Hostname or IP address. |
| port | The Prism Central port. Default is 9440. |
| UserName | Username with permission to access Prism Central. |
| 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:
|
| discoverInterval | The periodic interval (in minutes) for cluster discovery. |
| pollInterval | The polling interval (in minutes) for Prism Central–level operations. |
| addToGroup | Name of the monitor group to which this monitor must be added (optional). |
| groupID | ID of the monitor group (optional). |
REST API with Username/Password:
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=NutanixMultiCluster&displayname=multiCluster01&host=pc-host&port=9440&UserName=admin&Password=admin123&discoverInterval=10&pollInterval=5&deleteAction=Unmanage
REST API with Credential ID:
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=NutanixMultiCluster&displayname=multiCluster01&host=pc-host&port=9440&credentialID=2&discoveryFilter=cluster.*&discoverInterval=10&pollInterval=5&deleteAction=Retain
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.
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]
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 CiscoUCS. |
| host | The name of the host in 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. |
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
Thank you for your feedback!
