Resources / DeviceCommand

DeviceCommand

An imperative command issued to an MCU Device to update firmware or configuration parameters (spec 0044).

Overview

APIdevices.etorm.com/v1alpha1
Resourcedevicecommands (cluster-scoped inside its cluster)
Short namesdcmd
Available inproject clusters only
Statuswritten by a controller through /status

Minimal example

apiVersion: devices.etorm.com/v1alpha1
kind: DeviceCommand
metadata:
  name: example
spec:
  deviceRef:
    name: "<name>"
  action: update-firmware

Spec

FieldTypeRequiredDefaultAllowedDescription
deviceRefreference to DeviceyesTarget Device to receive this command. Immutable after creation.
actionstring (one of)yesupdate-firmware, update-config, inspect, vxlan-probe, rebootCommand action: update-firmware, update-config, inspect, vxlan-probe, or reboot. Immutable after creation.
firmwareobjectFirmware update payload (required when action is update-firmware).
firmware.versionstringup to 64 charactersTarget firmware version string.
firmware.urlstringup to 512 charactersHTTP or HTTPS URL of the firmware binary.
firmware.sha256stringup to 71 charactersExpected SHA-256 hex digest of the firmware binary.
configobjectConfiguration parameter update payload (required when action is update-config).
config.pollIntervalSecsintegerKubernetes API polling interval in seconds (5-3600).
config.ntpServerstringup to 128 charactersSNTP time synchronization server hostname.
config.maxTxPowerDbmintegerMaximum Wi-Fi transmit power in dBm (2-20).
config.logShipIntervalSecsintegerReal-time monitoring log shipping interval in seconds (1-300).

Status

FieldTypeRequiredDefaultAllowedDescription
phasestringPending, Dispatched, Running, Succeeded, or Failed.
messagestringHuman-readable status or error message from the controller or device.
observedGenerationintegerGeneration of the DeviceCommand observed by the controller.
dispatchedAtstringRFC 3339 UTC timestamp when the command was dispatched.
completedAtstringRFC 3339 UTC timestamp when the device completed the command.
reportedFirmwareHashstringFirmware SHA-256 reported by the device after command execution.
conditionslist of objectStandard status conditions.
conditions[].typestringCondition type.
conditions[].statusstringTrue, False, or Unknown.
conditions[].reasonstringMachine-readable reason.
conditions[].messagestringHuman-readable message.

Columns in listings

ColumnFrom
Device.spec.deviceRef.name
Action.spec.action
Phase.status.phase
Message.status.message

All resources