diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-storage-qnap-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-storage-qnap-snmp.md index 5a54bbdb8e47..93a8960e656f 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-storage-qnap-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-storage-qnap-snmp.md @@ -1,12 +1,26 @@ --- id: hardware-storage-qnap-snmp -title: Qnap +title: Qnap 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 **Qnap** +depuis la page **Configuration > Gestionnaire de connecteurs de supervision** : +* [Base Pack](./base-generic.md) + ## Contenu du pack +### Modèles d'équipement supportés + +* EKI utilisant le système d'opération QTS. + +### Modèles d'équipement non supportés + +* **Uniquement pour le service volume** : LAGMT utilisant le système d'opération QuTS hero (L'information "volume" n'est pas présente dans le fichier MIB du QuTS hero). + ### Modèles Le connecteur de supervision **Qnap** apporte un modèle d'hôte : @@ -50,31 +64,30 @@ 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 **HW-Storage-Qnap-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 **HW-Storage-Qnap-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 | -|:----------------------------------|:----------------------------------------------------------| -| HW-Storage-Qnap-SNMP-Disk-Name | Discover the disk partitions and monitor space occupation | -| HW-Storage-Qnap-SNMP-Disk-Name_1 | Discover the disk partitions and monitor space occupation | -| HW-Storage-Qnap-SNMP-Traffic-Name | Discover the disk partitions and monitor space occupation | +| Nom de la règle | Description | +|:----------------------------------|:---------------------------------------------------------------------------| +| HW-Storage-Qnap-SNMP-Disk-Name | Découvre les partitions du disque et supervise l'occupation de son espace | +| HW-Storage-Qnap-SNMP-Traffic-Name | Découvre les interfaces réseau et en supervise le statut et l'utilisation | 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 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é | +| Nom | Unité | |:-------------------------------------------|:------| | cpu.utilization.percentage | % | | *cpu_core*#core.cpu.utilization.percentage | % | @@ -84,7 +97,7 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat -| Métrique | Unité | +| Nom | Unité | |:--------------------------------------|:------| | storage.partitions.count | count | | *disk_name*#storage.space.usage.bytes | B | @@ -95,18 +108,18 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat -| Métrique | Unité | -|:-----------------------------------------|:-------| -| hardware.temperature.celsius | C | -| hardware.disk.temperature.celsius | C | -| hardware.mdisk.temperature.celsius | C | -| hardware.fan.speed.rpm | rpm | -| hardware.powersupply.fan.speed.rpm | N/A | +| Nom | Unité | +|:-----------------------------------|:------| +| hardware.temperature.celsius | C | +| hardware.disk.temperature.celsius | C | +| hardware.mdisk.temperature.celsius | C | +| hardware.fan.speed.rpm | rpm | +| hardware.powersupply.fan.speed.rpm | N/A | -| Métrique | Unité | +| Nom | Unité | |:------------------------|:------| | memory.usage.bytes | B | | memory.free.bytes | B | @@ -115,9 +128,9 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat -| Métrique | Unité | +| Nom | Unité | |:------------------------------------|:------| -| *pools*~pool-status | N/A | +| pool-status | N/A | | *pools*~pool.space.usage.bytes | B | | *pools*~pool.space.free.bytes | B | | *pools*~pool.space.usage.percentage | % | @@ -125,9 +138,9 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat -| Métrique | Unité | +| Nom | Unité | |:-----------------------------------------------------|:------| -| *interface_name*#status | N/A | +| status | N/A | | *interface_name*#interface.traffic.in.bitspersecond | b/s | | *interface_name*#interface.traffic.out.bitspersecond | b/s | @@ -136,9 +149,9 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat -| Métrique | Unité | +| Nom | Unité | |:----------------------------------------|:------| -| *volumes*~volume-status | N/A | +| volume-status | N/A | | *volumes*~volume.space.usage.bytes | B | | *volumes*~volume.space.free.bytes | B | | *volumes*~volume.space.usage.percentage | % | @@ -182,7 +195,7 @@ dnf install centreon-pack-hardware-storage-qnap-snmp ``` - + ```bash apt install centreon-pack-hardware-storage-qnap-snmp @@ -227,7 +240,7 @@ dnf install centreon-plugin-Hardware-Storage-Qnap-Snmp ``` - + ```bash apt install centreon-plugin-hardware-storage-qnap-snmp @@ -254,8 +267,8 @@ yum install centreon-plugin-Hardware-Storage-Qnap-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. @@ -268,113 +281,113 @@ yum install centreon-plugin-Hardware-Storage-Qnap-Snmp -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNING | Warning threshold average CPU utilization | 80 | | -| CRITICAL | Critical threshold average CPU utilization | 90 | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNING | Warning threshold average CPU utilization | 80 | | +| CRITICAL | Critical threshold average CPU utilization | 90 | | | 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 | -|:-------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| FILTER | Set the storage (number expected) example: 1, 2,... (empty means 'check all storage') | .* | | -| TRANSFORMDST | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | | | -| TRANSFORMSRC | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | | | -| CRITICAL | Critical threshold | 90 | | -| WARNING | Warning threshold | 80 | | -| 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 | +|:-------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| FILTER | Set the storage (number expected) example: 1, 2,... (empty means 'check all storage') | .* | | +| TRANSFORMDST | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | | | +| TRANSFORMSRC | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | | | +| CRITICAL | Critical threshold | 90 | | +| WARNING | Warning threshold | 80 | | +| 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 | -|:-------------|:-------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check (default: '.*'). Can be: 'disk', 'fan', 'mdisk', 'psu', 'raid', 'temperature' | .* | | -| 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 | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| COMPONENT | Which component to check (default: '.*'). Can be: 'disk', 'fan', 'mdisk', 'psu', 'raid', 'temperature' | .* | | +| 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 | -|:------------------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGMEMORYUSAGE | Thresholds | | | -| CRITICALMEMORYUSAGE | Thresholds | | | -| WARNINGMEMORYUSAGEFREE | Thresholds | | | -| CRITICALMEMORYUSAGEFREE | Thresholds | | | -| WARNINGMEMORYUSAGEPRCT | Thresholds | | | -| CRITICALMEMORYUSAGEPRCT | Thresholds | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNINGMEMORYUSAGE | Threshold | | | +| CRITICALMEMORYUSAGE | Threshold | | | +| WARNINGMEMORYUSAGEFREE | Threshold | | | +| CRITICALMEMORYUSAGEFREE | Threshold | | | +| WARNINGMEMORYUSAGEPRCT | Threshold | | | +| CRITICALMEMORYUSAGEPRCT | 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 pools by name (can be a regexp) | | | -| WARNINGPOOLSTATUS | Define the conditions to match for the status to be WARNING (default: '%{status} =~ /degraded\|warning/i'). You can use the following variables: %{status}, %{name} | %{status} =~ /degraded\|warning/i | | -| CRITICALPOOLSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%{status} =~ /error\|critical/i'). You can use the following variables: %{status}, %{name} | %{status} =~ /error\|critical/i | | -| WARNINGSPACEUSAGE | Thresholds | | | -| CRITICALSPACEUSAGE | Thresholds | | | -| WARNINGSPACEUSAGEFREE | Thresholds | | | -| CRITICALSPACEUSAGEFREE | Thresholds | | | -| WARNINGSPACEUSAGEPRCT | Thresholds | | | -| CRITICALSPACEUSAGEPRCT | 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 | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-----------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------|:-----------:| +| FILTERNAME | Filter pools by name (can be a regexp) | | | +| WARNINGPOOLSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %{status}, %{name} | %{status} =~ /degraded\|warning/i | | +| CRITICALPOOLSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %{status}, %{name} | %{status} =~ /error\|critical/i | | +| WARNINGSPACEUSAGE | Threshold | | | +| CRITICALSPACEUSAGE | Threshold | | | +| WARNINGSPACEUSAGEFREE | Threshold | | | +| CRITICALSPACEUSAGEFREE | Threshold | | | +| WARNINGSPACEUSAGEPRCT | Threshold | | | +| CRITICALSPACEUSAGEPRCT | 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). | --verbose | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| INTERFACEID | 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 | | | -| CRITICALIN | Thresholds | 90 | | -| WARNINGIN | Thresholds | 80 | | -| CRITICALOUT | Thresholds | 90 | | -| WARNINGOUT | Thresholds | 80 | | -| 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 | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| INTERFACEID | 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 | | | +| CRITICALIN | Threshold | 90 | | +| WARNINGIN | Threshold | 80 | | +| CRITICALOUT | Threshold | 90 | | +| WARNINGOUT | Threshold | 80 | | +| 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 | -|:--------------|:------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| INTERFACENAME | 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 | | | -| CRITICALIN | Thresholds | 90 | | -| WARNINGIN | Thresholds | 80 | | -| CRITICALOUT | Thresholds | 90 | | -| WARNINGOUT | Thresholds | 80 | | -| 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 | +|:--------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| INTERFACENAME | 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 | | | +| CRITICALIN | Threshold | 90 | | +| WARNINGIN | Threshold | 80 | | +| CRITICALOUT | Threshold | 90 | | +| WARNINGOUT | Threshold | 80 | | +| 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 | |:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| 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 | .* | | -| CRITICALIN | Thresholds | 90 | | -| WARNINGIN | Thresholds | 80 | | -| CRITICALOUT | Thresholds | 90 | | -| WARNINGOUT | Thresholds | 80 | | +| 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 | .* | | +| CRITICALIN | Threshold | 90 | | +| WARNINGIN | Threshold | 80 | | +| CRITICALOUT | Threshold | 90 | | +| WARNINGOUT | Threshold | 80 | | | 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 | -|:-----------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------|:-----------:| -| FILTERNAME | Filter volumes by name (can be a regexp) | | | -| WARNINGSPACEUSAGE | Thresholds | | | -| CRITICALSPACEUSAGE | Thresholds | | | -| WARNINGSPACEUSAGEFREE | Thresholds | | | -| CRITICALSPACEUSAGEFREE | Thresholds | | | -| WARNINGSPACEUSAGEPRCT | Thresholds | | | -| CRITICALSPACEUSAGEPRCT | Thresholds | | | -| WARNINGVOLUMESTATUS | Define the conditions to match for the status to be WARNING (default: '%{status} =~ /degraded\|warning/i'). You can use the following variables: %{status}, %{name} | %{status} =~ /degraded\|warning/i | | -| CRITICALVOLUMESTATUS | Define the conditions to match for the status to be CRITICAL (default: '%{status} =~ /critical/i'). You can use the following variables: %{status}, %{name} | %{status} =~ /critical/i | | -| 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 volumes by name (can be a regexp) | | | +| WARNINGSPACEUSAGE | Threshold | | | +| CRITICALSPACEUSAGE | Threshold | | | +| WARNINGSPACEUSAGEFREE | Threshold | | | +| CRITICALSPACEUSAGEFREE | Threshold | | | +| WARNINGSPACEUSAGEPRCT | Threshold | | | +| CRITICALSPACEUSAGEPRCT | Threshold | | | +| WARNINGVOLUMESTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %{status}, %{name} | %{status} =~ /degraded\|warning/i | | +| CRITICALVOLUMESTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %{status}, %{name} | %{status} =~ /critical/i | | +| 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 | | @@ -421,7 +434,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. @@ -460,61 +473,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 | 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\],\[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 @@ -523,144 +540,152 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous -| Option | Description | -|:-------------------|:----------------------------------------------| -| --use-ucd | Use UCD mib for CPU average. | -| --warning-average | Warning threshold average CPU utilization. | -| --critical-average | Critical threshold average CPU utilization. | -| --warning-core | Warning thresholds for each CPU core | -| --critical-core | Critical thresholds for each CPU core | +| Option | Description | +|:-------------------|:------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --use-ucd | Use UCD mib for CPU average. | +| --warning-average | Warning threshold average CPU utilization. | +| --critical-average | Critical threshold average CPU utilization. | +| --warning-core | Warning thresholds for each CPU core | +| --critical-core | Critical thresholds for each CPU core | -| Option | Description | -|:------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --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. | -| --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: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --warning-usage | Warning threshold. | -| --critical-usage | Critical threshold. | -| --warning-access | Warning threshold. | -| --critical-access | Critical threshold. Check if storage is readOnly: --critical-access=readOnly | -| --add-access | Check storage access (readOnly, readWrite). | -| --units | Units of thresholds (default: '%') ('%', 'B'). | -| --free | Thresholds are on free space left. | -| --storage | Set the storage (number expected) example: 1, 2,... (empty means 'check all storage'). | -| --name | Allows to use storage name with option --storage instead ofstorage oid index. | -| --regexp | Allows to use regexp to filter storage (with option --name). | -| --regexp-insensitive | Allows to use regexp non case-sensitive (with --regexp). | -| --path-best-match | Allows to select best path mount point (with --name). | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Choose OID used to filter storage (default: hrStorageDescr) (values: hrStorageDescr, hrFSMountPoint). | -| --oid-display | Choose OID used to display storage (default: hrStorageDescr) (values: hrStorageDescr, hrFSMountPoint). | -| --display-transform-src --display-transform-dst | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | -| --show-cache | Display cache storage data. | -| --space-reservation | Some filesystem has space reserved (like ext4 for root). The value is in percent of total (default: none) (results like 'df' command). | -| --filter-duplicate | Filter duplicate storages (in used size and total size). | -| --filter-storage-type | Filter storage types with a regexp (default: '^(hrStorageFixedDisk\|hrStorageNetworkDisk\|hrFSBerkeleyFFS)$'). | +| Option | Description | +|:------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --memcached | Memcached server to use (only one server). | +| --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 | 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: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --warning-usage | Warning threshold. | +| --critical-usage | Critical threshold. | +| --warning-access | Warning threshold. | +| --critical-access | Critical threshold. Check if storage is readOnly: --critical-access=readOnly | +| --add-access | Check storage access (readOnly, readWrite). | +| --units | Units of thresholds (default: '%') ('%', 'B'). | +| --free | Thresholds are on free space left. | +| --storage | Set the storage (number expected) example: 1, 2,... (empty means 'check all storage'). | +| --name | Allows to use storage name with option --storage instead of storage oid index. | +| --regexp | Allows to use regexp to filter storage (with option --name). | +| --regexp-insensitive | Allows to use regexp non case-sensitive (with --regexp). | +| --path-best-match | Allows to select best path mount point (with --name). | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Choose OID used to filter storage (default: hrStorageDescr) (values: hrStorageDescr, hrFSMountPoint). | +| --oid-display | Choose OID used to display storage (default: hrStorageDescr) (values: hrStorageDescr, hrFSMountPoint). | +| --display-transform-src --display-transform-dst | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | +| --show-cache | Display cache storage data. | +| --space-reservation | Some filesystem has space reserved (like ext4 for root). The value is in percent of total (default: none) (results like 'df' command). | +| --filter-duplicate | Filter duplicate storages (in used size and total size). | +| --filter-storage-type | Filter storage types with a regexp (default: '^(hrStorageFixedDisk\|hrStorageNetworkDisk\|hrFSBerkeleyFFS)$'). | -| Option | Description | -|:---------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'disk', 'fan', 'mdisk', 'psu', 'raid', 'temperature'. | -| --filter | Exclude the items given as a comma-separated list (example: --filter=disk). You can also exclude items from specific instances: --filter=disk,1 | -| --absent-problem | Return an error if an entity is not 'present' (default is skipping) (comma separated list) Can be specific or global: --absent-problem=disk | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,status,regexp). Example: --threshold-overload='disk,CRITICAL,^(?!(ready)$)' | -| --warning | Set warning threshold for temperatures (syntax: type,regexp,threshold) Example: --warning='temperature,cpu,30' --warning='fan,.*,1500' | -| --critical | Set critical threshold for temperatures (syntax: type,regexp,threshold) Example: --critical='temperature,system,40' --critical='disk,.*,40' | +| Option | Description | +|:---------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --component | Which component to check (default: '.*'). Can be: 'disk', 'fan', 'mdisk', 'psu', 'raid', 'temperature'. | +| --filter | Exclude the items given as a comma-separated list (example: --filter=disk). You can also exclude items from specific instances: --filter=disk,1 | +| --absent-problem | Return an error if an entity is not 'present' (default is skipping) (comma separated list) Can be specific or global: --absent-problem=disk | +| --no-component | Define the expected status if no components are found (default: critical). | +| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,status,regexp). Example: --threshold-overload='disk,CRITICAL,^(?!(ready)$)' | +| --warning | Set warning threshold for temperatures (syntax: type,regexp,threshold) Example: --warning='temperature,cpu,30' --warning='fan,.*,1500' | +| --critical | Set critical threshold for temperatures (syntax: type,regexp,threshold) Example: --critical='temperature,system,40' --critical='disk,.*,40' | +| --warning-count-* | Define the warning threshold for the number of components of one type (replace '*' with the component type). | +| --critical-count-* | Define the critical threshold for the number of components of one type (replace '*' with the component type). | -| Option | Description | -|:-------------------------|:---------------------------------------------------------------------------------------------| -| --force-counters-legacy | Force to use legacy counters. Should be used when EX/ES/QTS counters are buggy. | -| --warning-* --critical-* | Thresholds. Can be: 'memory-usage' (B), 'memory-usage-free' (B), 'memory-usage-prct' (%). | +| Option | Description | +|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --force-counters-legacy | Force to use legacy counters. Should be used when EX/ES/QTS counters are buggy. | +| --warning-* --critical-* | Thresholds. Can be: 'memory-usage' (B), 'memory-usage-free' (B), 'memory-usage-prct' (%). | -| Option | Description | -|:-------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-name | Filter pools by name (can be a regexp). | -| --unknown-pool-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %{status}, %{name} | -| --warning-pool-status | Define the conditions to match for the status to be WARNING (default: '%{status} =~ /degraded\|warning/i'). You can use the following variables: %{status}, %{name} | -| --critical-pool-status | Define the conditions to match for the status to be CRITICAL (default: '%{status} =~ /error\|critical/i'). You can use the following variables: %{status}, %{name} | -| --warning-* --critical-* | Thresholds. Can be: 'space-usage-prct', 'space-usage', 'space-usage-free'. | +| 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 pools by name (can be a regexp). | +| --unknown-pool-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %{status}, %{name} | +| --warning-pool-status | Define the conditions to match for the status to be WARNING (default: '%{status} =~ /degraded\|warning/i'). You can use the following variables: %{status}, %{name} | +| --critical-pool-status | Define the conditions to match for the status to be CRITICAL (default: '%{status} =~ /error\|critical/i'). You can use the following variables: %{status}, %{name} | +| --warning-* --critical-* | Thresholds. Can be: 'space-usage-prct', 'space-usage', 'space-usage-free'. | -| Option | Description | -|:------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --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. | -| --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: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --add-global | Check global port statistics (by default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --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} | -| --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. | -| --name | With this option, the interfaces will be filtered by name (givenin 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). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --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. | -| --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). | -| --oid-extra-display | Add an OID to display. | -| --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 to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --memcached | Memcached server to use (only one server). | +| --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 | 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: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --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} | +| --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. | +| --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). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --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. | +| --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). | +| --oid-extra-display | Add an OID to display. | +| --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-name | Filter volumes by name (can be a regexp). | -| --force-counters-legacy | Force to use legacy counters. Should be used when EX/QTS counters are buggy. | -| --unknown-volume-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %{status}, %{name} | -| --warning-volume-status | Define the conditions to match for the status to be WARNING (default: '%{status} =~ /degraded\|warning/i'). You can use the following variables: %{status}, %{name} | -| --critical-volume-status | Define the conditions to match for the status to be CRITICAL (default: '%{status} =~ /critical/i'). You can use the following variables: %{status}, %{name} | -| --warning-* --critical-* | Thresholds. Can be: 'space-usage-prct', 'space-usage', 'space-usage-free'. | +| 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 volumes by name (can be a regexp). | +| --force-counters-legacy | Force to use legacy counters. Should be used when EX/QTS counters are buggy. | +| --unknown-volume-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %{status}, %{name} | +| --warning-volume-status | Define the conditions to match for the status to be WARNING (default: '%{status} =~ /degraded\|warning/i'). You can use the following variables: %{status}, %{name} | +| --critical-volume-status | Define the conditions to match for the status to be CRITICAL (default: '%{status} =~ /critical/i'). You can use the following variables: %{status}, %{name} | +| --warning-* --critical-* | Thresholds. Can be: 'space-usage-prct', 'space-usage', 'space-usage-free'. | diff --git a/pp/integrations/plugin-packs/procedures/hardware-storage-qnap-snmp.md b/pp/integrations/plugin-packs/procedures/hardware-storage-qnap-snmp.md index 711019cc6401..67a989b12ff2 100644 --- a/pp/integrations/plugin-packs/procedures/hardware-storage-qnap-snmp.md +++ b/pp/integrations/plugin-packs/procedures/hardware-storage-qnap-snmp.md @@ -1,12 +1,26 @@ --- id: hardware-storage-qnap-snmp -title: Qnap +title: Qnap SNMP --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +## Connector dependencies + +The following monitoring connectors will be installed when you install the **Qnap** connector through the +**Configuration > Monitoring Connector Manager** menu: +* [Base Pack](./base-generic.md) + ## Pack assets +### Supported equipment models + +* EKI using the QTS operating system. + +### Unsupported equipment models + +* **Only for volume service** : LAGMT using the QuTS hero operating system (The volume information isn't present in the QuTS hero MIB file). + ### Templates The Monitoring Connector **Qnap** brings a host template: @@ -49,31 +63,30 @@ 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 **HW-Storage-Qnap-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 **HW-Storage-Qnap-SNMP-custom** host template. | More information about discovering hosts automatically is available on the [dedicated page](/docs/monitoring/discovery/hosts-discovery). #### Service discovery -| Rule name | Description | -|:----------------------------------|:----------------------------------------------------------| -| HW-Storage-Qnap-SNMP-Disk-Name | Discover the disk partitions and monitor space occupation | -| HW-Storage-Qnap-SNMP-Disk-Name_1 | Discover the disk partitions and monitor space occupation | -| HW-Storage-Qnap-SNMP-Traffic-Name | Discover the disk partitions and monitor space occupation | +| Rule name | Description | +|:----------------------------------|:--------------------------------------------------------------| +| HW-Storage-Qnap-SNMP-Disk-Name | Discover the disk partitions and monitor space occupation | +| HW-Storage-Qnap-SNMP-Traffic-Name | Discover network interfaces and monitor bandwidth utilization | 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). ### 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 | +| Name | Unit | |:-------------------------------------------|:------| | cpu.utilization.percentage | % | | *cpu_core*#core.cpu.utilization.percentage | % | @@ -83,7 +96,7 @@ Here is the list of services for this connector, detailing all metrics linked to -| Metric name | Unit | +| Name | Unit | |:--------------------------------------|:------| | storage.partitions.count | count | | *disk_name*#storage.space.usage.bytes | B | @@ -94,18 +107,18 @@ Here is the list of services for this connector, detailing all metrics linked to -| Metric name | Unit | -|:-----------------------------------------|:-------| -| hardware.temperature.celsius | C | -| hardware.disk.temperature.celsius | C | -| hardware.mdisk.temperature.celsius | C | -| hardware.fan.speed.rpm | rpm | -| hardware.powersupply.fan.speed.rpm | N/A | +| Name | Unit | +|:-----------------------------------|:-----| +| hardware.temperature.celsius | C | +| hardware.disk.temperature.celsius | C | +| hardware.mdisk.temperature.celsius | C | +| hardware.fan.speed.rpm | rpm | +| hardware.powersupply.fan.speed.rpm | N/A | -| Metric name | Unit | +| Name | Unit | |:------------------------|:------| | memory.usage.bytes | B | | memory.free.bytes | B | @@ -114,9 +127,9 @@ Here is the list of services for this connector, detailing all metrics linked to -| Metric name | Unit | +| Name | Unit | |:------------------------------------|:------| -| *pools*~pool-status | N/A | +| pool-status | N/A | | *pools*~pool.space.usage.bytes | B | | *pools*~pool.space.free.bytes | B | | *pools*~pool.space.usage.percentage | % | @@ -124,9 +137,9 @@ Here is the list of services for this connector, detailing all metrics linked to -| Metric name | Unit | +| Name | Unit | |:-----------------------------------------------------|:------| -| *interface_name*#status | N/A | +| status | N/A | | *interface_name*#interface.traffic.in.bitspersecond | b/s | | *interface_name*#interface.traffic.out.bitspersecond | b/s | @@ -135,9 +148,9 @@ Here is the list of services for this connector, detailing all metrics linked to -| Metric name | Unit | +| Name | Unit | |:----------------------------------------|:------| -| *volumes*~volume-status | N/A | +| volume-status | N/A | | *volumes*~volume.space.usage.bytes | B | | *volumes*~volume.space.free.bytes | B | | *volumes*~volume.space.usage.percentage | % | @@ -181,7 +194,7 @@ dnf install centreon-pack-hardware-storage-qnap-snmp ``` - + ```bash apt install centreon-pack-hardware-storage-qnap-snmp @@ -228,7 +241,7 @@ dnf install centreon-plugin-Hardware-Storage-Qnap-Snmp ``` - + ```bash apt install centreon-plugin-hardware-storage-qnap-snmp @@ -250,13 +263,13 @@ yum install centreon-plugin-Hardware-Storage-Qnap-Snmp 1. Log into Centreon and add a new host through **Configuration > Hosts**. 2. Fill in the **Name**, **Alias** & **IP Address/DNS** fields according to your resource's settings. -3. Apply the **HW-Storage-Qnap-SNMP-custom** template to the host. +3. Apply the **HW-Storage-Qnap-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. @@ -269,113 +282,113 @@ yum install centreon-plugin-Hardware-Storage-Qnap-Snmp -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNING | Warning threshold average CPU utilization | 80 | | -| CRITICAL | Critical threshold average CPU utilization | 90 | | +| Macro | Description | Default value | Mandatory | +|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNING | Warning threshold average CPU utilization | 80 | | +| CRITICAL | Critical threshold for average CPU utilization | 90 | | | 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 | -|:-------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| FILTER | Set the storage (number expected) example: 1, 2,... (empty means 'check all storage') | .* | | +| Macro | Description | Default value | Mandatory | +|:-------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| FILTER | Set the storage (number expected) example: 1, 2,... (empty means 'check all storage') | .* | | | TRANSFORMDST | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | | | | TRANSFORMSRC | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | | | -| CRITICAL | Critical threshold | 90 | | -| WARNING | Warning threshold | 80 | | -| 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 | | +| CRITICAL | Critical threshold | 90 | | +| WARNING | Warning threshold | 80 | | +| 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 | -|:-------------|:-------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check (default: '.*'). Can be: 'disk', 'fan', 'mdisk', 'psu', 'raid', 'temperature' | .* | | -| 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 | +|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| COMPONENT | Which component to check (default: '.*'). Can be: 'disk', 'fan', 'mdisk', 'psu', 'raid', 'temperature' | .* | | +| 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 | -|:------------------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGMEMORYUSAGE | Thresholds | | | -| CRITICALMEMORYUSAGE | Thresholds | | | -| WARNINGMEMORYUSAGEFREE | Thresholds | | | -| CRITICALMEMORYUSAGEFREE | Thresholds | | | -| WARNINGMEMORYUSAGEPRCT | Thresholds | | | -| CRITICALMEMORYUSAGEPRCT | Thresholds | | | +| Macro | Description | Default value | Mandatory | +|:------------------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNINGMEMORYUSAGE | Threshold | | | +| CRITICALMEMORYUSAGE | Threshold | | | +| WARNINGMEMORYUSAGEFREE | Threshold | | | +| CRITICALMEMORYUSAGEFREE | Threshold | | | +| WARNINGMEMORYUSAGEPRCT | Threshold | | | +| CRITICALMEMORYUSAGEPRCT | 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 pools by name (can be a regexp) | | | -| WARNINGPOOLSTATUS | Define the conditions to match for the status to be WARNING (default: '%{status} =~ /degraded\|warning/i'). You can use the following variables: %{status}, %{name} | %{status} =~ /degraded\|warning/i | | -| CRITICALPOOLSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%{status} =~ /error\|critical/i'). You can use the following variables: %{status}, %{name} | %{status} =~ /error\|critical/i | | -| WARNINGSPACEUSAGE | Thresholds | | | -| CRITICALSPACEUSAGE | Thresholds | | | -| WARNINGSPACEUSAGEFREE | Thresholds | | | -| CRITICALSPACEUSAGEFREE | Thresholds | | | -| WARNINGSPACEUSAGEPRCT | Thresholds | | | -| CRITICALSPACEUSAGEPRCT | 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 | | +| Macro | Description | Default value | Mandatory | +|:-----------------------|:---------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------|:-----------:| +| FILTERNAME | Filter pools by name (can be a regexp) | | | +| WARNINGPOOLSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %{status}, %{name} | %{status} =~ /degraded\|warning/i | | +| CRITICALPOOLSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %{status}, %{name} | %{status} =~ /error\|critical/i | | +| WARNINGSPACEUSAGE | Threshold | | | +| CRITICALSPACEUSAGE | Threshold | | | +| WARNINGSPACEUSAGEFREE | Threshold | | | +| CRITICALSPACEUSAGEFREE | Threshold | | | +| WARNINGSPACEUSAGEPRCT | Threshold | | | +| CRITICALSPACEUSAGEPRCT | 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). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:-------------|:------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| Macro | Description | Default value | Mandatory | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| | INTERFACEID | 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 | | | -| CRITICALIN | Thresholds | 90 | | -| WARNINGIN | Thresholds | 80 | | -| CRITICALOUT | Thresholds | 90 | | -| WARNINGOUT | Thresholds | 80 | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| CRITICALIN | Threshold | 90 | | +| WARNINGIN | Threshold | 80 | | +| CRITICALOUT | Threshold | 90 | | +| WARNINGOUT | Threshold | 80 | | +| 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 | -|:--------------|:------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| Macro | Description | Default value | Mandatory | +|:--------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| | INTERFACENAME | 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 | | | -| CRITICALIN | Thresholds | 90 | | -| WARNINGIN | Thresholds | 80 | | -| CRITICALOUT | Thresholds | 90 | | -| WARNINGOUT | Thresholds | 80 | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| CRITICALIN | Threshold | 90 | | +| WARNINGIN | Threshold | 80 | | +| CRITICALOUT | Threshold | 90 | | +| WARNINGOUT | Threshold | 80 | | +| 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 | |:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| 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 | .* | | -| CRITICALIN | Thresholds | 90 | | -| WARNINGIN | Thresholds | 80 | | -| CRITICALOUT | Thresholds | 90 | | -| WARNINGOUT | Thresholds | 80 | | +| 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 | .* | | +| CRITICALIN | Threshold | 90 | | +| WARNINGIN | Threshold | 80 | | +| CRITICALOUT | Threshold | 90 | | +| WARNINGOUT | Threshold | 80 | | | 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 | -|:-----------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------|:-----------:| -| FILTERNAME | Filter volumes by name (can be a regexp) | | | -| WARNINGSPACEUSAGE | Thresholds | | | -| CRITICALSPACEUSAGE | Thresholds | | | -| WARNINGSPACEUSAGEFREE | Thresholds | | | -| CRITICALSPACEUSAGEFREE | Thresholds | | | -| WARNINGSPACEUSAGEPRCT | Thresholds | | | -| CRITICALSPACEUSAGEPRCT | Thresholds | | | -| WARNINGVOLUMESTATUS | Define the conditions to match for the status to be WARNING (default: '%{status} =~ /degraded\|warning/i'). You can use the following variables: %{status}, %{name} | %{status} =~ /degraded\|warning/i | | -| CRITICALVOLUMESTATUS | Define the conditions to match for the status to be CRITICAL (default: '%{status} =~ /critical/i'). You can use the following variables: %{status}, %{name} | %{status} =~ /critical/i | | -| 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 volumes by name (can be a regexp) | | | +| WARNINGSPACEUSAGE | Threshold | | | +| CRITICALSPACEUSAGE | Threshold | | | +| WARNINGSPACEUSAGEFREE | Threshold | | | +| CRITICALSPACEUSAGEFREE | Threshold | | | +| WARNINGSPACEUSAGEPRCT | Threshold | | | +| CRITICALSPACEUSAGEPRCT | Threshold | | | +| WARNINGVOLUMESTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %{status}, %{name} | %{status} =~ /degraded\|warning/i | | +| CRITICALVOLUMESTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %{status}, %{name} | %{status} =~ /critical/i | | +| 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 | | @@ -385,7 +398,7 @@ yum install centreon-plugin-Hardware-Storage-Qnap-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 @@ -422,7 +435,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 @@ -459,61 +472,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 | 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\],\[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 @@ -522,144 +539,152 @@ All available options for each service template are listed below: -| Option | Description | -|:-------------------|:----------------------------------------------| -| --use-ucd | Use UCD mib for CPU average. | -| --warning-average | Warning threshold average CPU utilization. | -| --critical-average | Critical threshold average CPU utilization. | -| --warning-core | Warning thresholds for each CPU core | -| --critical-core | Critical thresholds for each CPU core | +| Option | Description | +|:-------------------|:------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --use-ucd | Use UCD mib for CPU average. | +| --warning-average | Warning threshold average CPU utilization. | +| --critical-average | Critical threshold average CPU utilization. | +| --warning-core | Warning thresholds for each CPU core | +| --critical-core | Critical thresholds for each CPU core | -| Option | Description | -|:------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --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. | -| --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: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --warning-usage | Warning threshold. | -| --critical-usage | Critical threshold. | -| --warning-access | Warning threshold. | -| --critical-access | Critical threshold. Check if storage is readOnly: --critical-access=readOnly | -| --add-access | Check storage access (readOnly, readWrite). | -| --units | Units of thresholds (default: '%') ('%', 'B'). | -| --free | Thresholds are on free space left. | -| --storage | Set the storage (number expected) example: 1, 2,... (empty means 'check all storage'). | -| --name | Allows to use storage name with option --storage instead ofstorage oid index. | -| --regexp | Allows to use regexp to filter storage (with option --name). | -| --regexp-insensitive | Allows to use regexp non case-sensitive (with --regexp). | -| --path-best-match | Allows to select best path mount point (with --name). | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Choose OID used to filter storage (default: hrStorageDescr) (values: hrStorageDescr, hrFSMountPoint). | -| --oid-display | Choose OID used to display storage (default: hrStorageDescr) (values: hrStorageDescr, hrFSMountPoint). | -| --display-transform-src --display-transform-dst | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | -| --show-cache | Display cache storage data. | -| --space-reservation | Some filesystem has space reserved (like ext4 for root). The value is in percent of total (default: none) (results like 'df' command). | -| --filter-duplicate | Filter duplicate storages (in used size and total size). | -| --filter-storage-type | Filter storage types with a regexp (default: '^(hrStorageFixedDisk\|hrStorageNetworkDisk\|hrFSBerkeleyFFS)$'). | +| Option | Description | +|:------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --memcached | Memcached server to use (only one server). | +| --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 | 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: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --warning-usage | Warning threshold. | +| --critical-usage | Critical threshold. | +| --warning-access | Warning threshold. | +| --critical-access | Critical threshold. Check if storage is readOnly: --critical-access=readOnly | +| --add-access | Check storage access (readOnly, readWrite). | +| --units | Units of thresholds (default: '%') ('%', 'B'). | +| --free | Thresholds are on free space left. | +| --storage | Set the storage (number expected) example: 1, 2,... (empty means 'check all storage'). | +| --name | Allows to use storage name with option --storage instead of storage oid index. | +| --regexp | Allows to use regexp to filter storage (with option --name). | +| --regexp-insensitive | Allows to use regexp non case-sensitive (with --regexp). | +| --path-best-match | Allows to select best path mount point (with --name). | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Choose OID used to filter storage (default: hrStorageDescr) (values: hrStorageDescr, hrFSMountPoint). | +| --oid-display | Choose OID used to display storage (default: hrStorageDescr) (values: hrStorageDescr, hrFSMountPoint). | +| --display-transform-src --display-transform-dst | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | +| --show-cache | Display cache storage data. | +| --space-reservation | Some filesystem has space reserved (like ext4 for root). The value is in percent of total (default: none) (results like 'df' command). | +| --filter-duplicate | Filter duplicate storages (in used size and total size). | +| --filter-storage-type | Filter storage types with a regexp (default: '^(hrStorageFixedDisk\|hrStorageNetworkDisk\|hrFSBerkeleyFFS)$'). | -| Option | Description | -|:---------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'disk', 'fan', 'mdisk', 'psu', 'raid', 'temperature'. | -| --filter | Exclude the items given as a comma-separated list (example: --filter=disk). You can also exclude items from specific instances: --filter=disk,1 | -| --absent-problem | Return an error if an entity is not 'present' (default is skipping) (comma separated list) Can be specific or global: --absent-problem=disk | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,status,regexp). Example: --threshold-overload='disk,CRITICAL,^(?!(ready)$)' | -| --warning | Set warning threshold for temperatures (syntax: type,regexp,threshold) Example: --warning='temperature,cpu,30' --warning='fan,.*,1500' | -| --critical | Set critical threshold for temperatures (syntax: type,regexp,threshold) Example: --critical='temperature,system,40' --critical='disk,.*,40' | +| Option | Description | +|:---------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --component | Which component to check (default: '.*'). Can be: 'disk', 'fan', 'mdisk', 'psu', 'raid', 'temperature'. | +| --filter | Exclude the items given as a comma-separated list (example: --filter=disk). You can also exclude items from specific instances: --filter=disk,1 | +| --absent-problem | Return an error if an entity is not 'present' (default is skipping) (comma separated list) Can be specific or global: --absent-problem=disk | +| --no-component | Define the expected status if no components are found (default: critical). | +| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,status,regexp). Example: --threshold-overload='disk,CRITICAL,^(?!(ready)$)' | +| --warning | Set warning threshold for temperatures (syntax: type,regexp,threshold) Example: --warning='temperature,cpu,30' --warning='fan,.*,1500' | +| --critical | Set critical threshold for temperatures (syntax: type,regexp,threshold) Example: --critical='temperature,system,40' --critical='disk,.*,40' | +| --warning-count-* | Define the warning threshold for the number of components of one type (replace '*' with the component type). | +| --critical-count-* | Define the critical threshold for the number of components of one type (replace '*' with the component type). | -| Option | Description | -|:-------------------------|:---------------------------------------------------------------------------------------------| -| --force-counters-legacy | Force to use legacy counters. Should be used when EX/ES/QTS counters are buggy. | -| --warning-* --critical-* | Thresholds. Can be: 'memory-usage' (B), 'memory-usage-free' (B), 'memory-usage-prct' (%). | +| Option | Description | +|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --force-counters-legacy | Force to use legacy counters. Should be used when EX/ES/QTS counters are buggy. | +| --warning-* --critical-* | Thresholds. Can be: 'memory-usage' (B), 'memory-usage-free' (B), 'memory-usage-prct' (%). | -| Option | Description | -|:-------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-name | Filter pools by name (can be a regexp). | -| --unknown-pool-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %{status}, %{name} | -| --warning-pool-status | Define the conditions to match for the status to be WARNING (default: '%{status} =~ /degraded\|warning/i'). You can use the following variables: %{status}, %{name} | -| --critical-pool-status | Define the conditions to match for the status to be CRITICAL (default: '%{status} =~ /error\|critical/i'). You can use the following variables: %{status}, %{name} | -| --warning-* --critical-* | Thresholds. Can be: 'space-usage-prct', 'space-usage', 'space-usage-free'. | +| 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 pools by name (can be a regexp). | +| --unknown-pool-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %{status}, %{name} | +| --warning-pool-status | Define the conditions to match for the status to be WARNING (default: '%{status} =~ /degraded\|warning/i'). You can use the following variables: %{status}, %{name} | +| --critical-pool-status | Define the conditions to match for the status to be CRITICAL (default: '%{status} =~ /error\|critical/i'). You can use the following variables: %{status}, %{name} | +| --warning-* --critical-* | Thresholds. Can be: 'space-usage-prct', 'space-usage', 'space-usage-free'. | -| Option | Description | -|:------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --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. | -| --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: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --add-global | Check global port statistics (by default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --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} | -| --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. | -| --name | With this option, the interfaces will be filtered by name (givenin 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). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --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. | -| --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). | -| --oid-extra-display | Add an OID to display. | -| --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 to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --memcached | Memcached server to use (only one server). | +| --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 | 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: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --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} | +| --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. | +| --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). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --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. | +| --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). | +| --oid-extra-display | Add an OID to display. | +| --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-name | Filter volumes by name (can be a regexp). | -| --force-counters-legacy | Force to use legacy counters. Should be used when EX/QTS counters are buggy. | -| --unknown-volume-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %{status}, %{name} | -| --warning-volume-status | Define the conditions to match for the status to be WARNING (default: '%{status} =~ /degraded\|warning/i'). You can use the following variables: %{status}, %{name} | -| --critical-volume-status | Define the conditions to match for the status to be CRITICAL (default: '%{status} =~ /critical/i'). You can use the following variables: %{status}, %{name} | -| --warning-* --critical-* | Thresholds. Can be: 'space-usage-prct', 'space-usage', 'space-usage-free'. | +| 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 volumes by name (can be a regexp). | +| --force-counters-legacy | Force to use legacy counters. Should be used when EX/QTS counters are buggy. | +| --unknown-volume-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %{status}, %{name} | +| --warning-volume-status | Define the conditions to match for the status to be WARNING (default: '%{status} =~ /degraded\|warning/i'). You can use the following variables: %{status}, %{name} | +| --critical-volume-status | Define the conditions to match for the status to be CRITICAL (default: '%{status} =~ /critical/i'). You can use the following variables: %{status}, %{name} | +| --warning-* --critical-* | Thresholds. Can be: 'space-usage-prct', 'space-usage', 'space-usage-free'. |