Get-GPRegistryValue

Get-GPRegistryValue
    -Guid <Guid>
    -Key <String>
    [-ValueName <String>]
    [-Domain <String>]
    [-Server <String>]
    [<CommonParameters>]

Get-GPRegistryValue
    [-Name] <String>
    -Key <String>
    [-ValueName <String>]
    [-Domain <String>]
    [-Server <String>]
    [<CommonParameters>]

The Get-GPRegistryValue cmdlet retrieves one or more registry-based policy settings under either Computer Configuration or User Configuration in a Group Policy Object (GPO).

You can get registry-based policy settings for a specific registry value, or for all the registry values under a key:

• To get the registry-based policy setting that configures a specific registry value, specify both the Key and the ValueName parameters.

• To get all the registry-based policy settings that configure values directly under a registry key, specify the Key parameter without the ValueName parameter.

If you specify only a key, in addition to the policy settings that configure values under the key, the following first-level subkeys of the key are returned:

• first-level subkeys that have a policy setting that configures a value.

• first-level subkeys that have a subkey, at any level, with a policy setting that configures a value.

You can use this information to browse for registry-based policy settings.

$params = @{
    ValueName = 'ValueOne'
    Key       = 'HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey'
    Name      = 'TestGPO'
}
Get-GPRegistryValue @params

KeyPath     : Software\Policies\Microsoft\ExampleKey
FullKeyPath : HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey
Hive        : CurrentUser
PolicyState : Set
Value       : TestGPO
Type        : String
ValueName   : ValueOne
HasValue    : True

This command gets the registry-based policy setting that configures the registry value HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey:ValueOne from User Configuration in the GPO named TestGPO.

Get-GPRegistryValue -Name "TestGPO" -Key "HKCU\Software\Policies\Microsoft\ExampleKey"

KeyPath     : Software\Policies\Microsoft\ExampleKey
FullKeyPath : HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey
Hive        : CurrentUser
PolicyState : Set
Value       : TestGPO
Type        : String
ValueName   : ValueOne
HasValue    : True

KeyPath     : Software\Policies\Microsoft\ExampleKey
FullKeyPath : HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey
Hive        : CurrentUser
PolicyState : Delete
Value       :
Type        : String
ValueName   : ValueTwo
HasValue    : True


KeyPath     : Software\Policies\Microsoft\ExampleKey\Subkey1
FullKeyPath : HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey\Subkey1
Hive        : CurrentUser

KeyPath     : Software\Policies\Microsoft\ExampleKey\SubKey2
FullKeyPath : HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey\SubKey2
Hive        : CurrentUser

This command gets all the registry-based policy settings that configure registry values under the key HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey from User Configuration in the GPO named TestGPO. Subkeys of this key that have registry-based policy settings, are also returned. The second registry-based policy setting (ValueTwo) is disabled (its PolicyState property is set to Delete).

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

You can pipe a GPO for which this cmdlet gets registry-based policy settings. Collections that contain GPOs from different domains are not supported.

This cmdlet returns PolicyRegistrySetting objects that represent registry-based policy settings. These objects can be piped into the following cmdlets:

• Set-GPRegistryValue

• Remove-GPRegistryValue

• The hive of the registry key that you specify (HKLM or HKCU) indicates whether the registry-based policy setting is retrieved from Computer Configuration or User Configuration.

  If the specified registry key cannot be located in policy (the registry key is not configured), a corresponding error message is displayed.

  You can use the Domain parameter to explicitly specify the ___domain for this cmdlet.

  If you do not explicitly specify the ___domain, the cmdlet uses a default ___domain. The default ___domain is the ___domain that is used to access network resources by the security context under which the current session is running. This ___domain is typically the ___domain of the user that is running the session. For instance, the ___domain of the user who started the session by opening Windows PowerShell or the ___domain of a user that is specified in a runas command. However, computer startup and shutdown scripts run under the context of the LocalSystem account. The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. Therefore, when this cmdlet is run from a startup or shutdown script, the default ___domain is the ___domain to which the computer is joined.