From 39227fd5fb0ba1379d8fdf259d5c2b181628a3b4 Mon Sep 17 00:00:00 2001 From: Lucie Dubrunfaut <123162035+lucie-dubrunfaut@users.noreply.github.com> Date: Tue, 26 Nov 2024 14:57:08 +0100 Subject: [PATCH] CTOR-1104 : Fortinet-Fortimanager-Device-Status-SNMP : Add device-policy-package-status thresholds (#3830) CTOR-1104 --- .../network-fortinet-fortimanager-snmp.md | 292 +++++++++-------- .../network-fortinet-fortimanager-snmp.md | 300 ++++++++++-------- 2 files changed, 318 insertions(+), 274 deletions(-) diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-fortinet-fortimanager-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-fortinet-fortimanager-snmp.md index 1ebe99bb9417..c57a08810d6a 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-fortinet-fortimanager-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-fortinet-fortimanager-snmp.md @@ -1,15 +1,21 @@ --- id: network-fortinet-fortimanager-snmp -title: Fortinet Fortimanager +title: Fortinet Fortimanager 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 **Fortinet Fortimanager SNMP** +depuis la page **Configuration > Gestionnaire de connecteurs de supervision** : +* [Base Pack](./base-generic.md) + ## Contenu du pack ### Modèles -Le connecteur de supervision **Fortinet Fortimanager** apporte un modèle d'hôte : +Le connecteur de supervision **Fortinet Fortimanager SNMP** apporte un modèle d'hôte : * **Net-Fortinet-Fortimanager-SNMP-custom** @@ -21,9 +27,9 @@ Le connecteur apporte les modèles de service suivants | Alias | Modèle de service | Description | |:-------|:---------------------------------------------|:----------------------------------------------------| -| Cpu | Net-Fortinet-Fortimanager-Cpu-SNMP-custom | Contrôle du taux d'utilisation du CPU de la machine. | -| Disk | Net-Fortinet-Fortimanager-Disk-SNMP-custom | Contrôle l'utilisation disque. | -| Memory | Net-Fortinet-Fortimanager-Memory-SNMP-custom | Contrôle l'utilisation mémoire. | +| Cpu | Net-Fortinet-Fortimanager-Cpu-SNMP-custom | Contrôle du taux d'utilisation du CPU de la machine | +| Disk | Net-Fortinet-Fortimanager-Disk-SNMP-custom | Contrôle l'utilisation disque | +| Memory | Net-Fortinet-Fortimanager-Memory-SNMP-custom | Contrôle l'utilisation mémoire | > Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte **Net-Fortinet-Fortimanager-SNMP-custom** est utilisé. @@ -32,7 +38,7 @@ Le connecteur apporte les modèles de service suivants | Alias | Modèle de service | Description | |:--------------|:----------------------------------------------------|:--------------------------------------------| -| Device-Status | Net-Fortinet-Fortimanager-Device-Status-SNMP-custom | Contrôle le statut des équipements Fortinet. | +| Device-Status | Net-Fortinet-Fortimanager-Device-Status-SNMP-custom | Contrôle le statut des équipements Fortinet | > 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é. @@ -43,51 +49,51 @@ Le connecteur apporte les modèles de service suivants #### Découverte d'hôtes -| Nom de la règle | 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-Fortinet-Fortimanager-SNMP-custom** host template | +| 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-Fortinet-Fortimanager-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. ### Métriques & statuts collectés -Voici le tableau des services pour ce connecteur, détaillant les métriques rattachées à chaque service. +Voici le tableau des services pour ce connecteur, détaillant les métriques et statuts rattachés à chaque service. -| Métrique | Unité | -|:------------|:------| -| cpu | % | +| Nom | Unité | +|:-----|:------| +| cpu | % | -| Métrique | Unité | -|:--------------------------------------------------|:------| -| *devices*~device-status | N/A | -| *devices*~device-con-status | N/A | -| *devices*~device-db-status | N/A | -| *devices*~device-config-status | N/A | -| *devices*~*packages*#device-policy-package-status | N/A | +| Nom | Unité | +|:-----------------------------|:------| +| device-status | N/A | +| device-con-status | N/A | +| device-db-status | N/A | +| device-config-status | N/A | +| device-policy-package-status | N/A | > Pour obtenir ce nouveau format de métrique, incluez la valeur **--use-new-perfdata** dans la macro de service **EXTRAOPTIONS**. -| Métrique | Unité | -|:------------|:------| -| used | B | +| Nom | Unité | +|:-----|:------| +| used | B | > Pour obtenir ce nouveau format de métrique, incluez la valeur **--use-new-perfdata** dans la macro de service **EXTRAOPTIONS**. -| Métrique | Unité | -|:------------|:------| -| used | B | +| Nom | Unité | +|:-----|:------| +| used | B | > Pour obtenir ce nouveau format de métrique, incluez la valeur **--use-new-perfdata** dans la macro de service **EXTRAOPTIONS**. @@ -146,7 +152,7 @@ yum install centreon-pack-network-fortinet-fortimanager-snmp -2. Quel que soit le type de la licence (*online* ou *offline*), installez le connecteur **Fortinet Fortimanager** +2. Quel que soit le type de la licence (*online* ou *offline*), installez le connecteur **Fortinet Fortimanager SNMP** depuis l'interface web et le menu **Configuration > Gestionnaire de connecteurs de supervision**. ### Plugin @@ -202,8 +208,8 @@ yum install centreon-plugin-Network-Fortinet-Fortimanager-Snmp > Si vous utilisez SNMP en version 3, vous devez configurer les paramètres spécifiques associés via la macro **SNMPEXTRAOPTIONS**. > Plus d'informations dans la section [Troubleshooting SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#snmpv3-options-mapping). -| Macro | Description | Valeur par défaut | Obligatoire | -|:-----------------|:-----------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| Macro | Description | Valeur par défaut | Obligatoire | +|:-----------------|:---------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| | SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | 4. [Déployez la configuration](/docs/monitoring/monitoring-servers/deploying-a-configuration). L'hôte apparaît dans la liste des hôtes supervisés, et dans la page **Statut des ressources**. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros. @@ -216,44 +222,46 @@ yum install centreon-plugin-Network-Fortinet-Fortimanager-Snmp -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNING | Warning threshold | | | -| CRITICAL | Critical threshold | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNING | Warning threshold | | | +| CRITICAL | Critical threshold | | | | 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 | -|:---------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------|:---------------------|:-----------:| -| FILTERNAME | Filter by device name (can be a regexp) | | | -| WARNINGDEVICECONFIGSTATUS | Set warning threshold for device configuration status. You can use the following variables: %{status}, %{name} | | | -| CRITICALDEVICECONFIGSTATUS | Set critical threshold for device configuration status. You can use the following variables: %{status}, %{name} | | | -| CRITICALDEVICECONSTATUS | Set critical threshold for device connection status (default: '%{status} =~ /down/i'). You can use the following variables: %{status}, %{name} | %{status} =~ /down/i | | -| WARNINGDEVICECONSTATUS | Set warning threshold for device connection status. You can use the following variables: %{status}, %{name} | | | -| WARNINGDEVICEDBSTATUS | Set warning threshold for device DB status. You can use the following variables: %{status}, %{name} | | | -| CRITICALDEVICEDBSTATUS | Set critical threshold for device DB status. You can use the following variables: %{status}, %{name} | | | -| WARNINGDEVICESTATUS | Set warning threshold for device status. You can use the following variables: %{status}, %{name} | | | -| CRITICALDEVICESTATUS | Set critical threshold for device status You can use the following variables: %{status}, %{name} | | | -| 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 | +|:---------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:---------------------|:-----------:| +| FILTERNAME | Filter by device name (can be a regexp) | | | +| WARNINGDEVICECONFIGSTATUS | Set warning threshold for device configuration status. You can use the following variables: %{status}, %{name} | | | +| CRITICALDEVICECONFIGSTATUS | Set critical threshold for device configuration status. You can use the following variables: %{status}, %{name} | | | +| CRITICALDEVICECONSTATUS | Set critical threshold for device connection status. You can use the following variables: %{status}, %{name} | %{status} =~ /down/i | | +| WARNINGDEVICECONSTATUS | Set warning threshold for device connection status. You can use the following variables: %{status}, %{name} | | | +| WARNINGDEVICEDBSTATUS | Set warning threshold for device DB status. You can use the following variables: %{status}, %{name} | | | +| CRITICALDEVICEDBSTATUS | Set critical threshold for device DB status. You can use the following variables: %{status}, %{name} | | | +| WARNINGDEVICEPOLICYSTATUS | Set warning threshold for device policy package status. You can use the following variables: %{status}, %{package\_name} | | | +| CRITICALDEVICEPOLICYSTATUS | Set critical threshold for device policy package status. You can use the following variables: %{status}, %{package\_name} | | | +| WARNINGDEVICESTATUS | Set warning threshold for device status. You can use the following variables: %{status}, %{name} | | | +| CRITICALDEVICESTATUS | Set critical threshold for device status You can use the following variables: %{status}, %{name} | | | +| 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 | -|:--------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGUSAGE | Warning threshold (in percent) | | | -| CRITICALUSAGE | Critical threshold (in percent) | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:--------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNINGUSAGE | Warning threshold (in percent) | | | +| 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 | -|:--------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGUSAGE | Warning threshold (in percent) | | | -| CRITICALUSAGE | Critical threshold (in percent) | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:--------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNINGUSAGE | Warning threshold (in percent) | | | +| 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). | | | @@ -285,13 +293,20 @@ telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) : --critical-device-db-status='' \ --warning-device-config-status='' \ --critical-device-config-status='' \ + --warning-device-policy-package-status='' \ + --critical-device-policy-package-status='' \ --verbose ``` La commande devrait retourner un message de sortie similaire à : ```bash -OK: policy packages are ok +OK: Device 'Device Ent Name' status: installed - connection status: up - db status: modified - configuration status: in-sync +checking device 'Device Ent Name' + status: installed + connection status: up + db status: modified + configuration status: in-sync ``` ### Diagnostic des erreurs communes @@ -301,7 +316,7 @@ pour le diagnostic des erreurs communes des plugins Centreon. ### Modes disponibles -Dans la plupart des cas, un mode correspond à un modèle de service. Le mode est renseigné dans la commande d'exécution +Dans la plupart des cas, un mode correspond à un modèle de service. Le mode est renseigné dans la commande d'exécution du connecteur. Dans l'interface de Centreon, il n'est pas nécessaire de les spécifier explicitement, leur utilisation est implicite dès lors que vous utilisez un modèle de service. En revanche, vous devrez spécifier le mode correspondant à ce modèle si vous voulez tester la commande d'exécution du connecteur dans votre terminal. @@ -330,61 +345,65 @@ 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. | -| --verbose | Display extended status information (long output). | -| --debug | Display debug messages. | -| --filter-perfdata | Keep only 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 an "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\],\[m ax\]\] Common examples: 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() | -| --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\[,\[ne wuom\],\[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: 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(traf fic\_(in\|out)\_$1)' | -| --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-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'. | -| --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. | +| 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 | #### Options des modes @@ -393,43 +412,46 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous -| Option | Description | -|:-----------|:-----------------------| -| --warning | Warning threshold. | -| --critical | Critical threshold. | +| Option | Description | +|:-----------|:-----------------------------| +| --warning | Warning threshold. | +| --critical | Critical threshold. | -| Option | Description | -|:----------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-name | Filter by device name (can be a regexp). | -| --warning-device-status | Set warning threshold for device status. You can use the following variables: %{status}, %{name} | -| --critical-device-status | Set critical threshold for device status. You can use the following variables: %{status}, %{name} | -| --warning-device-con-status | Set warning threshold for device connection status. You can use the following variables: %{status}, %{name} | -| --critical-device-con-status | Set critical threshold for device connection status (default: '%{status} =~ /down/i'). You can use the following variables: %{status}, %{name} | -| --warning-device-db-status | Set warning threshold for device DB status. You can use the following variables: %{status}, %{name} | -| --critical-device-db-status | Set critical threshold for device DB status. You can use the following variables: %{status}, %{name} | -| --warning-device-config-status | Set warning threshold for device configuration status. You can use the following variables: %{status}, %{name} | -| --critical-device-config-status | Set critical threshold for device configuration status. You can use the following variables: %{status}, %{name} | -| --warning-device-policy-package-status | Set warning threshold for device policy package status. You can use the following variables: %{status}, %{package\_name} | -| --critical-device-policy-package-status | Set critical threshold for device policy package status. You can use the following variables: %{status}, %{package\_name} | +| 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 by device name (can be a regexp). | +| --warning-device-status | Set warning threshold for device status. You can use the following variables: %{status}, %{name} | +| --critical-device-status | Set critical threshold for device status You can use the following variables: %{status}, %{name} | +| --warning-device-con-status | Set warning threshold for device connection status. You can use the following variables: %{status}, %{name} | +| --critical-device-con-status | Set critical threshold for device connection status (default: '%{status} =~ /down/i'). You can use the following variables: %{status}, %{name} | +| --warning-device-db-status | Set warning threshold for device DB status. You can use the following variables: %{status}, %{name} | +| --critical-device-db-status | Set critical threshold for device DB status. You can use the following variables: %{status}, %{name} | +| --warning-device-config-status | Set warning threshold for device configuration status. You can use the following variables: %{status}, %{name} | +| --critical-device-config-status | Set critical threshold for device configuration status. You can use the following variables: %{status}, %{name} | +| --warning-device-policy-package-status | Set warning threshold for device policy package status. You can use the following variables: %{status}, %{package\_name} | +| --critical-device-policy-package-status | Set critical threshold for device policy package status. You can use the following variables: %{status}, %{package\_name} | -| Option | Description | -|:-----------------|:------------------------------------| -| --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-usage | Warning threshold (in percent). | +| --critical-usage | Critical threshold (in percent). | -| Option | Description | -|:-----------------|:------------------------------------| -| --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-usage | Warning threshold (in percent). | +| --critical-usage | Critical threshold (in percent). | diff --git a/pp/integrations/plugin-packs/procedures/network-fortinet-fortimanager-snmp.md b/pp/integrations/plugin-packs/procedures/network-fortinet-fortimanager-snmp.md index 34b89451279a..0a6379e879a1 100644 --- a/pp/integrations/plugin-packs/procedures/network-fortinet-fortimanager-snmp.md +++ b/pp/integrations/plugin-packs/procedures/network-fortinet-fortimanager-snmp.md @@ -1,15 +1,21 @@ --- id: network-fortinet-fortimanager-snmp -title: Fortinet Fortimanager +title: Fortinet Fortimanager SNMP --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +## Connector dependencies + +The following monitoring connectors will be installed when you install the **Fortinet Fortimanager SNMP** connector through the +**Configuration > Monitoring Connector Manager** menu: +* [Base Pack](./base-generic.md) + ## Pack assets ### Templates -The Monitoring Connector **Fortinet Fortimanager** brings a host template: +The Monitoring Connector **Fortinet Fortimanager SNMP** brings a host template: * **Net-Fortinet-Fortimanager-SNMP-custom** @@ -20,9 +26,9 @@ The connector brings the following service templates (sorted by the host templat | Service Alias | Service Template | Service Description | |:--------------|:---------------------------------------------|:-----------------------------------------------------| -| Cpu | Net-Fortinet-Fortimanager-Cpu-SNMP-custom | Check the rate of utilization of CPU for the machine. | -| Disk | Net-Fortinet-Fortimanager-Disk-SNMP-custom | Check disk usage. | -| Memory | Net-Fortinet-Fortimanager-Memory-SNMP-custom | Check memory usage. | +| Cpu | Net-Fortinet-Fortimanager-Cpu-SNMP-custom | Check the rate of CPU utilization for the machine | +| Disk | Net-Fortinet-Fortimanager-Disk-SNMP-custom | Check disk usage | +| Memory | Net-Fortinet-Fortimanager-Memory-SNMP-custom | Check memory usage | > The services listed above are created automatically when the **Net-Fortinet-Fortimanager-SNMP-custom** host template is used. @@ -31,7 +37,7 @@ The connector brings the following service templates (sorted by the host templat | Service Alias | Service Template | Service Description | |:--------------|:----------------------------------------------------|:-----------------------------| -| Device-Status | Net-Fortinet-Fortimanager-Device-Status-SNMP-custom | Check Fortinet device status. | +| Device-Status | Net-Fortinet-Fortimanager-Device-Status-SNMP-custom | Check Fortinet device status | > 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. @@ -42,51 +48,51 @@ 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 and create a template mapper for the **Net-Fortinet-Fortimanager-SNMP-custom** host template | +| 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-Fortinet-Fortimanager-SNMP-custom** host template. | More information about discovering hosts automatically is available on the [dedicated page](/docs/monitoring/discovery/hosts-discovery). ### Collected metrics & status -Here is the list of services for this connector, detailing all metrics linked to each service. +Here is the list of services for this connector, detailing all metrics and statuses linked to each service. -| Metric name | Unit | -|:------------|:------| -| cpu | % | +| Name | Unit | +|:-----|:------| +| cpu | % | -| Metric name | Unit | -|:--------------------------------------------------|:------| -| *devices*~device-status | N/A | -| *devices*~device-con-status | N/A | -| *devices*~device-db-status | N/A | -| *devices*~device-config-status | N/A | -| *devices*~*packages*#device-policy-package-status | N/A | +| Name | Unit | +|:-----------------------------|:------| +| device-status | N/A | +| device-con-status | N/A | +| device-db-status | N/A | +| device-config-status | N/A | +| device-policy-package-status | N/A | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. -| Metric name | Unit | -|:------------|:------| -| used | B | +| Name | Unit | +|:-----|:------| +| used | B | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. -| Metric name | Unit | -|:------------|:------| -| used | B | +| Name | Unit | +|:-----|:------| +| used | B | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. @@ -145,8 +151,8 @@ yum install centreon-pack-network-fortinet-fortimanager-snmp -2. Whatever the license type (*online* or *offline*), install the **Fortinet Fortimanager** connector through -the **Configuration > Monitoring Connectors Manager** menu. +2. Whatever the license type (*online* or *offline*), install the **Fortinet Fortimanager SNMP** connector through +the **Configuration > Monitoring Connector Manager** menu. ### Plugin @@ -197,14 +203,14 @@ yum install centreon-plugin-Network-Fortinet-Fortimanager-Snmp ### Using a host template provided by the connector 1. Log into Centreon and add a new host through **Configuration > Hosts**. -2. Fill the **Name**, **Alias** & **IP Address/DNS** fields according to your ressource settings. -3. Apply the **Net-Fortinet-Fortimanager-SNMP-custom** template to the host. +2. Fill in the **Name**, **Alias** & **IP Address/DNS** fields according to your resource's settings. +3. Apply the **Net-Fortinet-Fortimanager-SNMP-custom** template to the host. > 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 | -|:-----------------|:-----------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| 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. @@ -217,44 +223,46 @@ yum install centreon-plugin-Network-Fortinet-Fortimanager-Snmp -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNING | Warning threshold | | | -| CRITICAL | Critical threshold | | | +| Macro | Description | Default value | Mandatory | +|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNING | Warning threshold | | | +| CRITICAL | Critical threshold | | | | 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 | -|:---------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------|:---------------------|:-----------:| -| FILTERNAME | Filter by device name (can be a regexp) | | | -| WARNINGDEVICECONFIGSTATUS | Set warning threshold for device configuration status. You can use the following variables: %{status}, %{name} | | | -| CRITICALDEVICECONFIGSTATUS | Set critical threshold for device configuration status. You can use the following variables: %{status}, %{name} | | | -| CRITICALDEVICECONSTATUS | Set critical threshold for device connection status (default: '%{status} =~ /down/i'). You can use the following variables: %{status}, %{name} | %{status} =~ /down/i | | -| WARNINGDEVICECONSTATUS | Set warning threshold for device connection status. You can use the following variables: %{status}, %{name} | | | -| WARNINGDEVICEDBSTATUS | Set warning threshold for device DB status. You can use the following variables: %{status}, %{name} | | | -| CRITICALDEVICEDBSTATUS | Set critical threshold for device DB status. You can use the following variables: %{status}, %{name} | | | -| WARNINGDEVICESTATUS | Set warning threshold for device status. You can use the following variables: %{status}, %{name} | | | -| CRITICALDEVICESTATUS | Set critical threshold for device status You can use the following variables: %{status}, %{name} | | | -| 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 | +|:---------------------------|:---------------------------------------------------------------------------------------------------------------------------------------|:---------------------|:-----------:| +| FILTERNAME | Filter by device name (can be a regexp) | | | +| WARNINGDEVICECONFIGSTATUS | Set warning threshold for device configuration status. You can use the following variables: %{status}, %{name} | | | +| CRITICALDEVICECONFIGSTATUS | Set critical threshold for device configuration status. You can use the following variables: %{status}, %{name} | | | +| CRITICALDEVICECONSTATUS | Set critical threshold for device connection status. You can use the following variables: %{status}, %{name} | %{status} =~ /down/i | | +| WARNINGDEVICECONSTATUS | Set warning threshold for device connection status. You can use the following variables: %{status}, %{name} | | | +| WARNINGDEVICEDBSTATUS | Set warning threshold for device DB status. You can use the following variables: %{status}, %{name} | | | +| CRITICALDEVICEDBSTATUS | Set critical threshold for device DB status. You can use the following variables: %{status}, %{name} | | | +| WARNINGDEVICEPOLICYSTATUS | Set warning threshold for device policy package status. You can use the following variables: %{status}, %{package\_name} | | | +| CRITICALDEVICEPOLICYSTATUS | Set critical threshold for device policy package status. You can use the following variables: %{status}, %{package\_name} | | | +| WARNINGDEVICESTATUS | Set warning threshold for device status. You can use the following variables: %{status}, %{name} | | | +| CRITICALDEVICESTATUS | Set critical threshold for device status You can use the following variables: %{status}, %{name} | | | +| 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 | -|:--------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGUSAGE | Warning threshold (in percent) | | | -| CRITICALUSAGE | Critical threshold (in percent) | | | +| Macro | Description | Default value | Mandatory | +|:--------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNINGUSAGE | Warning threshold (in percent) | | | +| 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 | -|:--------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGUSAGE | Warning threshold (in percent) | | | -| CRITICALUSAGE | Critical threshold (in percent) | | | +| Macro | Description | Default value | Mandatory | +|:--------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNINGUSAGE | Warning threshold (in percent) | | | +| 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). | | | @@ -265,7 +273,7 @@ yum install centreon-plugin-Network-Fortinet-Fortimanager-Snmp ## How to check in the CLI that the configuration is OK and what are the main options for? Once the plugin is installed, log into your Centreon poller's CLI using the -**centreon-engine** user account (`su - centreon-engine`). Test that the connector +**centreon-engine** user account (`su - centreon-engine`). Test that the connector is able to monitor a resource using a command like this one (replace the sample values by yours): ```bash @@ -284,13 +292,20 @@ is able to monitor a resource using a command like this one (replace the sample --critical-device-db-status='' \ --warning-device-config-status='' \ --critical-device-config-status='' \ + --warning-device-policy-package-status='' \ + --critical-device-policy-package-status='' \ --verbose ``` The expected command output is shown below: ```bash -OK: policy packages are ok +OK: Device 'Device Ent Name' status: installed - connection status: up - db status: modified - configuration status: in-sync +checking device 'Device Ent Name' + status: installed + connection status: up + db status: modified + configuration status: in-sync ``` ### Troubleshooting @@ -302,7 +317,7 @@ for Centreon Plugins typical issues. In most cases, a mode corresponds to a service template. The mode appears in the execution command for the connector. In the Centreon interface, you don't need to specify a mode explicitly: its use is implied when you apply a service template. -However, you will need to specify the correct mode for the template if you want to test the execution command for the +However, you will need to specify the correct mode for the template if you want to test the execution command for the connector in your terminal. All available modes can be displayed by adding the `--list-mode` parameter to @@ -329,61 +344,65 @@ 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. | -| --verbose | Display extended status information (long output). | -| --debug | Display debug messages. | -| --filter-perfdata | Keep only 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 an "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\],\[m ax\]\] Common examples: 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() | -| --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\[,\[ne wuom\],\[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: 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(traf fic\_(in\|out)\_$1)' | -| --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-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'. | -| --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. | +| 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 | #### Modes options @@ -392,43 +411,46 @@ All available options for each service template are listed below: -| Option | Description | -|:-----------|:-----------------------| -| --warning | Warning threshold. | -| --critical | Critical threshold. | +| Option | Description | +|:-----------|:-----------------------------| +| --warning | Warning threshold. | +| --critical | Critical threshold. | -| Option | Description | -|:----------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-name | Filter by device name (can be a regexp). | -| --warning-device-status | Set warning threshold for device status. You can use the following variables: %{status}, %{name} | -| --critical-device-status | Set critical threshold for device status. You can use the following variables: %{status}, %{name} | -| --warning-device-con-status | Set warning threshold for device connection status. You can use the following variables: %{status}, %{name} | -| --critical-device-con-status | Set critical threshold for device connection status (default: '%{status} =~ /down/i'). You can use the following variables: %{status}, %{name} | -| --warning-device-db-status | Set warning threshold for device DB status. You can use the following variables: %{status}, %{name} | -| --critical-device-db-status | Set critical threshold for device DB status. You can use the following variables: %{status}, %{name} | -| --warning-device-config-status | Set warning threshold for device configuration status. You can use the following variables: %{status}, %{name} | -| --critical-device-config-status | Set critical threshold for device configuration status. You can use the following variables: %{status}, %{name} | -| --warning-device-policy-package-status | Set warning threshold for device policy package status. You can use the following variables: %{status}, %{package\_name} | -| --critical-device-policy-package-status | Set critical threshold for device policy package status. You can use the following variables: %{status}, %{package\_name} | +| 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 by device name (can be a regexp). | +| --warning-device-status | Set warning threshold for device status. You can use the following variables: %{status}, %{name} | +| --critical-device-status | Set critical threshold for device status You can use the following variables: %{status}, %{name} | +| --warning-device-con-status | Set warning threshold for device connection status. You can use the following variables: %{status}, %{name} | +| --critical-device-con-status | Set critical threshold for device connection status (default: '%{status} =~ /down/i'). You can use the following variables: %{status}, %{name} | +| --warning-device-db-status | Set warning threshold for device DB status. You can use the following variables: %{status}, %{name} | +| --critical-device-db-status | Set critical threshold for device DB status. You can use the following variables: %{status}, %{name} | +| --warning-device-config-status | Set warning threshold for device configuration status. You can use the following variables: %{status}, %{name} | +| --critical-device-config-status | Set critical threshold for device configuration status. You can use the following variables: %{status}, %{name} | +| --warning-device-policy-package-status | Set warning threshold for device policy package status. You can use the following variables: %{status}, %{package\_name} | +| --critical-device-policy-package-status | Set critical threshold for device policy package status. You can use the following variables: %{status}, %{package\_name} | -| Option | Description | -|:-----------------|:------------------------------------| -| --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-usage | Warning threshold (in percent). | +| --critical-usage | Critical threshold (in percent). | -| Option | Description | -|:-----------------|:------------------------------------| -| --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-usage | Warning threshold (in percent). | +| --critical-usage | Critical threshold (in percent). |