1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
|
---
title: fwupd.conf file format
---
% fwupd.conf(5) {{PACKAGE_VERSION}} | Configuration File Format
## NAME
**fwupd.conf** — configuration file for the fwupd daemon.
## SYNOPSIS
The `{{SYSCONFDIR}}/fwupd/fwupd.conf` file is the main configuration file for the fwupd daemon.
The complete description of the file format and possible parameters are documented here for reference purposes.
## FILE FORMAT
The file consists of a multiple sections with optional parameters. Parameters are of the form:
```text
[section]
key = value
```
The file is line-based, each newline-terminated line represents either a comment, a section name or
a parameter.
Section and parameter names are case sensitive.
Only the first equals sign in a parameter is significant.
Whitespace before or after the first equals sign is discarded as is leading and trailing whitespace
in a parameter value.
Internal whitespace within a parameter value is retained.
Any line beginning with a hash (`#`) character is ignored, as are lines containing only whitespace.
The values following the equals sign in parameters are all either a string (no quotes needed),
unsigned integers, or a boolean, which may be given as **true** or **false**.
Case is not significant in boolean values, but is preserved in string values.
## DAEMON PARAMETERS
The `[fwupd]` section can contain the following parameters:
**DisabledDevices={{DisabledDevices}}**
Allow blocking specific devices by their GUID, using semicolons as delimiter.
**DisabledPlugins={{DisabledPlugins}}**
Allow blocking specific plugins by name.
Use **fwupdmgr get-plugins** to get the list of plugins.
**ArchiveSizeMax=**
Maximum archive size that can be loaded in Mb, with 25% of the total system memory as the default.
**IdleTimeout={{IdleTimeout}}**
Idle time in seconds to shut down the daemon, where a value of **0** specifies "never".
**NOTE:** some plugins might inhibit the auto-shutdown, for instance thunderbolt.
**IdleInhibitStartupThreshold={{IdleInhibitStartupThreshold}}**
If the daemon takes more than this time to startup (in milliseconds) then inhibit the idle
shutdown timer. A value of **0** specifies "never".
**VerboseDomains={{VerboseDomains}}**
Comma separated list of domains to log in verbose mode.
If unset, no domains are set to verbose.
If set to "*", all domains are verbose, which is the same as running the daemon with **--verbose --verbose**.
**UpdateMotd={{UpdateMotd}}**
Update the message of the day (MOTD) on device and metadata changes.
**EnumerateAllDevices={{EnumerateAllDevices}}**
For some plugins, enumerate only devices supported by metadata.
**ApprovedFirmware={{ApprovedFirmware}}**
A list of firmware checksums that has been approved by the site admin
If unset, all firmware is approved.
**BlockedFirmware={{BlockedFirmware}}**
Allow blocking specific devices by their cabinet checksum, either SHA-1 or SHA-256.
**UriSchemes={{UriSchemes}}**
Allowed URI schemes in the preference order; failed downloads from the first scheme will be retried with the next in order until no choices remain.
**IgnorePower={{IgnorePower}}**
Ignore power levels of devices when running updates.
**IgnoreRequirements={{IgnoreRequirements}}**
Ignore some device requirements, for instance removing the generic GUID requirement of a CHID,
child, parent or sibling.
This is not recommended for production systems, although it may be useful for firmware development.
**IgnoreEfivarsFreeSpace={{IgnoreEfivarsFreeSpace}}**
Ignore the efivars free space requirement for db, dbx, KEK and PK updates.
This may be required on Linux kernels older than 6.4, or where the hardware does not support UEFI `RT->QueryVariableInfo`.
**OnlyTrustPostQuantumSignatures={{OnlyTrustPostQuantumSignatures}}**
Only trust post-quantum cryptographic signatures.
This is only recommended when you are sure the firmware contains a valid PQ signature.
**OnlyTrusted={{OnlyTrusted}}**
Only support installing firmware signed with a trusted key.
Do not set this to `false` on a production or trusted system.
**ShowDevicePrivate={{ShowDevicePrivate}}**
Show data such as device serial numbers which some users may consider private.
**TrustedUids={{TrustedUids}}**
UIDs matching these values that call the D-Bus interface should marked as trusted.
**HostBkc={{HostBkc}}**
Comma separated list of best known configuration IDs to be used when using `fwupdmgr sync`.
This can downgrade firmware to factory versions or upgrade firmware to a supported config level. e.g. **vendor-factory-2021q1,mycompany-2023**
**ReleaseDedupe={{ReleaseDedupe}}**
Deduplicate duplicate releases by the archive checksum are available from more than one source.
**ReleasePriority={{ReleasePriority}}**
When the same version release is available from more than one source this option can be used to
either prefer the local version (avoiding a potentially expensive download) or to prefer the
remote version (which may have updated metadata such as release notes).
The possible options are `local` or `remote` or empty to not make any adjustment to the policy,
relying on the `OrderAfter` and `OrderBefore` sections in the remote.
**EspLocation=**
Set the preferred location used for the EFI system partition (ESP) path.
This is typically used if UDisks was not able to automatically identify the location for any reason.
**RequireImmutableEnumeration={{RequireImmutableEnumeration}}**
Don't allow fwupd plugins to directly interact with devices during probe or setup stages.
The kernel should provide all device information in sysfs files or udev properties.
This will block some plugins from working.
**Manufacturer=**
**ProductName=**
**ProductSku=**
**Family=**
**EnclosureKind=**
**BaseboardProduct=**
**BaseboardManufacturer=**
Override values for SMBIOS or Device Tree data on the local system.
These are only required when the SMBIOS or Device Tree data is invalid, missing, or to simulate running on another system.
Empty values should be used to populate blank entries or add values to populate specific entries.
**TrustedReports={{TrustedReports}}**
Vendor reports matching these expressions will have releases marked as `trusted-report`.
Each *OR* section is delimited by a `;` and each *AND* section delimited by `&`, e.g.
* `DistroId=chromeos`
Any report uploaded from ChromeOS is trusted.
* `DistroId=chromeos&RemoteId=lvfs`
Any report found in the `lvfs` remote uploaded from a ChromeOS machine is trusted.
* `DistroId=fedora&VendorId=19`
Any report uploaded from Fedora 19 is trusted.
* `DistroId=fedora&VendorId=$OEM`
Any report uploaded from Fedora by the hardware OEM is trusted.
* `DistroId=fedora;DistroId=rhel&DistroVersion=9`
Any report uploaded from Fedora (any version) or from RHEL 9 is trusted.
NOTE: a `VendorId` of `$OEM` represents the OEM vendor ID of the vendor that owns the firmware,
for example, where Lenovo QA has generated a signed report for a Lenovo laptop.
There are also three os-release values available, `$ID`, `$VERSION_ID` and `$VARIANT_ID`, which
allow expressions like:
* `DistroId=$ID`
* `DistroId=$ID,DistroVersion=$VERSION_ID`
* `Flags=is-upgrade,from-oem`
Any flags listed here must all be matched by the report.
**P2pPolicy={{P2pPolicy}}**
This tells the daemon what peer-to-peer policy to use. For instance, using Passim, an optional
local caching service. Using peer-to-peer data might reduce the amount of bandwidth used on your
network considerably.
There are three possible values:
* `nothing`: Do not publish any files
* `metadata`: Only publish shared metadata that is common to each machine.
* `firmware`: Only publish firmware archives **after the next reboot** of the machine.
At some point in the future fwupd will change the default to `metadata,firmware`.
**TestDevices={{TestDevices}}**
Create virtual test devices and remote for validating daemon flows.
This is only intended for CI testing and development purposes.
{% if plugin_uefi_capsule %}
## UEFI_CAPSULE PARAMETERS
The `[uefi_capsule]` section can contain the following parameters:
**EnableGrubChainLoad={{uefi_capsule_EnableGrubChainLoad}}**
Configure GRUB to launch `fwupdx64.efi` instead of using other methods such as NVRAM or Capsule-On-Disk.
**DisableShimForSecureBoot={{uefi_capsule_DisableShimForSecureBoot}}**
The shim loader is required to chainload the fwupd EFI binary unless the `fwupd.efi` file has been self-signed manually.
**RequireESPFreeSpace={{uefi_capsule_RequireESPFreeSpace}}**
Amount of free space required on the ESP, for example using `32` for 32Mb.
By default this is dynamically set to at least twice the size of the payload.
**DisableCapsuleUpdateOnDisk={{uefi_capsule_DisableCapsuleUpdateOnDisk}}**
Allow ignoring the CapsuleOnDisk support advertised by the firmware.
**EnableEfiDebugging={{uefi_capsule_EnableEfiDebugging}}**
Enable the low-level debugging of `fwupdx64.efi` to the `FWUPDATE_DEBUG_LOG` EFI variable.
**NOTE:** enabling this option is going to fill up the NVRAM store much more quickly and
should only be enabled when debugging an issue with the EFI binary.
This value also has no affect when using Capsule-on-Disk as the EFI helper binary is
not being used.
**RebootCleanup={{uefi_capsule_RebootCleanup}}**
Delete any capsule files copy to the ESP, and remove any EFI variables set for the update.
**NOTE:** disabling this option is only required when debugging the flash process and normal
users should not need to change this setting.
**ScreenWidth={{uefi_capsule_ScreenWidth}}**
Override the screen width in pixels of the EFI framebuffer as used by the UX capsule.
**ScreenHeight={{uefi_capsule_ScreenHeight}}**
Override the screen height in pixels of the EFI framebuffer as used by the UX capsule.
{% endif %}
{% if plugin_msr %}
## MSR PARAMETERS
The `[msr]` section can contain the following parameter:
**MinimumSmeKernelVersion={{msr_MinimumSmeKernelVersion}}**
Minimum kernel version to allow probing for sme flag.
This only needs to be modified by enterprise kernels that have cherry picked the feature into a
kernel with an old version number.
{% endif %}
{% if plugin_redfish %}
## REDFISH PARAMETERS
The `[redfish]` section can contain the following parameters:
**Uri={{redfish_Uri}}**
The URI to the Redfish service in the format `scheme://ip:port` for instance `https://192.168.0.133:443`
**Username={{redfish_Username}}**
The username to use when connecting to the Redfish service.
**Password={{redfish_Password}}**
The password to use when connecting to the Redfish service.
**CACheck={{redfish_CACheck}}**
Whether to verify the server certificate or not. This is turned off by default.
BMCs using self-signed certificates will not work unless the plugin does not verify it against the system CAs.
**IpmiDisableCreateUser={{redfish_IpmiDisableCreateUser}}**
Do not use IPMI KCS to create an initial user account if no SMBIOS data.
Setting this to **true** prevents creating user accounts on the BMC automatically.
**ManagerResetTimeout={{redfish_ManagerResetTimeout}}**
Amount of time in seconds to wait for a BMC restart.
{% endif %}
## THUNDERBOLT PARAMETERS
The `[thunderbolt]` section can contain the following parameters:
**MinimumKernelVersion={{thunderbolt_MinimumKernelVersion}}**
Minimum kernel version to allow use of this plugin.
This only needs to be modified by enterprise kernels that have cherry picked the feature into a
kernel with an old version number.
**DelayedActivation={{thunderbolt_DelayedActivation}}**
Forces delaying activation until shutdown/logout/reboot.
## DELL_KESTREL PARAMETERS
The `[dell_kestrel]` section can contain the following parameters:
**UpdateOnDisconnect={{dell_kestrel_UpdateOnDisconnect}}**
Delaying firmware activation until the dock cable is unplugged.
## TEST PARAMETERS
The `[test]` section can contain the following parameters:
**AnotherWriteRequired={{test_AnotherWriteRequired}}**
Do two passes of the write function.
**CompositeChild={{test_CompositeChild}}**
If the device should have a child device.
**DecompressDelay={{test_DecompressDelay}}**
Delay in milliseconds to use when decompressing the test device.
**NeedsActivation={{test_NeedsActivation}}**
If the device needs activating before deploying the update.
**NeedsReboot={{test_NeedsReboot}}**
If the device needs a reboot before deploying the update.
**RegistrationSupported={{RegistrationSupported}}**
If the device should register with other plugins.
**RequestDelay={{test_RequestDelay}}**
Delay in milliseconds to use when requesting user input from the user.
**RequestSupported={{test_RequestSupported}}**
If the device interactive request is supported.
**VerifyDelay={{test_DecompressDelay}}**
Delay in milliseconds to use when verifying the test device.
**WriteDelay={{test_DecompressDelay}}**
Delay in milliseconds to use when writing the test device.
**WriteSupported={{test_Supported}}**
If the device write is supported. If unsupported the device write will not start.
## NOTES
`{{SYSCONFDIR}}/fwupd/fwupd.conf` may contain either hardcoded or autogenerated credentials and must only be
readable by the user that is running the fwupd process, which is typically `root`.
## SEE ALSO
<fwupdmgr(1)>
<fwupd-remotes.d(5)>
|