GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • v10.9.4
  • v11.3.0
  • 12.xLatest
  • Support
  • Online Demo
  • Agent
  • SIEM
  • API Documentation
  • campaignSOAR
  • Rules
  • AI
  • Upgrade
  • Integrations
  • How Data Reaches UTMStack

This view

  • Original page
  • New address

GeezerVison is showing docs.utmstack.com — How Data Reaches UTMStack | Documentation

Getting Started›How Data Reaches UTMStack
UTMSTACK logoUTMSTACK logo
12.x
  • v10.9.4
  • v11.3.0
  • 12.x
Integrations
  • Agent
  • SIEM
  • API Documentation
  • SOAR
  • Rules
  • AI
  • Upgrade
  • Integrations

How Data Reaches UTMStack

UTMStack v12 receives logs in four ways: agents on your hosts, the UTMStack Forwarder for network devices and appliances, plugins that pull from cloud services, and two dedicated collectors. This page explains each one and how to use the Integrations page to set them up.

The four ways in

Way inWhat it isUsed forBadge on the card
AgentA service you install on each Windows, Linux or macOS host. It reads the host's own logs and sends them to UTMStack.Windows, Linux and macOS hostsAgent
UTMStack ForwarderA Linux service that listens for logs sent by other systems (syslog, NetFlow, HTTPS webhooks) and forwards them to UTMStack. The web interface calls it the Collector.Firewalls, switches, hypervisors, antivirus consoles, Suricata, Oracle, GitHub and moreCollector
PluginUTMStack itself connects to a cloud service's API and pulls the logs. You only enter credentials.AWS, Azure, Google Cloud, Microsoft 365, CrowdStrike, Sophos Central, BitdefenderPlugin
Dedicated collectorA Linux service built for one source.IBM AS/400 (IBM i), and UTMStack's own container logsCollector

Agents, the Forwarder and the dedicated collectors all talk to the UTMStack server on port 443 only. See Ports and Network Requirements.

In UTMStack v12 the agent no longer receives syslog. Every device that sends syslog now goes to a UTMStack Forwarder, which you install once and reuse for many integrations. See UTMStack Forwarder.

The Integrations page

Go to Configure > Integrations. The page shows one card per integration.

  • Search integrations… filters the cards by name.

  • The category list (All categories) narrows the cards to one category, for example Firewall or Cloud.

  • Custom shows only the integrations your team created.

  • The three agents (Windows, Linux, macOS) always come first.

  • The last card, Add custom integration, lets you create your own source with Create. See Custom integrations.

Each card shows its badge (Agent, Collector or Plugin) and a button:

ButtonMeaning
Set upOpen the setup guide.
EnabledA Plugin integration that has at least one saved config group in your current tenant.

Agent and Collector cards always show Set up, even while logs are arriving, because their setup lives on your hosts and not in UTMStack.

There is no "activate" switch in UTMStack v12. A device integration starts when you enable it on a Collector, an agent starts when you install it, and a cloud integration starts when you save a config group.

Inside an integration

Click a card to open its drawer. The top of the drawer shows the category, the badge and four buttons:

ButtonWhat it opens
Open dashboardThe dashboard list, searched for dashboards that belong to this integration.
View logsLog Explorer, filtered to this integration's data type for the last 24 hours.
RulesAlerting Rules, filtered to this integration's data type.
FiltersPipelines (parsing filters), filtered to this integration's data type.

Below the buttons is the setup guide:

  • Agents show the install command for each platform, and an Uninstall the agent section.

  • Collector integrations that use the Forwarder start with Enable this integration remotely, then the steps for the device, then Install the UTMStack Collector, Optional — Enable via the command line instead and Optional — Uninstall the Collector.

  • Plugin integrations show a credentials form. Each connection is saved as a config group with a name you choose (the v11 button "Add tenant" is now Add config group). The config group name becomes the data source name on the Data Sources page and cannot be changed later.

  • IBM AS/400 and Utmstack (self-monitoring) show the install guide of their own collector.

Data types

Every integration writes its logs under a data type, for example firewall-cisco-asa or wineventlog. The data type decides which parsing filter and which detection rules apply. You see it in Log Explorer, on the Data Sources page, and in the commands that enable an integration on the Forwarder.

Built-in integrations

UTMStack v12.0.2 ships 34 built-in integrations. Every tenant sees them; tenants cannot edit or delete them. Card names below are as shown in the product.

CardBadgeCategoryData typeSetup page
Windows AgentAgentOperating SystemwineventlogWindows Agent
Linux AgentAgentOperating SystemlinuxLinux Agent
MacosAgentOperating SystemmacosmacOS Agent
VmwareCollectorVirtualizationvmware-esxiVMware ESXi
NetflowCollectorNetworknetflowNetFlow
Cisco SwitchCollectorNetworkcisco-switchCisco Switch
CiscoCollectorFirewallfirewall-cisco-asaCisco ASA
Fire PowerCollectorFirewallfirewall-cisco-firepowerCisco Firepower
MerakiCollectorFirewallfirewall-merakiCisco Meraki
FortigateCollectorFirewallfirewall-fortigate-trafficFortinet FortiGate
FortiwebCollectorFirewallfirewall-fortiwebFortinet FortiWeb
Palo AltoCollectorFirewallfirewall-paloaltoPalo Alto Networks
Sonic WallCollectorFirewallfirewall-sonicwallSonicWall
Sophos XgCollectorFirewallfirewall-sophos-xgSophos Firewall (XG)
PfsenseCollectorFirewallfirewall-pfsensepfSense
MikrotikCollectorFirewallfirewall-mikrotikMikroTik
SuricataCollectorIDS / IPSsuricataSuricata
AixCollectorOperating Systemibm-aixIBM AIX
As 400CollectorOperating Systemibm-as400IBM AS/400 (IBM i) Collector
OracleCollectorDatabaseoracleOracle Database
UtmstackCollectorSIEMutmstackUTMStack Self-Monitoring
EsetCollectorAntivirusantivirus-esmc-esetESET PROTECT
KasperskyCollectorAntivirusantivirus-kasperskyKaspersky Security Center
Sentinel OneCollectorXDRantivirus-sentinel-oneSentinelOne
Deceptive BytesCollectorDeceptiondeceptive-bytesDeceptive Bytes
GithubCollectorDevOpsgithubGitHub
AWS CloudwatchPluginCloudawsAWS CloudWatch
AzurePluginCloudazureMicrosoft Azure
GcpPluginCloudgoogleGoogle Cloud
O365PluginCloudo365Microsoft 365
O365 GraphPluginCloudo365-graphMicrosoft 365 through Microsoft Graph
CrowdstrikePluginXDRcrowdstrikeCrowdStrike Falcon
SophosPluginXDRsophos-centralSophos Central
BitdefenderPluginAntivirusantivirus-bitdefender-gzBitdefender GravityZone

Permissions

ActionPermission needed
See the Integrations page and the setup guidesintegrations.read
Save cloud credentials, enable or disable an integration on a Collector, see the list of Collectorsintegrations.write
See the connection key inside the install commandsAdministrator role

Install commands contain your instance's connection key. If you are not an administrator, the key appears as ******* and the command will not work until an administrator gives you the real key. The key is managed under Configure > Settings > Connection Key.

Always copy install commands from your own UTMStack instance. They contain your server address and connection key. Do not share them.

Multi-tenant installations

With the multi-tenant licence, each tenant has its own integrations, config groups, agents and Collectors. When an operator has entered a child tenant, the install commands use that tenant's domain as the server address instead of the address in the browser. Copy commands from inside the tenant the host belongs to.

On this page
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.