About the Remote Registry Module

Remote Registry PowerShell Module
The module can be installed automatically by downloading the MSI package or manually by downloading a ZIP file. The MSI package will install the module under your Documents folder (%USERPROFILE%\Documents\WindowsPowerShell\Modules\RemoteRegistry). The ZIP file contains the module files only and you need to extract its content to one of two places:
  1. %USERPROFILE%\Documents\WindowsPowerShell\Modules
  2. %WINDIR%\System32\WindowsPowerShell\v1.0\Modules (need admin privileges)
  3. If the directory tree (of one of the above) doesn't exist then you should manually create it.

Prerequisites

Windows PowerShell 2.0 http://support.microsoft.com/kb/968929


How to use the module

Check if the module is installed correctly, from your PowerShell session type:

PS > Get-Module -Name PSRemoteRegistry -ListAvailable

ModuleType Name                      ExportedCommands
---------- ----                      ----------------
Manifest   PSRemoteRegistry          {}




If you don't see the above result then the module was not installed correctly. If you choose to download and install the module manually (zip file), make sure the module directory exists under "%USERPROFILE%\Documents\WindowsPowerShell\Modules"


Importing the module:

PS > Import-Module PSRemoteRegistry

NOTE An elevated PowerShell session is needed to load the module. If the session is not elevated a warning message is written to the console
and you wont be able to use any of the module’s functions.


PS > Get-Command -Module PSRemoteRegistry

CommandType Name                Definition
----------- ----                ----------
Function    Get-RegBinary       ...
Function    Get-RegDefault      ...
Function    Get-RegDWord        ...
Function    Get-RegExpandString ...
Function    Get-RegKey          ...
Function    Get-RegMultiString  ...
Function    Get-RegQWord        ...
Function    Get-RegString       ...
Function    Get-RegValue        ...
Function    New-RegKey          ...
Function    Remove-RegKey       ...
Function    Remove-RegValue     ...
Function    Set-RegBinary       ...
Function    Set-RegDefault      ...
Function    Set-RegDWord        ...
Function    Set-RegExpandString ...
Function    Set-RegMultiString  ...
Function    Set-RegQWord        ...
Function    Set-RegString       ...
Function    Test-RegKey         ...
Function    Test-RegValue       ...


There is also an about_PSRemoteRegistry_Module help file (under the en_US folder), to review it:

PS > Get-Help about_RemoteRegistry_Module


Known Issues


It seems that tab completion doesn't work for functions in $profile or functions loaded from a module when a function name is not the first token on the command line.

PS > Get-RegS[TAB] -> is working fine and completed to Get-RegString

This doesn't work:

PS > Get-Help Get-RegS[TAB] # nothing

I have filed a bug on connect: https://connect.microsoft.com/PowerShell/feedback/ViewFeedback.aspx?FeedbackID=522561

Last edited May 9, 2011 at 9:45 AM by Shay, version 2