
Canonical CommissionMachine
CertifiedEnterprise EditionCommission MAAS machine hardware
Canonical CommissionMachine
Commission MAAS machine hardware
Trigger MAAS commissioning on a machine to inventory and validate hardware. Supports optional SSH enablement, custom commissioning/testing scripts, and skip flags. Can poll until Ready (default 30m timeout) and retries nonce/503 submission failures.
type: io.kestra.plugin.ee.canonical.maas.CommissionMachineExamples
Commission a machine and wait for completion
id: commission_server
namespace: company.team
tasks:
- id: commission_server
type: io.kestra.plugin.ee.canonical.maas.CommissionMachine
url: "{{ secret('MAAS_URL') }}"
apiKey: "{{ secret('MAAS_API_KEY') }}"
systemId: "{{ outputs.enlist_new_server.systemId }}"
enableSsh: true
skipNetworking: false
skipStorage: false
commissioningScripts:
- "update_firmware"
- "configure_raid"
testingScripts:
- "smartctl-validate"
- "memtester"
waitForCompletion: true
timeout: PT30M
Properties
apiKey *Requiredstring
MAAS API key
MAAS API key in the consumer: token: secret format.
systemId *Requiredstring
System ID
MAAS system identifier of the machine to commission; machine must exist in MAAS.
url *Requiredstring
MAAS URL
Base URL of the MAAS server, including the MAAS context path.
Example: https://maas.example.com/MAAS
commissioningScripts array
Commissioning scripts
List of MAAS commissioning scripts to execute; comma-joined before submission.
enableSsh booleanstring
Enable SSH
Whether to enable SSH during commissioning; defaults to MAAS behavior when unset.
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
skipNetworking booleanstring
Skip networking
Whether to skip network setup during commissioning; leave unset to use MAAS defaults.
skipStorage booleanstring
Skip storage
Whether to skip storage configuration during commissioning; leave unset to use MAAS defaults.
testingScripts array
Testing scripts
List of MAAS testing scripts to execute; comma-joined before submission.
timeout string
PT30MTimeout
Maximum time to wait for commissioning to complete when waiting; defaults to 30 minutes.
waitForCompletion booleanstring
falseWait for completion
Whether to poll MAAS until the machine reaches the Ready state; defaults to false and increases run time when enabled.
Outputs
machine object
Machine details
Sanitized machine details after commissioning or wait.
systemId string
System ID
MAAS system identifier for the commissioned machine.