[Webinar] Discover key trends and best practices in Kubernetes observability with DevOps expert, Viktor Farcic.Register now
Our recognition in the inaugural Gartner MQ for DEM

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

Syntax

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.

FieldDescription        
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:
  • 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:
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

CISCO UCS

Syntax

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.

FieldDescription        
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.

Sample Request:

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!

Was this content helpful?

We are sorry. Help us improve this page.

How can we improve this page?
Do you need assistance with this topic?
By clicking "Submit", you agree to processing of personal data according to the Privacy Policy.
Back to Top