Devolutions.PowerShell core module

The PowerShell module now needs to be downloaded from the PowerShell Gallery. It is no longer included in the Remote Desktop Manager installation package. This also means that there is no need to install Remote Desktop Manager on a machine to run PowerShell scripts: the module is now sufficient.

To connect to an Advanced Data Source, the account used to connect to the data source must have an assigned Remote Desktop Manager license. The use of an application key with a Devolutions Server data source does not require a license.

Installation

Starting with Remote Desktop Manager 2023.1, PowerShell 7.2 or later is required to install the module. For Remote Desktop Manager versions prior to 2023.1, PowerShell 5.1 or later is required.

PowerShell installation

Install-Module -Name Devolutions.PowerShell

Manual installation

On some machines, it may be required to install the PowerShell module manually. Here are the steps to complete this process:

1. Download the Devolutions.PowerShell module NUPKG file from the PowerShell Gallery. 1. Change the file extension to .zip. 1. Extract the file in C:\Program Files\WindowsPowerShell\Modules\devolutions.powershell\version. 1. Unblock all newly extracted files.

cd c:\program files\WindowsPowerShell\modules\devolutions.powershell\<version>
dir * | unblock-file -verbose

Migration of your scripts

Once installed, the only required modification is to remove the Import-Module command from the scripts used with the old Remote Desktop Manager PowerShell module. As the module is now part of the PowerShell modules installed on the computer, it is no longer necessary to import it into the scripts.

Use an override configuration (portable)

By using the cmdlets Get-RDMPowerShellOverride and Set-RDMPowerShellOverride, it is possible to choose another destination folder to save the configuration files or to select a folder different from the one defined by default by the Devolutions.PowerShell module. These commands can also be used to select a folder containing files from an existing Remote Desktop Manager configuration other than the default.

Both properties are optional, and their default values are applied when left empty.

  • OptionFilePath: the full path to the RemoteDesktopManager.cfg file

Default: %LOCALAPPDATA%\Devolutions\RemoteDesktopManager

  • RemoteDesktopManagerExecutablePath: for the use of Start-RDMSession or Start-RDMProcess

Default: %ProgramFiles%\Devolutions\Remote Desktop Manager\RemoteDesktopManager.exe

$override = Get-RDMPowerShellOverride
$override.OptionFilePath = "PathToCfg" # C:\RemoteDesktopManager\2023.1\config\RemoteDesktopManager.cfg
$override.RemoteDesktopManagerExecutablePath = "Path to desired Remote Desktop Manager version" # C:\RemoteDesktopManager\2023.1\Devolutions.RemoteDesktopManager.Bin.2023.1.11.0\RemoteDesktopManager64.exe
Set-RDMPowerShellOverride
# Restart Powershell

Basic troubleshooting

Sometimes, several versions of the PowerShell module may appear to be in use. By typing $env:PSModulePath, you can then browse to these locations to delete the files RemoteDesktopManager and RemoteDesktopManager.PowershellModule to reinstall from fresh (renaming does not prevent the system from scanning and finding the modules in them).

$env:PSModulePath

C:\Users\admin\Documents\WindowsPowerShell\Modules;
C:\Program Files\WindowsPowerShell\Modules;
C:\windows\system32\WindowsPowerShell\v1.0\Modules

Query PowerShell version and the configuration file in use

Get-RDMInstance

ApplicationVersion OptionFilename
------------------ --------------
2023.1.0.14 C:\RemoteDesktopManager\2023.1\config\RemoteDesktopManager.cfg
Devolutions Forum logo Give us Feedback