Particular. module can be installed from the PowerShell Gallery, and is used to add, remove, update and delete instances of ServiceControl.
The ServiceControl PowerShell module has the following prerequisites:
- PowerShell Core 7.2 or later, or
- Windows PowerShell 5.1
In order to use the PowerShell module, the PowerShell execution policy needs to be set to
RemoteSigned. Refer to the PowerShell documentation on how to change the execution policy.
The module can be installed from the PowerShell Gallery with the following command:
Install-Module -Name Particular.ServiceControl.Management
Once the module is installed, it can be used by importing the module into the PowerShell session with the following command:
To obtain the version of the installed management module the following command can be used:
Get-Module Particular.ServiceControl.Management | Select-Object -ExpandProperty Version
ServiceControlMgmt that is only supported on Windows PowerShell 5.1. It does not work with newer versions of PowerShell. The ServiceControl installer creates a shortcut in the Windows start menu to launch an administrative PowerShell Session with this legacy module automatically loaded. The legacy module is not signed, so the PowerShell execution policy needs to be set to
Unrestricted to use it.
Method not found: 'System.Security.AccessControl.DirectorySecurity System.IO.DirectoryInfo.GetAccessControl(System.Security.AccessControl.AccessControlSections)'
This indicates that the PowerShell module is being executed using a newer version of PowerShell than it supports. To resolve this issue, make sure to use the PowerShell module hosted on the PowerShell Gallery.
For a complete overview of all cmdlets, see the Cmdlets and Aliases page.
The ServiceControl Management PowerShell module offers some cmdlets to assist with troubleshooting the installation of ServiceControl instances.
Before adding an instance of ServiceControl test if the port to use is currently in use.
Test-IfPortIsAvailable -Port 33333
This example shows the available ports out of a range of ports
33330..33339 | Test-IfPortIsAvailable | ? Available
If the port is already in use, then choose a different port.
The Window HTTPServer API is used by underlying components in ServiceControl. This API uses a permissions system to limit what accounts can add a HTTP listener to a specific URI. The standard mechanism for viewing and manipulating these ports is with the netsh.exe command line tool.
netsh. will list all of the available UrlAcls. This output is detailed but not easy to query. The ServiceControl Management PowerShell provides simplified PowerShell equivalents for listing, adding, and removing UrlAcls and makes the output easier to query.
For example the following command lists all of the UrlAcls assigned to any URI for port 33333.
Get-UrlAcls | ? Port -eq 33333
In this example any UrlAcl on port 33335 is removed
Get-UrlAcls | ? Port -eq 33335 | Remove-UrlAcl
The following example shows how to add a UrlAcl for a ServiceControl service that should only respond to a specific DNS name. This would require an update of the ServiceControl configuration file as well. Refer to setting a custom host name and port number
Add-UrlAcl -Url http://servicecontrol.mycompany.com:33333/api/ -Users Users