Canonical CommissionMachine

Canonical CommissionMachine

Certified
Enterprise Edition

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.

yaml
type: io.kestra.plugin.ee.canonical.maas.CommissionMachine

Commission a machine and wait for completion

yaml
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

MAAS API key

MAAS API key in the consumer: token: secret format.

System ID

MAAS system identifier of the machine to commission; machine must exist in MAAS.

MAAS URL

Base URL of the MAAS server, including the MAAS context path. Example: https://maas.example.com/MAAS

SubTypestring

Commissioning scripts

List of MAAS commissioning scripts to execute; comma-joined before submission.

Enable SSH

Whether to enable SSH during commissioning; defaults to MAAS behavior when unset.

Reference (ref) of the pluginDefaults to apply to this task.

Skip networking

Whether to skip network setup during commissioning; leave unset to use MAAS defaults.

Skip storage

Whether to skip storage configuration during commissioning; leave unset to use MAAS defaults.

SubTypestring

Testing scripts

List of MAAS testing scripts to execute; comma-joined before submission.

DefaultPT30M

Timeout

Maximum time to wait for commissioning to complete when waiting; defaults to 30 minutes.

Defaultfalse

Wait for completion

Whether to poll MAAS until the machine reaches the Ready state; defaults to false and increases run time when enabled.

Machine details

Sanitized machine details after commissioning or wait.

System ID

MAAS system identifier for the commissioned machine.