Proxmox VE ListResources

Proxmox VE ListResources

Certified

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.

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

List all cluster resources

yaml
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

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).

Password

Password for ticket-based authentication.

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

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.

Resource type filter

Optional filter: vm, node, storage, or pool. Omit to return all types.

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.