Keyboard settings
Supported on: All Citrix Workspace supported platforms
Description
The keyboard layout synchronization feature lets you switch among keyboard layouts on the client device. This feature synchronizes the client keyboard layout to the server. This feature provides you with the following options: • Allow dynamic sync - Synchronizes the client keyboard layout to the server when you make any changes. When selected, this option also enables the client IME for East Asian languages. Selecting Yes for this option overrides the following two options. • Sync only once – when session starts – Synchronizes the client keyboard layout to the server when the session launches. Any changes you make to the client keyboard layout during the session do not take effect immediately. To apply the changes, log off and log back on. • Don’t sync - Indicates that the client uses the keyboard layout present on the server. This policy is not configured by default. When you disable this policy, the client keyboard layout is synchronized to server only when the session is launched.
Registry
HKLM
Software\Policies\Citrix\Ica Client\Engine\Lockdown Profiles\All Regions\Lockdown\Virtual Channels\Keyboard This policy sets several registry values:
LocalIME Keyboard Enabled:
LocalIME = (deleted) Disabled:
LocalIME = 0 KeyboardSyncMode Keyboard Enabled:
KeyboardSyncMode = (deleted) Disabled:
KeyboardSyncMode = (User Profile) REG Builder
BETAConfigure the state and elements to generate .reg, PowerShell, Intune, and SCCM outputs.
These exports replicate the policy's registry effect. Editing the registry directly is not the same as applying the GPO through the management console (no gpupdate, no central reporting). Test before production; HKLM changes require administrator rights.
.reg file
Windows Registry Editor Version 5.00
; Exported from gporais.com
; Policy: Keyboard settings
; State: Enabled
; Supported on: All Citrix Workspace supported platforms
[HKEY_LOCAL_MACHINE\Software\Policies\Citrix\Ica Client\Engine\Lockdown Profiles\All Regions\Lockdown\GPO Disable\Keyboard]
"LocalIME"=-
"KeyboardSyncMode"=-
[HKEY_LOCAL_MACHINE\Software\Policies\Citrix\Ica Client\Engine\Lockdown Profiles\All Regions\Lockdown\Virtual Channels\Keyboard]
"LocalIME"="0"
"KeyboardSyncMode"="(User Profile)"PowerShell
# Exported from gporais.com
# Policy: Keyboard settings
# State: Enabled
# Supported on: All Citrix Workspace supported platforms
$path = 'HKLM:\Software\Policies\Citrix\Ica Client\Engine\Lockdown Profiles\All Regions\Lockdown\GPO Disable\Keyboard'
Remove-ItemProperty -Path $path -Name 'LocalIME' -ErrorAction SilentlyContinue
Remove-ItemProperty -Path $path -Name 'KeyboardSyncMode' -ErrorAction SilentlyContinue
$path = 'HKLM:\Software\Policies\Citrix\Ica Client\Engine\Lockdown Profiles\All Regions\Lockdown\Virtual Channels\Keyboard'
New-Item -Path $path -Force | Out-Null
Set-ItemProperty -Path $path -Name 'LocalIME' -Value '0' -Type String
Set-ItemProperty -Path $path -Name 'KeyboardSyncMode' -Value '(User Profile)' -Type StringIntune XML
No direct Policy CSP / OMA-URI mapping for this policy. Use the Intune Remediation tab, or ingest the ADMX in Intune.Intune Remediation
# === Detection script ===
# Exported from gporais.com
# Policy: Keyboard settings
# State: Enabled
# Supported on: All Citrix Workspace supported platforms
function Test-RegistryValue {
param(
[Parameter(Mandatory = $true)][string]$Path,
[Parameter(Mandatory = $true)][string]$Name,
[object]$Expected,
[ValidateSet('String', 'DWord', 'MultiString')][string]$Kind = 'String',
[switch]$Absent
)
try {
$item = Get-ItemProperty -LiteralPath $Path -Name $Name -ErrorAction Stop
} catch {
return $Absent.IsPresent
}
if ($Absent.IsPresent) { return $false }
$actual = $item.$Name
if ($Kind -eq 'DWord') { return ([int64]$actual) -eq ([int64]$Expected) }
if ($Kind -eq 'MultiString') {
$actualValues = @($actual)
$expectedValues = @($Expected)
if ($actualValues.Count -ne $expectedValues.Count) { return $false }
for ($i = 0; $i -lt $expectedValues.Count; $i++) {
if ([string]$actualValues[$i] -ne [string]$expectedValues[$i]) { return $false }
}
return $true
}
return [string]$actual -eq [string]$Expected
}
$checks = @(
(Test-RegistryValue -Path 'HKLM:\Software\Policies\Citrix\Ica Client\Engine\Lockdown Profiles\All Regions\Lockdown\GPO Disable\Keyboard' -Name 'LocalIME' -Absent)
(Test-RegistryValue -Path 'HKLM:\Software\Policies\Citrix\Ica Client\Engine\Lockdown Profiles\All Regions\Lockdown\GPO Disable\Keyboard' -Name 'KeyboardSyncMode' -Absent)
(Test-RegistryValue -Path 'HKLM:\Software\Policies\Citrix\Ica Client\Engine\Lockdown Profiles\All Regions\Lockdown\Virtual Channels\Keyboard' -Name 'LocalIME' -Expected '0' -Kind String)
(Test-RegistryValue -Path 'HKLM:\Software\Policies\Citrix\Ica Client\Engine\Lockdown Profiles\All Regions\Lockdown\Virtual Channels\Keyboard' -Name 'KeyboardSyncMode' -Expected '(User Profile)' -Kind String)
)
if ($checks -notcontains $false) {
Write-Output 'Compliant'
exit 0
}
Write-Output 'Non-compliant'
exit 1
# === Remediation script ===
# Exported from gporais.com
# Policy: Keyboard settings
# State: Enabled
# Supported on: All Citrix Workspace supported platforms
$path = 'HKLM:\Software\Policies\Citrix\Ica Client\Engine\Lockdown Profiles\All Regions\Lockdown\GPO Disable\Keyboard'
Remove-ItemProperty -Path $path -Name 'LocalIME' -ErrorAction SilentlyContinue
Remove-ItemProperty -Path $path -Name 'KeyboardSyncMode' -ErrorAction SilentlyContinue
$path = 'HKLM:\Software\Policies\Citrix\Ica Client\Engine\Lockdown Profiles\All Regions\Lockdown\Virtual Channels\Keyboard'
New-Item -Path $path -Force | Out-Null
Set-ItemProperty -Path $path -Name 'LocalIME' -Value '0' -Type String
Set-ItemProperty -Path $path -Name 'KeyboardSyncMode' -Value '(User Profile)' -Type StringSCCM CI
# Exported from gporais.com
# Policy: Keyboard settings
# State: Enabled
# Supported on: All Citrix Workspace supported platforms
# SCCM Configuration Item guidance:
# Create a Configuration Item of type "Setting: Script".
# Discovery script: use the Detection script below.
# Remediation script: use the Remediation script below.
# Compliance rule: the Discovery script output equals 'Compliant'.
# === Detection script ===
# Exported from gporais.com
# Policy: Keyboard settings
# State: Enabled
# Supported on: All Citrix Workspace supported platforms
function Test-RegistryValue {
param(
[Parameter(Mandatory = $true)][string]$Path,
[Parameter(Mandatory = $true)][string]$Name,
[object]$Expected,
[ValidateSet('String', 'DWord', 'MultiString')][string]$Kind = 'String',
[switch]$Absent
)
try {
$item = Get-ItemProperty -LiteralPath $Path -Name $Name -ErrorAction Stop
} catch {
return $Absent.IsPresent
}
if ($Absent.IsPresent) { return $false }
$actual = $item.$Name
if ($Kind -eq 'DWord') { return ([int64]$actual) -eq ([int64]$Expected) }
if ($Kind -eq 'MultiString') {
$actualValues = @($actual)
$expectedValues = @($Expected)
if ($actualValues.Count -ne $expectedValues.Count) { return $false }
for ($i = 0; $i -lt $expectedValues.Count; $i++) {
if ([string]$actualValues[$i] -ne [string]$expectedValues[$i]) { return $false }
}
return $true
}
return [string]$actual -eq [string]$Expected
}
$checks = @(
(Test-RegistryValue -Path 'HKLM:\Software\Policies\Citrix\Ica Client\Engine\Lockdown Profiles\All Regions\Lockdown\GPO Disable\Keyboard' -Name 'LocalIME' -Absent)
(Test-RegistryValue -Path 'HKLM:\Software\Policies\Citrix\Ica Client\Engine\Lockdown Profiles\All Regions\Lockdown\GPO Disable\Keyboard' -Name 'KeyboardSyncMode' -Absent)
(Test-RegistryValue -Path 'HKLM:\Software\Policies\Citrix\Ica Client\Engine\Lockdown Profiles\All Regions\Lockdown\Virtual Channels\Keyboard' -Name 'LocalIME' -Expected '0' -Kind String)
(Test-RegistryValue -Path 'HKLM:\Software\Policies\Citrix\Ica Client\Engine\Lockdown Profiles\All Regions\Lockdown\Virtual Channels\Keyboard' -Name 'KeyboardSyncMode' -Expected '(User Profile)' -Kind String)
)
if ($checks -notcontains $false) {
Write-Output 'Compliant'
exit 0
}
Write-Output 'Non-compliant'
exit 1
# === Remediation script ===
# Exported from gporais.com
# Policy: Keyboard settings
# State: Enabled
# Supported on: All Citrix Workspace supported platforms
$path = 'HKLM:\Software\Policies\Citrix\Ica Client\Engine\Lockdown Profiles\All Regions\Lockdown\GPO Disable\Keyboard'
Remove-ItemProperty -Path $path -Name 'LocalIME' -ErrorAction SilentlyContinue
Remove-ItemProperty -Path $path -Name 'KeyboardSyncMode' -ErrorAction SilentlyContinue
$path = 'HKLM:\Software\Policies\Citrix\Ica Client\Engine\Lockdown Profiles\All Regions\Lockdown\Virtual Channels\Keyboard'
New-Item -Path $path -Force | Out-Null
Set-ItemProperty -Path $path -Name 'LocalIME' -Value '0' -Type String
Set-ItemProperty -Path $path -Name 'KeyboardSyncMode' -Value '(User Profile)' -Type String