Automate OPNsense firewall administration, backups, and security monitoring via API and SSH.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install opnsense-admin
2. Manual Installation
Copy the skill folder to one of these locations
~/.openclaw/skills/ <project>/skills/ Priority: Workspace > Local > Bundled
3. Prompt Installation
Copy this prompt to OpenClaw to install it automatically.
Help me install opnsense-admin using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).
Prefer to download?
Get the raw skill files in a ZIP archive.
What is OPNsense Admin?
The OPNsense Admin skill provides a comprehensive interface for managing OPNsense firewalls, including DNS, IDS/IPS, and general network configurations. It leverages both RESTful API integrations and SSH command execution to provide high-privilege control over your network infrastructure, making it a vital part of your Openclaw Skills library. Whether you are automating routine configuration backups or troubleshooting complex network issues, this skill streamlines the administrative lifecycle for OPNsense 26.1+ environments. By integrating with the firewall's internal systems, it allows for seamless rule management, service monitoring, and performance diagnostics.
OPNsense Admin Use Cases
- Automated configuration backups with custom retention periods to prevent data loss
- Real-time monitoring of Suricata IDS/IPS status and security alerts
- Managing Unbound DNS resolver settings, blocklists, and DNS over TLS
- Creating and modifying firewall rules, NAT settings, or network aliases
- Restarting or reloading critical network services like DHCP or DNS via remote command execution
How OPNsense Admin Works
- Authenticates with the OPNsense host using generated API keys or SSH credentials stored in environment variables or configuration files.
- Executes RESTful API requests to the OPNsense core or specific plugin endpoints (like IDS or Unbound) to retrieve or update configuration data.
- Processes system health, firmware status, and service states through specialized helper scripts for high-level visibility.
- Performs administrative tasks such as configuration exports, rule updates, or service restarts using the most efficient protocol (API or SSH).
- Returns structured feedback regarding the success of network operations and provides diagnostic data for troubleshooting.
OPNsense Admin Setup
To begin using this tool within Openclaw Skills, you must first generate API credentials in your OPNsense dashboard under System -> Access -> Users -> API. Then, configure your environment using one of the following methods:
Method A: Environment Variables
export OPNSENSE_HOST="192.168.1.1"
export OPNSENSE_KEY="your_api_key"
export OPNSENSE_SECRET="your_api_secret"
Method B: Credentials File (Recommended)
mkdir -p ~/.opnsense
cat > ~/.opnsense/credentials << EOF
OPNSENSE_HOST=192.168.1.1
OPNSENSE_PORT=443
OPNSENSE_KEY=your_api_key
OPNSENSE_SECRET=your_api_secret
EOF
chmod 600 ~/.opnsense/credentials
OPNsense Admin Data Schema & Taxonomy
The skill organizes management data through standardized OPNsense API structures and local file system exports. Use the following table to understand the data organization:
| Data Component | Format | Primary Source |
|---|---|---|
| Credentials | Environment/Plaintext | ~/.opnsense/credentials |
| Configuration Backups | XML / RRD | /api/core/backup/backup |
| Service Status | JSON | /api/core/system/status |
| DNS Statistics | JSON | /api/unbound/diagnostics/stats |
| Firewall Rules | PF Table Data | /api/diagnostics/firewall/ |
| Local Storage | Directory Path | Default: ./backups |
OPNsense Admin Advanced Features
- Support for scheduled, automated configuration backups including full RRD performance data
- Multi-method service control enabling the ability to Start, Stop, Restart, or Reload services like dhcpd and unbound
- Secure SSL/TLS certificate validation for production-grade API calls with an optional insecure mode for self-signed certificates
- Granular control over Suricata IDS/IPS modes allowing for safe monitoring before enabling active blocking
- Extensible API helper script for custom GET and POST requests to any available OPNsense plugin or core module
SKILL.md
Loading
Related Openclaw Skills
ntopng Network Monitor (Secure Edition)
A high-privilege network auditing tool that extracts real-time device and traffic data from ntopng via secure SSH tunnels.
Token Monitor
A lightweight monitoring utility that tracks OpenClaw provider quotas and sends alerts when token levels drop below a configurable threshold.
M365 Calendar for Microsoft Graph
A comprehensive automation skill for managing Microsoft 365 Business and Consumer calendars through the Microsoft Graph API.
Key Expiry Tracker
A metadata-only tracker that alerts you before your API keys, client secrets, and certificates expire to prevent unexpected service outages.
AI Trend Hunter Pro - Automated Content Agent
A high-performance automation agent that transforms global trends into viral social media posts for platforms like X, LinkedIn, and Xiaohongshu.
Trading Brain
A professional-grade trading strategy skill that equips AI agents with information scaling, risk management, and the Next Wave investment framework.
METADATA
Featured*
