FWUPDTOOL

Section: User Commands (1)
Updated: March 2021
Page Index

NAME

fwupdtool - Standalone firmware update utility

DESCRIPTION

Usage:

: fwupdtool [OPTION�.�]
activate [DEVICE-ID|GUID]: Activate pending devices
attach DEVICE-ID|GUID: Attach to firmware mode
bind-driver SUBSYSTEM DRIVER [DEVICE-ID|GUID]: Bind new kernel driver
build-firmware FILE-IN FILE-OUT [SCRIPT] [OUTPUT]: Build firmware using a sandbox
detach DEVICE-ID|GUID: Detach to bootloader mode
esp-list: Lists files on the ESP
esp-mount: Mounts the ESP
esp-unmount: Unmounts the ESP
export-hwids HWIDS-FILE: Save a file that allows generation of hardware IDs
firmware-build BUILDER-XML FILENAME-DST: Build a firmware file
firmware-convert FILENAME-SRC FILENAME-DST [FIRMWARE-TYPE-SRC] [FIRMWARE-TYPE-DST]: Convert a firmware file
firmware-dump FILENAME [DEVICE-ID|GUID]: Read a firmware blob from a device
firmware-extract FILENAME [FIRMWARE-TYPE]: Extract a firmware blob to images
firmware-parse FILENAME [FIRMWARE-TYPE]: Parse and show details about a firmware file
get-details: Gets details about a firmware file
get-device-flags: Get all device flags supported by fwupd
get-devices: Get all devices that support firmware updates
get-firmware-types: List the available firmware types
get-history: Show history of firmware updates
get-plugins: Get all enabled plugins registered with the system
get-remotes: Gets the configured remotes
get-topology: Alias to get-devices
get-updates [DEVICE-ID|GUID]: Gets the list of updates for connected hardware
get-upgrades [DEVICE-ID|GUID]: Alias to get-updates
hwids [SMBIOS-FILE|HWIDS-FILE]: Return all the hardware IDs for the machine
install FILE [DEVICE-ID|GUID]: Install a firmware file on this hardware
install-blob FILENAME DEVICE-ID: Install a firmware blob on a device
monitor: Monitor the daemon for events
refresh: Refresh metadata from remote server
reinstall DEVICE-ID|GUID: Reinstall firmware on a device
security: Gets the host security attributes
self-sign TEXT: Sign data using the client certificate
smbios-dump FILE: Dump SMBIOS data from a file
switch-branch [DEVICE-ID|GUID] [BRANCH]: Switch the firmware branch on the device
unbind-driver [DEVICE-ID|GUID]: Unbind current driver
update [DEVICE-ID|GUID]: Update all devices that match local metadata
upgrade [DEVICE-ID|GUID]: Alias to update
verify-update [DEVICE-ID|GUID]: Update the stored metadata with current contents
watch: Watch for hardware changes

Help Options:

-h, --help: Show help options
--help-all: Show all help options

Application Options:

--version: Show client and daemon versions
--allow-reinstall: Allow reinstalling existing firmware versions
--allow-older: Allow downgrading firmware versions
--allow-branch-switch: Allow switching firmware branch
--force: Force the action by relaxing some runtime checks
--ignore-checksum: Ignore firmware checksum failures
--ignore-vid-pid: Ignore firmware hardware mismatch failures
--ignore-power: Ignore requirement of external power source
--no-reboot-check: Do not check for reboot after update
--no-safety-check: Do not perform device safety checks
--show-all: Show all results
--plugins: Manually enable specific plugins
--prepare: Run the plugin composite prepare routine when using install-blob
--cleanup: Run the plugin composite cleanup routine when using install-blob
--enable-json-state: Save device state into a JSON file between executions
--disable-ssl-strict: Ignore SSL strict checks when downloading files
--filter: Filter with a set of device flags using a ~ prefix to exclude, e.g. 'internal,~needs-reboot'
-v, --verbose: Show debugging information for all domains
--no-timestamp: Do not include timestamp prefix
--no-domain: Do not include log domain prefix
--plugin-verbose=,PLUGIN-NAME/: Show plugin verbose information
--daemon-verbose=,DOMAIN/: Show daemon verbose information for a particular domain

This tool allows an administrator to use the fwupd plugins without being installed on the host system.