KVM / Libvirt StopVm

KVM / Libvirt StopVm

Certified

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.

yaml
type: io.kestra.plugin.kvm.StopVm
yaml
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

Domain name

Name of the libvirt domain to stop.

Defaultfalse

Force power off

If true, calls destroy (hard power off); otherwise uses graceful shutdown. Default false.

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

DefaultPT1M

Max wait duration

Maximum time to wait for SHUTOFF when waitForStopped is true. Default PT60S.

Libvirt URI

Defaultfalse

Wait for SHUTOFF

If true, polls until the domain is SHUTOFF or timeout. Default false.

VM Name

Stopped domain name.

VM State

Libvirt domain state after the stop attempt.