From c738a05d74ab5d5a380f12e3845957bfa900815f Mon Sep 17 00:00:00 2001 From: Lucie Dubrunfaut Date: Thu, 30 Jan 2025 10:47:25 +0100 Subject: [PATCH] Add ha-status, license, vpn-status ans list-vpns modes --- .../procedures/network-cyberoam-snmp.md | 337 +++++++++++------ .../procedures/network-cyberoam-snmp.md | 339 ++++++++++++------ 2 files changed, 463 insertions(+), 213 deletions(-) diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-cyberoam-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-cyberoam-snmp.md index 33b36cbca2a4..cc57c811b6dc 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-cyberoam-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-cyberoam-snmp.md @@ -1,21 +1,21 @@ --- id: network-cyberoam-snmp -title: Cyberoam +title: Cyberoam SNMP --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; ## Dépendances du connecteur de supervision -Les connecteurs de supervision suivants sont automatiquement installés lors de l'installation du connecteur **Cyberoam** -depuis l'interface web et le menu **Configuration > Gestionnaire de connecteurs de supervision** : +Les connecteurs de supervision suivants sont automatiquement installés lors de l'installation du connecteur **Cyberoam SNMP** +depuis la page **Configuration > Gestionnaire de connecteurs de supervision** : * [Base Pack](./base-generic.md) ## Contenu du pack ### Modèles -Le connecteur de supervision **Cyberoam** apporte un modèle d'hôte : +Le connecteur de supervision **Cyberoam SNMP** apporte un modèle d'hôte : * **Net-Cyberoam-SNMP-custom** @@ -25,13 +25,15 @@ Le connecteur apporte les modèles de service suivants -| Alias | Modèle de service | Description | -|:---------|:----------------------------------|:----------------------------------------------------| -| Cpu | Net-Cyberoam-Cpu-SNMP-custom | Contrôle du taux d'utilisation du CPU de la machine | -| Disks | Net-Cyberoam-Disks-SNMP-custom | Contrôle du taux d'utilisation du stockage | -| Memory | Net-Cyberoam-Memory-SNMP-custom | Contrôle du taux d'utilisation des mémoires | -| Requests | Net-Cyberoam-Requests-SNMP-custom | Contrôle le nombre de requêtes par protocole | -| Services | Net-Cyberoam-Services-SNMP-custom | Contrôle l'état des services | +| Alias | Modèle de service | Description | +|:----------|:-----------------------------------|:----------------------------------------------------| +| Cpu | Net-Cyberoam-Cpu-SNMP-custom | Contrôle du taux d'utilisation du CPU de la machine | +| Disks | Net-Cyberoam-Disks-SNMP-custom | Contrôle du taux d'utilisation du stockage | +| Ha-Status | Net-Cyberoam-Ha-Status-SNMP-custom | Contrôle l'état de la haute disponibilité | +| License | Net-Cyberoam-License-SNMP-custom | Contrôle l'état de la licence | +| Memory | Net-Cyberoam-Memory-SNMP-custom | Contrôle du taux d'utilisation des mémoires | +| Requests | Net-Cyberoam-Requests-SNMP-custom | Contrôle le nombre de requêtes par protocole | +| Services | Net-Cyberoam-Services-SNMP-custom | Contrôle l'état des services | > Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte **Net-Cyberoam-SNMP-custom** est utilisé. @@ -40,7 +42,8 @@ Le connecteur apporte les modèles de service suivants | Alias | Modèle de service | Description | Découverte | |:---------------|:----------------------------------------|:----------------------------------------------------------|:----------:| -| Traffic-Global | Net-Cyberoam-Traffic-Global-SNMP-custom | Contrôle le trafic réseau de plusieurs interfaces réseau | X | +| Traffic-Global | Net-Cyberoam-Traffic-Global-SNMP-custom | Contrôle le traffic réseau de plusieurs interfaces réseau | X | +| Vpn-Status | Net-Cyberoam-Vpn-Status-SNMP-custom | Contrôle l'état des réseaux privés virtuels | X | > Les services listés ci-dessus ne sont pas créés automatiquement lorsqu'un modèle d'hôte est appliqué. Pour les utiliser, [créez un service manuellement](/docs/monitoring/basic-objects/services) et appliquez le modèle de service souhaité. @@ -53,24 +56,25 @@ Le connecteur apporte les modèles de service suivants #### Découverte d'hôtes -| Nom de la règle | Description | -|:----------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| SNMP Agents | Découvre les ressources via un scan réseau SNMP. Installez le connecteur [Generic SNMP](./applications-protocol-snmp.md) pour obtenir la règle de découverte et créez un modificateur pour le modèle d'hôte **Net-Cyberoam-SNMP-custom** | +| Nom de la règle | Description | +|:----------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SNMP Agents | Découvre les ressources via un scan réseau SNMP. Installez le connecteur [Generic SNMP](./applications-protocol-snmp.md) pour obtenir la règle de découverte et créez un modificateur pour le modèle d'hôte **Net-Cyberoam-SNMP-custom**. | Rendez-vous sur la [documentation dédiée](/docs/monitoring/discovery/hosts-discovery) pour en savoir plus sur la découverte automatique d'hôtes. #### Découverte de services -| Nom de la règle | Description | -|:-------------------------------|:------------------------------------------------------------------------| -| Net-Cyberoam-SNMP-Traffic-Name | Découvre les interfaces réseau et supervise leur statut et leur utilisation | +| Nom de la règle | Description | +|:-------------------------------|:--------------------------------------------------------------------------------------------------| +| Net-Cyberoam-SNMP-Traffic-Name | Découvre les interfaces réseau en utilisant leur nom et supervise leur statut et leur utilisation | +| Net-Cyberoam-SNMP-Vpn-Name | Découvre les réseaux privés virtuels et supervise leur état | Rendez-vous sur la [documentation dédiée](/docs/monitoring/discovery/services-discovery) pour en savoir plus sur la découverte automatique de services et sa [planification](/docs/monitoring/discovery/services-discovery/#règles-de-découverte). ### Métriques & statuts collectés -Voici le tableau des services pour ce connecteur, détaillant les métriques et statuts rattachées à chaque service. +Voici le tableau des services pour ce connecteur, détaillant les métriques et statuts rattachés à chaque service. @@ -88,6 +92,23 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques et > Pour obtenir ce nouveau format de métrique, incluez la valeur **--use-new-perfdata** dans la macro de service **EXTRAOPTIONS**. + + + +| Nom | Unité | +|:-------|:------| +| status | N/A | + +> Pour obtenir ce nouveau format de métrique, incluez la valeur **--use-new-perfdata** dans la macro de service **EXTRAOPTIONS**. + + + + +| Nom | Unité | +|:-----------------------------------|:------| +| status | N/A | +| *licenses*#license.expires.seconds | s | + @@ -122,14 +143,24 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques et -| Nom | Unité | -|:------------------------------------------------------|:------| -| status | N/A | -| status | N/A | -| *interface_name1*#interface.traffic.in.bitspersecond | b/s | -| *interface_name2*#interface.traffic.in.bitspersecond | b/s | -| *interface_name1*#interface.traffic.out.bitspersecond | b/s | -| *interface_name2*#interface.traffic.out.bitspersecond | b/s | +| Nom | Unité | +|:-----------------------------------------------------|:------| +| status | N/A | +| *interface_name*#interface.traffic.in.bitspersecond | b/s | +| *interface_name*#interface.traffic.out.bitspersecond | b/s | + + + + +| Nom | Unité | +|:--------------------------|:------| +| vpn.total.count | count | +| vpn.inactive.count | count | +| vpn.active.count | count | +| vpn.partiallyactive.count | count | +| status | N/A | + +> Pour obtenir ce nouveau format de métrique, incluez la valeur **--use-new-perfdata** dans la macro de service **EXTRAOPTIONS**. @@ -138,12 +169,14 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques et ### Configuration SNMP -Le service SNMP doit être activé et configuré sur l'équipement. Veuillez vous référer à la documentation officielle du constructeur/éditeur. +L'agent SNMP doit être activé et configuré sur l'équipement. +Veuillez vous référer à la documentation officielle du constructeur/éditeur. +Il se peut que votre équipement nécessite qu'une liste d'adresses autorisées à l'interroger soit paramétrée. +Veillez à ce que les adresses des collecteurs Centreon y figurent bien. ### Flux réseau -La communication doit être possible sur le port UDP 161 depuis le collecteur -Centreon vers la ressource supervisée. +La communication doit être possible sur le port UDP 161 depuis le collecteur Centreon vers la ressource supervisée. ## Installer le connecteur de supervision @@ -170,7 +203,7 @@ dnf install centreon-pack-network-cyberoam-snmp ``` - + ```bash apt install centreon-pack-network-cyberoam-snmp @@ -186,7 +219,7 @@ yum install centreon-pack-network-cyberoam-snmp -2. Quel que soit le type de la licence (*online* ou *offline*), installez le connecteur **Cyberoam** +2. Quel que soit le type de la licence (*online* ou *offline*), installez le connecteur **Cyberoam SNMP** depuis l'interface web et le menu **Configuration > Gestionnaire de connecteurs de supervision**. ### Plugin @@ -215,7 +248,7 @@ dnf install centreon-plugin-Network-Cyberoam-Snmp ``` - + ```bash apt install centreon-plugin-network-cyberoam-snmp @@ -271,6 +304,27 @@ yum install centreon-plugin-Network-Cyberoam-Snmp | CRITICALUSAGE | Critical threshold (in percent) | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | + + + +| Macro | Description | Valeur par défaut | Obligatoire | +|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------|:-----------:| +| WARNINGSTATUS | Trigger warning on %\{hastatus\} or %\{hastate\} or %\{peer\_hastate\} values | | | +| CRITICALSTATUS | Trigger critical on %\{hastatus\} or %\{hastate\} or %\{peer\_hastate\} values. (default: '%\{hastatus\} =~ /^enabled$/ && %\{hastate\} =~ /^faulty$/') | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --no-ha-status='UNKNOWN' | | + + + + +| Macro | Description | Valeur par défaut | Obligatoire | +|:----------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------------|:-----------:| +| FILTERNAME | Filter licenses by name (can be a regexp) | | | +| WARNINGEXPIRES | Threshold. Example: C\<--unit=w --warning-expires=2:\> will result in a WARNING state when one of the licenses expires in less than two weeks | | | +| CRITICALEXPIRES | Threshold. Example: C\<--unit=w --critical-expires=2:\> will result in a CRITICAL state when one of the licenses expires in less than two weeks | | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{name\}, %\{status\} | %\{status\} =~ /expired/i | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{name\}, %\{status\} | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | + @@ -312,15 +366,36 @@ yum install centreon-plugin-Network-Cyberoam-Snmp -| Macro | Description | Valeur par défaut | Obligatoire | -|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| FILTER | Define the interface filter on IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | .* | | -| WARNINGIN | Threshold | 80 | | -| CRITICALIN | Threshold | 90 | | -| WARNINGOUT | Threshold | 80 | | -| CRITICALOUT | Threshold | 90 | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| FILTER | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | .* | | +| WARNINGIN | Threshold | 80 | | +| CRITICALIN | Threshold | 90 | | +| WARNINGOUT | Threshold | 80 | | +| CRITICALOUT | Threshold | 90 | | | CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | + + + + +| Macro | Description | Valeur par défaut | Obligatoire | +|:-----------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------|:-----------:| +| FILTERCOUNTER | Only display some counters (regexp can be used). Example: --filter-counters='^total$\ |^total-normal$' | | | +| FILTERNAME | Filter VPN name (can be a regexp) | | | +| FILTERVPNACTIVATED | Filter by the activation status of the VPN (can be a regexp). Values: active, inactive | | | +| FILTERCONNECTIONMODE | Filter by the connection mode of the VPN (can be a regexp) | | | +| WARNINGSTATUS | Trigger warning on %\{connection\_status\} values. | %\{connection\_status\} =~ /partiallyActive/ | | +| CRITICALSTATUS | Trigger critical on %\{connection\_status\} values. | %\{connection\_status\} =~ /inactive/ | | +| WARNINGTOTAL | Thresholds | | | +| CRITICALTOTAL | Thresholds | | | +| WARNINGTOTALACTIVE | Thresholds | | | +| CRITICALTOTALACTIVE | Thresholds | | | +| WARNINGTOTALINACTIVE | Thresholds | | | +| CRITICALTOTALINACTIVE | Thresholds | | | +| WARNINGTOTALPARTIALLYACTIVE | Thresholds | | | +| CRITICALTOTALPARTIALLYACTIVE | Thresholds | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | @@ -358,6 +433,7 @@ La commande devrait retourner un message de sortie similaire à : ```bash OK: All interfaces are ok | 'interface_name1#interface.traffic.in.bitspersecond'=20b/s;80;90;; 'interface_name2#interface.traffic.in.bitspersecond'=20b/s;80;90;; 'interface_name1#interface.traffic.out.bitspersecond'=20b/s;80;90;; 'interface_name2#interface.traffic.out.bitspersecond'=20b/s;80;90;; + ``` ### Diagnostic des erreurs communes @@ -386,12 +462,16 @@ Le plugin apporte les modes suivants : | Mode | Modèle de service associé | |:-----------------------------------------------------------------------------------------------------------------------------|:----------------------------------------| | cpu [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/cyberoam/snmp/mode/cpu.pm)] | Net-Cyberoam-Cpu-SNMP-custom | +| ha-status [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/cyberoam/snmp/mode/hastatus.pm)] | Net-Cyberoam-Ha-Status-SNMP-custom | | interfaces [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/interfaces.pm)] | Net-Cyberoam-Traffic-Global-SNMP-custom | +| license [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/cyberoam/snmp/mode/license.pm)] | Net-Cyberoam-License-SNMP-custom | | list-interfaces [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/listinterfaces.pm)] | Used for service discovery | +| list-vpns [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/cyberoam/snmp/mode/listvpns.pm)] | Used for service discovery | | memory [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/cyberoam/snmp/mode/memory.pm)] | Net-Cyberoam-Memory-SNMP-custom | | requests [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/cyberoam/snmp/mode/requests.pm)] | Net-Cyberoam-Requests-SNMP-custom | | services [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/cyberoam/snmp/mode/services.pm)] | Net-Cyberoam-Services-SNMP-custom | | storage [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/cyberoam/snmp/mode/storage.pm)] | Net-Cyberoam-Disks-SNMP-custom | +| vpn-status [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/cyberoam/snmp/mode/vpnstatus.pm)] | Net-Cyberoam-Vpn-Status-SNMP-custom | ### Options disponibles @@ -399,65 +479,66 @@ Le plugin apporte les modes suivants : Les options génériques sont listées ci-dessous : -| Option | Description | -|:-------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --mode | Define the mode in which you want the plugin to be executed (see --list-mode). | -| --dyn-mode | Specify a mode with the module's path (advanced). | -| --list-mode | List all available modes. | -| --mode-version | Check minimal version of mode. If not, unknown error. | -| --version | Return the version of the plugin. | -| --pass-manager | Define the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass. | -| --hostname | Name or address of the host to monitor (mandatory). | -| --snmp-community | SNMP community (default value: public). It is recommended to use a read-only community. | -| --snmp-version | Version of the SNMP protocol. 1 for SNMP v1 (default), 2 for SNMP v2c, 3 for SNMP v3. | -| --snmp-port | UDP port to send the SNMP request to (default: 161). | -| --snmp-timeout | Time to wait before sending the request again if no reply has been received, in seconds (default: 1). See also --snmp-retries. | -| --snmp-retries | Maximum number of retries (default: 5). | -| --maxrepetitions | Max repetitions value (default: 50) (only for SNMP v2 and v3). | -| --subsetleef | How many OID values per SNMP request (default: 50) (for get\_leef method. Be cautious when you set it. Prefer to let the default value). | -| --snmp-autoreduce | Progressively reduce the number of requested OIDs in bulk mode. Use it in case of SNMP errors (by default, the number is divided by 2). | -| --snmp-force-getnext | Use SNMP getnext function in SNMP v2c and v3. This will request one OID at a time. | -| --snmp-cache-file | Use SNMP cache file. | -| --snmp-username | SNMP v3 only: User name (securityName). | -| --authpassphrase | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option. | -| --authprotocol | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512. | -| --privpassphrase | SNMP v3 only: Privacy pass phrase (privPassword) to encrypt messages using the protocol defined in the --privprotocol option. | -| --privprotocol | SNMP v3 only: Privacy protocol (privProtocol) used to encrypt messages. Supported protocols are: DES\|AES and since net-snmp 5.9.1: AES192\|AES192C\|AES256\|AES256C. | -| --contextname | SNMP v3 only: Context name (contextName), if relevant for the monitored host. | -| --contextengineid | SNMP v3 only: Context engine ID (contextEngineID), if relevant for the monitored host, given as a hexadecimal string. | -| --securityengineid | SNMP v3 only: Security engine ID, given as a hexadecimal string. | -| --snmp-errors-exit | Expected status in case of SNMP error or timeout. Possible values are warning, critical and unknown (default). | -| --snmp-tls-transport | Transport protocol for TLS communication (can be: 'dtlsudp', 'tlstcp'). | -| --snmp-tls-our-identity | X.509 certificate to identify ourselves. Can be the path to the certificate file or its contents. | -| --snmp-tls-their-identity | X.509 certificate to identify the remote host. Can be the path to the certificate file or its contents. This option is unnecessary if the certificate is already trusted by your system. | -| --snmp-tls-their-hostname | Common Name (CN) expected in the certificate sent by the host if it differs from the value of the --hostname parameter. | -| --snmp-tls-trust-cert | A trusted CA certificate used to verify a remote host's certificate. If you use this option, you must also define --snmp-tls-their-hostname. | -| --verbose | Display extended status information (long output). | -| --debug | Display debug messages. | -| --filter-perfdata | Filter perfdata that match the regexp. Example: adding --filter-perfdata='avg' will remove all metrics that do not contain 'avg' from performance data. | -| --filter-perfdata-adv | Filter 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-max | Create 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-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[newuom\],\[min\],\[max\]\] Common examples: =over 4 Convert 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()' =back | -| --change-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[newuom\],\[min\],\[max\]\] Common examples: =over 4 Convert 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()' =back | -| --extend-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[newuom\],\[min\],\[max\]\] Common examples: =over 4 Convert 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()' =back | -| --extend-perfdata-group | Add 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,namesofnewmetrics,calculation\[,\[newuom\],\[min\],\[max\]\] regex: regular expression namesofnewmetrics: 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 newuom (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: =over 4 Sum 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)' =back | -| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-exit | Replace 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. | -| --range-perfdata | Rewrite 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-uom | Mask the units when they don't match the given regular expression. | -| --opt-exit | Replace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown. | -| --output-ignore-perfdata | Remove all the metrics from the service. The service will still have a status and an output. | -| --output-ignore-label | Remove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Example: 'OK: Ram Total:...' will become 'Ram Total:...' | -| --output-xml | Return the output in XML format (to send to an XML API). | -| --output-json | Return the output in JSON format (to send to a JSON API). | -| --output-openmetrics | Return the output in OpenMetrics format (to send to a tool expecting this format). | -| --output-file | Write output in file (can be combined with json, xml and openmetrics options). E.g.: --output-file=/tmp/output.txt will write the output in /tmp/output.txt. | -| --disco-format | Applies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML). | -| --disco-show | Applies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery. | -| --float-precision | Define the float precision for thresholds (default: 8). | -| --source-encoding | Define the character encoding of the response sent by the monitored resource Default: 'UTF-8'. =head1 DESCRIPTION B\. =cut | +| Option | Description | +|:-------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --mode | Define the mode in which you want the plugin to be executed (see --list-mode). | +| --dyn-mode | Specify a mode with the module's path (advanced). | +| --list-mode | List all available modes. | +| --mode-version | Check minimal version of mode. If not, unknown error. | +| --version | Return the version of the plugin. | +| --pass-manager | Define the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass. | +| --hostname | Name or address of the host to monitor (mandatory). | +| --snmp-community | SNMP community (default value: public). It is recommended to use a read-only community. | +| --snmp-version | Version of the SNMP protocol. 1 for SNMP v1 (default), 2 for SNMP v2c, 3 for SNMP v3. | +| --snmp-port | UDP port to send the SNMP request to (default: 161). | +| --snmp-timeout | Time to wait before sending the request again if no reply has been received, in seconds (default: 1). See also --snmp-retries. | +| --snmp-retries | Maximum number of retries (default: 5). | +| --maxrepetitions | Max repetitions value (default: 50) (only for SNMP v2 and v3). | +| --subsetleef | How many OID values per SNMP request (default: 50) (for get\_leef method. Be cautious when you set it. Prefer to let the default value). | +| --snmp-autoreduce | Progressively reduce the number of requested OIDs in bulk mode. Use it in case of SNMP errors (by default, the number is divided by 2). | +| --snmp-force-getnext | Use SNMP getnext function in SNMP v2c and v3. This will request one OID at a time. | +| --snmp-cache-file | Use SNMP cache file. | +| --snmp-username | SNMP v3 only: User name (securityName). | +| --authpassphrase | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option. | +| --authprotocol | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512. | +| --privpassphrase | SNMP v3 only: Privacy pass phrase (privPassword) to encrypt messages using the protocol defined in the --privprotocol option. | +| --privprotocol | SNMP v3 only: Privacy protocol (privProtocol) used to encrypt messages. Supported protocols are: DES\|AES and since net-snmp 5.9.1: AES192\|AES192C\|AES256\|AES256C. | +| --contextname | SNMP v3 only: Context name (contextName), if relevant for the monitored host. | +| --contextengineid | SNMP v3 only: Context engine ID (contextEngineID), if relevant for the monitored host, given as a hexadecimal string. | +| --securityengineid | SNMP v3 only: Security engine ID, given as a hexadecimal string. | +| --snmp-errors-exit | Expected status in case of SNMP error or timeout. Possible values are warning, critical and unknown (default). | +| --snmp-tls-transport | Transport protocol for TLS communication (can be: 'dtlsudp', 'tlstcp'). | +| --snmp-tls-our-identity | X.509 certificate to identify ourselves. Can be the path to the certificate file or its contents. | +| --snmp-tls-their-identity | X.509 certificate to identify the remote host. Can be the path to the certificate file or its contents. This option is unnecessary if the certificate is already trusted by your system. | +| --snmp-tls-their-hostname | Common Name (CN) expected in the certificate sent by the host if it differs from the value of the --hostname parameter. | +| --snmp-tls-trust-cert | A trusted CA certificate used to verify a remote host's certificate. If you use this option, you must also define --snmp-tls-their-hostname. | +| --verbose | Display extended status information (long output). | +| --debug | Display debug messages. | +| --filter-perfdata | Filter perfdata that match the regexp. Example: adding --filter-perfdata='avg' will remove all metrics that do not contain 'avg' from performance data. | +| --filter-perfdata-adv | Filter 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-max | Create 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-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[\\],\[min\],\[max\]\] Common examples: =over 4 Convert 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()' =back | +| --change-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[\\],\[min\],\[max\]\] Common examples: =over 4 Convert 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()' =back | +| --extend-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[\\],\[min\],\[max\]\] Common examples: =over 4 Convert 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()' =back | +| --extend-perfdata-group | Add 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: =over 4 Sum 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)' =back | +| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-exit | Replace 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-adv | Replace 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-perfdata | Rewrite 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-uom | Mask the units when they don't match the given regular expression. | +| --opt-exit | Replace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown. | +| --output-ignore-perfdata | Remove all the metrics from the service. The service will still have a status and an output. | +| --output-ignore-label | Remove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Example: 'OK: Ram Total:...' will become 'Ram Total:...' | +| --output-xml | Return the output in XML format (to send to an XML API). | +| --output-json | Return the output in JSON format (to send to a JSON API). | +| --output-openmetrics | Return the output in OpenMetrics format (to send to a tool expecting this format). | +| --output-file | Write 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-format | Applies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML). | +| --disco-show | Applies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery. | +| --float-precision | Define the float precision for thresholds (default: 8). | +| --source-encoding | Define the character encoding of the response sent by the monitored resource Default: 'UTF-8'. =head1 DESCRIPTION B\. =cut | #### Options des modes @@ -480,6 +561,29 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous | --warning-usage | Warning threshold (in percent). | | --critical-usage | Critical threshold (in percent). | + + + +| Option | Description | +|:------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-status | Trigger warning on %\{hastatus\} or %\{hastate\} or %\{peer\_hastate\} values. | +| --critical-status | Trigger critical on %\{hastatus\} or %\{hastate\} or %\{peer\_hastate\} values. (default: '%\{hastatus\} =~ /^enabled$/ && %\{hastate\} =~ /^faulty$/'). | +| --no-ha-status | Status to return when HA not running or not installed (default: 'UNKNOWN'). | + + + + +| Option | Description | +|:-------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --filter-name | Filter licenses by name (can be a regexp). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{name\}, %\{status\}. | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} =~ /expired/i'). You can use the following variables: %\{name\}, %\{status\}. | +| --unit | Select the time unit for the expiration thresholds. May be 's' for seconds, 'm' for minutes, 'h' for hours, 'd' for days, 'w' for weeks. Default is seconds. | +| --warning-expires | Threshold. Example: C\<--unit=w --warning-expires=2:\> will result in a WARNING state when one of the licenses expires in less than two weeks. | +| --critical-expires | Threshold. Example: C\<--unit=w --critical-expires=2:\> will result in a CRITICAL state when one of the licenses expires in less than two weeks. | + @@ -521,7 +625,7 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous | --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | | --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | | --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | +| --failback-file | Fall back on a local file if Redis connection fails. | | --memexpiration | Time to keep data in seconds (default: 86400). | | --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | | --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | @@ -537,15 +641,15 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous | --add-cast | Check interface cast. | | --add-speed | Check interface speed. | | --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | | --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | | --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | | --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | | --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | -| --interface | Define the interface filter on IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | | --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | | --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | | --speed | Set interface speed for incoming/outgoing traffic (in Mb). | @@ -553,7 +657,7 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous | --speed-out | Set interface speed for outgoing traffic (in Mb). | | --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | | --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32-bits counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | | --reload-cache-time | Time in minutes before reloading cache file (default: 180). | | --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | | --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | @@ -561,6 +665,27 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous | --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | | --show-cache | Display cache interface data. | + + + +| Option | Description | +|:----------------------------------|:---------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^total$\|^total-normal$' | +| --filter-name | Filter VPN name (can be a regexp). | +| --filter-vpn-activated | Filter by the activation status of the VPN (can be a regexp). Values: active, inactive | +| --filter-connection-mode | Filter by the connection mode of the VPN (can be a regexp). | +| --connection-type | Filter by the connection type of the VPN (can be a regexp). Values: host-to-host, site-to-site, tunnel-interface | +| --warning-status | Trigger warning on %\{connection\_status\} values. (default: '%\{connection\_status\} =~ /partiallyActive/'). | +| --critical-status | Trigger critical on %\{connection\_status\} values. (default: '%\{connection\_status\} =~ /inactive/'). | +| --warning-total | Thresholds. | +| --critical-total | Thresholds. | +| --warning-total-inactive | Thresholds. | +| --critical-total-inactive | Thresholds. | +| --warning-total-partially-active | Thresholds. | +| --critical-total-partially-active | Thresholds. | +| --warning-total-active | Thresholds. | +| --critical-total-active | Thresholds. | + diff --git a/pp/integrations/plugin-packs/procedures/network-cyberoam-snmp.md b/pp/integrations/plugin-packs/procedures/network-cyberoam-snmp.md index 5b4c040b8f48..15421b63e322 100644 --- a/pp/integrations/plugin-packs/procedures/network-cyberoam-snmp.md +++ b/pp/integrations/plugin-packs/procedures/network-cyberoam-snmp.md @@ -1,13 +1,13 @@ --- id: network-cyberoam-snmp -title: Cyberoam +title: Cyberoam SNMP --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -## Connector Dependencies +## Connector dependencies -The following monitoring connectors will be installed when you install the **Cyberoam** connector through the +The following monitoring connectors will be installed when you install the **Cyberoam SNMP** connector through the **Configuration > Monitoring Connector Manager** menu: * [Base Pack](./base-generic.md) @@ -15,7 +15,7 @@ The following monitoring connectors will be installed when you install the **Cyb ### Templates -The Monitoring Connector **Cyberoam** brings a host template: +The Monitoring Connector **Cyberoam SNMP** brings a host template: * **Net-Cyberoam-SNMP-custom** @@ -24,22 +24,25 @@ The connector brings the following service templates (sorted by the host templat -| Service Alias | Service Template | Service Description | -|:--------------|:----------------------------------|:-----------------------------------------------------| -| Cpu | Net-Cyberoam-Cpu-SNMP-custom | Check the rate of CPU utilization for the machine | -| Disks | Net-Cyberoam-Disks-SNMP-custom | Check storage usage | -| Memory | Net-Cyberoam-Memory-SNMP-custom | Check the rate of the utilization of memories | -| Requests | Net-Cyberoam-Requests-SNMP-custom | Check request statistics | -| Services | Net-Cyberoam-Services-SNMP-custom | Check services | +| Service Alias | Service Template | Service Description | +|:--------------|:-----------------------------------|:-----------------------------------------------------| +| Cpu | Net-Cyberoam-Cpu-SNMP-custom | Check the rate of utilization of CPU for the machine | +| Disks | Net-Cyberoam-Disks-SNMP-custom | Check storage usage | +| Ha-Status | Net-Cyberoam-Ha-Status-SNMP-custom | Check the status of the high availability | +| License | Net-Cyberoam-License-SNMP-custom | Monitor the status of the license | +| Memory | Net-Cyberoam-Memory-SNMP-custom | Check the rate of the utilization of memories | +| Requests | Net-Cyberoam-Requests-SNMP-custom | Check request statistics | +| Services | Net-Cyberoam-Services-SNMP-custom | Check services | > The services listed above are created automatically when the **Net-Cyberoam-SNMP-custom** host template is used. -| Service Alias | Service Template | Service Description | Discovery | -|:---------------|:----------------------------------------|:---------------------------------------------|:----------:| -| Traffic-Global | Net-Cyberoam-Traffic-Global-SNMP-custom | Check traffic of multiple network interfaces | X | +| Service Alias | Service Template | Service Description | Discovery | +|:---------------|:----------------------------------------|:---------------------------------------------|:---------:| +| Traffic-Global | Net-Cyberoam-Traffic-Global-SNMP-custom | Check traffic of multiple network interfaces | X | +| Vpn-Status | Net-Cyberoam-Vpn-Status-SNMP-custom | Monitor virtual private networks | X | > The services listed above are not created automatically when a host template is applied. To use them, [create a service manually](/docs/monitoring/basic-objects/services), then apply the service template you want. @@ -52,9 +55,9 @@ The connector brings the following service templates (sorted by the host templat #### Host discovery -| Rule name | Description | -|:----------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------| -| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule | +| Rule name | Description | +|:----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **Net-Cyberoam-SNMP-custom** host template. | More information about discovering hosts automatically is available on the [dedicated page](/docs/monitoring/discovery/hosts-discovery). @@ -63,6 +66,7 @@ More information about discovering hosts automatically is available on the [dedi | Rule name | Description | |:-------------------------------|:--------------------------------------------------------------| | Net-Cyberoam-SNMP-Traffic-Name | Discover network interfaces and monitor bandwidth utilization | +| Net-Cyberoam-SNMP-Vpn-Name | Discover virtual private networks and monitor state | More information about discovering services automatically is available on the [dedicated page](/docs/monitoring/discovery/services-discovery) and in the [following chapter](/docs/monitoring/discovery/services-discovery/#discovery-rules). @@ -87,6 +91,23 @@ Here is the list of services for this connector, detailing all metrics and statu > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. + + + +| Name | Unit | +|:-------|:------| +| status | N/A | + +> To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. + + + + +| Name | Unit | +|:-----------------------------------|:------| +| status | N/A | +| *licenses*#license.expires.seconds | s | + @@ -121,14 +142,24 @@ Here is the list of services for this connector, detailing all metrics and statu -| Name | Unit | -|:------------------------------------------------------|:------| -| status | N/A | -| status | N/A | -| *interface_name1*#interface.traffic.in.bitspersecond | b/s | -| *interface_name2*#interface.traffic.in.bitspersecond | b/s | -| *interface_name1*#interface.traffic.out.bitspersecond | b/s | -| *interface_name2*#interface.traffic.out.bitspersecond | b/s | +| Name | Unit | +|:-----------------------------------------------------|:------| +| status | N/A | +| *interface_name*#interface.traffic.in.bitspersecond | b/s | +| *interface_name*#interface.traffic.out.bitspersecond | b/s | + + + + +| Name | Unit | +|:--------------------------|:------| +| vpn.total.count | count | +| vpn.inactive.count | count | +| vpn.active.count | count | +| vpn.partiallyactive.count | count | +| status | N/A | + +> To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. @@ -137,12 +168,14 @@ Here is the list of services for this connector, detailing all metrics and statu ### SNMP Configuration -The SNMP service must be configured and activated on the host. Please refer to the official documentation from the manufacturer/publisher. +The SNMP agent must be enabled and configured on the resource. +Please refer to the official documentation from the manufacturer/publisher. +Your resource may require a list of addresses authorized to query it to be set up. +Please ensure that the addresses of the Centreon pollers are included in this list. ### Network flow -The target resource must be reachable from the Centreon poller on the UDP/161 -SNMP port. +The target resource must be reachable from the Centreon poller on the UDP/161 SNMP port. ## Installing the monitoring connector @@ -169,7 +202,7 @@ dnf install centreon-pack-network-cyberoam-snmp ``` - + ```bash apt install centreon-pack-network-cyberoam-snmp @@ -185,7 +218,7 @@ yum install centreon-pack-network-cyberoam-snmp -2. Whatever the license type (*online* or *offline*), install the **Cyberoam** connector through +2. Whatever the license type (*online* or *offline*), install the **Cyberoam SNMP** connector through the **Configuration > Monitoring Connector Manager** menu. ### Plugin @@ -216,7 +249,7 @@ dnf install centreon-plugin-Network-Cyberoam-Snmp ``` - + ```bash apt install centreon-plugin-network-cyberoam-snmp @@ -243,9 +276,9 @@ yum install centreon-plugin-Network-Cyberoam-Snmp > When using SNMP v3, use the **SNMPEXTRAOPTIONS** macro to add specific authentication parameters. > More information in the [Troubleshooting SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#snmpv3-options-mapping) section. -| Macro | Description | Default value | Mandatory | -|:-----------------|:-----------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:-----------------|:------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a ---verbose flag for example). All options are listed [here](#available-options). | | | 4. [Deploy the configuration](/docs/monitoring/monitoring-servers/deploying-a-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. @@ -272,6 +305,27 @@ yum install centreon-plugin-Network-Cyberoam-Snmp | CRITICALUSAGE | Critical threshold (in percent) | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | + + + +| Macro | Description | Default value | Mandatory | +|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------|:-----------:| +| WARNINGSTATUS | Trigger warning on %\{hastatus\} or %\{hastate\} or %\{peer\_hastate\} values | | | +| CRITICALSTATUS | Trigger critical on %\{hastatus\} or %\{hastate\} or %\{peer\_hastate\} values. (default: '%\{hastatus\} =~ /^enabled$/ && %\{hastate\} =~ /^faulty$/') | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --no-ha-status='UNKNOWN' | | + + + + +| Macro | Description | Default value | Mandatory | +|:----------------|:------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------------|:-----------:| +| FILTERNAME | Filter licenses by name (can be a regexp) | | | +| WARNINGEXPIRES | Threshold. Example: C\<--unit=w --warning-expires=2:\> will result in a WARNING state when one of the licenses expires in less than two weeks | | | +| CRITICALEXPIRES | Threshold. Example: C\<--unit=w --critical-expires=2:\> will result in a CRITICAL state when one of the licenses expires in less than two weeks | | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{name\}, %\{status\} | %\{status\} =~ /expired/i | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{name\}, %\{status\} | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | + @@ -313,15 +367,36 @@ yum install centreon-plugin-Network-Cyberoam-Snmp -| Macro | Description | Default value | Mandatory | -|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| FILTER | Define the interface filter on IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | .* | | -| WARNINGIN | Threshold | 80 | | -| CRITICALIN | Threshold | 90 | | -| WARNINGOUT | Threshold | 80 | | -| CRITICALOUT | Threshold | 90 | | +| Macro | Description | Default value | Mandatory | +|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| FILTER | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | .* | | +| WARNINGIN | Threshold | 80 | | +| CRITICALIN | Threshold | 90 | | +| WARNINGOUT | Threshold | 80 | | +| CRITICALOUT | Threshold | 90 | | | CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | + + + + +| Macro | Description | Default value | Mandatory | +|:-----------------------------|:---------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------|:-----------:| +| FILTERCOUNTER | Only display some counters (regexp can be used). Example: --filter-counters='^total$\ |^total-normal$' | | | +| FILTERNAME | Filter VPN name (can be a regexp) | | | +| FILTERVPNACTIVATED | Filter by the activation status of the VPN (can be a regexp). Values: active, inactive | | | +| FILTERCONNECTIONMODE | Filter by the connection mode of the VPN (can be a regexp) | | | +| WARNINGSTATUS | Trigger warning on %\{connection\_status\} values. | %\{connection\_status\} =~ /partiallyActive/ | | +| CRITICALSTATUS | Trigger critical on %\{connection\_status\} values. | %\{connection\_status\} =~ /inactive/ | | +| WARNINGTOTAL | Thresholds | | | +| CRITICALTOTAL | Thresholds | | | +| WARNINGTOTALACTIVE | Thresholds | | | +| CRITICALTOTALACTIVE | Thresholds | | | +| WARNINGTOTALINACTIVE | Thresholds | | | +| CRITICALTOTALINACTIVE | Thresholds | | | +| WARNINGTOTALPARTIALLYACTIVE | Thresholds | | | +| CRITICALTOTALPARTIALLYACTIVE | Thresholds | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | @@ -357,6 +432,7 @@ The expected command output is shown below: ```bash OK: All interfaces are ok | 'interface_name1#interface.traffic.in.bitspersecond'=20b/s;80;90;; 'interface_name2#interface.traffic.in.bitspersecond'=20b/s;80;90;; 'interface_name1#interface.traffic.out.bitspersecond'=20b/s;80;90;; 'interface_name2#interface.traffic.out.bitspersecond'=20b/s;80;90;; + ``` ### Troubleshooting @@ -385,12 +461,16 @@ The plugin brings the following modes: | Mode | Linked service template | |:-----------------------------------------------------------------------------------------------------------------------------|:----------------------------------------| | cpu [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/cyberoam/snmp/mode/cpu.pm)] | Net-Cyberoam-Cpu-SNMP-custom | +| ha-status [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/cyberoam/snmp/mode/hastatus.pm)] | Net-Cyberoam-Ha-Status-SNMP-custom | | interfaces [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/interfaces.pm)] | Net-Cyberoam-Traffic-Global-SNMP-custom | +| license [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/cyberoam/snmp/mode/license.pm)] | Net-Cyberoam-License-SNMP-custom | | list-interfaces [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/listinterfaces.pm)] | Used for service discovery | +| list-vpns [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/cyberoam/snmp/mode/listvpns.pm)] | Used for service discovery | | memory [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/cyberoam/snmp/mode/memory.pm)] | Net-Cyberoam-Memory-SNMP-custom | | requests [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/cyberoam/snmp/mode/requests.pm)] | Net-Cyberoam-Requests-SNMP-custom | | services [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/cyberoam/snmp/mode/services.pm)] | Net-Cyberoam-Services-SNMP-custom | | storage [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/cyberoam/snmp/mode/storage.pm)] | Net-Cyberoam-Disks-SNMP-custom | +| vpn-status [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/cyberoam/snmp/mode/vpnstatus.pm)] | Net-Cyberoam-Vpn-Status-SNMP-custom | ### Available options @@ -398,65 +478,66 @@ The plugin brings the following modes: All generic options are listed here: -| Option | Description | -|:-------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --mode | Define the mode in which you want the plugin to be executed (see --list-mode). | -| --dyn-mode | Specify a mode with the module's path (advanced). | -| --list-mode | List all available modes. | -| --mode-version | Check minimal version of mode. If not, unknown error. | -| --version | Return the version of the plugin. | -| --pass-manager | Define the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass. | -| --hostname | Name or address of the host to monitor (mandatory). | -| --snmp-community | SNMP community (default value: public). It is recommended to use a read-only community. | -| --snmp-version | Version of the SNMP protocol. 1 for SNMP v1 (default), 2 for SNMP v2c, 3 for SNMP v3. | -| --snmp-port | UDP port to send the SNMP request to (default: 161). | -| --snmp-timeout | Time to wait before sending the request again if no reply has been received, in seconds (default: 1). See also --snmp-retries. | -| --snmp-retries | Maximum number of retries (default: 5). | -| --maxrepetitions | Max repetitions value (default: 50) (only for SNMP v2 and v3). | -| --subsetleef | How many OID values per SNMP request (default: 50) (for get\_leef method. Be cautious when you set it. Prefer to let the default value). | -| --snmp-autoreduce | Progressively reduce the number of requested OIDs in bulk mode. Use it in case of SNMP errors (by default, the number is divided by 2). | -| --snmp-force-getnext | Use SNMP getnext function in SNMP v2c and v3. This will request one OID at a time. | -| --snmp-cache-file | Use SNMP cache file. | -| --snmp-username | SNMP v3 only: User name (securityName). | -| --authpassphrase | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option. | -| --authprotocol | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512. | -| --privpassphrase | SNMP v3 only: Privacy pass phrase (privPassword) to encrypt messages using the protocol defined in the --privprotocol option. | -| --privprotocol | SNMP v3 only: Privacy protocol (privProtocol) used to encrypt messages. Supported protocols are: DES\|AES and since net-snmp 5.9.1: AES192\|AES192C\|AES256\|AES256C. | -| --contextname | SNMP v3 only: Context name (contextName), if relevant for the monitored host. | -| --contextengineid | SNMP v3 only: Context engine ID (contextEngineID), if relevant for the monitored host, given as a hexadecimal string. | -| --securityengineid | SNMP v3 only: Security engine ID, given as a hexadecimal string. | -| --snmp-errors-exit | Expected status in case of SNMP error or timeout. Possible values are warning, critical and unknown (default). | -| --snmp-tls-transport | Transport protocol for TLS communication (can be: 'dtlsudp', 'tlstcp'). | -| --snmp-tls-our-identity | X.509 certificate to identify ourselves. Can be the path to the certificate file or its contents. | -| --snmp-tls-their-identity | X.509 certificate to identify the remote host. Can be the path to the certificate file or its contents. This option is unnecessary if the certificate is already trusted by your system. | -| --snmp-tls-their-hostname | Common Name (CN) expected in the certificate sent by the host if it differs from the value of the --hostname parameter. | -| --snmp-tls-trust-cert | A trusted CA certificate used to verify a remote host's certificate. If you use this option, you must also define --snmp-tls-their-hostname. | -| --verbose | Display extended status information (long output). | -| --debug | Display debug messages. | -| --filter-perfdata | Filter perfdata that match the regexp. Example: adding --filter-perfdata='avg' will remove all metrics that do not contain 'avg' from performance data. | -| --filter-perfdata-adv | Filter 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-max | Create 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-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[newuom\],\[min\],\[max\]\] Common examples: =over 4 Convert 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()' =back | -| --change-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[newuom\],\[min\],\[max\]\] Common examples: =over 4 Convert 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()' =back | -| --extend-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[newuom\],\[min\],\[max\]\] Common examples: =over 4 Convert 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()' =back | -| --extend-perfdata-group | Add 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,namesofnewmetrics,calculation\[,\[newuom\],\[min\],\[max\]\] regex: regular expression namesofnewmetrics: 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 newuom (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: =over 4 Sum 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)' =back | -| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-exit | Replace 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. | -| --range-perfdata | Rewrite 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-uom | Mask the units when they don't match the given regular expression. | -| --opt-exit | Replace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown. | -| --output-ignore-perfdata | Remove all the metrics from the service. The service will still have a status and an output. | -| --output-ignore-label | Remove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Example: 'OK: Ram Total:...' will become 'Ram Total:...' | -| --output-xml | Return the output in XML format (to send to an XML API). | -| --output-json | Return the output in JSON format (to send to a JSON API). | -| --output-openmetrics | Return the output in OpenMetrics format (to send to a tool expecting this format). | -| --output-file | Write output in file (can be combined with json, xml and openmetrics options). E.g.: --output-file=/tmp/output.txt will write the output in /tmp/output.txt. | -| --disco-format | Applies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML). | -| --disco-show | Applies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery. | -| --float-precision | Define the float precision for thresholds (default: 8). | -| --source-encoding | Define the character encoding of the response sent by the monitored resource Default: 'UTF-8'. =head1 DESCRIPTION B\. =cut | +| Option | Description | +|:-------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --mode | Define the mode in which you want the plugin to be executed (see --list-mode). | +| --dyn-mode | Specify a mode with the module's path (advanced). | +| --list-mode | List all available modes. | +| --mode-version | Check minimal version of mode. If not, unknown error. | +| --version | Return the version of the plugin. | +| --pass-manager | Define the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass. | +| --hostname | Name or address of the host to monitor (mandatory). | +| --snmp-community | SNMP community (default value: public). It is recommended to use a read-only community. | +| --snmp-version | Version of the SNMP protocol. 1 for SNMP v1 (default), 2 for SNMP v2c, 3 for SNMP v3. | +| --snmp-port | UDP port to send the SNMP request to (default: 161). | +| --snmp-timeout | Time to wait before sending the request again if no reply has been received, in seconds (default: 1). See also --snmp-retries. | +| --snmp-retries | Maximum number of retries (default: 5). | +| --maxrepetitions | Max repetitions value (default: 50) (only for SNMP v2 and v3). | +| --subsetleef | How many OID values per SNMP request (default: 50) (for get\_leef method. Be cautious when you set it. Prefer to let the default value). | +| --snmp-autoreduce | Progressively reduce the number of requested OIDs in bulk mode. Use it in case of SNMP errors (by default, the number is divided by 2). | +| --snmp-force-getnext | Use SNMP getnext function in SNMP v2c and v3. This will request one OID at a time. | +| --snmp-cache-file | Use SNMP cache file. | +| --snmp-username | SNMP v3 only: User name (securityName). | +| --authpassphrase | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option. | +| --authprotocol | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512. | +| --privpassphrase | SNMP v3 only: Privacy pass phrase (privPassword) to encrypt messages using the protocol defined in the --privprotocol option. | +| --privprotocol | SNMP v3 only: Privacy protocol (privProtocol) used to encrypt messages. Supported protocols are: DES\|AES and since net-snmp 5.9.1: AES192\|AES192C\|AES256\|AES256C. | +| --contextname | SNMP v3 only: Context name (contextName), if relevant for the monitored host. | +| --contextengineid | SNMP v3 only: Context engine ID (contextEngineID), if relevant for the monitored host, given as a hexadecimal string. | +| --securityengineid | SNMP v3 only: Security engine ID, given as a hexadecimal string. | +| --snmp-errors-exit | Expected status in case of SNMP error or timeout. Possible values are warning, critical and unknown (default). | +| --snmp-tls-transport | Transport protocol for TLS communication (can be: 'dtlsudp', 'tlstcp'). | +| --snmp-tls-our-identity | X.509 certificate to identify ourselves. Can be the path to the certificate file or its contents. | +| --snmp-tls-their-identity | X.509 certificate to identify the remote host. Can be the path to the certificate file or its contents. This option is unnecessary if the certificate is already trusted by your system. | +| --snmp-tls-their-hostname | Common Name (CN) expected in the certificate sent by the host if it differs from the value of the --hostname parameter. | +| --snmp-tls-trust-cert | A trusted CA certificate used to verify a remote host's certificate. If you use this option, you must also define --snmp-tls-their-hostname. | +| --verbose | Display extended status information (long output). | +| --debug | Display debug messages. | +| --filter-perfdata | Filter perfdata that match the regexp. Example: adding --filter-perfdata='avg' will remove all metrics that do not contain 'avg' from performance data. | +| --filter-perfdata-adv | Filter 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-max | Create 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-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[\\],\[min\],\[max\]\] Common examples: =over 4 Convert 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()' =back | +| --change-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[\\],\[min\],\[max\]\] Common examples: =over 4 Convert 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()' =back | +| --extend-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[\\],\[min\],\[max\]\] Common examples: =over 4 Convert 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()' =back | +| --extend-perfdata-group | Add 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: =over 4 Sum 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)' =back | +| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-exit | Replace 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-adv | Replace 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-perfdata | Rewrite 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-uom | Mask the units when they don't match the given regular expression. | +| --opt-exit | Replace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown. | +| --output-ignore-perfdata | Remove all the metrics from the service. The service will still have a status and an output. | +| --output-ignore-label | Remove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Example: 'OK: Ram Total:...' will become 'Ram Total:...' | +| --output-xml | Return the output in XML format (to send to an XML API). | +| --output-json | Return the output in JSON format (to send to a JSON API). | +| --output-openmetrics | Return the output in OpenMetrics format (to send to a tool expecting this format). | +| --output-file | Write 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-format | Applies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML). | +| --disco-show | Applies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery. | +| --float-precision | Define the float precision for thresholds (default: 8). | +| --source-encoding | Define the character encoding of the response sent by the monitored resource Default: 'UTF-8'. =head1 DESCRIPTION B\. =cut | #### Modes options @@ -479,6 +560,29 @@ All available options for each service template are listed below: | --warning-usage | Warning threshold (in percent). | | --critical-usage | Critical threshold (in percent). | + + + +| Option | Description | +|:------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-status | Trigger warning on %\{hastatus\} or %\{hastate\} or %\{peer\_hastate\} values. | +| --critical-status | Trigger critical on %\{hastatus\} or %\{hastate\} or %\{peer\_hastate\} values. (default: '%\{hastatus\} =~ /^enabled$/ && %\{hastate\} =~ /^faulty$/'). | +| --no-ha-status | Status to return when HA not running or not installed (default: 'UNKNOWN'). | + + + + +| Option | Description | +|:-------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --filter-name | Filter licenses by name (can be a regexp). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{name\}, %\{status\}. | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} =~ /expired/i'). You can use the following variables: %\{name\}, %\{status\}. | +| --unit | Select the time unit for the expiration thresholds. May be 's' for seconds, 'm' for minutes, 'h' for hours, 'd' for days, 'w' for weeks. Default is seconds. | +| --warning-expires | Threshold. Example: C\<--unit=w --warning-expires=2:\> will result in a WARNING state when one of the licenses expires in less than two weeks. | +| --critical-expires | Threshold. Example: C\<--unit=w --critical-expires=2:\> will result in a CRITICAL state when one of the licenses expires in less than two weeks. | + @@ -520,7 +624,7 @@ All available options for each service template are listed below: | --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | | --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | | --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | +| --failback-file | Fall back on a local file if Redis connection fails. | | --memexpiration | Time to keep data in seconds (default: 86400). | | --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | | --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | @@ -536,15 +640,15 @@ All available options for each service template are listed below: | --add-cast | Check interface cast. | | --add-speed | Check interface speed. | | --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | | --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | | --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | | --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | | --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | -| --interface | Define the interface filter on IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | | --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | | --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | | --speed | Set interface speed for incoming/outgoing traffic (in Mb). | @@ -552,7 +656,7 @@ All available options for each service template are listed below: | --speed-out | Set interface speed for outgoing traffic (in Mb). | | --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | | --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32-bits counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | | --reload-cache-time | Time in minutes before reloading cache file (default: 180). | | --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | | --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | @@ -560,6 +664,27 @@ All available options for each service template are listed below: | --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | | --show-cache | Display cache interface data. | + + + +| Option | Description | +|:----------------------------------|:---------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^total$\|^total-normal$' | +| --filter-name | Filter VPN name (can be a regexp). | +| --filter-vpn-activated | Filter by the activation status of the VPN (can be a regexp). Values: active, inactive | +| --filter-connection-mode | Filter by the connection mode of the VPN (can be a regexp). | +| --connection-type | Filter by the connection type of the VPN (can be a regexp). Values: host-to-host, site-to-site, tunnel-interface | +| --warning-status | Trigger warning on %\{connection\_status\} values. (default: '%\{connection\_status\} =~ /partiallyActive/'). | +| --critical-status | Trigger critical on %\{connection\_status\} values. (default: '%\{connection\_status\} =~ /inactive/'). | +| --warning-total | Thresholds. | +| --critical-total | Thresholds. | +| --warning-total-inactive | Thresholds. | +| --critical-total-inactive | Thresholds. | +| --warning-total-partially-active | Thresholds. | +| --critical-total-partially-active | Thresholds. | +| --warning-total-active | Thresholds. | +| --critical-total-active | Thresholds. | +