KVM / Libvirt ListVms
CertifiedList VMs
KVM / Libvirt ListVms
List VMs
Lists the KVM/Libvirt virtual machines, optionally filtered by status.
type: io.kestra.plugin.kvm.ListVmsExamples
id: kvm_lifecycle_ssh
namespace: kvmtest.ssh
tasks:
- id: list_initial_vms
type: io.kestra.plugin.kvm.ListVms
uri: qemu+ssh://root@167.99.104.163/system
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
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
{}1150statusFilter string
Status Filter
uri string
Libvirt URI
Outputs
vms array
The listed virtual machines
io.kestra.plugin.kvm.ListVms-VmEntry
VM Name
VM State
VM UUID
