Cato Networks Topology

Plugin: go.d.plugin Module: cato_networks

Overview

Map a Cato Networks SASE fabric. The Cato collector renders sites, sockets, and gateways with their tunnel and transport paths.

The Cato collector reads the Cato Management Application over its API and renders the fabric as a netdata.topology.v1 graph.

This integration is supported on all platforms.

This integration supports multiple instances configured side-by-side.

Default Behavior

Auto-Detection

Built from the configured Cato account.

Limits

The default configuration for this integration does not impose any limits.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

Setup

You can configure the cato_networks collector in two ways:

Method	Best for	How to
UI	Fast setup without editing files	Go to Nodes → Configure this node → Collectors → Jobs, search for cato_networks, then click + to add a job.
File	If you prefer configuring via file, or need to automate deployments (e.g., with Ansible)	Edit go.d/cato_networks.conf and add a job.

important

UI configuration requires paid Netdata Cloud plan.

Prerequisites

Cato API access

A Cato Management Application API key with read access to the account you want to map.

Configuration

Options

Configure the Cato Networks collector with your account ID and API key. See the Cato Networks collector page for all options. update_every must be at least 60; url defaults to the Cato public GraphQL endpoint and only needs setting for a different region or a proxy.

via UI

Configure the cato_networks collector from the Netdata web interface:

1. Go to Nodes.
2. Select the node where you want the cato_networks data-collection job to run and click the ⚙ (Configure this node). That node will run the data collection.
3. The Collectors → Jobs view opens by default.
4. In the Search box, type cato_networks (or scroll the list) to locate the cato_networks collector.
5. Click the + next to the cato_networks collector to add a new job.
6. Fill in the job fields, then click Test to verify the configuration and Submit to save.
   • Test runs the job with the provided settings and shows whether data can be collected.
   • If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.

via File

The configuration file name for this integration is go.d/cato_networks.conf.

The file format is YAML. Generally, the structure is:

update_every: 1
autodetection_retry: 0
jobs:
  - name: some_name1
  - name: some_name2

You can edit the configuration file using the edit-config script from the Netdata config directory.

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/cato_networks.conf

Examples

Minimal job

The two required fields. url defaults to the Cato public GraphQL endpoint, and update_every must be at least 60.

jobs:
  - name: cato
    account_id: "12345"
    api_key: SECRET

Alerts

There are no alerts configured by default for this integration.

Metrics