KVM / Libvirt DeleteVm

KVM / Libvirt DeleteVm

Certified

Delete or undefine KVM domain

Looks up a libvirt domain by name, stops it if running, and undefines it. Can also delete attached storage volumes parsed from the domain XML when deleteStorage is true (default false). Fails when the domain is missing unless failIfNotFound is set to false (default true).

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

tasks:
  - id: delete_vm
    type: io.kestra.plugin.kvm.DeleteVm
    uri: "qemu+ssh://root@167.99.104.163/system"
    name: "kestra-worker-nodes"
    deleteStorage: true
    failIfNotFound: 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 delete.

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
Defaultfalse

Delete storage volumes

If true, deletes volumes referenced in the domain XML by pool/name before undefine. Default false.

Defaulttrue

Fail if missing

If true, throws when the domain does not exist; if false, logs a warning and continues. Default true.

Libvirt URI

SubTypestring

Deleted volumes

Volume identifiers removed when deleteStorage is true.

Defaultfalse

Delete succeeded

True when the domain was found and undefined; false when skipped.

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