KVM / Libvirt StartVm

KVM / Libvirt StartVm

Certified

Start a KVM domain

Boots a libvirt domain if it isn't already running. Can optionally wait until the domain reaches RUNNING state using exponential retry up to timeToWait (default PT60S). Requires access to the target libvirt URI.

yaml
type: io.kestra.plugin.kvm.StartVm
yaml
id: kvm_lifecycle_ssh
namespace: kvmtest.ssh

tasks:
  - id: start_vm
    type: io.kestra.plugin.kvm.StartVm
    uri: qemu+ssh://root@167.99.104.163/system
    name: "kestra-worker-nodes"
    waitForRunning: true
Installation

Our standard Docker images already include this plugin. If you use a -slim image or another setup, install it with the following command: 

kestractl plugins get io.kestra.plugin:plugin-kvm --compatible-for $KESTRA_VERSION

For kestractl, use your Kestra version with --compatible-for, or specify an exact plugin version.

For Kestra CLI, replace LATEST with a specific version or version range to pin the plugin version.

Properties

Domain name

Name of the libvirt domain to start.

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
DefaultPT1M

Max wait duration

Maximum time to wait for RUNNING when waitForRunning is true. Default PT60S.

Libvirt URI

Defaultfalse

Wait for RUNNING

If true, polls domain state until RUNNING or timeout. Default false.

VM Name

Started domain name.

VM State

Libvirt domain state after the start attempt.

More Plugins in this Category

Canonical (EE)
Canonical
Enterprise

Tasks to interact with Canonical services, enabling automation and infrastructure management through API-driven workflows.

CloudInfrastructure

5 tasks

Pure Storage FlashArray (EE)
Pure Storage FlashArray
Enterprise

Manage Pure Storage FlashArray systems from Kestra: volumes, snapshots, ActiveDR pods, and array/alert monitoring.

Infrastructure

17 tasks