Guy recommends :
Free Permissions
Analyzer Tool

Solarwinds Free Download of Permissions Analyzer

 

View the effective permissions for a folder or shared drive. Free download try it now!


Accessing the Registry with PowerShell

Accessing the Registry with PowerShell

Editing the PowerShell registry is a knack.  In the beginning accessing values in the registry with PowerShell navigation is deceptively difficult, but once you master the syntax of HKLM:\ the technique it becomes reassuringly easy.

Topics for Editing a PowerShell Registry Key

 ♣

The Beginner's Conundrum

As a beginner, people will tell you that accessing the registry with PowerShell is as easy as accessing the file system.  Guy says that doing useful work means learning knack.  Let start with PowerShell's PSDrive provider, which opens the door to the registry.  Thus you can type:

CD HKLM:\   (Similar to typing:  cd C:\)

I reminder that HKLM is an abbreviation of HKEY_LOCAL_MACHINE, which is well-known to PowerShell.  There is also the users section of the registry at HKCU.

To go back a step, this is how you make the connection between PowerShell, the registry, and the file system; simply type:  Get-PSDrive

Easy Ways of Accessing the Registry with PowerShell

 a) Using the familiar aliases cd and DIR

# PowerShell Registry Access
cd HKLM:\
Dir

Note: You need a carriage return after the first line.

b) This is how you can get the same result as above, but using native PowerShell commands:

# PowerShell Registry listing
Set-Location HKLM:\
Get-Childitem -ErrorAction SilentlyContinue

Learning Points

Note 1: You need the colon, thus HKLM: (and not plain HKLM)

Note 2: The backslash makes sure that you connect to the root of HKLM.

Note 3: -ErrorAction SilentlyContinue suppresses the error message PermissionDenied to the SECURITY hive.

Note 4: If you see 'SKC' it means SubKey count, and VC means Value count.

Using PowerShell to Search for Registry Entries
Get-ChildItem is like DOS's dir, -recurse tells PowerShell to drill down starting at HKLM.  The crucial command is -Include followed by the value to search for, which in this case is Winlogon.

Clear-Host
# Example script for PowerShell to search the registry
Get-ChildItem HKLM:\Software\Microsoft -recurse -Include Winlogon `
-ErrorAction SilentlyContinue

Note 5: The backtick means the command continues on the next line.

See more on ErrorAction SilentlyContinue

Guy Recommends:  A Free Trial of the Network Performance Monitor (NPM)Review of Orion NPM v10

SolarWinds' Network Performance Monitor will help you discover what's happening on your network.  This utility will also guide you through troubleshooting; the dashboard will indicate whether the root cause is a broken link, faulty equipment or resource overload.

What I like best is the way NPM suggests solutions to network problems.  Its also has the ability to monitor the health of individual VMware virtual machines.  If you are interested in troubleshooting, and creating network maps, then I recommend that you try NPM now.

Download a free trial of Solarwinds' Network Performance Monitor

List Registry Values with PowerShell

Superficially, the simple commands shown above work as expected.  Problems start when you try to view values in the registry, and they get worse if you try and change Reg_SZ or DWORD setting.  This is where analogies with the file-system break down, and we need to learn new techniques.

Scenario: you want to check or enumerate the name of the user who is logged on.

# PowerShell Registry Key Winlogon
Clear-Host
$Registry_Key ="Software\Microsoft\Windows NT\CurrentVersion\Winlogon\"
Cd hklm:\$Registry_Key
Get-ItemProperty -path. -name DefaultUserName

Note 6:  To omit the dot (period) after -path is fatal.  -path. is correct.

Note 7:  Finding this PowerShell registry key also works without the final \'
"Software\Microsoft\Windows NT\CurrentVersion\Winlogon"

Note 8:  Here is an alternative version without the final \

# PowerShell Registry Key example
$Registry_Key = "HKLM:\Software\Microsoft\Windows NT\CurrentVersion\Winlogon"
Get-ItemProperty -path $Registry_Key -name DefaultUserName

ItemProperty - An Important PowerShell Noun for the Registry

We have already had a lucky break, because we've been tipped off there is PowerShell cmdlet called Get-ItemProperty.  Now we can exploit this knowledge by checking for similar nouns to ItemProperty.

# Research more PowerShell registry cmdlets
Get-Command -Noun ItemProperty

Expected Results
Clear-ItemProperty
Copy-ItemProperty
Get-ItemProperty
Move-ItemProperty
New-ItemProperty
Remove-ItemProperty
Rename-ItemProperty
Set-ItemProperty

Eureka!  Let us investigate Set-ItemProperty and see if it has any parameters to change settings in the registry.

# Find more about the PowerShell Set-ItemProperty cmdlet
Get-Help Set-ItemProperty -full

Note 9:  Do you see a parameter called -Value?   Now we have the skill to employ PowerShell to change values in a named registry key.

Guy Recommends: Free WMI Monitor for PowerShellSolarwinds Free WMI Monitor for PowerShell

Windows Management Instrumentation (WMI) is one of the hidden treasures of Microsoft's operating systems.  Fortunately, SolarWinds have created a Free WMI Monitor so that you can discover these gems of performance information, and thus improve your PowerShell scripts.

Take the guess work out of which WMI counters to use when scripting the operating system, Active Directory, or Exchange Server. Give this WMI monitor a try - it's free.

Download your free copy of WMI Monitor

Changing Registry Values with PowerShell's Set-ItemProperty

I have just chosen CachedLogonsCount almost at random, my greatest joy is when you change this REG_SZ registry entry to a value that you are interested in.

Scenario - Let us increase Cached Logons to 50. 
(It does not make sense to change the DefaultUserName.)

If you haven't backed up at least the Winlogon portion of the registry, please take this action before continuing:
Launch Regedit, File Menu, Export..., Click the radio button next to: Selected Branch, give the file a name.

# Example of a PowerShell registry change
$RegKey ="HKLM:\Software\Microsoft\Windows NT\CurrentVersion\Winlogon"
Set-ItemProperty -path $RegKey -name cachedlogonscount -value 50

Learning Points

Note 10:  The crucial point is that to change a PowerShell registry key we need the verb 'Set' not 'Get'.  Set-ItemProperty has the useful parameter -value.

Note 11: On reflection, you can see how PowerShell mimics the registry's sections of: Key, Value, Data.  However, confusingly, the registry's value = PowerShell -name. Furthermore, Registry's Data = PowerShell's -value.

See more examples of PowerShell registry keys here.

Summary of Editing the PowerShell Registry

The union between PowerShell and the Registry is a marriage made in heaven.  If you are a minor expert on Regedit then PowerShell scripting is a wonderful alternative way of making changes.  From a learning point of view, go slowly at first.  Tune-In to the PowerShell method for navigating the registry keys, and go slowly through the syntax for enumerating the values.  Once you learn about Set-ItemProperty then you can script changes to your favorite registry hacks.

If you like this page then please share it with your friends

 


See more Microsoft PowerShell Examples of Real Life Tasks

PowerShell Real-life Examples   • Test-Connection   • Invoke-Expression   • Invoke-Command

Com   • Shell Application   • Measure-Object   • PowerShell Registry   • Compare-Object Registry

PowerShell and Exchange   • PowerShell and SQL   • Restore-Computer   • Engineers Toolset

Please email me if you have a better example script. Also please report any factual mistakes, grammatical errors or broken links, I will be happy to correct the fault.

Download my ebook:Getting Started with PowerShell
Getting Started with PowerShell - only $9.25

You get 36 topics organized into these 3 sections:
   1) Getting Started
   2) Real-life tasks
   3) Examples of Syntax.

In addition to the ebook, you get a PDF version of this  Introduction to PowerShell ebook  It runs to 120 pages of A4.

 *


Custom Search

Site Home

Guy Recommends: WMI Monitor for PowershellSolarwinds WMI Monitor

Windows Management Instrumentation (WMI) is most useful for PowerShell scripting.

SolarWinds have produced this Free WMI Monitor to take the guess work out of which WMI counters to use for applications like Microsoft Active Directory, SQL or Exchange Server.

Download your free copy of WMI Monitor

Author: Guy Thomas Copyright © 1999-2013 Computer Performance LTD All rights reserved.

Please report a broken link, or an error to: