Opnsense-Helper

The backend api for opnsense

• create, assign and enable lan / phy interfaces and all the other stuff that is *Not enabled* in the opnsense api

• use the config_manager to apply all your configs in runtime at once

• uses the opnsense backend via shh

• configctl and pluginctl commands

• around 80 opnsense scripts you can call

• automatically configures your Vlan and Phy Interfaces after applying configuration

About:

• about opnsense-helper
• install
  • pip
• usage
  • required variables
  • config_manager
  • scripts and commands
  • Frontend Api
  • contribute
• motivation

Python API-Dokumentation

• Opnsense-Helper
  • Opnsense_Helper
• coonfig_manager
• commands
  • Commands
  • configctl
  • pluginctl
  • reconfigure
• scripts
  • Scripts
  • Wireguard
  • auth
  • dhcp
  • dns
  • filter
  • firmware
  • health
  • interfaces
  • ipsec
  • netflow
  • openssh
  • openvpn
  • routes
  • shaper
  • shell
  • suricata
  • syslog
  • system
  • unbound

opnsense-scripts-autodocs

• auth
  • script add_user.php
  • script list_group_members.php
• dhcp
  • script cleanup_leases4.php
  • script cleanup_leases6.php
  • script dnsmasq_watcher.py
  • script get_kea_leases.py
  • script prefixes.sh
  • script prefixes.sh
• dns
  • script query_dns.py
• filter
  • script kill_states.py
  • script list_states.py
  • script rollback_cancle.php
  • script rollback_timer.php
  • script update_bogons.sh
• firmware
  • script changelog.sh
  • script env_init.sh
  • script connection.sh
  • script details.sh
  • script health.sh
  • script hostnames.sh
  • script install.sh
  • script latest.php
  • script firmware_runner.sh
  • script license.sh
  • script lock.sh
  • script plugin.sh
  • script product.php
  • script query.sh
  • script read.sh
  • script reboot.sh
  • script register.php
  • script reinstall.sh
  • script remove.sh
  • script resync.sh
  • script running.sh
  • script security.sh
  • script sync.sh
  • script unlock.sh
  • script update.sh
  • script upgrade.sh
• repos
  • script FreeBSD.php
  • script OPNsense.php
• health
  • script updaterrd.php
• definitions
• interfaces
  • script carp_global_status.php
  • script carp_set_status.php
  • script ifctl.sh
  • script reconfigure_gifs.php
  • script reconfigure_gres.php
  • script reconfigure_laggs.php
  • script reconfigure_neighbors.php
  • script reconfigure_vips.php
  • script reconfigure_vlans.php
  • script rtsold_resolvconf.sh
  • script traffic_stats.php
• ipsec
  • script get_legacy_vti.php
• netflow
  • script flush_all.sh
• openssh
• openvpn
  • script client_connect.php
  • script client_disconnect.sh
  • script ovpn_service_control.php
  • script tls_verify.php
  • script user_pass_verify.php
• routes
  • script del_route.py
  • script gateway_status.php
  • script gateway_watcher.php
  • script gateways.php
• shaper
• shell
  • script banner.php
  • script defaults.php
  • script firmware.sh
  • script halt.php
  • script password.php
  • script ping.php
  • script netboot.php
  • script restore.sh
  • script script setaddr.php
  • script setports.php
• suricata
  • script listRuleMetadata.py
  • script suricata_setup.sh
• syslog
  • script clearlog.php
  • script list_applications.php
  • script queryLog.py
  • script streamLog.py
• system
  • script cpu.py
  • script nameservers.php
  • script remote_backup.php
  • script ssl_ciphers.py
  • script status.php
  • script sysctl.py
  • script temperature.sh
• unbound
  • script cache.sh
  • script logger.py
  • script restore_db.py
  • script start.sh
  • script stats.py
  • script wrapper.py
• Wireguard