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:

MS Office SharePoint

Syntax

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&username=[USERNAME]&password=[PASSWORD]&version=[SHAREPOINT VERSION]&SPType=[SHAREPOINT TYPE]&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.
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

http://prod-server5:9090/AppManager/xml/AddMonitor?apikey=4df5040d6db873dcdaf4359b259fd494&type=MSOfficeSharePointServer&displayname=ms&host=app-server&username=administrator&password=admin123&version=2010&SPType=SPServer&Powershell=True& Services=SharepointServices,ContentDB,WebApplication,TimerJobs,AccessServices,InfoPathServices,VisioWebAccess Services,ExcelServices,OfficeSearchGatherer

WebLogic Integration

Syntax:

http://[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:

http://prod-server3:9090/AppManager/xml/AddMonitor?apikey=136edbeb3ccb83c6cc71df03ef273313&type=WebLogic Integration&displayname=apm&host=app-server&port=7001&username=weblogics&password=weblogic&version=8.1

IBM WebSphere MQ

Syntax:

http://[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]

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 IBM WebSphere MQ.
host The name of the host where the WebSphere MQ server is running.
listenerport The listener port number of the IBM 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. 

Sample Request:

http://prod-server8:9090/AppManager/xml/AddMonitor?apikey=bc76b1abb8e9b209824a39d84578a194&type=IBM%20Websphere%20MQ&host=app-server&listenerport=1416&displayname=mqws&serverconnectionchannel=SCCHANEL1&Queue%20Manager=QMANAGER_QA1&AuthEnabled=true&username=test&password=test&&MonitorBroker=true&v10=true&BrokerPort=4416&BrokerAuthEnabled=true&brokerusername=test&brokerpassword=test

Microsoft Message Queue (MSMQ)

Syntax:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&username=[USERNAME]&password=[PASSWORD]

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

Sample Request:

http://prod-server8:9090/AppManager/xml/AddMonitor?apikey=256d041620d0aee9901558b44706dc84&type=Microsoft MQ&displayname=msmq&host=app-server&username=administrator&password=password

RabbitMQ

Syntax:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST] &port=[PORT]&username=[USERNAME]&password=[PASSWORD]

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.

Sample Request:

http://app-xp5:9090/AppManager/xml/AddMonitor?apikey=bc76b1abb8e9b209824a39d84578a194&type=VMware vFabric tc Server&displayname=vFabric&host=app-server&port=6969&username=admin&password=admin123&JNDIPath=/jmxrmi

Microsoft BizTalk

Syntax

http://[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]

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.

Sample Request

  • http://app-x5p:9400/AppManager/xml/AddMonitor?apikey=fcc04ce64410e0dd7ccf72371a79761c&type=BizTalkServer&displayname=BizTalk2016&host=apm-biz1-1&Version=2016&UserName=apm\administrator&Password=Pass123&PowerShell=True&CredSSP=False&DBServer=apm-biz1-1&DBName=BizTalkMgmtDb
  • http://app-x5p:9400/AppManager/xml/AddMonitor?apikey=ddc04ce64410e0dd7ccf72371a79761c&type=BizTalkServer&displayname=BizTalk2016&host=apm-biz16-1&Version=2013&UserName=apm\administrator&Password=Pass123&PowerShell=False&CredSSP=False

Oracle Tuxedo

Syntax:

http://[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:

http://app-xp5:9090/AppManager/xml/AddMonitor?apikey=a169e7aa3b4656d0db29532fd4347&type=Oracle Tuxedo&displayname=Tuxedo&host=172.31.10.1&SNMPPORT=161&snmpCommunityString=public&timeout=40

Microsoft Skype for Business

Syntax

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&username=[USERNAME]&password=[PASSWORD]&Version=[VERSION]&Roles=[ROLES]

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:
  • lync
  • sfb2015
Roles Provide the role(s) that you wish to monitor as comma separated values :
  • FrontEndServer
  • A/V Conferencing Server
  • EdgeServer
  • MediationServer

Sample Request

http://app-xp5:9090/AppManager/xml/AddMonitor?apikey=4787dvds8941bc5a7b0db85d43a5b789&type=LyncServer&displayname=LyncAPI&host=172.31.10.1&UserName=APM\administrator&Password=pass&Version=sfb2015&Roles=FrontEndServer,A/V Conferencing Server,MediationServer

Azure Service Bus

Syntax:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[AzureServiceBus]&displayname=[DISPLAYNAME]&SubscriptionId=[SUBSCRIPTIONID]&Namespace=[NAMESPACE]&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        
SubscriptionID Subscription ID of the Azure Subscription used.
Namespace Service Bus Namespace name.
Timeout Timeout in seconds.

Sample Request:

http://anne-2394:9096/AppManager/xml/AddMonitor?apikey=35eb5a8f77a1595f9d9e575a7c3575ad &type=AzureServiceBus&displayname=azureapmsbadmin&SubscriptionId=1591f1b0-6e8c-461f-8916-df7954193ec2&Namespace=applicationsmanager&Timeout=20

Apache ActiveMQ

Syntax:

http://[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:

http://prod-server8:9091/AppManager/xml/AddMonitor?apikey=ff5db35538c534e24dc2154cffbc7e6e&type=ApacheActiveMQ&displayname=Success&HostName=app-w8-aio-5&Port=1099&UserName=&Password=&JNDIPath=/jmxrmi