Registry Provider
Applies To: Windows PowerShell 2.0
PROVIDER NAME
Registry
DRIVES
HKLM:, HKCU:
SHORT DESCRIPTION
Provides access to the registry keys, entries, and values in Windows PowerShell.
DETAILED DESCRIPTION
The Windows PowerShell Registry provider lets you get, add, change, clear, and delete registry keys, entries, and values in Windows PowerShell.
Registry keys are represented as instances of the Microsoft.Win32.RegistryKey class. Registry entries are represented as instances of the PSCustomObject class.
The Registry provider lets you access a hierarchical namespace that consists of registry keys and subkeys. Registry entries and values are not components of that hierarchy. Instead, they are properties of each of the keys.
The Registry provider supports all the cmdlets that contain the Item noun (the Item cmdlets), such as Get-Item, Copy-Item, and Rename-Item, except for the Invoke-Item cmdlet. Use the Item cmdlets when you work with registry keys and subkeys.
The Registry provider also supports the cmdlets that contain the ItemProperty noun (the ItemProperty cmdlets). Use the ItemProperty cmdlets when you work with registry entries. You cannot use the cmdlets that contain the Content noun (the Content cmdlets) with the Registry provider.
Each registry key is protected by a security descriptor. You can use Get-Acl to view the security descriptor of a key.
CAPABILITIES
ShouldProcess, UseTransactions
EXAMPLES
Navigating the Registry
-------------------------- EXAMPLE 1 --------------------------
This command sets the current location to the HKEY_LOCAL_MACHINE\Software registry key:
set-location hklm:\software
-------------------------- EXAMPLE 2 --------------------------
This command gets an object that represents the current location:
get-location
Managing Registry Keys
-------------------------- EXAMPLE 1 --------------------------
This command gets each immediate subkeys of the HKEY_LOCAL_MACHINE\Software registry key:
get-childitem -path hklm:\software
-------------------------- EXAMPLE 2 --------------------------
This command creates the TestNew subkey under the HKCU:\Environment subkey:
new-item -path hkcu:\Environment\TestNew
-------------------------- EXAMPLE 3 --------------------------
This command deletes the TestNew subkey of the HKEY_CURRENT_USER\Environment key:
remove-item -path hkcu:\Environment\TestNew
-------------------------- EXAMPLE 4 --------------------------
This command copies the TestNew key to the TestCopy subkey:
copy-item -path hkcu:\Environment\TestNew hkcu:\Environment\TestNew\TestCopy
-------------------------- EXAMPLE 5 --------------------------
This command gets all the subkeys of the HKEY_LOCAL_MACHINE\Software registry key:
get-childitem -path hklm:\Software -recurse
-------------------------- EXAMPLE 6 --------------------------
This command moves the HKEY_CURRENT_USER\Environment\testnewcopy registry key, its subkeys and their registry entries to the HKEY_CURRENT_USER\Environment\testnew key:
move-item -path hkcu:\environment\testnewcopy -destination hkcu:\environment\testnew
-------------------------- EXAMPLE 7 --------------------------
This command renames the HKEY_CURRENT_USER\Environment\testnew registry key to HKEY_CURRENT_USER\Environment\test:
rename-item -path hkcu:\environment\testnew\ -newname test
-------------------------- EXAMPLE 8 --------------------------
This command gets the security descriptor of the specified registry key:
get-acl -path hkcu:\environment\testnew | format-list -property *
Managing Registry Entries
-------------------------- EXAMPLE 1 --------------------------
This command gets the registry entries in the HKEY_CURRENT_USER\Environment registry key:
get-itemproperty -path hkcu:\Environment
This command gets the Default registry entry only when it contains data.
-------------------------- EXAMPLE 2 --------------------------
This command gets the Temp registry entry in the HKEY_CURRENT_USER\Environment key:
get-itemproperty -path hkcu:\Environment -name Temp
-------------------------- EXAMPLE 3 --------------------------
This command creates a PSTest registry entry in the HKEY_CURRENT_USER\Environment key and sets its value to 1:
new-itemproperty -path hkcu:\environment -name PSTest -value 1 -propertyType dword
-------------------------- EXAMPLE 4 --------------------------
This command changes the value of the PSTest registry entry in the HKEY_CURRENT_USER\Environment key to "Start" and changes its data type to REG_SZ (string):
set-itemproperty -path hkcu:\environment -name PSTest -value Start -type string
-------------------------- EXAMPLE 5 --------------------------
This command renames the PSTest registry entry in the HKEY_CURRENT_USER\Environment key to PSTestNew:
rename-itemproperty -path hkcu:\environment -name PSTest
-newname PSTestNew
-------------------------- EXAMPLE 6 --------------------------
This command copies the PSTestNew registry entry from the HKEY_CURRENT_USER\Environment key to the HKEY_CURRENT_USER\Environment\testnewcopy key:
copy-itemproperty -path hkcu:\environment -destination hkcu:\environment\testnewcopy -name pstestnew
-------------------------- EXAMPLE 7 --------------------------
The command moves the pstestnew registry entry from the HKEY_CURRENT_USER\environment\testnewcopy key to the HKEY_CURRENT_USER\environment\testnew key:
move-itemproperty -path hkcu:\environment\testnewcopy -destination hkcu:\environment\testnew -name pstestnew
-------------------------- EXAMPLE 8 --------------------------
This command clears the value of the pstestnew registry entry in the HKEY_CURRENT_USER\Environment\testnew key:
clear-itemproperty -path hkcu:\environment\testnew -name pstestnew
You can use the Clear-Item cmdlet to clear the value of the default registry entry for a subkey. For example, the following command clears the value of the default entry of the HKEY_CURRENT_USER\Environment\testnew registry key: clear-item -path hkcu:\environment\testnew
-------------------------- EXAMPLE 9 --------------------------
This command deletes the pstestnew registry entry from the HKEY_CURRENT_USER\Environment\testnew registry key:
remove-itemproperty -path hkcu:\environment\testnew -name pstestnew
-------------------------- EXAMPLE 10 --------------------------
This command changes the value of the default registry entry in the HKEY_CURRENT_USER\Environment\testnew key to "default value":
set-itemproperty -path hkcu:\environment\testnew -name "(default)" -value "default value"
You can also change the default value of a registry key by using the Set-Item cmdlet. For example, the following command updates the default value of the testnew key: set-item -path hkcu:\environment\testnew -value "another default value"
DYNAMIC PARAMETERS
Dynamic parameters are cmdlet parameters that are added by a Windows PowerShell provider and are available only when the cmdlet is being used in the provider-enabled drive.
Type <Microsoft.Win32.RegistryValueKind>
Establishes or changes the data type of a registry value. The default is String (REG_SZ).
This parameter works as designed on the Set-ItemProperty cmdlet. It is also available on the Set-Item cmdlet in the registry drives, but it has no effect.
| Value | Description |
|---|---|
String |
Specifies a null-terminated string. Equivalent to REG_SZ. |
ExpandString |
Specifies a null-terminated string that contains unexpanded references to environment variables that are expanded when the value is retrieved. Equivalent to REG_EXPAND_SZ. |
Binary |
Specifies binary data in any form. Equivalent to REG_BINARY. |
DWord |
Specifies a 32-bit binary number. Equivalent to REG_DWORD. |
MultiString |
Specifies an array of null-terminated strings terminated by two null characters. Equivalent to REG_MULTI_SZ. |
QWord |
Specifies a 64-bit binary number. Equivalent to REG_QWORD. |
Unknown |
Indicates an unsupported registry data type, such as REG_RESOURCE_LIST. |