PowerShell for BizTalk Administration: Is this thing on? Part 2

In Part 1, the story is set up that we may need to get some information on BizTalk in a quick, detailed way.  We could certainly use the BizTalk Administration console, but I'd have to remote in to the server.  Our security model makes that a little difficult.

So the first thing I'd like to check are the Receive Locations and the Send Ports.  I want to create this in a script so I can run this at-will.  There are a few ways to do this: NotePad being the most basic, or we could download the PowerShell ISE.  But my favorite is SAPIEN PowerShell Studio.  I'm still trying to figure out why Microsoft hasn't tightly integrated this kind of functionality to Visual Studio.

So back to the scenario.  The object to use in both cases is the Microsoft.BizTalk.ExplorerOM.BtsCatalogExplorer:

[System.Reflection.Assembly]::loadwithPartialName("Microsoft.BizTalk.ExplorerOM")

view raw gistfile1.ps1 hosted with ❤ by GitHub

You may notice the hard way that this object is a 32-bit only object.  So, if you are running in a 64-bit mode of PowerShell, your script won't run.  You will need to force 32-bit mode.  This can be done with the following:

	## - Force 32-bit mode, BizTalk.ExplorerOM does NOT support 64-bit mode
	if ($env:Processor_Architecture -ne "x86")
	{
	write-warning "Running x86 PowerShell..."
	if ($myInvocation.Line)
	{
	&"$env:WINDIR\syswow64\windowspowershell\v1.0\powershell.exe" -NonInteractive -NoProfile $myInvocation.Line
	}
	else
	{
	&"$env:WINDIR\syswow64\windowspowershell\v1.0\powershell.exe" -NonInteractive -NoProfile -file "$($myInvocation.InvocationName)" $args
	}
	exit $lastexitcode
	}

view raw gistfile1.ps1 hosted with ❤ by GitHub

The above two snippets are the basis of setting up both Receive Locations and Send Ports.  I'll first focus on the Send Ports.  The first thing is to instantiate an object using the BizTalk Explorer Object Model.  Once that's done, we'll need to connect to the proper BizTalk database.  After that's done, it's a simple loop to go through each Send Port:

	$Catalog = New-Object Microsoft.BizTalk.ExplorerOM.BtsCatalogExplorer
	$Catalog.ConnectionString = "SERVER=xxxxx;DATABASE=BizTalkMgmtDb;Integrated Security=SSPI"
	foreach($port in $catalog.SendPorts)
	{
	$portname = $port.name
	$portapplication = $port.application.name
	$portstatus = $port.status
	Write-Host "Name: $portname App: $portapplication Status: $portstatus"
	}

view raw gistfile1.ps1 hosted with ❤ by GitHub

Receive Locations are nested one level deeper than Send Ports, otherwise they are essentially the same process.

	foreach($port in $catalog.ReceivePorts)
	{
	foreach ($location in $port.ReceiveLocations)
	{
	$rxlocation = $port.ReceiveLocations
	$locationname = $location.name
	$locationapplication = $port.application.name
	$locationstatus = $location.Enable
	}
	}

view raw gistfile1.ps1 hosted with ❤ by GitHub

And (surprise, surprise) the Orchestration model is very similar as well.

	foreach($application in $catalog.Applications)
	{
	foreach ($orchestration in $application.Orchestrations)
	{
	$AppName = $application.Name
	$OrchName = $orchestration.FullName
	$OrchApp = $orchestration.Application
	$OrchHost = $orchestration.Host
	$OrchStatus = $orchestration.Status
	}
	}

view raw gistfile1.ps1 hosted with ❤ by GitHub

And that's it.  Nothing incredibly complicated.  Obviously you'll want to code additional functionality (write out to a log file, for example) to tailor to your specific needs.  As a side note, a wonderful tool which helped me discover most BizTalk WMI objects is the PowerShell WMI Explorer.

Part 3 will cover Host Instances.