tlm-cli fm devices¶
Commands for managing devices in the Fleet Manager (FM).
The Fleet Manager tracks devices that have been claimed from the Product Management System (PMS) and are actively deployed in the field. Claiming transfers a device from manufacturing into the fleet so it can be monitored and managed.
list¶
List fleet devices with interactive pagination.
Fetches devices in batches of 200 and displays 25 at a time.
| Option | Type | Description |
|---|---|---|
--serial TEXT |
string | Filter by serial number (fuzzy match). |
--name TEXT |
string | Filter by device name (fuzzy match). |
Keyboard shortcuts
| Key | Action |
|---|---|
Enter |
Next page |
d |
Toggle detail view (adds FW Version, Last Seen) |
q or Esc |
Quit |
Example
# List all fleet devices
tlm-cli fm devices list
# Filter by serial number
tlm-cli fm devices list --serial "SN-001"
# Filter by name
tlm-cli fm devices list --name "gateway"
Compact view columns: Serial Number, Name, Status
Detail view adds: FW Version, Last Seen
show¶
Show attributes and live status for a single fleet device.
| Argument | Description |
|---|---|
SERIAL_NUMBER |
Serial number of the device to display. |
Example
Output fields: Serial Number, Name, Status, FW Version, Last Seen
claim¶
Claim a manufacturing device into the Fleet Manager.
The device must already be provisioned in PMS before it can be claimed. Attempting to claim an unprovisioned device returns a clear 404 error.
| Argument / Option | Type | Required | Description |
|---|---|---|---|
SERIAL_NUMBER |
string | yes | Serial number of the device to claim. |
--name TEXT |
string | no | Name to assign to the claimed device. |
If --name is provided the CLI retries name assignment up to 5 times (with a 3-second delay between attempts) to allow
the backend to become ready after claiming.
Example
# Claim without a name
tlm-cli fm devices claim SN-001234
# Claim and assign a name
tlm-cli fm devices claim SN-001234 --name "Gateway-001234"
claim-bulk¶
Bulk-claim all PMS devices not yet present in the Fleet Manager.
The command fetches all serial numbers from both PMS and FM, computes the difference, and claims the missing devices.
| Option | Type | Description |
|---|---|---|
--dry-run |
flag | Show what would be claimed without claiming. |
--yes / -y |
flag | Skip the confirmation prompt. |
Example
# Preview what would be claimed
tlm-cli fm devices claim-bulk --dry-run
# Claim with confirmation
tlm-cli fm devices claim-bulk
# Claim without prompt
tlm-cli fm devices claim-bulk --yes
Output is a summary table with columns: Serial Number, Status (green ok / error: ... / dim dry-run).
unclaim¶
Un-claim a device from the Fleet Manager.
Resolves the claimed device by exact serial number, shows its details, then prompts for confirmation before removing it from the Fleet Manager.
| Argument / Option | Type | Required | Description |
|---|---|---|---|
SERIAL_NUMBER |
string | yes | Serial number of the device to un-claim. |
--yes / -y |
flag | no | Skip the confirmation prompt. |
--dry-run |
flag | no | Show resolved details without un-claiming. |
# Un-claim a device
tlm-cli fm devices unclaim SN-001234
# Skip confirmation
tlm-cli fm devices unclaim SN-001234 --yes
# Preview
tlm-cli fm devices unclaim SN-001234 --dry-run