KVM / Libvirt StopVm
CertifiedStop or shutdown KVM domain
KVM / Libvirt StopVm
Stop or shutdown KVM domain
Sends a shutdown or hard power-off (force) to a libvirt domain. Can optionally wait until the domain reaches SHUTOFF using exponential retry up to timeToWait (default PT60S). Requires access to the target libvirt URI.
type: io.kestra.plugin.kvm.StopVmExamples
id: kvm_lifecycle_ssh
namespace: kvmtest.ssh
tasks:
- id: stop_vm
type: io.kestra.plugin.kvm.StopVm
uri: qemu+ssh://root@167.99.104.163/system
name: "kestra-worker-nodes"
force: true
Properties
name *string
Domain name
Name of the libvirt domain to stop.
assets
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.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset 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.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150force booleanstring
falseForce power off
If true, calls destroy (hard power off); otherwise uses graceful shutdown. Default false.
timeToWait string
PT1MMax wait duration
Maximum time to wait for SHUTOFF when waitForStopped is true. Default PT60S.
uri string
Libvirt URI
waitForStopped booleanstring
falseWait for SHUTOFF
If true, polls until the domain is SHUTOFF or timeout. Default false.
Outputs
name string
VM Name
Stopped domain name.
state string
VM State
Libvirt domain state after the stop attempt.
