Proxmox VE GetFirewallRules

Proxmox VE GetFirewallRules
Certified
Get firewall rules on a Proxmox VE node

Retrieves firewall rules from /nodes/{node}/firewall/rules. Optionally scope to a specific VM or container by providing a vmId. When vmId is set, reads /nodes/{node}/qemu/{vmid}/firewall/rules (VM) or /nodes/{node}/lxc/{vmid}/firewall/rules (container) based on resourceType.

yaml
type: io.kestra.plugin.proxmox.network.GetFirewallRules

Examples

Get node-level firewall rules

yaml
id: get_firewall_rules
namespace: company.team

tasks:
  - id: rules
    type: io.kestra.plugin.proxmox.network.GetFirewallRules
    host: "{{ secret('PROXMOX_HOST') }}"
    username: "{{ secret('PROXMOX_USERNAME') }}"
    password: "{{ secret('PROXMOX_PASSWORD') }}"
    node: pve

Get VM-level firewall rules

yaml
id: get_vm_firewall_rules
namespace: company.team

tasks:
  - id: rules
    type: io.kestra.plugin.proxmox.network.GetFirewallRules
    host: "{{ secret('PROXMOX_HOST') }}"
    username: "{{ secret('PROXMOX_USERNAME') }}"
    password: "{{ secret('PROXMOX_PASSWORD') }}"
    node: pve
    vmId: "100"
    resourceType: 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).

password string

Password

Password for ticket-based authentication.

pluginDefaultsRef string

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

port integerstring

Default8006

API port

Defaults to 8006.

resourceType string

Possible Values

VMCONTAINER

Resource type

Resource type: vm or container.

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.

username string

Username

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

verifySsl booleanstring

Defaulttrue

Verify SSL

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

vmId string

VM or container ID

When set, retrieves firewall rules scoped to this VM or container instead of the node.

OPA (Open Policy Agent)

Enterprise

Tasks to manage Open Policy Agent policies and decisions, including upload, evaluation, and partial evaluation.

Infrastructure

Ansible

Tasks that orchestrate Ansible playbooks from Kestra flows.

Infrastructure

Proxmox VE GetFirewallRulesCertifiedGet firewall rules on a Proxmox VE node

Proxmox VE GetFirewallRules

More Plugins in this Category

OPA (Open Policy Agent)

Ansible

Proxmox VE GetFirewallRules
Certified
Get firewall rules on a Proxmox VE node