Manage Firmwares¶

How to create, inspect, and delete IoT firmware using the pms models firmwares commands.

Each IoT model has at most one associated firmware. The firmware defines the target hardware architecture and tracks all versioned releases. Firmware is created after the model and is a prerequisite for uploading bills of materials via tlm-cli cs bom upload.

View firmware for a model¶

Show the firmware details and all releases for a model:

tlm-cli pms models show "gateway-v2"

The output shows the model details, the firmware's architecture, active release, and a releases table with version, mandatory flag, and which release is currently active (marked ✓).

Create a firmware¶

A model must already exist before you can create a firmware for it. See Manage Models if you need to create the model first.

tlm-cli pms models firmwares create "fw-gateway-v2" --model "gateway-v2" --architecture x86_64

Add a description:

tlm-cli pms models firmwares create "fw-gateway-v2" --model "gateway-v2" \
  --architecture x86_64 --description "Main gateway firmware"

Common architecture values: ARM, x86, x86_64. Use whatever matches the device MCU.

Preview the request before sending:

tlm-cli pms models firmwares create "fw-gateway-v2" --model "gateway-v2" --architecture x86_64 --dry-run

Note

The firmware name is used as the subproject name when uploading BOMs via tlm-cli cs bom upload. Choose a name that clearly identifies the firmware family.

Delete a firmware¶

tlm-cli pms models firmwares delete "gateway-v2"

The command resolves the model by name, shows the firmware details, then asks for confirmation. Pass --yes to skip the prompt in scripts:

tlm-cli pms models firmwares delete "gateway-v2" --yes

Preview what would be deleted without making changes:

tlm-cli pms models firmwares delete "gateway-v2" --dry-run

Warning

Deleting a firmware is permanent. Any BOM data associated with the firmware's subprojects in the cybersecurity service is not automatically removed.