Flags

Details

class Fwupd.ClientDownloadFlags(value)

Bases: GLib.Flags

The options to use for downloading.

NONE = 0

No flags set.

New in version 1.4.5.

ONLY_P2P = 1

Only use peer-to-peer when downloading URIs.

New in version 1.9.4.

class Fwupd.ClientUploadFlags(value)

Bases: GLib.Flags

The options to use for uploading.

NONE = 0

No flags set.

New in version 1.4.5.

ALWAYS_MULTIPART = 1

Always use multipart/form-data.

New in version 1.4.5.

class Fwupd.CodecFlags(value)

Bases: GLib.Flags

The flags to use when converting data from one form to another.

NONE = 0

No flags set.

New in version 2.0.0.

TRUSTED = 1

Include values that may be regarded as trusted or sensitive.

New in version 2.0.0.

class Fwupd.DeviceFlags(value)

Bases: GLib.Flags

Flags used to represent device attributes

INSTALL_ALL_RELEASES = -2147483648

Install each intermediate releases for the device rather than jumping directly to the newest.

New in version 1.3.7.

AFFECTS_FDE = 0

The device is warning that a volume with full-disk-encryption was found on this machine, typically a Windows NTFS partition with BitLocker. Updating the firmware on this device may invalidate secrets used to decrypt the volume, and the recovery key may be required.

Supported clients will display this information as a warning to the user.

New in version 1.7.1.

BACKUP_BEFORE_INSTALL = 0

The device firmware should be saved before installing firmware.

New in version 1.5.0.

CAN_EMULATION_TAG = 0

The device can be recorded by the backend, allowing emulation.

New in version 2.0.1.

EMULATED = 0

The device is emulated and should not be recorded by the backend.

New in version 1.8.11.

EMULATION_TAG = 0

The device should be recorded by the backend, allowing emulation.

New in version 1.8.11.

END_OF_LIFE = 0

The device is no longer supported by the original hardware vendor as it is considered end-of-life. It it unlikely to receive firmware updates, even for security issues.

New in version 1.7.5.

HAS_MULTIPLE_BRANCHES = 0

The device supports switching to a different stream of firmware.

New in version 1.5.0.

INSTALL_SKIP_VERSION_CHECK = 0

The device doesn’t require verification of the newly installed version.

New in version 2.0.2.

NONE = 0

No flags set

New in version 0.1.3.

ONLY_EXPLICIT_UPDATES = 0

The device should stay on one firmware version unless the new version is explicitly specified.

This can either be done using fwupdmgr install, using GNOME Firmware, or using a BKC config.

New in version 1.9.3.

ONLY_VERSION_UPGRADE = 0

The device firmware can only be updated to a newer version and never downgraded or reinstalled.

New in version 1.6.2.

SIGNED_PAYLOAD = 0

The firmware payload is verified on-device the payload using strong cryptography such as RSA, AES or ECC.

It is usually not possible to modify or flash custom firmware not provided by the vendor.

New in version 1.7.6.

UNREACHABLE = 0

The device is currently unreachable, perhaps because it is in a lower power state or is out of wireless range.

New in version 1.7.0.

UNSIGNED_PAYLOAD = 0

The firmware payload is unsigned and it is possible to modify and flash custom firmware.

New in version 1.7.6.

UPDATABLE_HIDDEN = 0

The device is updatable but is currently inhibited from updates in the client. Reasons include but are not limited to low power or requiring reboot from a previous update.

New in version 1.4.1.

WILDCARD_INSTALL = 0

All devices with matching GUIDs will be updated at the same time.

For some devices it is not possible to have different versions of firmware for hardware of the same type. Updating one device will force update of others with exactly the same instance IDs.

New in version 1.6.2.

INTERNAL = 1

Device is internal to the platform and cannot be removed easily.

New in version 0.1.3.

NOTIFIED = 1024

The user has been notified about a change in the device state.

New in version 1.0.5.

NEEDS_ACTIVATION = 1048576

The device update needs to be separately activated. This process may occur automatically on shutdown in some operating systems or when the device is unplugged with some devices.

New in version 1.2.6.

VERSION_CHECK_REQUIRED = 1073741824

All firmware updates for this device require a firmware version check.

New in version 1.3.7.

NEEDS_SHUTDOWN = 131072

The device requires the system to be shutdown to finish application of new firmware.

New in version 1.2.4.

DUAL_IMAGE = 134217728

The device firmware update architecture uses a redundancy mechanism such as A/B partitions for updates.

New in version 1.3.3.

LOCKED = 16

The device can not be updated without manual user interaction.

New in version 0.6.3.

WAIT_FOR_REPLUG = 16384

The device is in the middle of and update and the hardware is waiting to be probed or replugged.

New in version 1.1.2.

WILL_DISAPPEAR = 16777216

The device will disappear after the update is complete and success or failure can’t be verified.

New in version 1.3.3.

UPDATABLE = 2

Device has the ability to be updated in this or any other mode.

New in version 0.9.7.

NEEDS_REBOOT = 256

The device requires a system reboot to apply firmware or to reload hardware.

New in version 0.9.7.

ANOTHER_WRITE_REQUIRED = 262144

The device requires the update to be retried, possibly with a different plugin.

New in version 1.2.5.

SELF_RECOVERY = 268435456

In flashing mode, the device will only accept intended payloads and will revert back to a valid firmware image if an invalid or incomplete payload was sent.

New in version 1.3.3.

SUPPORTED = 32

The device is found in metadata loaded into the daemon.

New in version 0.7.1.

CAN_VERIFY = 33554432

The device checksums can be compared against metadata.

New in version 1.3.3.

HISTORICAL = 4194304

The device is used for historical data only.

New in version 1.3.2.

REPORTED = 512

The success or failure of a previous update has been reported to a metadata server.

New in version 1.0.4.

USABLE_DURING_UPDATE = 536870912

The device remains usable while the update flashes or schedules the update. The update will implicitly be applied next time the device is power cycled or possibly activated.

New in version 1.3.3.

NEEDS_BOOTLOADER = 64

The device requires entering a bootloader mode to be manually.

New in version 0.7.3.

CAN_VERIFY_IMAGE = 67108864

The device application firmware image can be dumped from device for verification.

New in version 1.3.3.

REQUIRE_AC = 8

Device requires an external power source to be connected or the battery level at a minimum threshold to update.

New in version 0.6.3.

IS_BOOTLOADER = 8192

The device is currently in a read-only bootloader mode and not running application code.

New in version 1.0.8.

class Fwupd.DeviceProblem(value)

Bases: GLib.Flags

Problems are reasons why the device is not updatable.

All problems have to be fixable by the user, rather than the plugin author.

UNKNOWN = -1

This problem is not defined, this typically will happen from mismatched fwupd library and clients.

New in version 1.8.1.

NONE = 0

No device problems detected.

New in version 1.8.1.

SYSTEM_POWER_TOO_LOW = 1

The system power is too low to perform the update.

New in version 1.8.1.

IN_USE = 1024

The device is in use and cannot be interrupted, for instance taking a phone call.

New in version 1.9.1.

MISSING_LICENSE = 128

The device cannot be updated due to missing vendor’s license.

New in version 1.8.6.

REQUIRE_AC_POWER = 16

The device requires AC power to be connected.

New in version 1.8.1.

UNREACHABLE = 2

The device is unreachable, or out of wireless range.

New in version 1.8.1.

DISPLAY_REQUIRED = 2048

The device cannot be used while there are no displays plugged in.

New in version 1.9.6.

SYSTEM_INHIBIT = 256

The device cannot be updated due to a system-wide inhibit.

New in version 1.8.10.

LID_IS_CLOSED = 32

The device cannot be used while the laptop lid is closed.

New in version 1.8.1.

POWER_TOO_LOW = 4

The device battery power is too low.

New in version 1.8.1.

LOWER_PRIORITY = 4096

We have two ways of communicating with one physical device, so we hide the worse one.

New in version 2.0.0.

UPDATE_IN_PROGRESS = 512

The device cannot be updated as it is already being updated.

New in version 1.8.11.

IS_EMULATED = 64

The device is emulated from a different host.

New in version 1.8.3.

UPDATE_PENDING = 8

The device is waiting for the update to be applied.

New in version 1.8.1.

class Fwupd.FeatureFlags(value)

Bases: GLib.Flags

The flags to the feature capabilities of the front-end client.

NONE = 0

No trust.

New in version 1.4.5.

CAN_REPORT = 1

Can upload a report of the update back to the server.

New in version 1.4.5.

SHOW_PROBLEMS = 128

Can show problems when getting the update list.

New in version 1.8.1.

REQUESTS = 16

Can show interactive requests.

New in version 1.6.2.

DETACH_ACTION = 2

Can perform detach action, typically showing text.

New in version 1.4.5.

ALLOW_AUTHENTICATION = 256

Can authenticate with PolicyKit for requests.

New in version 1.8.4.

FDE_WARNING = 32

Can warn about full disk encryption.

New in version 1.7.1.

UPDATE_ACTION = 4

Can perform update action, typically showing text.

New in version 1.4.5.

REQUESTS_NON_GENERIC = 512

Can handle showing non-generic request message text.

New in version 1.9.8.

COMMUNITY_TEXT = 64

Can show information about community supported.

New in version 1.7.5.

SWITCH_BRANCH = 8

Can switch the firmware branch.

New in version 1.5.0.

class Fwupd.GuidFlags(value)

Bases: GLib.Flags

The flags to show how the data should be converted.

NONE = 0

No endian swapping.

New in version 1.2.5.

NAMESPACE_MICROSOFT = 1

Use the Microsoft-compatible namespace.

New in version 1.2.5.

MIXED_ENDIAN = 2

Use EFI mixed endian representation, as used in EFI.

New in version 1.2.5.

class Fwupd.InstallFlags(value)

Bases: GLib.Flags

Flags to set when performing the firmware update or install.

NONE = 0

No flags set.

New in version 0.7.0.

IGNORE_VID_PID = 128

Ignore firmware vendor and project checks.

New in version 1.5.0.

NO_HISTORY = 16

Do not write to the history database.

New in version 1.0.8.

ALLOW_REINSTALL = 2

Allow reinstalling the same version.

New in version 0.7.0.

Do not use heuristics when parsing the image.

New in version 1.5.0.

ALLOW_BRANCH_SWITCH = 32

Allow firmware branch switching.

New in version 1.5.0.

ALLOW_OLDER = 4

Allow downgrading firmware.

New in version 0.7.0.

IGNORE_REQUIREMENTS = 512

Ignore version requirement checks.

New in version 1.9.21.

IGNORE_CHECKSUM = 64

Ignore firmware CRCs and checksums.

New in version 1.5.0.

FORCE = 8

Force the update even if not a good idea.

New in version 0.7.1.

class Fwupd.PluginFlags(value)

Bases: GLib.Flags

Flags used to represent plugin attributes

UNKNOWN = -1

The plugin flag is unknown. This is usually caused by a mismatched libfwupdplugin and daemon.

New in version 1.5.0.

NONE = 0

No plugin flags are set.

New in version 1.5.0.

DISABLED = 1

The plugin has been disabled, either by daemon configuration or a problem.

New in version 1.5.0.

REQUIRE_HWID = 1024

A specific HWID is required to use this plugin.

New in version 1.5.8.

ESP_NOT_FOUND = 128

The plugins discovered that the EFI system partition was not found. Supported clients will display this information to a user.

New in version 1.5.0.

READY = 131072

The plugin is ready for use and all devices have been coldplugged.

New in version 1.9.6.

CAPSULES_UNSUPPORTED = 16

The plugin discovered that UEFI UpdateCapsule are unsupported. Supported clients will display this information to a user.

New in version 1.5.0.

MODULAR = 16384

The plugin is loaded from an external module.

New in version 1.8.6.

USER_WARNING = 2

The plugin has a problem and would like to show a user warning to a supported client.

New in version 1.5.0.

KERNEL_TOO_OLD = 2048

The feature is not supported as the kernel is too old.

New in version 1.6.2.

LEGACY_BIOS = 256

The plugin discovered the system is running in legacy CSM mode. Supported clients will display this information to a user.

New in version 1.5.0.

TEST_ONLY = 262144

The plugin is used for virtual devices that exercising daemon flows.

New in version 2.0.0.

UNLOCK_REQUIRED = 32

The plugin discovered that hardware unlock is required. Supported clients will display this information to a user.

New in version 1.5.0.

MEASURE_SYSTEM_INTEGRITY = 32768

The plugin will be checked that it preserves system state such as KEK, PK, BOOT#### etc.

New in version 1.8.7.

CLEAR_UPDATABLE = 4

When the plugin loads it should clear the UPDATABLE flag from any devices. This typically happens when the device requires a system restart.

New in version 1.5.0.

AUTH_REQUIRED = 4096

The plugin requires the user to provide authentication details. Supported clients will display this information to a user.

New in version 1.6.2.

FAILED_OPEN = 512

Failed to open plugin = missing dependency,. Supported clients will display this information to a user.

New in version 1.5.0.

EFIVAR_NOT_MOUNTED = 64

The plugin discovered the efivar filesystem is not found and is required for this plugin. Supported clients will display this information to a user.

New in version 1.5.0.

ESP_NOT_VALID = 65536

The plugins discovered that the EFI system partition may not be valid. Supported clients will display this information to a user.

New in version 1.9.3.

NO_HARDWARE = 8

The plugin won’t load because no supported hardware was found. This typically happens with plugins designed for a specific platform design = such as the dell plugin only works on Dell systems,.

New in version 1.5.0.

SECURE_CONFIG = 8192

The plugin requires the config file to be saved with permissions that only allow the root user to read.

New in version 1.8.5.

class Fwupd.ReleaseFlags(value)

Bases: GLib.Flags

Flags used to represent release attributes

UNKNOWN = -1

The release flag is unknown, typically caused by using mismatched client and daemon.

New in version 1.2.6.

NONE = 0

No flags are set.

New in version 1.2.6.

TRUSTED_PAYLOAD = 1

The payload binary is trusted.

New in version 1.2.6.

IS_COMMUNITY = 128

The release is supported by the community and not the hardware vendor.

New in version 1.7.5.

BLOCKED_VERSION = 16

The installation of the release is blocked as below device version-lowest.

New in version 1.2.6.

TRUSTED_METADATA = 2

The payload metadata is trusted.

New in version 1.2.6.

TRUSTED_REPORT = 256

The payload has been tested by a report we trust.

New in version 1.9.1.

BLOCKED_APPROVAL = 32

The installation of the release is blocked as release not approved by an administrator.

New in version 1.2.6.

IS_UPGRADE = 4

The release is newer than the device version.

New in version 1.2.6.

IS_ALTERNATE_BRANCH = 64

The release is an alternate branch of firmware.

New in version 1.5.0.

IS_DOWNGRADE = 8

The release is older than the device version.

New in version 1.2.6.

class Fwupd.RemoteFlags(value)

Bases: GLib.Flags

The flags available for the remote.

NONE = 0

No flags set.

New in version 1.9.4.

ENABLED = 1

Is enabled.

New in version 1.9.4.

ALLOW_P2P_METADATA = 16

Use peer-to-peer locations for metadata.

New in version 1.9.5.

APPROVAL_REQUIRED = 2

Requires approval for each firmware.

New in version 1.9.4.

ALLOW_P2P_FIRMWARE = 32

Use peer-to-peer locations for firmware.

New in version 1.9.5.

AUTOMATIC_REPORTS = 4

Send firmware reports automatically.

New in version 1.9.4.

AUTOMATIC_SECURITY_REPORTS = 8

Send security reports automatically.

New in version 1.9.4.

class Fwupd.ReportFlags(value)

Bases: GLib.Flags

Flags used to represent report attributes

UNKNOWN = -1

The report flag is unknown.

This is usually caused by a mismatched libfwupdplugin and daemon.

New in version 1.9.1.

NONE = 0

No report flags are set.

New in version 1.9.1.

FROM_OEM = 1

The report was generated by the OEM.

New in version 1.9.1.

IS_UPGRADE = 2

The new firmware was newer than the old firmware.

New in version 1.9.14.

class Fwupd.RequestFlags(value)

Bases: GLib.Flags

Flags used to represent request attributes

UNKNOWN = -1

The request flag is unknown, typically caused by using mismatched client and daemon.

New in version 1.8.6.

NONE = 0

No flags are set.

New in version 1.8.6.

ALLOW_GENERIC_MESSAGE = 1

Use a generic (translated) request message.

New in version 1.8.6.

ALLOW_GENERIC_IMAGE = 2

Use a generic (translated) request image.

New in version 1.8.6.

NON_GENERIC_MESSAGE = 4

Device requires a non-generic interaction with custom non-translatable text.

New in version 1.9.10.

NON_GENERIC_IMAGE = 8

Device requires to show the user a custom image for the action to make sense.

New in version 1.9.10.

class Fwupd.SecurityAttrFlags(value)

Bases: GLib.Flags

The flags available for HSI attributes.

NONE = 0

No flags set.

SUCCESS = 1

Success.

RUNTIME_ISSUE = 1024

Suffix !.

CAN_FIX = 16384

The failure can be automatically fixed.

OBSOLETED = 2

Obsoleted by another attribute.

ACTION_CONTACT_OEM = 2048

Contact the firmware vendor for a update.

RUNTIME_UPDATES = 256

Suffix U.

CAN_UNDO = 32768

The fix can be automatically reverted.

MISSING_DATA = 4

Missing data.

ACTION_CONFIG_FW = 4096

Failure may be fixed by changing FW config.

RUNTIME_ATTESTATION = 512

Suffix A.

ACTION_CONFIG_OS = 8192

Failure may be fixed by changing OS config.

class Fwupd.SelfSignFlags(value)

Bases: GLib.Flags

Flags to set when performing the firmware update or install.

NONE = 0

No flags set.

New in version 1.2.6.

ADD_TIMESTAMP = 1

Add the timestamp to the detached signature.

New in version 1.2.6.

ADD_CERT = 2

Add the certificate to the detached signature.

New in version 1.2.6.