SonicWall

UTMStack v12 collects SonicWall firewall logs through the UTMStack Forwarder, which the web interface calls the Collector. You enable the SonicWall integration on a Collector, then add the Collector as a syslog server in SonicOS. Nothing is installed on the firewall.

Connection details

SettingValue
Card on the Integrations pageSonic Wall (category Firewall)
Data typefirewall-sonicwall
Default ports on the Collector7009/UDP; 7009/TCP (also used for TLS)
Log format UTMStack readsSonicOS CEF (the ArcSight format, which the product recommends) and SonicOS key=value syslog (id=firewall sn=… msg="…")
Parsing pipelinesonicwall/sonic_wall.yaml, version 4.2.0. Filters in the card's drawer opens it.
Detection rules7. Rules in the card's drawer opens them.

Before you begin

  • A Collector must be installed and online. If you do not have one, see UTMStack Forwarder. One Collector can serve all your integrations.

  • The firewall must reach the Collector host on the port you use. Open it on the Collector host and on any firewall in between.

  • You need the integrations.write permission to enable the integration from the web interface.

Step 1: Enable the integration on a Collector

  1. 1

    Open the integration

    In UTMStack, go to Configure > Integrations and open the Sonic Wall card.

    SonicWall setup guide in UTMStack, showing How it works and the Enable this integration remotely panel with the Collector, Protocol and Port fields

    A different number typed in Port does not change the port the Collector listens on; see Use a different port below.

  2. 2

    Choose the Collector and protocol

    Under Enable this integration remotely, select the Collector and the Protocol (UDP, TCP or TLS). Use UDP unless your SonicOS version can send syslog over TCP. Leave Port at the default it fills in.

  3. 3

    Enable it

    Click Enable integration. The panel then shows, for example, Currently: enabled · udp · port 7009.

To do the same on the Collector host instead, run:

sudo /opt/utmstack-forwarder/utmstack_forwarder enable-integration firewall-sonicwall udp

The command prints the port the Collector really listens on, for example Integration "firewall-sonicwall" enabled on udp port 7009.

To use TLS, load a certificate on the Collector first. See UTMStack Forwarder.

Use a different port

For built-in integrations, the Collector always listens on the port saved on the Collector host. That is the default port unless you change it there. A different number typed in Port, or on the enable-integration command line, is not used. To use another port:

  1. On the Collector host, change the saved port, for example:

    sudo /opt/utmstack-forwarder/utmstack_forwarder change-port firewall-sonicwall udp 7109

    Use tcp instead of udp for TCP and TLS.

  2. In the Sonic Wall card, type the same port in Port when you enable the integration. If it is already enabled, click Disable integration first, then enable it again with the new port. The panel shows the port you type there, not a value read from the Collector, so typing the same port keeps the two in step.

  3. Use the new port in the syslog server entry in step 2.

Step 2: Add a syslog server in SonicOS

  1. 1

    Open the syslog settings

    In SonicOS, go to Device > Log > Syslog (Manage > Log > Syslog on older firmware).

  2. 2

    Add the Collector

    Add a Syslog Server with the address of the Collector host and port 7009.

  3. 3

    Choose the CEF format

    Set the Syslog Format to ArcSight (CEF), then click Apply. UTMStack parses SonicWall in CEF.

The setup guide in UTMStack fills in your UTMStack server's address in this step. Keep it only if the Collector runs on the UTMStack server; otherwise use the address of the Collector host.

The UTMStack pipeline also reads SonicOS's key=value syslog (id=firewall sn=… msg="…"), so logs sent in the default format still parse. CEF is the format the product recommends.

Step 3: Check that logs arrive

  1. 1

    Open the logs

    In the Sonic Wall drawer, click View logs. Log Explorer opens with the firewall-sonicwall data type for the last 24 hours. You can also open Log Explorer, keep the data set logs and choose firewall-sonicwall as the data type.

  2. 2

    Check the parsed fields

    Expand an event. Parsed events have standard fields such as origin.ip, target.ip, target.port and action, and SonicWall fields under log.. The event should have no errors.

  3. 3

    Check the data source

    Within about 20 minutes, the firewall appears on the Data Sources page under Direct, named after the address its logs come from.

To list the latest events and any processing errors, switch Log Explorer to SQL mode and run:

SELECT `@timestamp`, dataSource, errors, raw
FROM logs
WHERE dataType = 'firewall-sonicwall'
  AND `@timestamp` > now() - INTERVAL 1 HOUR
ORDER BY `@timestamp` DESC
LIMIT 20

Troubleshooting

SymptomLikely causeWhat to do
Nothing arrivesThe Collector is offline, or the firewall sends to the wrong address, port or protocol, or a firewall blocks the port.Check that the Collector shows as online in the Collector list, that the syslog server entry matches, and that the Collector host allows the port in. See Forwarder Troubleshooting.
Nothing arrives, and the Forwarder guide filled in the UTMStack server's addressThe firewall sends to the UTMStack server, but the Collector runs on another host.Use the Collector host's address in the syslog server entry.
Only some events arriveThe log event profile or the logging level filters events out.Check the log settings in SonicOS and raise the logging level or enable the event categories you need.
Events arrive but have almost no fieldsThe firewall sends a format the pipeline does not read.Set the Syslog Format to ArcSight (CEF).
Long messages are cut offOver UDP, the Collector reads at most 2,048 bytes of each message.Send over TCP if your SonicOS version supports it.
SonicWall logs appear under another data typeThe firewall sends to the port of a different integration.Send to the port that the SonicWall integration listens on.

Stop collecting

In the Sonic Wall card, select the same Collector and click Disable integration, or run on the Collector host, with the protocol you enabled (udp, tcp or tls):

sudo /opt/utmstack-forwarder/utmstack_forwarder disable-integration firewall-sonicwall udp

Then remove the syslog server entry in SonicOS.