Skip to content

tlm-cli pms models

Commands for browsing IoT models and their firmware in the Product Management System (PMS).

tlm-cli pms models [COMMAND] [OPTIONS]

A model defines the firmware profile for a class of devices. Each model may have an associated firmware and one or more firmware releases.

list

List models sorted by name.

tlm-cli pms models list [OPTIONS]

Returns the first 25 models by default. Use filters to narrow results (up to 100).

Option Type Description
--name TEXT string Filter by model name (fuzzy match).
--tag TEXT string Filter by tag.
--customer TEXT string Filter by customer code (resolved to tenant ID internally).

Example

# List all models (first 25)
tlm-cli pms models list

# Filter by name
tlm-cli pms models list --name "gateway"

# Filter by customer
tlm-cli pms models list --customer ACME

# Combine filters
tlm-cli pms models list --name "sensor" --tag "v2"

Output columns: Name, Description, Tags, Customers

show

Show details for a model, including its firmware and all firmware releases.

tlm-cli pms models show MODEL_NAME
Argument Description
MODEL_NAME Exact model name to display.

Example

tlm-cli pms models show "gateway-v2"

Output includes:

  • Model details: Name, Description, Tags, Customers
  • Firmware details: Architecture, Active Release, Description
  • Releases table: Version, Mandatory, Active (marked with ✓)

create

Create a new IoT model.

tlm-cli pms models create MODEL_NAME [OPTIONS]
Argument / Option Type Required Description
MODEL_NAME string yes Model name.
--description TEXT / -d string no Model description.
--tenant TEXT / -t string no Tenant ID to associate (repeatable).
--dry-run flag no Print the request payload without sending it.

Example

# Create a model
tlm-cli pms models create "gateway-v2"

# With description and tenant
tlm-cli pms models create "sensor-x" --description "Outdoor sensor" --tenant tenant-001

# Associate with multiple tenants
tlm-cli pms models create "sensor-x" --tenant tenant-001 --tenant tenant-002

# Preview the request
tlm-cli pms models create "sensor-x" --dry-run

delete

Delete an IoT model by name.

tlm-cli pms models delete MODEL_NAME [OPTIONS]

Resolves the model by exact name, shows its details, then prompts for confirmation before deleting.

Argument / Option Type Required Description
MODEL_NAME string yes Exact model name to delete.
--yes / -y flag no Skip the confirmation prompt.
--dry-run flag no Show resolved details without deleting.

Example

tlm-cli pms models delete "gateway-v2"

# Skip confirmation
tlm-cli pms models delete "gateway-v2" --yes

# Preview
tlm-cli pms models delete "gateway-v2" --dry-run

firmwares

Firmware subcommands are available under tlm-cli pms models firmwares. Use them to create or delete the firmware linked to a model.

Command Description
create NAME --model MODEL --architecture ARCH Create a firmware and link it to a model.
delete MODEL Delete the firmware linked to a model.

See the tlm-cli pms models firmwares reference for full option tables and examples.