Flags

Details

class Fwupd.ClientDownloadFlags(value)

Bases: GLib.Flags

The options to use for downloading.

NONE = 0

No flags set.

ONLY_P2P = 1

Only use peer-to-peer when downloading URIs.

class Fwupd.ClientUploadFlags(value)

Bases: GLib.Flags

The options to use for uploading.

NONE = 0

No flags set.

ALWAYS_MULTIPART = 1

Always use multipart/form-data.

class Fwupd.CodecFlags(value)

Bases: GLib.Flags

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

NONE = 0

No flags set.

TRUSTED = 1

Include values that may be regarded as trusted or sensitive.

COMPRESSED = 2

Compress values to the smallest possible size.

class Fwupd.DeviceFlags(value)

Bases: GLib.Flags

Flags used to represent device attributes

UNKNOWN = -1

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

INSTALL_ALL_RELEASES = -2147483648

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

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.

BACKUP_BEFORE_INSTALL = 0

The device firmware should be saved before installing firmware.

CAN_EMULATION_TAG = 0

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

EMULATED = 0

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

EMULATION_TAG = 0

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

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.

HAS_MULTIPLE_BRANCHES = 0

The device supports switching to a different stream of firmware.

INSTALL_SKIP_VERSION_CHECK = 0

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

NONE = 0

No flags set

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.

ONLY_VERSION_UPGRADE = 0

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

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.

UNREACHABLE = 0

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

UNSIGNED_PAYLOAD = 0

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

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.

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.

INTERNAL = 1

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

NOTIFIED = 1024

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

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.

VERSION_CHECK_REQUIRED = 1073741824

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

NEEDS_SHUTDOWN = 131072

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

DUAL_IMAGE = 134217728

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

LOCKED = 16

The device can not be updated without manual user interaction.

WAIT_FOR_REPLUG = 16384

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

WILL_DISAPPEAR = 16777216

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

UPDATABLE = 2

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

NEEDS_REBOOT = 256

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

ANOTHER_WRITE_REQUIRED = 262144

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

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.

SUPPORTED = 32

The device is found in metadata loaded into the daemon.

CAN_VERIFY = 33554432

The device checksums can be compared against metadata.

HISTORICAL = 4194304

The device is used for historical data only.

REPORTED = 512

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

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.

NEEDS_BOOTLOADER = 64

The device requires entering a bootloader mode to be manually.

CAN_VERIFY_IMAGE = 67108864

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

REQUIRE_AC = 8

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

IS_BOOTLOADER = 8192

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

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.

NONE = 0

No device problems detected.

SYSTEM_POWER_TOO_LOW = 1

The system power is too low to perform the update.

IN_USE = 1024

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

MISSING_LICENSE = 128

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

REQUIRE_AC_POWER = 16

The device requires AC power to be connected.

FIRMWARE_LOCKED = 16384

The firmware is locked in the system setup.

UNREACHABLE = 2

The device is unreachable, or out of wireless range.

DISPLAY_REQUIRED = 2048

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

SYSTEM_INHIBIT = 256

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

LID_IS_CLOSED = 32

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

POWER_TOO_LOW = 4

The device battery power is too low.

LOWER_PRIORITY = 4096

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

UPDATE_IN_PROGRESS = 512

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

IS_EMULATED = 64

The device is emulated from a different host.

UPDATE_PENDING = 8

The device is waiting for the update to be applied.

INSECURE_PLATFORM = 8192

The device is signed with an insecure key

class Fwupd.FeatureFlags(value)

Bases: GLib.Flags

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

UNKNOWN = -1

Unknown flag.

NONE = 0

No trust.

CAN_REPORT = 1

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

SHOW_PROBLEMS = 128

Can show problems when getting the update list.

REQUESTS = 16

Can show interactive requests.

DETACH_ACTION = 2

Can perform detach action, typically showing text.

ALLOW_AUTHENTICATION = 256

Can authenticate with PolicyKit for requests.

FDE_WARNING = 32

Can warn about full disk encryption.

UPDATE_ACTION = 4

Can perform update action, typically showing text.

REQUESTS_NON_GENERIC = 512

Can handle showing non-generic request message text.

COMMUNITY_TEXT = 64

Can show information about community supported.

SWITCH_BRANCH = 8

Can switch the firmware branch.

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.

UNKNOWN = -1

Unknown flag

NONE = 0

No flags set.

ONLY_EMULATED = 1024

Only install to emulated devices.

IGNORE_VID_PID = 128

This is now unused; see #FuFirmwareParseFlags.

NO_HISTORY = 16

Do not write to the history database.

ALLOW_REINSTALL = 2

Allow reinstalling the same version.

This is now only for internal use.

ALLOW_BRANCH_SWITCH = 32

Allow firmware branch switching.

ALLOW_OLDER = 4

Allow downgrading firmware.

IGNORE_REQUIREMENTS = 512

Ignore version requirement checks.

IGNORE_CHECKSUM = 64

This is now unused; see #FuFirmwareParseFlags.

FORCE = 8

Force the update even if not a good idea.

class Fwupd.JsonExportFlags(value)

Bases: GLib.Flags

JSON export flags.

NONE = 0
INDENT = 1
TRAILING_NEWLINE = 2
class Fwupd.JsonLoadFlags(value)

Bases: GLib.Flags

JSON load flags.

NONE = 0
TRUSTED = 1
STATIC_KEYS = 2
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.

NONE = 0

No plugin flags are set.

DISABLED = 1

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

REQUIRE_HWID = 1024

A specific HWID is required to use this plugin.

ESP_NOT_FOUND = 128

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

READY = 131072

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

CAPSULES_UNSUPPORTED = 16

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

MODULAR = 16384

The plugin is loaded from an external module.

USER_WARNING = 2

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

KERNEL_TOO_OLD = 2048

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

LEGACY_BIOS = 256

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

TEST_ONLY = 262144

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

UNLOCK_REQUIRED = 32

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

MEASURE_SYSTEM_INTEGRITY = 32768

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

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.

AUTH_REQUIRED = 4096

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

FAILED_OPEN = 512

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

MUTABLE_ENUMERATION = 524288

Some devices supported by the plugin may cause a device to momentarily stop working while probing.

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.

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.

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,.

SECURE_CONFIG = 8192

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

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.

NONE = 0

No flags are set.

TRUSTED_PAYLOAD = 1

The payload binary is trusted.

IS_COMMUNITY = 128

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

BLOCKED_VERSION = 16

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

TRUSTED_METADATA = 2

The payload metadata is trusted.

TRUSTED_REPORT = 256

The payload has been tested by a report we trust.

BLOCKED_APPROVAL = 32

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

IS_UPGRADE = 4

The release is newer than the device version.

IS_ALTERNATE_BRANCH = 64

The release is an alternate branch of firmware.

IS_DOWNGRADE = 8

The release is older than the device version.

class Fwupd.RemoteFlags(value)

Bases: GLib.Flags

The flags available for the remote.

NONE = 0

No flags set.

ENABLED = 1

Is enabled.

ALLOW_P2P_METADATA = 16

Use peer-to-peer locations for metadata.

APPROVAL_REQUIRED = 2

Requires approval for each firmware.

ALLOW_P2P_FIRMWARE = 32

Use peer-to-peer locations for firmware.

AUTOMATIC_REPORTS = 4

Send firmware reports automatically.

NO_PHASED_UPDATES = 64

Do not slow deployment using phased updates.

AUTOMATIC_SECURITY_REPORTS = 8

Send security reports automatically.

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.

NONE = 0

No report flags are set.

FROM_OEM = 1

Report was generated by the OEM.

IS_UPGRADE = 2

New firmware was newer than the old firmware.

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.

NONE = 0

No flags are set.

ALLOW_GENERIC_MESSAGE = 1

Use a generic (translated) request message.

ALLOW_GENERIC_IMAGE = 2

Use a generic (translated) request image.

NON_GENERIC_MESSAGE = 4

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

NON_GENERIC_IMAGE = 8

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

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

Fwupd.SelfSignFlags: Flags to set when performing the firmware update or install.

UNKNOWN = -1

Unknown flag

NONE = 0

No flags set.

ADD_TIMESTAMP = 1

Add the timestamp to the detached signature.

ADD_CERT = 2

Add the certificate to the detached signature.