Proxmox VE ListPools

Proxmox VE ListPools

Certified

List resource pools in a Proxmox VE cluster

Retrieves all resource pools from /pools. The node property is used to connect to the API but does not filter results to that node.

yaml
type: io.kestra.plugin.proxmox.cluster.ListPools

List all resource pools

yaml
id: list_pools
namespace: company.team

tasks:
  - id: pools
    type: io.kestra.plugin.proxmox.cluster.ListPools
    host: "{{ secret('PROXMOX_HOST') }}"
    username: "{{ secret('PROXMOX_USERNAME') }}"
    password: "{{ secret('PROXMOX_PASSWORD') }}"
    node: pve
Properties

Proxmox host

Hostname or IP address of the Proxmox VE node (no scheme, no port).

Proxmox node name

Name of the cluster node that scopes all API calls (e.g. pve, node1).

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

Password

Password for ticket-based authentication.

Default8006

API port

Defaults to 8006.

API token ID

Full token identifier in the form user@realm!tokenname (e.g. root@pam!mytoken). Use together with tokenSecret.

API token secret

The UUID secret associated with the token ID.

Username

PAM or PVE user in the form user@realm (e.g. root@pam). Required when using ticket-based auth.

Defaulttrue

Verify SSL

Validate the server TLS certificate. Defaults to true; set to false only for trusted networks with self-signed Proxmox certificates.