Management using PowerShell

A PowerShell module that sets up a computer to run NServiceBus.

The PowerShell module provides cmdlets to assist with:

  • Installing Microsoft Message Queuing Service (MSMQ)
  • Configuring Microsoft Distributed Transaction Coordinator (MSDTC)
  • Setting the addresses of the default Error and Audit queues for use by deployed Endpoints
  • Importing a Particular Platform license into the Registry
  • Removing a worker from a Distributor

Prerequisites

Prior to installation ensure that PowerShell 2 or higher is installed.

Installation

The installation file for the module can be downloaded here.

Usage

After installation the module can be loaded into a PowerShell session by issuing the following command:

Import-Module NServiceBus.PowerShell

The installation adds the NServiceBus.PowerShell module location to the PSModulePath environment variable. If the module isn't available restarting the Windows session may be required for this change to take effect.

As most of the cmdlets require elevated privileges the module should be used in a PowerShell session that is launched with Run As Administrator.

Help

A list of available cmdlets can be found by issuing the following PowerShell command

Get-Command -Module NServiceBus.PowerShell

Help for each cmdlet is incorporated within the module. Help can be accessed via the standard PowerShell Get-Help Command, e.g. Get-Help Set-NServiceBusLocalMachineSettings.

Related Articles


Last modified