AddMonitor APIs - Middleware/Portal
This section explains how to use the AddMonitor API to add monitors of the category type 'Middleware/Portal'. The following monitors are supported:
Supported HTTP methods: POST
Allowed roles: Administrator
MS Office SharePoint
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&username=[USERNAME]&password=[PASSWORD]&version=[SHAREPOINT VERSION]&SPType=[SHAREPOINT TYPE]&Timeout=[TIMEOUT]&Powershell=[IS POWERSHELL ENABLED]&Services=[SHAREPOINT SERVICES]
Request Parameters
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 MSOfficeSharePointServer. |
| version | The Version of Microsoft Office SharePoint Server. Possible values are 2007, 2010, 2013, 2016 or 2019. |
| host | The name of the host where the Office SharePoint server is running. |
| username | The user name of the SharePoint server. |
| password | The password of the SharePoint server. |
| SPType | The SharePoint server type. Possible Values are:- Farm -If the server has a Farm setup.
- SPServer-If the server has a Stand Alone setup.
|
| Timeout | The timeout value in seconds. Value should be between 60 and 900 seconds (defualt is 300 seconds). |
| Powershell (optional): | Specifies if Powershell is enabled. Possible values are:- True - If powershell is enabled.
- False - If powershell is not enabled.
|
| Service (optional): | | Version | Field Name | Possible Values |
|---|
| 2007 | Service | ExcelServices / DocumentConversions / OfficeSearchGatherer | | 2010 & 2013 | Services | SharepointServices / ContentDB / WebApplication / TimerJobs / AccessServices / InfoPathServices / VisioWebAccess Services / ExcelServices / OfficeSearchGatherer | | 2016 & 2019 | SP2016Services | SharepointServices / ContentDB / WebApplication / TimerJobs / AccessServices / InfoPathServices / VisioWebAccess Services / SearchServices |
|
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=MSOfficeSharePointServer&displayname=ms&host=app-server&username=admin&password=appman&version=2010&SPType=SPServer&Timeout=300&Powershell=True& Services=SharepointServices,ContentDB,WebApplication,TimerJobs,AccessServices,InfoPathServices,VisioWebAccess Services,ExcelServices,OfficeSearchGatherer
WebLogic Integration
Syntax:
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&username=[USERNAME]&password=[PASSWORD]&version=[VERSION]
Request Parameters:
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 WebLogic Integration. |
| host | The name of the host where the WebLogic Integration server is running. |
| port | The port number where the WebLogic Integration server is running. |
| username | The user name of the WebLogic Integration server . |
| password | The password of the WebLogic Integration server. |
| version | The WebLogic Integration server version. Value is 8.1 |
Sample Request:
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=WebLogic Integration&displayname=apm&host=app-server&port=7001&username=admin&password=appman&version=8.1
IBM App Connect Enterprise
Syntax:
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[IBMAppConnectEnterprise]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&username=[USERNAME]&password=[PASSWORD]&pollInterval=[pollInterval]&AddContainers=[AddContainers]
Request Parameters:
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 monitor you want to add. Value should be IBMAppConnectEnterprise. |
| host | The name of the host where the IBM App Connect Enterprise is running. |
| port | The port number through which the IBM App Connect Enterprise Node communicates. |
| displayname | The display name of the monitor. |
| username | The username required to authenticate with the IBM App Connect Enterprise Node. |
| password | The password required to authenticate with the IBM App Connect Enterprise Node. |
| pollInterval | The polling interval (in minutes) at which Applications Manager should collect metrics from the IBM App Connect Enterprise Node. |
| AddContainers | Specify whether to enable the Server Discovery.
Values can be 0 - Do Not Discover, 1 - Discover but do not monitor the metrics, 2 - Discover all the servers and monitor the metrics. |
Sample Request:
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=IBMAppConnectEnterprise&displayname=ACE_Node&host=app-server&port=7600&username=admin&password=appman&pollInterval=10&AddContainers=1
IBM App Connect Enterprise Servers
Syntax:
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[IBMAppConnectEnterpriseServers]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&username=[USERNAME]&password=[PASSWORD]&pollInterval=[pollInterval]
Request Parameters:
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 monitor you want to add. Value should be IBMAppConnectEnterpriseServers. |
| host | The name of the host where the IBM App Connect Enterprise server is running. |
| port | The port number through which the IBM App Connect Enterprise Server communicates. |
| displayname | The display name of the monitor. |
| username | The username required to authenticate with the IBM App Connect Enterprise Server. |
| password | The password required to authenticate with the IBM App Connect Enterprise Server. |
| pollInterval | The polling interval (in minutes) at which Applications Manager should collect metrics from the IBM App Connect Enterprise Server. |
Sample Request:
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=IBMAppConnectEnterpriseServers&displayname=IBMAceServer&host=ace-server&port=7600&username=admin&password=appman&pollInterval=10
IBM WebSphere MQ
Syntax:
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&listenerport=[PORT]&displayname=[DISPLAYNAME]&serverconnectionchannel=[SERVERCONNECTIONCHANNEL]&Queue%20Manager=[QUEUEMANAGER]&AuthEnabled=[AUTHENABLED]&username=[USERNAME]&password=[PASSWORD]&MonitorBroker=[MONITORBROKER]&v10=[ISV10]&BrokerPort=[BROKERPORT]&BrokerAuthEnabled=[BROKERAUTHENABLED]&brokerusername=[BROKERUSERNAME]&brokerpassword=[BROKERPASSWORD]&timezone=[TIMEZONE]&discoverInterval=[INTERVAL]
Request Parameters:
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 WebsphereMQ. |
| host | The name of the host where the WebSphere MQ server is running. |
| listenerport | The listener port number of the WebSphere MQ server. |
| displayname | The display name of the monitor. |
| serverconnectionchannel | The server connection channel through which the WebSphere MQ clients communicate. |
| Queue Manager | The name of the Queue Manager through which the WebSphere MQ clients communicate. |
| SSLEnabled | Specify if SSL is enabled. Values are true or false. |
| SSLCipherSpec | The name of SSL Cipher Spec. |
| AuthEnabled | Specifies if authentication is enabled. Possible values are true or false. |
| username | The username to connect the websphere mq queue manager. |
| password | The password to connect the websphere mq queue manager. |
| FilterSysObject | The Filter System Objects.Possible values are true or false. |
| SysObjects | The System Objects to monitor. |
| MonitorBroker | Specifies if MessageBroker is enabled. Possible values are true or false. |
| v10 IIB | Specifies if the Version is 10 and above. Possible values are true or false. |
| BrokerPort | The Port number of the IBMIntegrationBus(MessageBroker). Provide 0 if not applicable. |
| BrokerAuthEnabled | Specifies if the BrokerAuthentication is enabled. Possible values are true or false. |
| brokerusername | The username to connect to the websphere message broker. |
| brokerpassword | The password to connect to the websphere message broker. |
| timezone | The timezone of the WebSphere MQ server. |
| discoverInterval | The time interval for automatically discovering and monitoring child monitors in minutes. |
Sample Request:
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=WebsphereMQ&host=app-server&listenerport=1416&displayname=mqws&serverconnectionchannel=SCCHANEL1&Queue%20Manager=QMANAGER_QA1&AuthEnabled=true&username=admin&password=appman&&MonitorBroker=true&v10=true&BrokerPort=4416&BrokerAuthEnabled=true&brokerusername=test&brokerpassword=test&timezone=Default&discoverInterval=10
Microsoft Message Queue (MSMQ)
Syntax:
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&username=[USERNAME]&password=[PASSWORD]&Powershell=[True/False]&Timeout=[TIMEOUT]
Request Parameters:
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 Microsoft MQ. |
| host | The name of the host where the Microsoft MQ server is running. |
| username | The username of the MSMQ server. |
| password | The password of the MSMQ server. |
| Powershell | Indicates whether Powershell is enabled in the MSMQ server. (True or False) |
| Timeout | The timeout value in seconds. Value should be between 60 and 900 seconds. Applicable only when Powershell is enabled in MSMQ server. |
Sample Request:
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Microsoft MQ&displayname=msmq&host=app-server&username=admin&password=appman&Powershell=True&Timeout=500
RabbitMQ
Syntax:
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&username=[USERNAME]&password=[PASSWORD]&filterEnabled=[true/false]&DiscoveryFilterRegex=[REGEX_TO_BE_USED]
Request Parameters:
The parameters involved in the API request are described below. Also, refer to the list of common request parameters.
| Field | Description |
|---|
| type | Denotes the category type of the monitor you want to add. The value should be as 'RabbitMQ'. |
| host | The name of the host where the RabbitMQ server is running. |
| port | The port number where RabbitMQ server is running. |
| username | The username of the RabbitMQ server server. |
| password | The password of the RabbitMQ server server. |
| filterEnabled | Value has to be true if the user wants to enable Discovery Filter for the monitor specified for Discovery, else false. |
| DiscoveryFilterRegex | If the value for this parameter is true, the user should specify the Regex to be used. If the value for filterEnabled parameter is given as true, then DiscoveryFilterRegex parameter should be mandatorily specified. |
Sample Request
- When Discovery filter is enabled : https://localhost:8445/AppManager/xml/AddMonitor?apikey=67c012bc188b51815b9f2702a54e9edc&type=RabbitMQ&displayname=RabbitMQ Test&host=apm-kubernetes&port=15672&username=admin&password=admin&filterEnabled=true&DiscoveryFilterRegex=CHANNEL_USER=admin
- When Discovery filter is disabled :https://localhost:8445/AppManager/xml/AddMonitor?apikey=67c012bc188b51815b9f2702a54e9edc&type=RabbitMQ&displayname=RabbitMQ Test&host=apm-kubernetes&port=15672&username=admin&password=admin&filterEnabled=false
Microsoft BizTalk
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=BizTalkServer&displayname=[DISPLAYNAME]&host=[BIZTALKHOST]&Version=[2013/2016]&UserName=[USERNAME]&Password=[PASSWORD]&PowerShell=[TRUE/FALSE]&CredSSP=[YES/FALSE]&DBServer=[DBSERVERHOST]&DBName=[BIZTALKMANAGEMENTDBNAME]&kerberos=[True/False]
Request Parameters
The parameters involved in the API request are described below. Also, refer to the list of common request parameters.
| Field | Description |
|---|
| type | The category type of the monitor you want to add. The value should be BizTalkServer. |
| host | The name of the host where where BizTalk is installed. |
| Version | Version of Biztalk Application- 2013 - If Biztalk version is 2013 or below
- 2016 - If Biztalk version is 2016
|
| UserName | The username of the BizTalk server host machine. |
| Password | The password of the BizTalk server host machine. |
| PowerShell | Is powershell enabled? Values are:- True - powershell is enabled
- False - powershell is disabled
|
| DBServer | The name of the server where the configuration database is stored (required only if PowerShell is enabled). |
| DBName | The name of the configuration database (required only if PowerShell is enabled). |
| CredSSP | Specifies if CredSSP Authentication should be used,when Use Powershell option is chosen. The value is Yes if credssp needs to be enabled and False if not enabled. |
| kerberos | Option to enable Kerberos authentication. (True or False) |
Sample Request
- https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=BizTalkServer&displayname=BizTalk2016&host=apm-biz1-1&Version=2016&UserName=apm\admin&Password=appman&PowerShell=True&CredSSP=Yes&DBServer=apm-biz1-1&DBName=BizTalkMgmtDb&kerberos=False
- https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=BizTalkServer&displayname=BizTalk2016&host=apm-biz16-1&Version=2013&UserName=apm\admin&Password=appman&PowerShell=False&CredSSP=False&kerberos=False
Oracle Tuxedo
Syntax:
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST] &SNMPPORT=[PORT]&snmpCommunityString=[COMMUNITYSTRING]&timeout=[TIMEOUT]
Request Parameters:
The parameters involved in the API request are described below. Also, refer to the list of common request parameters.
| Field | Description |
|---|
| type | The category type of the monitor you want to add. The value should be Oracle Tuxedo. |
| host | The name of the host where where Tuxedo is installed. |
| displayname | The Display Name of the monitor. |
| SNMPPORT | The SNMP port number , on which the Tuxedo SNMP agent is running. The default port number is 161. |
| snmpCommunityString | The SNMP community string of Tuxedo SNMP agent. The default value is 'public'. Make sure you use a community string, that has at least 'Read-only' privileges. |
| timeout | The timeout in seconds. |
Sample Request:
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Oracle Tuxedo&displayname=Tuxedo&host=172.31.10.1&SNMPPORT=161&snmpCommunityString=public&timeout=40
Microsoft Skype for Business
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&username=[USERNAME]&password=[PASSWORD]&Version=[VERSION]&Roles=[ROLES]&kerberos=[True/False]
Request Parameters
The parameters involved in the API request are described below. Also, refer to the list of common request parameters.
| Field | Description |
|---|
| type | The category type of the monitor you want to add. The value should be LyncServer. |
| host | The Host Name or IP Address of the host where the Microsoft Skype for Business Server runs. |
| displayname | The Display Name of the monitor. |
| UserName | The UserName of the account used to monitor the Microsoft Skype for Business Server. The account should have administrator privileges to access Microsoft Skype for Business Server. |
| password | The password of the above user who has administrator privileges to access Microsoft Skype for Business Server. |
| Version | The version Microsoft Skype for Business 2015 or Microsoft Lync Server whichever is installed on the server. Possible values are: |
| Roles | Provide the role(s) that you wish to monitor as comma separated values :- FrontEndServer
- A/V Conferencing Server
- EdgeServer
- MediationServer
|
| kerberos | Option to enable Kerberos authentication. (True or False) |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=LyncServer&displayname=LyncAPI&host=172.31.10.1&UserName=APM\admin&Password=appman&Version=sfb2015&Roles=FrontEndServer,A/V Conferencing Server,MediationServer&kerberos=False
Apache ActiveMQ
Syntax:
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[apikey]&type=ApacheActiveMQ&displayname=[Displayname]&HostName=[HostName]&Port=[Port]&UserName=[UserName]&Password=[Password]&JNDIPath=/jmxrmi
Request Parameters:
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 database you want to add. Value should be ApacheActiveMQ. |
| display name | Display name of the ActiveMQ monitor. |
| hostname | The name of the host in which ActiveMQ server is running. |
| port | The port number where ActiveMQ server is running. |
| username | The name of the user who has permission to access the Apache ActiveMQ server. |
| JNDIPath | JNDI path to be used. |
Sample Request:
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=ApacheActiveMQ&displayname=Success&HostName=app-host-server&Port=1099&UserName=admin&Password=appman&JNDIPath=/jmxrmi
Apache Kafka
Syntax
https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[API KEY]&type=Kafka&displayname=[Displayname]&HostName=[Hostname]&Port=[Port]&UserName=[UserName]&Password=[Password]&JNDIPath=/jmxrmi
Request Parameters
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 database you want to add. Value should be Kafka. |
| display name | Display name of the Kafka monitor. |
| hostname | The name of the host in which Kafka server is running. |
| port | The port number where Kafka server is running. |
| username | The name of the user who has permission to access the Apache Kafka server. |
| JNDIPath | JNDI path to be used. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Kafka&displayname=Kafka&HostName=172.20.8.62&Port=9999&UserName=admin&Password=appman&JNDIPath=/jmxrmi
