Skip to Content
  •  +49 (861) 88 00 32 00
COD powered by extocode GmbH
  • 0
  • Sign in
  • English (US) Français Deutsch Español Türkçe
  • Open the demo
  • Home
  • COD Overview
    Platform
    OverviewPlatform: tenants and brandFeaturesProblems & SolutionsArchitectureDocumentationIntegrationsPricing
    Operations & Network
    MonitoringNetworkNetwork Access Control (NAC)TACACS+Captive PortalFirewall
    Security & Resilience
    Governance, Risk & ComplianceBackupHypervisorOTPPasskeeprAutomation
    Solutions & More
    NIS2 & CompliancecodPassAI documentation (InfraScan add-on)Open the demoReferencesDownloadsFAQ
  • Pricing
  • News
    • Blog
    • Roadmap
  • FAQ
  • About us
    • About us
    • Careers
    • Partners
    • References
  • Academy
  • Contact
COD powered by extocode GmbH
  • 0
    • Home
    • COD Overview
    • Pricing
    • News
      • Blog
      • Roadmap
    • FAQ
    • About us
      • About us
      • Careers
      • Partners
      • References
    • Academy
    • Contact
  •  +49 (861) 88 00 32 00
  • English (US) Français Deutsch Español Türkçe
  • Sign in
  • Open the demo
  1. Home
  2. Documentation
  3. Modules
  4. Firewall

Firewall

This page describes how COD connects firewalls, which rights and settings are needed and where the limits are.

What the module does is described on the module page.

As of: November 2026, COD 3.8.6

Documentation contents
  • Overview
  • Getting started
  • Requirements
  • Names and addresses
  • Network devices
  • Time and DNS
  • Installation
  • Deployment shapes
  • Initial setup
  • Updates
  • Modules
  • Network and MikroTik
  • Automation
  • NAC
  • TACACS+
  • Firewall
  • Captive Portal
  • Monitoring
  • Backup
  • Hypervisor
  • OTP
  • Passkeepr
  • GRC
  • Inventory and CMDB import
  • Troubleshooting
  • Security
  • Versions
  • Version history
  • Support

Documentation

  • Overview
  • Getting started
  • Requirements
  • Names and addresses
  • Network devices
  • Time and DNS
  • Installation
  • Deployment shapes
  • Initial setup
  • Updates
  • Modules
  • Network and MikroTik
  • Automation
  • NAC
  • TACACS+
  • Firewall
  • Captive Portal
  • Monitoring
  • Backup
  • Hypervisor
  • OTP
  • Passkeepr
  • GRC
  • Inventory and CMDB import
  • Troubleshooting
  • Security
  • Versions
  • Version history
  • Support

Overview

ItemValue
PurposeFirmware level and updates, live state, reachability, VPN overview (WireGuard, IPsec, OpenVPN), aliases and zones, certificates, rules (experimental), self-registration
VendorsAIMdefense, OPNsense, pfSense, DynFi
Connections and directionCOD server to firewall: HTTPS API and SSH. ICMP and TCP for reachability. For self-registration, once from firewall to COD
CredentialsAPI key and API secret, SSH user and password, SSH port, optionally the firewall’s CA certificate
Assetbuilt-in asset type “Firewall”
Firewall rulesCustomers and partners receive the list of connections and firewall rules as part of the project.

Functions per vendor

FunctionAIMdefenseOPNsensepfSenseDynFi
Status, firmware, aliases, VPN overviewyesyesclarify in the projectclarify in the project
Certificate table, object migration, alias importyesyesnono
Self-registration with the pluginnoyesnono
Captive portalnoyesnono

Requirements

On the firewall

RequirementWhy
API access with API key and API secretStatus, firmware, aliases, VPN, certificates
API user with administrator rights (recommended)With restricted rights, the user needs at least the OPNsense privileges “Interfaces: Virtual IPs: Status” and “System: High Availability” to show clusters in the layer 3 map. You receive the minimum rights as part of the project.
SSH with a dedicated user for CODRules, configuration, terminal
API and SSH access restricted to the source address of the COD serverAll queries come from the COD server
Reachable via ICMP and TCP from the COD serverReachability check

In COD

  • Firewall module enabled for the tenant.
  • Built-in asset type “Firewall” in the asset catalogue. Do not change its name.
  • Asset activated, vendor set.
  • Mail setting of the location, so that outage messages arrive.
  • If the firewall uses a certificate from its own CA: the CA certificate stored in COD.

Setup

Adding a firewall by hand

  1. On the firewall, create the API user and the SSH user for COD.
  2. In COD, create the asset with the type “Firewall” and the vendor. Activate it.
  3. Enter address, API key, API secret, SSH user, password and SSH port. If the firewall uses its own CA, store the CA certificate.
  4. Check status and firmware level in the module overview.

Self-registration with the OPNsense plugin

An OPNsense firewall can register itself with COD through the COD plugin. Agree with your partner on how to obtain the plugin.

  1. Enter the COD address in the plugin.
  2. Log in in the plugin with a COD user, its password and the one-time code.
  3. Choose the location.
  4. Choose the local OPNsense user for whom the plugin creates an API key.
  5. The plugin sends management address, port and key to COD once.
  6. The firewall appears in COD under “Firewall > Pending”. Accept the entry.

Note: “Reject” under “Firewall > Pending” deletes the asset. Reject only if the asset should be removed.

Reachability check

  1. Set the check schedule per location (cron, default every minute).
  2. Enter the recipients of outage messages.
  3. Check that the location’s mail setting works.

The check uses ICMP and a TCP connection to the firewall’s API port. Throttling per firewall prevents repeated mails about the same problem.

Technical details

ItemValue
ConnectionHTTPS API of the firewall. SSH for rules, configuration and terminal
ReachabilityICMP and TCP from the COD server, schedule per location, mail with throttling per firewall
VPNWireGuard, OpenVPN and IPsec across all locations in tables and a topology view
Aliases and zonescentral maintenance of aliases (IPs, networks, ports). Zones distribute new aliases to all firewalls in the zone. A reference check prevents deleting objects still in use
Layer 3 mapFirewalls appear as nodes, CARP pairs as a box
TerminalSSH session in the browser, opened by the COD server
AssetThe “References” tab shows the firewall entry, Zabbix host, voucher configuration and tasks

How quickly COD reports an outage

That depends on the schedule you set per location. COD actively reports the reachability of the firewall by mail. You see the state of VPN tunnels in the tables and the topology view. Alerts from your monitoring come from Zabbix. See Monitoring.

Configuration backup

The Firewall module does not back up configurations. The Backup module does that. If you pick a firewall from the inventory there, COD fills in the address and credentials once.

Known limits

LimitWhat you can do
The rule editor is experimental. It works over SSH, and a mistake when applying can take a firewall offlineMaintain rules in the firewall’s own interface. Use aliases and zones in COD
The update buttons do not ask for confirmationClick them only in a maintenance window and after a current backup
“Reject” under “Firewall > Pending” deletes the assetReject only if the asset should be removed
There is no outage message for VPN tunnelsMonitor tunnels in Zabbix
The built-in asset type “Firewall” must not be renamedKeep the name in the asset catalogue
Self-registration and captive portal only for OPNsenseAdd other firewalls by hand
Certificate table, object migration and alias import only for AIMdefense and OPNsenseMaintain these items for pfSense and DynFi in the firewall itself
Scope of functions for pfSense and DynFiThe scope for your firewalls is clarified in the project.
Minimum rights of the API userYou receive the minimum rights as part of the project.

Further reading

  • Firewall module page
  • Captive Portal
  • What your network needs for Firewall and Captive Portal
  • Network and MikroTik: layer 3 map
  • Troubleshooting
  • Questions about the modules
  • Support: your partner is your first point of contact. Technical questions to extocode go through the helpdesk form.
← Previous: TACACS+Next: Captive Portal →
Folgen Sie uns
​
  • COD Overview
  • Features
  • Demo
  • Pricing
  • Integrations
  • NIS2
  • codPass
  • References

Help

  • FAQ
  • Documentation
  • Downloads
  • Contact

Kotzinger Straße 21 • 83278 Traunstein • Deutschland

  • ​+49 (861) 88 00 32 00
  • ​info@extocode.com
Datenschutz Impressum ​
Copyright © extocode GmbH
English (US) Français Deutsch Español Türkçe

We use cookies to provide you a better user experience on this website. Privacy Policy

Decline Accept