Aller au contenu principal

Cato Networks API

Dépendances du connecteur de supervision​

Les connecteurs de supervision suivants sont automatiquement installés lors de l'installation du connecteur Cato Networks API depuis la page Configuration > Connecteurs > Connecteurs de supervision :

Contenu du pack​

Modèles​

Le connecteur de supervision Cato Networks API apporte un modèle d'hôte :

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

Le connecteur apporte les modèles de service suivants (classés selon le modèle d'hôte auquel ils sont rattachés) :

AliasModèle de serviceDescription
EventsNetwork-Security-Cato-Networks-Events-Api-customContrôler les événements Cato Networks

Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte Network-Security-Cato-Networks-Api-custom est utilisé.

Règles de découverte​

Découverte de services​

Nom de la règleDescription
Network-Security-Cato-Networks-Api-SiteDécouvre les sites Cato Networks via l'API et supervise leur connectivité

Rendez-vous sur la documentation dédiée pour en savoir plus sur la découverte automatique de services et sa planification.

Métriques & statuts collectés​

Voici le tableau des services pour ce connecteur, détaillant les métriques et statuts rattachés à chaque service.

NomUnité
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

Prérequis​

Reportez-vous à la documentation officielle Cato Networks afin de configurer l'accès à l'API GraphQL.

Installer le connecteur de supervision​

Pack​

La procédure d'installation des connecteurs de supervision diffère légèrement suivant que votre licence est offline ou online.

  1. Si la plateforme est configurée avec une licence online, l'installation d'un paquet n'est pas requise pour voir apparaître le connecteur dans le menu Configuration > Connecteurs > Connecteurs de supervision. Au contraire, si la plateforme utilise une licence offline, installez le paquet sur le serveur central via la commande correspondant au gestionnaire de paquets associé à sa distribution :
dnf install centreon-pack-network-security-cato-networks-api
  1. Quel que soit le type de la licence (online ou offline), installez le connecteur Cato Networks API depuis l'interface web et le menu Configuration > Connecteurs > Connecteurs de supervision.

Plugin​

À partir de Centreon 22.04, il est possible de demander le déploiement automatique du plugin lors de l'utilisation d'un connecteur. Si cette fonctionnalité est activée, et que vous ne souhaitez pas découvrir des éléments pour la première fois, alors cette étape n'est pas requise.

Plus d'informations dans la section Installer le plugin.

Utilisez les commandes ci-dessous en fonction du gestionnaire de paquets de votre système d'exploitation :

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

Utiliser le connecteur de supervision​

Utiliser un modèle d'hôte issu du connecteur​

  1. Ajoutez un hôte à Centreon depuis la page Configuration > Hôtes.
  2. Complétez les champs Nom, Alias & IP Address/DNS correspondant à votre ressource.
  3. Appliquez le modèle d'hôte Network-Security-Cato-Networks-Api-custom. Une liste de macros apparaît. Les macros vous permettent de définir comment le connecteur se connectera à la ressource, ainsi que de personnaliser le comportement du connecteur.
  4. Renseignez les macros désirées. Attention, certaines macros sont obligatoires.
MacroDescriptionValeur par défautObligatoire
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. Déployez la configuration. L'hôte apparaît dans la liste des hôtes supervisés, et dans la page Statut des ressources. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros.

Utiliser un modèle de service issu du connecteur​

  1. Si vous avez utilisé un modèle d'hôte et coché la case Créer aussi les services liés aux modèles, les services associés au modèle ont été créés automatiquement, avec les modèles de services correspondants. Sinon, créez les services désirés manuellement et appliquez-leur un modèle de service.
  2. Renseignez les macros désirées (par exemple, ajustez les seuils d'alerte). Les macros indiquées ci-dessous comme requises (Obligatoire) doivent être renseignées.
MacroDescriptionValeur par défautObligatoire
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 on .X
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. Default: --critical-connectivity-status='%{connectivity} !~ /Connected/'%{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. Default: --critical-operational-status='%{operational} !~ /active|new/'%{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). Toutes les options sont listées ici.
  1. Déployez la configuration. Le service apparaît dans la liste des services supervisés, et dans la page Statut des ressources. La commande envoyée par le connecteur est indiquée dans le panneau de détails du service : celle-ci montre les valeurs des macros.

Comment puis-je tester le plugin et que signifient les options des commandes ?​

Une fois le plugin installé, vous pouvez tester celui-ci directement en ligne de commande depuis votre collecteur Centreon en vous connectant avec l'utilisateur centreon-engine (su - centreon-engine). Vous pouvez tester que le connecteur arrive bien à superviser une ressource en utilisant une commande telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) :

/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=''

La commande devrait retourner un message de sortie similaire à :

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

Diagnostic des erreurs communes​

Rendez-vous sur la documentation dédiée des plugins basés sur HTTP/API.

Modes disponibles​

Dans la plupart des cas, un mode correspond à un modèle de service. Le mode est renseigné dans la commande d'exécution du connecteur. Dans l'interface de Centreon, il n'est pas nécessaire de les spécifier explicitement, leur utilisation est implicite dès lors que vous utilisez un modèle de service. En revanche, vous devrez spécifier le mode correspondant à ce modèle si vous voulez tester la commande d'exécution du connecteur dans votre terminal.

Tous les modes disponibles peuvent être affichés en ajoutant le paramètre --list-mode à la commande :

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

Le plugin apporte les modes suivants :

ModeModèle de service associé
connectivity [code]Network-Security-Cato-Networks-Connectivity-Api-custom
discovery [code]Utilisé pour la découverte d'hôtes
events [code]Network-Security-Cato-Networks-Events-Api-custom
query [code]Network-Security-Cato-Networks-Query-Api-custom

Options disponibles​

Options génériques​

Les options génériques sont listées ci-dessous :

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).

Options des modes​

Les options disponibles pour chaque modèle de services sont listées ci-dessous :

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.

Pour un mode, la liste de toutes les options disponibles et leur signification peut être affichée en ajoutant le paramètre --help à la commande :

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