Proxmox VE ListResources
CertifiedList cluster resources on Proxmox VE
Proxmox VE ListResources
List cluster resources on Proxmox VE
Retrieves resources from /cluster/resources. Optionally filter by type: vm, node, storage, or pool. The node property is used to connect to the API but does not filter results to that node.
type: io.kestra.plugin.proxmox.cluster.ListResourcesExamples
List all cluster resources
id: list_cluster_resources
namespace: company.team
tasks:
- id: resources
type: io.kestra.plugin.proxmox.cluster.ListResources
host: "{{ secret('PROXMOX_HOST') }}"
username: "{{ secret('PROXMOX_USERNAME') }}"
password: "{{ secret('PROXMOX_PASSWORD') }}"
node: pve
typeFilter: vm
Properties
host *string
Proxmox host
Hostname or IP address of the Proxmox VE node (no scheme, no port).
node *string
Proxmox node name
Name of the cluster node that scopes all API calls (e.g. pve, node1).
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
{}1150password string
Password
Password for ticket-based authentication.
port integerstring
8006API port
Defaults to 8006.
tokenId string
API token ID
Full token identifier in the form user@realm!tokenname (e.g. root@pam!mytoken). Use together with tokenSecret.
tokenSecret string
API token secret
The UUID secret associated with the token ID.
typeFilter string
Resource type filter
Optional filter: vm, node, storage, or pool. Omit to return all types.
username string
Username
PAM or PVE user in the form user@realm (e.g. root@pam). Required when using ticket-based auth.
verifySsl booleanstring
trueVerify SSL
Validate the server TLS certificate. Defaults to true; set to false only for trusted networks with self-signed Proxmox certificates.
