What it does
Note: In order to use this policy, you must clear all settings in the old Preferences (Deprecated) section. If this policy is enabled, you can use JSON to configure preferences. If this policy is disabled or not configured, preferences are not modified. For detailed information on creating the policy, see https://github.com/mozilla/policy-templates/blob/master/README.md#preferences.
What it writes
- Hive
- HKEY_LOCAL_MACHINE or HKEY_CURRENT_USER
- Registry key
Software\Policies\Mozilla\Firefox
Options
| Option | Type | Registry value | Allowed values |
|---|---|---|---|
| JSON | Multi-line text | Preferences |
Any |
Configure and deploy
Choose a state and the option values; the output below is generated from the template for exactly that.
Enabled · Computer · template defaults
Registry file (.reg)
Windows Registry Editor Version 5.00
[HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox]
"Preferences"=hex(7):00,00,00,00
PowerShell
$ErrorActionPreference = 'Stop'
function Set-RegistryValue {
param(
[Parameter(Mandatory = $true)][string] $Path,
[Parameter(Mandatory = $true)][string] $Name,
[Parameter(Mandatory = $true)][string] $PropertyType,
[Parameter(Mandatory = $true)][object] $Value
)
if (-not (Test-Path -LiteralPath $Path)) {
New-Item -Path $Path -Force | Out-Null
}
New-ItemProperty -LiteralPath $Path -Name $Name -PropertyType $PropertyType -Value $Value -Force | Out-Null
}
function Remove-RegistryValue {
param(
[Parameter(Mandatory = $true)][string] $Path,
[Parameter(Mandatory = $true)][string] $Name
)
if (Test-Path -LiteralPath $Path) {
Remove-ItemProperty -LiteralPath $Path -Name $Name -Force -ErrorAction SilentlyContinue
}
}
function Clear-RegistryKeyValues {
param(
[Parameter(Mandatory = $true)][string] $Path
)
if (-not (Test-Path -LiteralPath $Path)) {
return
}
foreach ($propertyName in (Get-Item -LiteralPath $Path).Property) {
Remove-ItemProperty -LiteralPath $Path -Name $propertyName -Force -ErrorAction SilentlyContinue
}
}
# Policy: Preferences
# Name: Preferences
# Scope: Machine
# State: Enabled
# Source: firefox.admx
Set-RegistryValue -Path 'Registry::HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox' -Name 'Preferences' -PropertyType 'MultiString' -Value @()
- The OMA-URI is an inferred ADMX-backed Policy CSP candidate derived from the source ADMX file name and policy name.
- Some Microsoft policies use built-in Policy CSP pages whose area names don't match the ADMX file name, so verify the candidate against Microsoft Learn before deployment.
- The generated payload is incomplete because one or more ADMX element values were not supplied: JSON
ADMX profile candidate (OMA-URI)
./Device/Vendor/MSFT/Policy/Config/ADMX_firefox/PreferencesIntune remediation scripts
Detection
$ErrorActionPreference = 'Stop'
$reasons = [System.Collections.Generic.List[string]]::new()
function Test-RegistryValueExists {
param(
[Parameter(Mandatory = $true)][string] $Path,
[Parameter(Mandatory = $true)][string] $Name
)
if (-not (Test-Path -LiteralPath $Path)) {
return $false
}
return $null -ne (Get-ItemProperty -LiteralPath $Path -Name $Name -ErrorAction SilentlyContinue)
}
function Test-RegistryValueEquals {
param(
[Parameter(Mandatory = $true)][string] $Path,
[Parameter(Mandatory = $true)][string] $Name,
[Parameter(Mandatory = $true)][string] $Kind,
[Parameter(Mandatory = $true)][object] $Expected
)
if (-not (Test-Path -LiteralPath $Path)) {
return $false
}
$valueObject = Get-ItemProperty -LiteralPath $Path -Name $Name -ErrorAction SilentlyContinue
if ($null -eq $valueObject) {
return $false
}
$actual = $valueObject.$Name
switch ($Kind) {
'String' { return [string]$actual -ceq [string]$Expected }
'ExpandString' { return [string]$actual -ceq [string]$Expected }
'DWord' { return [uint32]$actual -eq [uint32]$Expected }
'QWord' { return [uint64]$actual -eq [uint64]$Expected }
'MultiString' {
$actualArray = @($actual)
$expectedArray = @($Expected)
if ($actualArray.Count -ne $expectedArray.Count) { return $false }
for ($index = 0; $index -lt $actualArray.Count; $index++) {
if ([string]$actualArray[$index] -cne [string]$expectedArray[$index]) { return $false }
}
return $true
}
'Binary' {
$actualArray = [byte[]]$actual
$expectedArray = [byte[]]$Expected
if ($actualArray.Length -ne $expectedArray.Length) { return $false }
for ($index = 0; $index -lt $actualArray.Length; $index++) {
if ($actualArray[$index] -ne $expectedArray[$index]) { return $false }
}
return $true
}
default { return [string]$actual -ceq [string]$Expected }
}
}
# Policy: Preferences
# Name: Preferences
# Scope: Machine
# State: Enabled
# Source: firefox.admx
$isMatch = Test-RegistryValueEquals -Path 'Registry::HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox' -Name 'Preferences' -Kind 'MultiString' -Expected @()
if (-not $isMatch) {
$reasons.Add('Value mismatch: HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox\Preferences') | Out-Null
}
if ($reasons.Count -eq 0) {
Write-Output 'Compliant'
exit 0
}
$reasons | ForEach-Object { Write-Output $_ }
exit 1
Remediation
$ErrorActionPreference = 'Stop'
function Set-RegistryValue {
param(
[Parameter(Mandatory = $true)][string] $Path,
[Parameter(Mandatory = $true)][string] $Name,
[Parameter(Mandatory = $true)][string] $PropertyType,
[Parameter(Mandatory = $true)][object] $Value
)
if (-not (Test-Path -LiteralPath $Path)) {
New-Item -Path $Path -Force | Out-Null
}
New-ItemProperty -LiteralPath $Path -Name $Name -PropertyType $PropertyType -Value $Value -Force | Out-Null
}
function Remove-RegistryValue {
param(
[Parameter(Mandatory = $true)][string] $Path,
[Parameter(Mandatory = $true)][string] $Name
)
if (Test-Path -LiteralPath $Path) {
Remove-ItemProperty -LiteralPath $Path -Name $Name -Force -ErrorAction SilentlyContinue
}
}
function Clear-RegistryKeyValues {
param(
[Parameter(Mandatory = $true)][string] $Path
)
if (-not (Test-Path -LiteralPath $Path)) {
return
}
foreach ($propertyName in (Get-Item -LiteralPath $Path).Property) {
Remove-ItemProperty -LiteralPath $Path -Name $propertyName -Force -ErrorAction SilentlyContinue
}
}
# Policy: Preferences
# Name: Preferences
# Scope: Machine
# State: Enabled
# Source: firefox.admx
Set-RegistryValue -Path 'Registry::HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox' -Name 'Preferences' -PropertyType 'MultiString' -Value @()
History 45 retained releases
- 4.418 Oct 2022
- Translations changed; choose a language above to compare its wording.
- 3.102 Jun 2022
- Translations changed; choose a language above to compare its wording.
- 3.48 Dec 2021
- Translations changed; choose a language above to compare its wording.
- 2.111 Jun 2021
- Template definition changed; registry values, options and limits are the same.
- 2.1019 Apr 2021
- Translations changed; choose a language above to compare its wording.
- 2.823 Feb 2021
- Template definition changed; registry values, options and limits are the same.
- 2.725 Jan 2021
- Translations changed; choose a language above to compare its wording.
- 2.517 Nov 2020
- Description
[added: Note: In order to use this policy, you must clear all settings in the old Preferences (Deprecated) section.
]If this policy is enabled, you can use JSON to configure preferences.
…
Whole description, marked
[added: Note: In order to use this policy, you must clear all settings in the old Preferences (Deprecated) section. ]If this policy is enabled, you can use JSON to configure preferences. If this policy is disabled or not configured, preferences are not modified. For detailed information on creating the policy, see https://github.com/mozilla/policy-templates/blob/master/README.md#preferences.
- Description
[added: Note: In order to use this policy, you must clear all settings in the old Preferences (Deprecated) section.
]If this policy is enabled, you can use JSON to configure preferences.
…
- 2.322 Sep 2020
- Added in this release.
17 later releases left it unchanged.
Template
- Internal name
Preferences- Namespace
Mozilla.Policies.Firefox- Template file
firefox.admx- Release
- Mozilla Firefox 4.7 · file set
e3837384c3b8245f…
Definition, editor controls and support
Definition
<policy class="Both" displayName="$(string.Preferences)" explainText="$(string.Preferences_Explain)" key="Software\Policies\Mozilla\Firefox" name="Preferences" presentation="$(presentation.JSON)" xmlns="http://schemas.microsoft.com/GroupPolicy/2006/07/PolicyDefinitions">
<parentCategory ref="Mozilla.Policies.Firefox:firefox" />
<supportedOn ref="Mozilla.Policies.Firefox:SUPPORTED_FF81" />
<elements>
<multiText id="JSON" maxLength="16384" valueName="Preferences" />
</elements>
</policy>Editor controls
<presentation id="JSON" xmlns="http://schemas.microsoft.com/GroupPolicy/2006/07/PolicyDefinitions">
<multiTextBox refId="JSON" />
</presentation>Supported platforms and category
Mozilla.Policies.Firefox:category:firefox
<category displayName="$(string.firefox)" name="firefox" xmlns="http://schemas.microsoft.com/GroupPolicy/2006/07/PolicyDefinitions">
<parentCategory ref="Mozilla.Policies:Cat_Mozilla" />
</category>
Mozilla.Policies.Firefox:definition:SUPPORTED_FF81
<definition displayName="$(string.SUPPORTED_FF81)" name="SUPPORTED_FF81" xmlns="http://schemas.microsoft.com/GroupPolicy/2006/07/PolicyDefinitions" />
Mozilla.Policies:category:Cat_Mozilla
<category displayName="$(string.mozilla)" name="Cat_Mozilla" xmlns="http://schemas.microsoft.com/GroupPolicy/2006/07/PolicyDefinitions" />
Mozilla.Policies.Firefox:category:firefox
<category displayName="$(string.firefox)" name="firefox" xmlns="http://schemas.microsoft.com/GroupPolicy/2006/07/PolicyDefinitions">
<parentCategory ref="Mozilla.Policies:Cat_Mozilla" />
</category>
<strings><string id="Mozilla.Policies.Firefox:firefox">Firefox</string></strings>
Mozilla.Policies.Firefox:definition:SUPPORTED_FF81
<definition displayName="$(string.SUPPORTED_FF81)" name="SUPPORTED_FF81" xmlns="http://schemas.microsoft.com/GroupPolicy/2006/07/PolicyDefinitions" />
<strings><string id="Mozilla.Policies.Firefox:SUPPORTED_FF81">Firefox 81 or later, Firefox 78.3 ESR or later</string></strings>
Mozilla.Policies:category:Cat_Mozilla
<category displayName="$(string.mozilla)" name="Cat_Mozilla" xmlns="http://schemas.microsoft.com/GroupPolicy/2006/07/PolicyDefinitions" />
<strings><string id="Mozilla.Policies:mozilla">Mozilla</string></strings>