msbiztalkserver.ps1 - powershell script by ActiveXperts Software
msbiztalkserver.ps1 checks whether MS BizTalk is running; it checks services, processes and performance counters.
Use msbiztalkserver.ps1 directly from ActiveXperts Network Monitor; in the Manager's 'Monitor' menu, select 'New Check (Script)' and select msbiztalkserver.ps1. Configure the required parameter, or press 'Load a working sample'.
In ActiveXperts Network Monitor, Administrators can use three different scripting languages: Powershell, VBScript and SSH.
msbiztalkserver.ps1 script code
#################################################################################
# ActiveXperts Network Monitor PowerShell script, © ActiveXperts Software B.V.
# For more information about ActiveXperts Network Monitor, visit the ActiveXperts
# Network Monitor web site at http://www.activexperts.com
#################################################################################
# Script:
# MsBizTalkServer.ps1
# Description:
# Checks if BizTalk is running; it checks the Biztalk services and Biztalk processes
# Declare Parameters:
# 1) strHost (string) - Hostname or IP address of the server you want to check
# 2) strVersion (string) - BizTalk Server version (either 2013, 2010 or 2009)
# 3) strAltCredentials (string, optional) - Specify an empty string to use Network Monitor service credentials.
# To use alternate credentials, enter a server that is defined in Server Credentials table.
# (To define Server Credentials, choose Tools->Options->Server Credentials)
# Usage:
# .\MsBizTalkServer.ps1 '<Hostname | IP>' '<version>' '[alt-credentials]'
# Sample:
# .\MsBizTalkServer.ps1 'localhost' '2013'
#################################################################################
# -- Declare Parameters
param ( [string]$strHost = '', [string]$strVersion = '', [string]$strAltCredentials = '' )
# -- Use _activexperts.ps1 with common functions
. 'C:\Program Files\ActiveXperts\Network Monitor\Scripts\Monitor (ps1)\_activexperts.ps1'
#################################################################################
# // --- Private Functions section ---
#################################################################################
function getSoftwareInfo( $strVersion, [ref]$lstServices, [ref]$lstProcesses, [ref]$lstPerfCounters )
{
# Retrieve services, processes and counters associated to the specific version of the software. Entries that start
# with '!' are optional services/processes/counters and are not checked by default. Remove '!' mark to enable monitoring those items.
switch( $strVersion )
{
'2013'
{
$lstServices.value = @( @( 'BTSSvc$BizTalkServerApplication', 'BizTalk Service BizTalk Group : BizTalkServerApplication' ),
@( 'MSSQLSERVER', 'SQL Server (MSSQLSERVER)' ),
@( '', '' ) )
$lstProcesses.value = @( 'BTSNTSvc.exe', 'sqlservr.exe', '' )
$lstPerfCounters.value = @( @( 'Memory', '', 'Available Bytes', '-gt 104857600' ),
@( 'Processor', '_TOTAL', '% Processor Time', '-lt 90' ),
@( '', '' ) )
return $AXSUCCESS
}
'2010'
{
$lstServices.value = @( @( 'BTSSvc$BizTalkServerApplication', 'BizTalk Service BizTalk Group : BizTalkServerApplication' ),
@( '!BTSSvc$InetHost', 'BizTalk Service BizTalk Group : InetHost' ),
@( '!BTSSvc$InetSend', 'BizTalk Service BizTalk Group : InetSend' ),
@( '!BTSSvc$NewsHost', 'BizTalk Service BizTalk Group : NewsHost' ),
@( 'BTSSvc$NewsSend', 'DisplayBizTalk Service BizTalk Group : NewsSend' ),
@( 'BTSSvc$OrderLineSend', 'DisplayBizTalk Service BizTalk Group : OrderLineSend' ),
@( 'BTSSvc$OrdlineHost', 'DisplayBizTalk Service BizTalk Group : OrdlineHost' ),
@( 'BTSSvc$P2BHost', 'DisplayBizTalk Service BizTalk Group : P2BHost' ),
@( 'BTSSvc$P2BIn', 'DisplayBizTalk Service BizTalk Group : P2BIn' ),
@( 'BTSSvc$P2BSend', 'DisplayBizTalk Service BizTalk Group : P2BSend' ),
@( 'BTSSvc$Press', 'DisplayBizTalk Service BizTalk Group : Press' ),
@( 'BTSSvc$PressIn', 'DisplayBizTalk Service BizTalk Group : PressIn' ),
@( 'BTSSvc$PressOut', 'DisplayBizTalk Service BizTalk Group : PressOut' ),
@( 'BTSSvc$Subscription', 'DisplayBizTalk Service BizTalk Group : Subscription' ),
@( 'BTSSvc$SubscriptionSend', 'DisplayBizTalk Service BizTalk Group : SubscriptionSend' ),
@( '!EDI Subsystem', 'BizTalk Base EDI service' ),
@( '', '' ) )
$lstProcesses.value = @( 'BTSNTSvc.exe', 'BizMon.AlertService.exe', '' )
$lstPerfCounters.value = @( @( 'Memory', '', 'Available Bytes', '-gt 104857600' ),
@( 'Processor', '_TOTAL', '% Processor Time', '-lt 90' ),
@( '', '' ) )
return $AXSUCCESS
}
'2009'
{
$lstServices.value = @( @( 'BTSSvc$BizTalkServerApplication', 'BizTalk Service BizTalk Group : BizTalkServerApplication' ),
@( '!BTSSvc$InetHost', 'BizTalk Service BizTalk Group : InetHost' ),
@( '!BTSSvc$InetSend', 'BizTalk Service BizTalk Group : InetSend' ),
@( '!BTSSvc$NewsHost', 'BizTalk Service BizTalk Group : NewsHost' ),
@( 'BTSSvc$NewsSend', 'DisplayBizTalk Service BizTalk Group : NewsSend' ),
@( 'BTSSvc$OrderLineSend', 'DisplayBizTalk Service BizTalk Group : OrderLineSend' ),
@( 'BTSSvc$OrdlineHost', 'DisplayBizTalk Service BizTalk Group : OrdlineHost' ),
@( 'BTSSvc$P2BHost', 'DisplayBizTalk Service BizTalk Group : P2BHost' ),
@( 'BTSSvc$P2BIn', 'DisplayBizTalk Service BizTalk Group : P2BIn' ),
@( 'BTSSvc$P2BSend', 'DisplayBizTalk Service BizTalk Group : P2BSend' ),
@( 'BTSSvc$Press', 'DisplayBizTalk Service BizTalk Group : Press' ),
@( 'BTSSvc$PressIn', 'DisplayBizTalk Service BizTalk Group : PressIn' ),
@( 'BTSSvc$PressOut', 'DisplayBizTalk Service BizTalk Group : PressOut' ),
@( 'BTSSvc$Subscription', 'DisplayBizTalk Service BizTalk Group : Subscription' ),
@( 'BTSSvc$SubscriptionSend', 'DisplayBizTalk Service BizTalk Group : SubscriptionSend' ),
@( '!EDI Subsystem', 'BizTalk Base EDI service' ),
@( '', '' ) )
$lstProcesses.value = @( 'BTSNTSvc.exe', 'BizMon.AlertService.exe', '' )
$lstPerfCounters.value = @( , @('Memory','', 'Available Bytes', '-gt 104857600'),
@('Processor','_TOTAL', '% Processor Time', '-lt 90') )
return $AXSUCCESS
}
default
{
$lstServices.value = @( , @( '', '' ) )
$lstProcesses.value = @( , '' )
$lstPerfCounters.value = @( , @( '', '' ) )
return $AXERROR
}
}
}
#################################################################################
# // --- Main script ---
#################################################################################
# -- Clear screen and clear error
cls
$Error.Clear()
# -- Validate parameters, return on parameter mismatch
if( $strHost -eq '' -or $strVersion -eq '' )
{
$res = 'UNCERTAIN: Parameter error - Usage: .\MsBizTalkServer.ps1 "<Hostname | IP>" "version" "[alt-credentials]"'
echo $res
exit
}
# Declare local variables by assigning an initial value to it
$lstServices = $null
$lstProcesses = $null
$lstPerfCounters = $null
$objAltCredentials = $null
$strExplanation = ''
# If alternate credentials are specified, retrieve the alternate login and password from the ActiveXperts global settings
if( $strAltCredentials -ne '' )
{
# Get the Alternate Credentials object. Function "AxGetCredentials" is implemented in "activexperts.ps1"
if( ( AxGetCredentials $strHost $strAltCredentials ([ref]$objAltCredentials) ([ref]$strExplanation) ) -ne $AXSUCCESS )
{
echo $strExplanation
exit
}
}
# Retrieve product processes/services/performance-counters list
if( ( getSoftwareInfo $strVersion ([ref]$lstServices) ([ref]$lstProcesses) ([ref]$lstPerfCounters) ) -ne $AXSUCCESS )
{
$res = 'ERROR: Version [' + $strVersion + '] is not supported.'
echo $res
exit
}
# -- Check services
if( ( AxCheckServices $strHost ([ref]$lstServices) $objAltCredentials ([ref]$strExplanation) ) -ne $AXSUCCESS )
{
echo $strExplanation
exit
}
# -- Check processes
if( ( AxCheckProcesses $strHost ([ref]$lstProcesses) $objAltCredentials ([ref]$strExplanation) ) -ne $AXSUCCESS )
{
echo $strExplanation
exit
}
# -- Check performance counters
if( ( AxCheckPerfCounters $strHost ([ref]$lstPerfCounters) $objAltCredentials ([ref]$strExplanation) ) -ne $AXSUCCESS )
{
echo $strExplanation
exit
}
# -- Print script result
$res = 'SUCCESS: All services, processes and counters successfully checked'
echo $res
exit
#################################################################################
# // --- Catch script exceptions ---
#################################################################################
trap [Exception]
{
$res = 'UNCERTAIN: ' + $_.Exception.Message
echo $res
exit
}
