Skip to main content
Network

Network Firewall (Appliance)

Monitor your perimeter firewall's reachability, firmware level, licences, and live measurements through REST API, local API, or SNMP across twelve vendor surfaces.

The Network Firewall (Appliance) check monitors a perimeter firewall — its reachability, firmware level, license / feature-key status, and security signals. It runs every 15 minutes on the octoja agent; the interval is not user-configurable. The agent platform (Windows, macOS, or Linux) is irrelevant — what matters is that the agent can reach the appliance or the vendor cloud.

octoja reaches the firewall through one of twelve vendor surfaces: Clavister NetWall (REST API), Check Point (SNMP), FortiGate (REST API), FortiGate (SNMP), OPNsense, pfSense (SNMP), Securepoint UTM (SNMP), Sophos XG / XGS (local), Sophos XG / XGS (SNMP), WatchGuard (REST), WatchGuard (SNMP), and SonicWall (SNMP). The fields visible in the UI depend on the selected vendor.

Which vendor surface?

VendorAPI surfaceAuthAgent placement
Clavister NetWall (REST API)cOS Core REST API over HTTPS (/api/about, /api/stats, /api/oper/license, /api/oper/ha; default port 443)HTTP Basic with username + passwordoctoja agent on a host that can reach the appliance's REST API port
Check Point (SNMP)SNMP v2c / v3 (default UDP port 161; CHECKPOINT-MIB + IF-MIB)v2c community string, or SNMPv3 user with auth + privacyoctoja agent on a host that can reach the gateway over SNMP
FortiGate (REST API)FortiOS REST API over HTTPS (default port 443)REST API token (Authorization: Bearer)octoja agent on a host that can reach the appliance's management port
FortiGate (SNMP)SNMP v2c / v3 (default UDP port 161; FORTINET-FORTIGATE-MIB + IF-MIB)v2c community string, or SNMPv3 user with auth + privacyoctoja agent on a host that can reach the appliance over SNMP
OPNsenseOPNsense REST (/api/core/firmware/*) over HTTPSHTTP Basic with API key + secretoctoja agent on a host that can reach the OPNsense management address
pfSense (SNMP)SNMP v2c (default UDP port 161; BEGEMOT-PF-MIB + HOST-RESOURCES-MIB + IF-MIB)v2c community stringoctoja agent on a host that can reach the appliance over SNMP
Securepoint UTM (SNMP)SNMP v2c / v3 (default UDP port 161; SECUREPOINT-MIB + UCD-SNMP-MIB + IF-MIB)v2c community string, or SNMPv3 user with auth + privacyoctoja agent on a host that can reach the appliance over SNMP
Sophos XG / XGS (local)Sophos XML API (/webconsole/APIController, HTTPS, default port 4444)Username + password in the XML request bodyoctoja agent on a host that can reach the appliance's API port
Sophos XG / XGS (SNMP)SNMP v2c / v3 (default UDP port 161; SOPHOS-XG-MIB + IF-MIB)v2c community string, or SNMPv3 user with auth + privacyoctoja agent on a host that can reach the appliance over SNMP
WatchGuard (REST)WatchGuard Cloud REST (/rest/platform/allocation/v2/*, /rest/threatsync/management/v1/*)OAuth2 client_credentials + WatchGuard-API-Key headeroctoja agent on any internet-connected device — the appliance does not need to be local; the target is the regional WatchGuard Cloud endpoint
WatchGuard (SNMP)SNMP v2c / v3 on the Firebox (default UDP port 161)v2c community string, or SNMPv3 user with auth + privacyoctoja agent on a host that can reach the appliance over SNMP
SonicWall (SNMP)SNMP v2c / v3 (default UDP port 161)v2c community string, or SNMPv3 user with auth + privacyoctoja agent on a host that can reach the appliance over SNMP

The REST and local-API surfaces track firmware and license status; the SNMP surfaces read live measurements. What each surface delivers:

  • Clavister NetWall (REST API) reads firmware, CPU, RAM, connection-table usage, license and subscription expiry, SECaaS status, and HA peer health through the local cOS Core REST API.
  • FortiGate (REST API) reports the installed firmware version and FortiGuard license expiry. FortiGate (SNMP) reads live measurements: CPU, memory, disk, sessions, VPN tunnels, HA cluster members, and interfaces.
  • WatchGuard (SNMP) delivers CPU, sessions, interfaces, and HA, plus feature-key expiry and firmware level.
  • SonicWall (SNMP) delivers CPU, RAM, sessions, interfaces, and VPN tunnels.
  • Sophos XG / XGS (SNMP) delivers RAM, disk, interfaces, and VPN tunnels.
  • Securepoint UTM (SNMP) delivers CPU, RAM, sessions, interfaces, VPN tunnels (IPsec, OpenVPN, and WireGuard), HA sync state, firmware level, and license expiry.
  • Check Point (SNMP) delivers CPU, RAM, disk, sessions, interfaces, VPN tunnels, HA, the gateway's overall status, and license expiry.
  • pfSense (SNMP) delivers CPU, RAM, root file system, packet-filter state, sessions, and interfaces.

For a FortiGate, pick the surface that matches what you want to watch: FortiGate (REST API) for firmware and FortiGuard license status, or FortiGate (SNMP) for live measurements. You can configure both checks against the same appliance if you want each set of signals. Sophos XG / XGS offers the same choice: Sophos XG / XGS (local) for firmware and gateway status over the XML API, or Sophos XG / XGS (SNMP) for live memory, disk, VPN, and interface measurements.

Prerequisites

  • A managed Clavister NetWall, OPNsense, pfSense, WatchGuard, Sophos XG / XGS, FortiGate, SonicWall, Securepoint UTM, or Check Point appliance
  • The octoja agent installed on a device that can reach the appliance (every surface except WatchGuard REST) or the WatchGuard Cloud (WatchGuard REST)
  • API credentials for the chosen vendor, or — for any SNMP surface — an SNMP community string or SNMPv3 user with read access (see the vendor sections below)
  • Alternatively, the firewall registered in octoja as a network device — then octoja supplies its IP to the check automatically

Steps

  1. Go to Devices and open the device where the octoja agent is installed — or open the firewall itself if it is registered as a network device.
  2. Click the Checks tab → Add Check → Network Firewall (Appliance).
  3. Pick a Vendor. The form rearranges to show the relevant fields.
  4. Fill in the vendor-specific fields (see below).
  5. Adjust License warning (days) if 30 days is not enough lead time for your renewal workflow (Clavister NetWall, WatchGuard, FortiGate, Securepoint UTM, and Check Point).
  6. Leave Verify TLS certificate off unless your appliance presents a certificate signed by a trusted CA — most perimeter firewalls do not. The field appears on the OPNsense, Sophos XG / XGS (local), and FortiGate (REST API) surfaces. Clavister NetWall has Verify Clavister TLS certificate instead, which is on by default.
  7. Click Add Check.

After the first check interval, the result appears in the device's Checks tab with online status, firmware level, license expiry (WatchGuard), open incidents (WatchGuard), and an issue list.

Adding the check on a network device. When the firewall itself is registered as a network device instead of running the octoja agent, the Host / IP field does not appear — octoja fills in the device's own IP each time the check runs, and the check runs from the agent picked as the device's Monitoring asset. The same applies to this check rolled out from a config package, so one package can cover every firewall in the group.

If you protect multiple appliances of the same vendor, configure one check per appliance. All the local-API and SNMP surfaces are appliance-local; only the WatchGuard (REST) surface is account-wide (one check covers every Firebox in the account).

Settings

Common fields apply across vendors; the rest are revealed when the matching vendor is selected.

Common

FieldTypeRequiredDefaultDescription
VendorselectYesOPNsenseSelects which appliance surface to probe. Drives which fields are shown. Options: Clavister NetWall (REST API), Check Point (SNMP), FortiGate (REST API), FortiGate (SNMP), OPNsense, pfSense (SNMP), Securepoint UTM (SNMP), Sophos XG / XGS (local), Sophos XG / XGS (SNMP), WatchGuard (REST), WatchGuard (SNMP), SonicWall (SNMP)
Verify TLS certificatebooleanNofalseValidate the appliance TLS certificate. Off by default because appliances typically present a self-signed certificate. Shown only for OPNsense, Sophos XG / XGS (local), and FortiGate (REST API). Clavister NetWall (REST API) has its own field

Clavister NetWall (REST API)

FieldTypeRequiredDefaultDescription
Host / IPstringYes—Hostname or IP of the appliance (no scheme)
REST API portnumberNo443HTTPS port of the cOS Core REST API
Verify Clavister TLS certificatebooleanNotrueValidate the REST API's TLS certificate. Unlike the other REST surfaces, on by default; turn it off only if the appliance presents a self-signed certificate
UsernamestringYes—User with REST API access (HTTP Basic)
PasswordpasswordYes—Password for the user
Target cOS Core versionstringNo—Set to evaluate up-to-date status against this version. Empty = skip the up-to-date dimension
Include HAbooleanNotrueQuery HA status. When HA is enabled and the peer is not alive, Critical is raised
CPU warning (%)numberNo85CPU usage at or above this raises a warning
CPU critical (%)numberNo95CPU usage at or above this raises Critical
RAM warning (%)numberNo85Memory usage at or above this raises a warning
RAM critical (%)numberNo95Memory usage at or above this raises Critical
Connection warning (%)numberNo80Connection-table usage (active versus available connections) at or above this raises a warning
Connection critical (%)numberNo95Connection-table usage at or above this raises Critical
License warning (days)numberNo30A license or subscription expiring within this many days raises a warning

OPNsense

FieldTypeRequiredDefaultDescription
Host / IPstringYes—Management hostname or IP of the appliance (no scheme), e.g. 192.168.1.1
API portnumberNo443HTTPS management / API port. The default matches a stock OPNsense install; OPNsense allows moving the GUI off 443
API keypasswordYes—API key from the OPNsense user that owns the credentials
API secretpasswordYes—API secret paired with the key

Where do I get an OPNsense API key/secret? octoja needs an API key and matching secret from an OPNsense user with read access to status and firmware information. Generate the key/secret pair in the OPNsense web UI and paste both into the fields above — see your firewall vendor's documentation for the exact steps.

WatchGuard (REST)

FieldTypeRequiredDefaultDescription
Region base URLstringNohttps://api.deu.cloud.watchguard.comBase URL from the WatchGuard Cloud Managed Access page. EU customers use https://api.deu.cloud.watchguard.com (default); US customers use the corresponding usa URL
WatchGuard API keypasswordYes—API key issued to your MSP account from Administration → Managed Access
Client ID (read-only access)stringYes—OAuth2 client ID from the same Managed Access page — request a read-only client
Client secretpasswordYes—OAuth2 client secret
Account IDstringYes—Account identifier that appears in WatchGuard Cloud API paths, e.g. WGC-1-XXXXXXXX or ACC-XXXXXXXX
Target Fireware versionstringNo—Set to evaluate up-to-date status. Empty = skip the up-to-date dimension (the WatchGuard Cloud API does not expose a reliable "latest" version)
License warning (days)numberNo30Feature-key / license expiring within this many days raises a warning

Sophos XG / XGS (local)

FieldTypeRequiredDefaultDescription
Host / IPstringYes—Hostname or IP of the appliance (no scheme)
API portnumberNo4444Sophos XML API port. The default matches the Sophos default. Sophos exposes a different port if you have moved the WebAdmin port
UsernamestringYes—Sophos admin user with API access. See your firewall vendor's documentation for enabling API access
PasswordpasswordYes—Password for the admin user
Target firmware versionstringNo—Compare against this version (e.g. 21.0.0 GA). Empty = skip the up-to-date dimension — the local Sophos XML API does not report the latest available version

FortiGate (REST API)

FieldTypeRequiredDefaultDescription
Host / IPstringYes—Hostname or IP of the appliance (no scheme)
Management portnumberNo443HTTPS management port. The default matches a stock FortiGate install; FortiGate admin access is frequently moved off 443
REST API tokenpasswordYes—Token of a read-only REST API administrator (System > Administrators), sent as Authorization: Bearer. See your firewall vendor's documentation for creating one
License warning (days)numberNo30Feature-key / license expiring within this many days raises a warning

FortiGate (SNMP)

Before you configure the check, enable SNMP on the appliance and create a v2c community string or an SNMPv3 user with read access — see your firewall vendor's documentation.

FieldTypeRequiredDefaultDescription
Host / IPstringYes—Hostname or IP of the appliance (no scheme)
SNMP versionselectNov2cSNMP protocol version. Options: v2c, v3
SNMP portnumberNo161UDP port the appliance listens on for SNMP
Community (v2c)stringNopublicRead community string. Shown when SNMP version is v2c
SNMPv3 userstringNo—SNMPv3 username. Shown when SNMP version is v3
Auth protocol (v3)selectNoSHA-1SNMPv3 authentication protocol. Options: None, SHA-1, SHA-256. Shown when SNMP version is v3
Auth password (v3)passwordNo—Authentication password. Shown when the auth protocol is not None
Privacy protocol (v3)selectNoAES-128SNMPv3 encryption protocol. Options: None, AES-128, AES-192, AES-256. Shown when the auth protocol is not None
Privacy password (v3)passwordNo—Privacy password. Shown when the privacy protocol is not None
CPU warning (%)numberNo85CPU usage at or above this raises a warning
CPU critical (%)numberNo95CPU usage at or above this raises Critical
RAM warning (%)numberNo85Memory usage at or above this raises a warning
RAM critical (%)numberNo95Memory usage at or above this raises Critical
Disk warning (%)numberNo85Disk usage at or above this raises a warning
Disk critical (%)numberNo95Disk usage at or above this raises Critical
Include interfaces (IF-MIB)booleanNotrueCollect interface status and in/out error counters
Interfaces that must be uparrayNo—Names selected from interfaces discovered on the last run. Any operationally down raises Critical. Shown when interfaces are included
Warn if any interface downbooleanNofalseWarn when any admin-up interface is operationally down. Shown when interfaces are included
Include VPN tunnelsbooleanNotrueCollect VPN tunnel status
VPN tunnels that must be uparrayNo—Names selected from tunnels discovered on the last run. Any down / missing raises Critical. Shown when VPN tunnels are included
Warn if any VPN tunnel downbooleanNofalseWarn when any discovered tunnel is down. Shown when VPN tunnels are included
Include HAbooleanNotrueCollect HA cluster member information
HA expected cluster members (0 = off)numberNo0Critical when fewer HA cluster members are visible than this value (failed peer). 0 disables the HA alarm. Shown when HA is included

VPN tunnel status is aggregated by tunnel name: a tunnel counts as up when any of its selectors is up.

WatchGuard (SNMP)

Enable SNMP on the Firebox and create a v2c community string or an SNMPv3 user with read access first — see your firewall vendor's documentation. RAM, disk, and VPN measurements are not collected on this surface.

FieldTypeRequiredDefaultDescription
Host / IPstringYes—Hostname or IP of the Firebox (no scheme)
SNMP version / port / credentialsgroupNov2c, 161Same SNMP connection fields as FortiGate (SNMP): version (v2c / v3), port, v2c community, and the SNMPv3 user / auth protocol / auth password / privacy protocol / privacy password
CPU warning (%)numberNo85CPU usage at or above this raises a warning
CPU critical (%)numberNo95CPU usage at or above this raises Critical
Include interfaces (IF-MIB)booleanNotrueCollect interface status and in/out error counters
Interfaces that must be uparrayNo—Names selected from interfaces discovered on the last run. Any operationally down raises Critical. Shown when interfaces are included
Warn if any interface downbooleanNofalseWarn when any admin-up interface is operationally down. Shown when interfaces are included
Include HAbooleanNotrueCollect HA cluster member information
HA expected cluster members (0 = off)numberNo0Critical when fewer HA cluster members are visible than this value (failed peer). 0 disables the HA alarm. Shown when HA is included
Target Fireware versionstringNo—Set to evaluate up-to-date status against this version. Empty = skip the up-to-date dimension
License warning (days)numberNo30A feature key expiring within this many days raises a warning

SonicWall (SNMP)

Enable SNMP on the appliance and create a v2c community string or an SNMPv3 user with read access first — see your firewall vendor's documentation. Disk and HA measurements are not collected on this surface.

FieldTypeRequiredDefaultDescription
Host / IPstringYes—Hostname or IP of the appliance (no scheme)
SNMP version / port / credentialsgroupNov2c, 161Same SNMP connection fields as FortiGate (SNMP): version (v2c / v3), port, v2c community, and the SNMPv3 user / auth protocol / auth password / privacy protocol / privacy password
CPU warning (%)numberNo85CPU usage at or above this raises a warning
CPU critical (%)numberNo95CPU usage at or above this raises Critical
RAM warning (%)numberNo85Memory usage at or above this raises a warning
RAM critical (%)numberNo95Memory usage at or above this raises Critical
Include interfaces (IF-MIB)booleanNotrueCollect interface status and in/out error counters
Interfaces that must be uparrayNo—Names selected from interfaces discovered on the last run. Any operationally down raises Critical. Shown when interfaces are included
Warn if any interface downbooleanNofalseWarn when any admin-up interface is operationally down. Shown when interfaces are included
Include VPN tunnelsbooleanNotrueCollect VPN tunnel status
VPN tunnels that must be uparrayNo—Names selected from tunnels discovered on the last run. Any missing raises Critical. Shown when VPN tunnels are included
Target SonicOS versionstringNo—Set to evaluate up-to-date status against this version. Empty = skip the up-to-date dimension

Sophos XG / XGS (SNMP)

Enable SNMP on the appliance and create a v2c community string or an SNMPv3 user with read access first — see your firewall vendor's documentation. The SOPHOS-XG-MIB exposes no CPU object, so CPU and HA measurements are not collected on this surface.

FieldTypeRequiredDefaultDescription
Host / IPstringYes—Hostname or IP of the appliance (no scheme)
SNMP version / port / credentialsgroupNov2c, 161Same SNMP connection fields as FortiGate (SNMP): version (v2c / v3), port, v2c community, and the SNMPv3 user / auth protocol / auth password / privacy protocol / privacy password
RAM warning (%)numberNo85Memory usage at or above this raises a warning
RAM critical (%)numberNo95Memory usage at or above this raises Critical
Disk warning (%)numberNo85Disk usage at or above this raises a warning
Disk critical (%)numberNo95Disk usage at or above this raises Critical
Include interfaces (IF-MIB)booleanNotrueCollect interface status and in/out error counters
Interfaces that must be uparrayNo—Names selected from interfaces discovered on the last run. Any operationally down raises Critical. Shown when interfaces are included
Warn if any interface downbooleanNofalseWarn when any admin-up interface is operationally down. Shown when interfaces are included
Include VPN tunnelsbooleanNotrueCollect IPsec VPN connection status. A connection counts as up only when it is fully active — partially active means some of its tunnels are down
VPN tunnels that must be uparrayNo—Names selected from tunnels discovered on the last run. Any down / missing raises Critical. Shown when VPN tunnels are included
Warn if any VPN tunnel downbooleanNofalseWarn when any discovered tunnel is down. Shown when VPN tunnels are included
Target firmware versionstringNo—Compare against this version (e.g. 21.0.0 GA). Empty = skip the up-to-date dimension — the appliance does not report the latest available version. Shared with the local Sophos surface

pfSense (SNMP)

The pfSense surface uses SNMP v2c only — the SNMP version and SNMPv3 fields are not shown. First enable the SNMP service on the pfSense with the MIB II, Host Resources, and PF modules.

FieldTypeRequiredDefaultDescription
Host / IPstringYes—Hostname or IP of the appliance (no scheme)
SNMP portnumberNo161UDP port for SNMP
Community (v2c)stringNopublicRead community string
CPU warning (%)numberNo85CPU usage at or above this raises a warning
CPU critical (%)numberNo95CPU usage at or above this raises Critical
RAM warning (%)numberNo85Memory usage at or above this raises a warning
RAM critical (%)numberNo95Memory usage at or above this raises Critical
Disk warning (%)numberNo85Root file system usage at or above this raises a warning
Disk critical (%)numberNo95Root file system usage at or above this raises Critical
Include interfaces (IF-MIB)booleanNotrueCollect interface status and in/out error counters
Interfaces that must be uparrayNo—Names selected from interfaces discovered on the last run. Any operationally down raises Critical. Shown when interfaces are included
Warn if any interface downbooleanNofalseWarn when any admin-up interface is operationally down. Shown when interfaces are included

Securepoint UTM (SNMP)

Enable SNMP on the appliance and create a v2c community string or an SNMPv3 user with read access first — see your firewall vendor's documentation. Disk measurements are not collected on this surface. The appliance reports its firmware level and remaining license days itself, so no target version is configured.

FieldTypeRequiredDefaultDescription
Host / IPstringYes—Hostname or IP of the appliance (no scheme)
SNMP version / port / credentialsgroupNov2c, 161Same SNMP connection fields as FortiGate (SNMP): version (v2c / v3), port, v2c community, and the SNMPv3 user / auth protocol / auth password / privacy protocol / privacy password
CPU warning (%)numberNo85CPU usage at or above this raises a warning
CPU critical (%)numberNo95CPU usage at or above this raises Critical
RAM warning (%)numberNo85Memory usage at or above this raises a warning
RAM critical (%)numberNo95Memory usage at or above this raises Critical
Include interfaces (IF-MIB)booleanNotrueCollect interface status and in/out error counters
Interfaces that must be uparrayNo—Names selected from interfaces discovered on the last run. Any operationally down raises Critical. Shown when interfaces are included
Warn if any interface downbooleanNofalseWarn when any admin-up interface is operationally down. Shown when interfaces are included
Include VPN tunnelsbooleanNotrueCollect VPN tunnel status across IPsec, OpenVPN, and WireGuard
VPN tunnels that must be uparrayNo—Names selected from tunnels discovered on the last run. Any down / missing raises Critical. Shown when VPN tunnels are included
Warn if any VPN tunnel downbooleanNofalseWarn when any discovered tunnel is down. Shown when VPN tunnels are included
Include HAbooleanNotrueCollect cluster state and sync status. A cluster that is not synchronized raises a warning, a reported sync error raises Critical
License warning (days)numberNo30A license expiring within this many days raises a warning

Check Point (SNMP)

Enable SNMP on the gateway and create a v2c community string or an SNMPv3 user with read access first — see your firewall vendor's documentation.

FieldTypeRequiredDefaultDescription
Host / IPstringYes—Hostname or IP of the gateway (no scheme)
SNMP version / port / credentialsgroupNov2c, 161Same SNMP connection fields as FortiGate (SNMP): version (v2c / v3), port, v2c community, and the SNMPv3 user / auth protocol / auth password / privacy protocol / privacy password
CPU warning (%)numberNo85CPU usage at or above this raises a warning
CPU critical (%)numberNo95CPU usage at or above this raises Critical
RAM warning (%)numberNo85Memory usage at or above this raises a warning
RAM critical (%)numberNo95Memory usage at or above this raises Critical
Disk warning (%)numberNo85Disk usage at or above this raises a warning
Disk critical (%)numberNo95Disk usage at or above this raises Critical
Include interfaces (IF-MIB)booleanNotrueCollect interface status and in/out error counters
Interfaces that must be uparrayNo—Names selected from interfaces discovered on the last run. Any operationally down raises Critical. Shown when interfaces are included
Warn if any interface downbooleanNofalseWarn when any admin-up interface is operationally down. Shown when interfaces are included
Include VPN tunnelsbooleanNotrueCollect VPN tunnel status, grouped by peer
VPN tunnels that must be uparrayNo—Names selected from tunnels discovered on the last run. Any down / missing raises Critical. Shown when VPN tunnels are included
Warn if any VPN tunnel downbooleanNofalseWarn when any discovered tunnel is down. Shown when VPN tunnels are included
Include HAbooleanNotrueCollect ClusterXL state. A non-zero HA status raises a warning, a state of down raises Critical
Target Gaia versionstringNo—Set to evaluate up-to-date status against this version (e.g. R81.20). Empty = skip the up-to-date dimension
License warning (days)numberNo30An active license blade expiring within this many days raises a warning

Field behaviour

  • The Interfaces that must be up and VPN tunnels that must be up pickers populate from what the previous SNMP run discovered. Run the check once, then come back to select the names you want to require.
  • SNMP and Clavister thresholds are normalised so that the warning value is never higher than the critical value — if entered the wrong way round, octoja swaps them.
  • Version comparison ignores letter case and matches on whole version components: the running version counts as up to date when it equals the target or extends it at a component boundary. 12.7.1 meets a target of 12.7, and 21.0.0 GA meets 21.0.0, while 20.0.2 does not meet a target of 2. Set Target firmware version to a shorter prefix to let patch revisions through.
  • The SNMP interface collection skips software loopback interfaces. A required interface that is admin-up but operationally down is reported as down.

Results

Issue codes

The check reports a list of issue rows; the worst severity becomes the overall result. When all dimensions are clean, the result is OK.

CodeVendorSeverityMeaning
offlineAllCriticalAppliance unreachable, or one Firebox in the account is disconnected
outdatedClavister*, OPNsense, Sophos*, WatchGuard*, SonicWall (SNMP)*, Securepoint UTM (SNMP), Check Point (SNMP)*WarningCurrent firmware does not match latest / target. Detail = current → target
pending-updatesOPNsenseWarningUp-to-date but the upgrade mirror has pending package updates. Detail = count
needs-rebootOPNsenseWarningOPNsense flagged a pending reboot
update-check-unavailableOPNsenseWarningUpgrade mirror unreachable; up-to-date verdict above is unreliable. Detail = connection status
gateway-downSophosWarningSophos device-info gateway status is not True. Detail = reported status
no-devicesWatchGuardWarningWatchGuard Cloud inventory returned no Fireboxes for the account
license-expiredClavister, WatchGuard, Securepoint UTM (SNMP), Check Point (SNMP)CriticalSoonest feature-key / subscription expiry is in the past. Detail = days past expiry (Clavister: license name)
license-expiringClavister, WatchGuard, FortiGate (REST API), Securepoint UTM (SNMP), Check Point (SNMP)WarningSoonest feature-key / subscription expiry is within the warning window. Detail = days remaining (Clavister: license name and days remaining)
open-incidentsWatchGuardCriticalThreatSync reports open threat incidents. Detail = count
cpu-highClavister and all SNMP surfaces except Sophos XG / XGS (SNMP)Warning / CriticalCPU usage reached the warning or critical threshold. Detail = value% / threshold%
ram-highClavister and all SNMP surfaces except WatchGuard (SNMP)Warning / CriticalMemory usage reached the warning or critical threshold. Detail = value% / threshold%
disk-highFortiGate (SNMP), pfSense (SNMP), Sophos XG / XGS (SNMP), Check Point (SNMP)Warning / CriticalDisk usage reached the warning or critical threshold. Detail = value% / threshold%
vpn-required-downFortiGate (SNMP), Sophos XG / XGS (SNMP), Securepoint UTM (SNMP), Check Point (SNMP)CriticalA tunnel listed in VPN tunnels that must be up is down. Detail = tunnel name
vpn-required-missingFortiGate (SNMP), SonicWall (SNMP), Sophos XG / XGS (SNMP), Securepoint UTM (SNMP), Check Point (SNMP)CriticalA tunnel listed in VPN tunnels that must be up was not found. Detail = tunnel name
vpn-any-downFortiGate (SNMP), Sophos XG / XGS (SNMP), Securepoint UTM (SNMP), Check Point (SNMP)WarningOne or more discovered tunnels are down (when Warn if any VPN tunnel down is on). Detail = tunnel names
if-required-downAll SNMP surfacesCriticalAn interface listed in Interfaces that must be up is operationally down. Detail = interface name
if-required-missingAll SNMP surfacesCriticalAn interface listed in Interfaces that must be up was not found. Detail = interface name
if-any-downAll SNMP surfacesWarningOne or more admin-up interfaces are operationally down (when Warn if any interface down is on). Detail = interface names
ha-degradedClavister, FortiGate (SNMP), WatchGuard (SNMP), Securepoint UTM (SNMP), Check Point (SNMP)Warning / CriticalFewer HA cluster members are visible than the expected count (FortiGate, WatchGuard — Critical, detail = visible/expected), the HA peer is not alive (Clavister — Critical), or the cluster reports a degraded sync / HA state (Securepoint UTM, Check Point — Critical on an error or down state, otherwise Warning; detail = the reported state)
health-not-okCheck Point (SNMP)WarningThe gateway reports a non-zero system status. Detail = the reported status text
health-not-okClavisterWarning / CriticalConnection-table usage reached the warning or critical threshold; SECaaS is not running normally (Critical); statistics or HA status unavailable (Warning); the REST API returns an HTTP error (Critical from 500, otherwise Warning)
packet-filter-disabledpfSense (SNMP)CriticalThe pfSense packet filter is not running
pf-status-unavailablepfSense (SNMP)WarningThe packet-filter state could not be read over SNMP, for example because the PF module is not enabled
firmware-unknownClavister, Sophos, WatchGuard, SonicWall (SNMP), Check Point (SNMP)WarningA target version is configured but the current firmware version could not be read. Detail = the configured target

*Clavister, Sophos, WatchGuard, SonicWall (SNMP) and Check Point (SNMP) outdated only fires when the matching target version is configured. OPNsense and Securepoint UTM (SNMP) need no target version — the appliance itself reports the available upgrade. FortiGate (REST API) reports the installed firmware version only, so the up-to-date dimension does not apply to that surface, nor to pfSense (SNMP).

OPNsense and Sophos feature-key / license expiry is currently not surfaced. The license dimension applies to Clavister, WatchGuard, FortiGate (REST API), Securepoint UTM (SNMP) and Check Point (SNMP).

Error codes

When the check itself cannot run (incomplete configuration, authentication failure, unreachable API), it reports a Failure result with one of the following error codes instead of issue rows. The check detail view shows the matching message.

CodeMeaning
invalid-vendorUnknown or unconfigured vendor
check-failedUnexpected error while running the check
clavister-config-requiredClavister requires host, username and password
clavister-config-invalidClavister connection thresholds must be between 0 and 100
clavister-auth-failedClavister authentication failed (check username/password)
opnsense-config-requiredOPNsense requires host, API key and API secret
opnsense-auth-failedOPNsense authentication failed (check API key/secret)
sophos-config-requiredSophos requires host, username and password
sophos-auth-failedSophos authentication failed (check username/password)
sophos-unparseableSophos returned an unparseable response
sophos-no-deviceinfoSophos response did not contain DeviceInfo (API user may lack access)
watchguard-config-requiredWatchGuard requires base URL, API key, client ID/secret and account ID
watchguard-token-failedWatchGuard token request failed
watchguard-no-access-tokenWatchGuard token response did not contain an access token
watchguard-unreachableWatchGuard Cloud unreachable
watchguard-auth-failedWatchGuard authorization failed (check API key / account ID)
watchguard-listing-failedWatchGuard device listing failed
fortigate-config-requiredFortiGate requires host and a REST API token
fortigate-auth-failedFortiGate authentication failed (check API token)
fortigate-snmp-config-requiredFortiGate (SNMP) requires a host
watchguard-snmp-config-requiredWatchGuard (SNMP) requires a host
sonicwall-snmp-config-requiredSonicWall (SNMP) requires a host
sophos-snmp-config-requiredSophos (SNMP) requires a host
securepoint-snmp-config-requiredSecurepoint (SNMP) requires a host
checkpoint-snmp-config-requiredCheck Point (SNMP) requires a host
pfsense-snmp-config-requiredpfSense (SNMP) requires a host

Metrics collected

  • vendor — the vendor string echoed back for the renderer
  • online — appliance is reachable / at least one Firebox is connected
  • firmwareCurrent — currently installed firmware version (best-effort across vendor JSON shapes)
  • firmwareLatest — latest version reported by OPNsense or Securepoint UTM, or the configured target string for Clavister, Sophos, WatchGuard, SonicWall and Check Point
  • upToDate — true / false / null (null when the up-to-date dimension was not evaluated)
  • licenseExpiresAt — soonest feature-key / subscription expiry (Clavister, WatchGuard, FortiGate (REST API), Securepoint UTM and Check Point), ISO-8601
  • openAlerts — ThreatSync open-incident count when available (WatchGuard only)
  • issues — list of {severity, code, detail} entries that contributed to the result

The SNMP surfaces and Clavister additionally return the live measurements below; which of them are populated depends on what the vendor MIB or API exposes.

  • sysName / model / osVersion / uptimeDays — appliance identity and uptime
  • cpuPercent / memPercent / diskPercent — CPU, memory, and disk usage in percent
  • memTotalMB / diskTotalMB — total memory and disk capacity
  • sessionCount — active session count
  • sessionLimit / sessionPercent — connection-table size and usage (Clavister only)
  • vpnTunnels plus vpnTunnelsTotal / vpnTunnelsUp / vpnTunnelsDown — per-tunnel status and totals
  • haMode / haGroup / haNodes / haNodeCount — HA mode, group, and per-node CPU / memory
  • interfaces plus ifTotal / ifUp / ifDown and ifInErrors / ifOutErrors — interface status and aggregate error counters

Notes

  • HTTP timeout per API call is 30 seconds.
  • Use a dedicated read-only API user where the vendor allows it. The OPNsense and Sophos APIs accept credentials with browse-only permissions for status and firmware queries.
  • The OPNsense flow triggers a fresh firmware-check before reading status, then waits 4 seconds — the OPNsense API serves a cached status until a check is explicitly triggered.
  • For WatchGuard, the ThreatSync incident check is best-effort — accounts without a ThreatSync subscription return a non-success code and octoja silently skips that dimension.
  • The WatchGuard parser is tolerant of field-name variations across tenants: connectionStatus / status, fireboxVersion / osVersion, featureKeyExpiration / expirationDate, and so on.
  • The Sophos XML API requires the credentials in the request body, not headers — octoja escapes user input via the XML serializer before posting.