Skip to main content

Cato Networks API

Connector dependencies​

The following monitoring connectors will be installed when you install the Cato Networks API connector through the Configuration > Connectors > Monitoring Connectors menu:

Pack assets​

Templates​

The Monitoring Connector Cato Networks API brings a host template:

  • Network-Security-Cato-Networks-Api-custom

The connector brings the following service templates (sorted by the host template they are attached to):

Service AliasService TemplateService Description
EventsNetwork-Security-Cato-Networks-Events-Api-customCheck Cato Networks events

The services listed above are created automatically when the Network-Security-Cato-Networks-Api-custom host template is used.

Discovery rules​

Service discovery​

Rule nameDescription
Network-Security-Cato-Networks-Api-SiteDiscover Cato Networks sites using the API and monitor their connectivity

More information about discovering services automatically is available on the dedicated page and in the following chapter.

Collected metrics & status​

Here is the list of services for this connector, detailing all metrics and statuses linked to each service.

NameUnit
connectivity.upstream.max.bytesB
connectivity.downstream.max.bytesB
connectivity.upstream.lost.percentage%
connectivity.downstream.lost.percentage%
connectivity.downstream.discarded.countN/A
connectivity.upstream.discarded.countN/A
connectivity.upstream.jitter.msms
connectivity.downstream.jitter.msms
connectivity.lastmile.packetloss.countN/A
connectivity.lastmile.latency.msms

Prerequisites​

Refer to the Cato Networks documentation for more information on how to set up access to the GraphQL API.

Installing the monitoring connector​

Pack​

The installation procedures for monitoring connectors are slightly different depending on whether your license is offline or online.

  1. If the platform uses an online license, you can skip the package installation instruction below as it is not required to have the connector displayed within the Configuration > Connectors > Monitoring Connectors menu. If the platform uses an offline license, install the package on the central server with the command corresponding to the operating system's package manager:
dnf install centreon-pack-network-security-cato-networks-api
  1. Whatever the license type (online or offline), install the Cato Networks API connector through the Configuration > Connectors > Monitoring Connectors menu.

Plugin​

Since Centreon 22.04, you can benefit from the 'Automatic plugin installation' feature. When this feature is enabled, you can skip the installation part below.

You still have to manually install the plugin on the poller(s) when:

  • Automatic plugin installation is turned off
  • You want to run a discovery job from a poller that doesn't monitor any resource of this kind yet

More information in the Installing the plugin section.

Use the commands below according to your operating system's package manager:

dnf install centreon-plugin-Network-Security-Cato-Networks-Api

Using the monitoring connector​

Using a host template provided by the connector​

  1. Log into Centreon and add a new host through Configuration > Hosts.
  2. Fill in the Name, Alias & IP Address/DNS fields according to your resource's settings.
  3. Apply the Network-Security-Cato-Networks-Api-custom template to the host. A list of macros appears. Macros allow you to define how the connector will connect to the resource, and to customize the connector's behavior.
  4. Fill in the macros you want. Some macros are mandatory.
MacroDescriptionDefault valueMandatory
CATOAPINAMEapi.catonetworks.com
PROTOProtocol usedhttps
PORT443
ACCOUNTIDAccount IDX
APIKEYCato Networks API authentication keyX
ENDPOINTCato GraphQL API relative endpoint URI (default : /api/v1/graphql2)/api/v1/graphql2
MAXRETRYCOUNTMaximum number of retry attempts5
RETRYDELAYDelay between retries in seconds5
TIMEOUTSet timeout in seconds10
  1. Deploy the configuration. The host appears in the list of hosts, and on the Resources Status page. The command that is sent by the connector is displayed in the details panel of the host: it shows the values of the macros.

Using a service template provided by the connector​

  1. If you have used a host template and checked Create Services linked to the Template too, the services linked to the template have been created automatically, using the corresponding service templates. Otherwise, create manually the services you want and apply a service template to them.
  2. Fill in the macros you want (e.g. to change the thresholds for the alerts). Some macros are mandatory (see the table below).
MacroDescriptionDefault valueMandatory
BUCKETSDefines the number of buckets for the query's time interval. For example: a 10 minutes interval with 5 buckets results in 2 minute per bucket.5
TIMEFRAMEThe timeframe defines the period over which the performance metrics are aggregated. The parameters timeframe and timeframe-unit allow retrieving data from a specific interval while timeframe-query allows to defining a more complex time interval. timeframe is ignored if timeframe-query is set. Numeric timeframe to use. Meaning that data from the last 5 minutes will be retrieved5
TIMEFRAMEUNITUnit to use with timeframe option (m: minutes, h: hours, D: days, M: months, Y: years)m
TIMEFRAMEQUERYTimeframe query to use (example: utc.2025-09-11/{14:00:00--14:30:00}). Refer to Cato API documentation for more information about supported formats.
SITEIDSite ID to run query onX
PERFORMANCEMETRICSSpecify the performance metrics to query (comma separated list). You can use this option multiple times. Supported values are: all, none, bytesUpstreamMax, bytesDownstreamMax, lostUpstreamPcnt, lostDownstreamPcnt, packetsDiscardedDownstream, packetsDiscardedUpstream, jitterUpstream, jitterDownstream, lastMilePacketLoss, lastMileLatency. all means that all metrics are collected whereas none means none are collected. Refer to Cato API documentation https://api.catonetworks.com/documentation/#definition-TimeseriesKey for more information about supported metricsall
WARNINGCONNECTEDSINCEThreshold in seconds
CRITICALCONNECTEDSINCEThreshold in seconds
CRITICALCONNECTIVITYSTATUSDefine the connectivity status conditions to match for the status to be CRITICAL.%{connectivity} !~ /Connected/
WARNINGCONNECTIVITYSTATUSDefine the connectivity status conditions to match for the status to be WARNING. Example: --warning-connectivity-status='%{connectivity} =~ /Degraded/'
WARNINGDISCARDEDDOWNSTREAMThreshold
CRITICALDISCARDEDDOWNSTREAMThreshold
WARNINGDISCARDEDUPSTREAMThreshold
CRITICALDISCARDEDUPSTREAMThreshold
WARNINGDOWNSTREAMMAXThreshold in bytes
CRITICALDOWNSTREAMMAXThreshold in bytes
WARNINGJITTERDOWNSTREAMThreshold in milliseconds
CRITICALJITTERDOWNSTREAMThreshold in milliseconds
WARNINGJITTERUPSTREAMThreshold in milliseconds
CRITICALJITTERUPSTREAMThreshold in milliseconds
WARNINGLASTCONNECTEDThreshold in seconds
CRITICALLASTCONNECTEDThreshold in seconds
WARNINGLASTMILELATENCYThreshold in milliseconds
CRITICALLASTMILELATENCYThreshold in milliseconds
WARNINGLASTMILEPACKETLOSSThreshold
CRITICALLASTMILEPACKETLOSSThreshold
WARNINGLOSTDOWNSTREAMThreshold in percentage
CRITICALLOSTDOWNSTREAMThreshold in percentage
WARNINGLOSTUPSTREAMThreshold in percentage
CRITICALLOSTUPSTREAMThreshold in percentage
CRITICALOPERATIONALSTATUSDefine the operational status conditions to match for the status to be CRITICAL.%{operational} !~ /active|new/
WARNINGOPERATIONALSTATUSDefine the operational status conditions to match for the status to be WARNING. Example: --warning-operational-status='%{operational} !~ /active/'
WARNINGPOPNAMEDefine the pop name conditions to match for the status to be WARNING. Example: --warning-pop-name='%{pop_name} !~ /Toulouse/'
CRITICALPOPNAMEDefine the pop name conditions to match for the status to be CRITICAL. Example: --critical-pop-name='%{pop_name} !~ /Toulouse/'
WARNINGUPSTREAMMAXThreshold in bytes
CRITICALUPSTREAMMAXThreshold in bytes.
EXTRAOPTIONSAny extra option you may want to add to the command (a --verbose flag for example). All options are listed here.
  1. Deploy the configuration. The service appears in the list of services, and on the Resources Status page. The command that is sent by the connector is displayed in the details panel of the service: it shows the values of the macros.

How to check in the CLI that the configuration is OK and what are the main options for?​

Once the plugin is installed, log into your Centreon poller's CLI using the centreon-engine user account (su - centreon-engine). Test that the connector is able to monitor a resource using a command like this one (replace the sample values by yours):

/usr/lib/centreon/plugins/centreon_cato_networks_api.pl \
	--plugin=network::security::cato::networks::api::plugin \
	--mode=events \
	--api-key='xxx' \
	--account-id='xxx' \
	--proto='https' \
	--port='443' \
	--hostname='' \
	--endpoint='/api/v1/graphql2' \
	--max-retry-count='5' \
	--timeout='10' \
	--retry-delay='5' \
	--type='' \
	--sub-type='' \
	--include-status='' \
	--exclude-status='Closed' \
	--include='' \
	--exclude='' \
	--display='event\_id,time\_str,event\_type,event\_sub\_type,severity,title,event\_message,pop\_name,src\_site\_name,dest\_site\_name' \
	--warning-count='' \
	--critical-count='' \
	--warning-event='' \
	--critical-event=''

The expected command output is shown below:

OK: Number of records: 3578 All records are ok | 'count'=3578;;;0;

Troubleshooting​

Please find the troubleshooting documentation for the API-based plugins in this chapter.

Available modes​

In most cases, a mode corresponds to a service template. The mode appears in the execution command for the connector. In the Centreon interface, you don't need to specify a mode explicitly: its use is implied when you apply a service template. However, you will need to specify the correct mode for the template if you want to test the execution command for the connector in your terminal.

All available modes can be displayed by adding the --list-mode parameter to the command:

/usr/lib/centreon/plugins/centreon_cato_networks_api.pl \
	--plugin=network::security::cato::networks::api::plugin \
	--list-mode

The plugin brings the following modes:

ModeLinked service template
connectivity [code]Network-Security-Cato-Networks-Connectivity-Api-custom
discovery [code]Used for host discovery
events [code]Network-Security-Cato-Networks-Events-Api-custom
query [code]Network-Security-Cato-Networks-Query-Api-custom

Available options​

Generic options​

All generic options are listed here:

OptionDescription
--modeDefine the mode in which you want the plugin to be executed (see --list-mode).
--dyn-modeSpecify a mode with the module's path (advanced).
--list-modeList all available modes.
--mode-versionCheck minimal version of mode. If not, unknown error.
--versionReturn the version of the plugin.
--custommodeWhen a plugin offers several ways (CLI, library, etc.) to get information the desired one must be defined with this option.
--list-custommodeList all available custom modes.
--multipleMultiple custom mode objects. This may be required by some specific modes (advanced).
--pass-managerDefine the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass.
--verboseDisplay extended status information (long output).
--debugDisplay debug messages.
--filter-perfdataFilter perfdata that match the regexp. Example: adding --filter-perfdata='avg' will remove all metrics that do not contain 'avg' from performance data.
--filter-perfdata-advFilter perfdata based on a "if" condition using the following variables: label, value, unit, warning, critical, min, max. Variables must be written either %{variable} or %(variable). Example: adding --filter-perfdata-adv='not (%(value) == 0 and %(max) eq "")' will remove all metrics whose value equals 0 and that don't have a maximum value.
--explode-perfdata-maxCreate a new metric for each metric that comes with a maximum limit. The new metric will be named identically with a '_max' suffix. Example: it will split 'used_prct'=26.93%;0:80;0:90;0;100 into 'used_prct'=26.93%;0:80;0:90;0;100 'used_prct_max'=100%;;;;
--change-perfdata --extend-perfdataChange or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[new-unit-of-mesure],[min],[max]] Common examples: onvert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage free perfdata into used: --change-perfdata='used,free,invert()' Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)' Scale traffic values in Mbps: --change-perfdata='traffic_in,,scale(Mbps),mbps' Change traffic values in percent: --change-perfdata='traffic_in,,percent()'
--extend-perfdata-groupAdd new aggregated metrics (min, max, average or sum) for groups of metrics defined by a regex match on the metrics' names. Syntax: --extend-perfdata-group=regex,names-of-new-metrics,calculation[,[new-unit-of-mesure],[min],[max]] regex: regular expression names-of-new-metrics: how the new metrics' names are composed (can use $1, $2... for groups defined by () in regex). calculation: how the values of the new metrics should be calculated new-unit-of-mesure (optional): unit of measure for the new metrics min (optional): lowest value the metrics can reach max (optional): highest value the metrics can reach Common examples: um wrong packets from all interfaces (with interface need --units-errors=absolute): --extend-perfdata-group=',packets_wrong,sum(packets_(discard|error)_(in|out))' Sum traffic by interface: --extend-perfdata-group='traffic_in_(.*),traffic_$1,sum(traffic_(in|out)_$1)'
--change-short-output --change-long-outputModify the short/long output that is returned by the plugin. Syntax: --change-short-output=patternreplacementmodifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OKUpgi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up'
--change-exitReplace an exit code with one of your choice. Example: adding --change-exit=unknown=critical will result in a CRITICAL state instead of an UNKNOWN state.
--change-output-advReplace short output and exit code based on a "if" condition using the following variables: short_output, exit_code. Variables must be written either %{variable} or %(variable). Example: adding --change-output-adv='%(short_ouput) =~ /UNKNOWN: No daemon/,OK: No daemon,OK' will change the following specific UNKNOWN result to an OK result.
--range-perfdataRewrite the ranges displayed in the perfdata. Accepted values: 0: nothing is changed. 1: if the lower value of the range is equal to 0, it is removed. 2: remove the thresholds from the perfdata.
--filter-uomMask the units when they don't match the given regular expression.
--opt-exitReplace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown.
--output-ignore-perfdataRemove all the metrics from the service. The service will still have a status and an output.
--output-ignore-labelRemove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Example: 'OK: Ram Total:...' will become 'Ram Total:...'
--output-xmlReturn the output in XML format (to send to an XML API).
--output-jsonReturn the output in JSON format (to send to a JSON API).
--output-openmetricsReturn the output in OpenMetrics format (to send to a tool expecting this format).
--output-fileWrite output in file (can be combined with JSON, XML and OpenMetrics options). Example: --output-file=/tmp/output.txt will write the output in /tmp/output.txt.
--disco-formatApplies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML).
--disco-showApplies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery.
--float-precisionDefine the float precision for thresholds (default: 8).
--source-encodingDefine the character encoding of the response sent by the monitored resource Default: 'UTF-8'. output.
--filter-countersOnly display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx|yyyy$'
--http-peer-addrSet the address you want to connect to. Useful if hostname is only a vhost, to avoid IP resolution.
--proxyurlProxy URL. Example: http://my.proxy:3128
--proxypacProxy PAC file (can be a URL or a local file).
--insecureAccept insecure SSL connections.
--http-backendPerl library to use for HTTP transactions. Possible values are: lwp (default) and curl.
--memcachedMemcached server to use (only one server).
--redis-serverRedis server to use (only one server). Syntax: address[:port]
--redis-attributeSet Redis Options (--redis-attribute="cnx_timeout=5").
--redis-dbSet Redis database index.
--failback-fileFall back on a local file if Redis connection fails.
--memexpirationTime to keep data in seconds (default: 86400).
--statefile-dirDefine the cache directory (default: '/var/lib/centreon/centplugins').
--statefile-suffixDefine a suffix to customize the statefile name (default: '').
--statefile-concat-cwdIf used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux.
--statefile-formatDefine the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default).
--statefile-keyDefine the key to encrypt/decrypt the cache.
--statefile-cipherDefine the cipher algorithm to encrypt the cache (default: 'AES').
--api-keyCato Networks API authentication key.
--account-idAccount ID.
--hostnameCato Networks API hostname (default: api.catonetworks.com).
--protoProtocol used (default: 'https').
--endpointCato GraphQL API relative endpoint URI (default : /api/v1/graphql2).
--max-retry-countMaximum number of retry attempts (default: 5).
--retry-delayDelay between retries in seconds (default: 5).
--timeoutSet timeout in seconds (default: 10).

Modes options​

All available options for each service template are listed below:

OptionDescription
--filter-countersOnly display some counters (regexp can be used). Example: --filter-counters='connected'
--site-idSite ID to run query on .
--timeframeThe timeframe defines the period over which the performance metrics are aggregated. The parameters timeframe and timeframe-unit allow retrieving data from a specific interval while timeframe-query allows to defining a more complex time interval. timeframe is ignored if timeframe-query is set. Numeric timeframe to use (default: 5). Meaning that data from the last 5 minutes will be retrieved.
--timeframe-unitUnit to use with timeframe option (m: minutes, h: hours, D: days, M: months, Y: years) (default: m).
--timeframe-queryTimeframe query to use (example: utc.2025-09-11/\{14:00:00--14:30:00\}). Refer to Cato API documentation for more information about supported formats.
--bucketsDefines the number of buckets for the query's time interval. For example: a 10 minutes interval with 5 buckets results in 2 minute per bucket (default: 5).
--performance-metricsSpecify the performance metrics to query (comma separated list) (default: 'all'). You can use this option multiple times. Supported values are: all, none, bytesUpstreamMax, bytesDownstreamMax, lostUpstreamPcnt, lostDownstreamPcnt, packetsDiscardedDownstream, packetsDiscardedUpstream, jitterUpstream, jitterDownstream, lastMilePacketLoss, lastMileLatency. all means that all metrics are collected whereas none means none are collected. Refer to Cato API documentation https://api.catonetworks.com/documentation/#definition-TimeseriesKey for more information about supported metrics.
--warning-discarded-downstreamThreshold.
--critical-discarded-downstreamThreshold.
--warning-discarded-upstreamThreshold.
--critical-discarded-upstreamThreshold.
--warning-downstream-maxThreshold in bytes.
--critical-downstream-maxThreshold in bytes.
--warning-jitter-downstreamThreshold in milliseconds.
--critical-jitter-downstreamThreshold in milliseconds.
--warning-jitter-upstreamThreshold in milliseconds.
--critical-jitter-upstreamThreshold in milliseconds.
--warning-lastmile-latencyThreshold in milliseconds.
--critical-lastmile-latencyThreshold in milliseconds.
--warning-lastmile-packetlossThreshold.
--critical-lastmile-packetlossThreshold.
--warning-lost-downstreamThreshold in percentage.
--critical-lost-downstreamThreshold in percentage.
--warning-lost-upstreamThreshold in percentage.
--critical-lost-upstreamThreshold in percentage.
--warning-upstream-maxThreshold in bytes.
--critical-upstream-maxThreshold in bytes.
--warning-connectivity-statusDefine the connectivity status conditions to match for the status to be WARNING. Example: --warning-connectivity-status='%{connectivity} =~ /Degraded/'
--critical-connectivity-statusDefine the connectivity status conditions to match for the status to be CRITICAL. Default: --critical-connectivity-status='%{connectivity} !~ /Connected/'
--warning-operational-statusDefine the operational status conditions to match for the status to be WARNING. Example: --warning-operational-status='%{operational} !~ /active/'
--critical-operational-statusDefine the operational status conditions to match for the status to be CRITICAL. Default: --critical-operational-status='%{operational} !~ /active|new/'
--warning-pop-nameDefine the pop name conditions to match for the status to be WARNING. Example: --warning-pop-name='%{pop_name} !~ /Toulouse/'
--critical-pop-nameDefine the pop name conditions to match for the status to be CRITICAL. Example: --critical-pop-name='%{pop_name} !~ /Toulouse/'
--warning-last-connectedThreshold in seconds.
--critical-last-connectedThreshold in seconds.
--warning-connected-sinceThreshold in seconds.
--critical-connected-sinceThreshold in seconds.

All available options for a given mode can be displayed by adding the --help parameter to the command:

/usr/lib/centreon/plugins/centreon_cato_networks_api.pl \
	--plugin=network::security::cato::networks::api::plugin \
	--mode=events \
	--help