Private/Helper/Set-RegistryValueForAllUsers.ps1
|
<#
Copyright © 2024 Integris. For internal company use only. All rights reserved. #> FUNCTION Set-RegistryValueForAllUsers { <# .SYNOPSIS This FUNCTION uses Active Setup to create a "seeder" key which creates or modifies a user-based registry value for all users on a computer. If the key path doesn't exist to the value, it will automatically create the key and add the value. .EXAMPLE PS> Set-RegistryValueForAllUsers -RegistryInstance @{'Name' = 'Setting'; 'Type' = 'String'; 'Value' = 'someval'; 'Path' = 'SOFTWARE\Microsoft\Windows\Something'} This example would modify the string registry value 'Type' in the path 'SOFTWARE\Microsoft\Windows\Something' to 'someval' for every user registry hive. .PARAMETER RegistryInstance A hash table containing key names of 'Name' designating the registry value name, 'Type' to designate the type of registry value which can be 'String,Binary,Dword,ExpandString or MultiString', 'Value' which is the value itself of the registry value and 'Path' designating the parent registry key the registry value is in. #> [CmdletBinding()] param ( [Parameter(Mandatory=$True)] [hashtable[]]$RegistryInstance ) try { New-PSDrive -Name HKU -PSProvider Registry -Root Registry::HKEY_USERS | Out-Null ## Change the registry values for the currently logged on user. Each logged on user SID is under HKEY_USERS $LoggedOnSids = (Get-ChildItem HKU: | Where-Object { $_.Name -match 'S-\d-\d+-(\d+-){1,14}\d+$' }).PSChildName Write-Host "Found $($LoggedOnSids.Count) logged on user SIDs" foreach ($sid in $LoggedOnSids) { Write-Host -Message "Loading the user registry hive for the logged on SID $sid" foreach ($instance in $RegistryInstance) { ## Create the key path if it doesn't exist $path = "HKU:\$sid\$($instance.Path)" if(!(Test-Path $path)){ New-Item $path -Force | Out-Null } ## Create (or modify) the value specified in the param Set-ItemProperty -Path "HKU:\$sid\$($instance.Path)" -Name $instance.Name -Value $instance.Value -Type $instance.Type -Force } } ## Create the Active Setup registry key so that the reg add cmd will get ran for each user ## logging into the machine. ## http://www.itninja.com/blog/view/an-active-setup-primer Write-Host "Setting Active Setup registry value to apply to all other users" foreach ($instance in $RegistryInstance) { ## Generate a unique value (usually a GUID) to use for Active Setup $Guid = [guid]::NewGuid().Guid $ActiveSetupRegParentPath = 'HKLM:\Software\Microsoft\Active Setup\Installed Components' ## Create the GUID registry key under the Active Setup key New-Item -Path $ActiveSetupRegParentPath -Name $Guid -ErrorAction SilentlyContinue | Out-Null -ErrorAction SilentlyContinue $ActiveSetupRegPath = "HKLM:\Software\Microsoft\Active Setup\Installed Components\$Guid" Write-Host "Using registry path '$ActiveSetupRegPath'" ## Convert the registry value type to one that reg.exe can understand. This will be the ## type of value that's created for the value we want to set for all users switch ($instance.Type) { 'String' { $RegValueType = 'REG_SZ' } 'Dword' { $RegValueType = 'REG_DWORD' } 'Binary' { $RegValueType = 'REG_BINARY' } 'ExpandString' { $RegValueType = 'REG_EXPAND_SZ' } 'MultiString' { $RegValueType = 'REG_MULTI_SZ' } default { throw "Registry type '$($instance.Type)' not recognized" } } ## Build the registry value to use for Active Setup which is the command to create the registry value in all user hives $ActiveSetupValue = "reg add `"{ 0}`" /v {1}/t {2}/d {3}/f" -f "HKCU\$($instance.Path)", $instance.Name, $RegValueType, $instance.Value Write-Host -Message "Active setup value is '$ActiveSetupValue'" ## Create the necessary Active Setup registry values Set-ItemProperty -Path $ActiveSetupRegPath -Name '(Default)' -Value 'Active Setup Test' -ErrorAction SilentlyContinue Set-ItemProperty -Path $ActiveSetupRegPath -Name 'Version' -Value '1' -ErrorAction SilentlyContinue Set-ItemProperty -Path $ActiveSetupRegPath -Name 'StubPath' -Value $ActiveSetupValue -ErrorAction SilentlyContinue } }catch { Write-Warning -Message $_.Exception.Message } } |