pfSense firewall

v0.1.0

Operate a pfSense firewall over its REST API: read firewall rules, NAT, aliases, interface / gateway / service / VPN status, DHCP leases, routes, ARP, CARP, and logs, plus a few gated mutators (apply filter, flush states, restart a service, reboot). Uses the community pfSense-pkg-RESTAPI package (/api/v2), which runs on the firewall and works across CE and Plus.

Pack ID

pfsense

Vendor

emisar

linux

Actions

Required binaries: curl. Actions that call a missing binary fail at run time — install these on the host before relying on the pack.

Install

emisar pack install validates the pack and verifies its content hash before copying it into /etc/emisar/packs. The --hash below pins the install to the exact bytes on this page — a tampered copy is rejected. After install, reload the runner; it re-reads the catalog and advertises every action.

content hash: sha256:b6dc51a0343f8366e1484c98f576adbabfd473117ff5d0a0b35380873ef019b9

on the runner host

sudo emisar pack install pfsense \
  --hash sha256:b6dc51a0343f8366e1484c98f576adbabfd473117ff5d0a0b35380873ef019b9 \
  --dest /etc/emisar/packs

# Reload so the runner re-reads the catalog:
sudo systemctl reload emisar

Actions 22 total

View on GitHub

pfsense.aliases script low

GET /api/v2/firewall/aliases
pfsense.apply_filter script medium

POST /api/v2/firewall/apply
pfsense.arp_table script low

GET /api/v2/diagnostics/arp_table
pfsense.carp_status script low

GET /api/v2/status/carp
pfsense.dhcp_leases script low

GET /api/v2/status/dhcp_server/leases
pfsense.firewall_log script low

GET /api/v2/status/logs/firewall
pfsense.firewall_rules script low

GET /api/v2/firewall/rules
pfsense.flush_states script high

DELETE /api/v2/firewall/states
pfsense.gateway_status script low

GET /api/v2/status/gateways
pfsense.interface_status script low

GET /api/v2/status/interfaces
pfsense.ipsec_status script low

GET /api/v2/status/ipsec/sas
pfsense.nat_outbound script low

GET /api/v2/firewall/nat/outbound/mappings
pfsense.nat_port_forwards script low

GET /api/v2/firewall/nat/port_forwards
pfsense.openvpn_status script low

GET /api/v2/status/openvpn/servers
pfsense.reboot script critical

POST /api/v2/diagnostics/reboot
pfsense.restart_service script high

POST /api/v2/status/service (restart)
pfsense.service_status script low

GET /api/v2/status/services
pfsense.states_size script low

GET /api/v2/firewall/states/size
pfsense.static_routes script low

GET /api/v2/routing/static_routes
pfsense.system_log script low

GET /api/v2/status/logs/system
pfsense.system_status script low

GET /api/v2/status/system
pfsense.version script low

GET /api/v2/system/version

← Back to registry

Pack reference Publish your own →