Skip to content
TakoAPI
Back to skills

opnsense-admin

by transcendenceia

DevOps & Cloud
—Not yet rated
Your rating

Brief

Manage OPNsense firewall, DNS, IDS/IPS, and network configuration via API and SSH.

Description

What This Skill Does

Administers OPNsense firewalls through its REST API and SSH. Covers firewall rules, NAT, Suricata IDS/IPS, Unbound DNS, configuration backups, and service management. Targets OPNsense 26.1 and later.

Wraps both the OPNsense REST API and SSH service control in one skill, removing the need to navigate the web UI or write raw curl commands for routine administration tasks.

When to Use It

  • Scheduling nightly configuration backups with 30-day retention
  • Blocking a suspicious IP range by adding a firewall alias and rule
  • Switching Suricata from IDS detection mode to IPS blocking mode
  • Restarting Unbound DNS after updating blocklist settings
  • Pulling live firewall and interface statistics during a network incident

Example Workflow

INPUT

User asks: Create a backup of the current OPNsense configuration

AGENT
  1. 1

    Reads OPNSENSE_HOST, OPNSENSE_KEY, and OPNSENSE_SECRET from environment or credentials file

  2. 2

    Calls GET /api/core/backup/backup against the OPNsense API

  3. 3

    Saves the response to a timestamped file in the configured backup directory

  4. 4

    Verifies the file is non-empty and logs the backup path

OUTPUT

Configuration backup saved to ./backups/opnsense-config-2026-03-19.xml

Requirements

  • OPNsense 26.1+ instance accessible over HTTPS
  • OPNSENSE_KEY API key generated under System → Access → Users → API in OPNsense
  • OPNSENSE_SECRET API secret paired with the API key
  • OPNSENSE_HOST environment variable set to the firewall IP or hostname

Installation

clawhub install transcendenceia/opnsense-admin

Run the CLI command, or paste the prompt into Claude Code, Cursor, Codex or whichever coding agent you use.

Links