E.1 PowerShell support
Using the Swyx PowerShell module, administrative tasks can be performed via the command line or automated using PowerShell scripts.
Over 100 Cmdlets help to run both simple administrative processes as well as complex administration tasks.
It is recommended that you familiarize yourself with the general use of Windows PowerShell before using the Swyx PowerShell module.
By running PowerShell commands with administrator privileges, you gain full control over Swyx, which can have serious consequences for the Swyx configuration.
Test your commands and scripts and use the parameter "-whatif" in order to check the potential consequences of a command.
Test your commands and scripts and use the parameter "-whatif" in order to check the potential consequences of a command.
When all or many users, groups or trunks are processed in an operation, then the system load on the SwyxServer may reach levels that are too high.
Run the corresponding commands or scripts only within a period of low server demand.
Installation
The PowerShell module is installed by default with Swyx Administration.
Starting
You can run the PowerShell module via the corresponding symbol in the start menu entry. In this case, Windows PowerShell is launched with the Swyx module loaded.Alternatively, you can open Windows PowerShell directly and reload with the command "Import-Module IpPbx".
Help on module and list of Cmdlets
You can access further information on working with the module using the command "Get-Help about_IpPbx_Module".
You can open a list of all Cmdlets available with the command: "Get-Command -Module IpPbx".
Here, you can run individual Cmdlets with the parameter "?", which every Cmdlet supports.
You can obtain detailed help on the individual Cmdlets with "Get-Help -full <CmdletName>".