From da8ac24dd52b4428e9caf71d1dd4b68ba0c3b402 Mon Sep 17 00:00:00 2001 From: lucie-tirand Date: Tue, 21 Oct 2025 18:31:46 +0200 Subject: [PATCH 1/2] enh(hardware-pdu-gude-epc-snmp): enhance documentation page CTOR-1990 --- .../procedures/hardware-pdu-gude-epc-snmp.md | 369 +++++++++-------- .../procedures/hardware-pdu-gude-epc-snmp.md | 382 ++++++++++-------- 2 files changed, 400 insertions(+), 351 deletions(-) diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-pdu-gude-epc-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-pdu-gude-epc-snmp.md index a8af300811ae..c990c381613a 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-pdu-gude-epc-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-pdu-gude-epc-snmp.md @@ -5,6 +5,12 @@ title: Gude EPC PDU 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 **Gude EPC SNMP** +depuis la page **Configuration > Gestionnaire de connecteurs de supervision** : +* [Base Pack](./base-generic.md) + ## Contenu du pack ### Modèles @@ -22,7 +28,7 @@ Le connecteur apporte les modèles de service suivants | Alias | Modèle de service | Description | Découverte | |:------------------|:----------------------------------------------|:--------------------------------------------|:----------:| | Power-Channels | HW-Pdu-Gude-Epc-Power-Channels-SNMP-custom | Contrôle les power channels | | -| Sp-Power-Channels | HW-Pdu-Gude-Epc-Sp-Power-Channels-SNMP-custom | Contrôle les ports unitaires power channels | X | +| Sp-Power-Channels | HW-Pdu-Gude-Epc-Sp-Power-Channels-SNMP-custom | Contrôle les ports unitaires power channels | X | > Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte **HW-Pdu-Gude-Epc-SNMP-custom** est utilisé. @@ -35,38 +41,38 @@ 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-Pdu-Gude-Epc-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-Pdu-Gude-Epc-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-Pdu-Gude-Epc-SNMP-Sp-Power-Channel-Name | | +| Nom de la règle | Description | +|:-------------------------------------------|:-------------------------------------------------------------| +| HW-Pdu-Gude-Epc-SNMP-Sp-Power-Channel-Name | Découvre les ports unitaires power channels et les supervise | 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é | |:------------------------------------------------------------------|:------| | pdu.power_channels.active.count | count | -| *channels*#status | N/A | -| *channels*#ovp-status | N/A | -| *channels*#ps-status | N/A | +| status | N/A | +| ovp-status | N/A | +| ps-status | N/A | | *channels*#pdu.interface.power_channel.current.ampere | A | | *channels*#pdu.interface.power_channel.energy.active.kilowatthour | kWh | | *channels*#pdu.interface.power_channel.frequency.hertz | Hz | -| *channels*#pdu.interface.power_channel.phase.angle.degree | N/A | +| phase-angle | N/A | | *channels*#pdu.interface.power_channel.active.watt | W | | *channels*#pdu.interface.power_channel.power.apparent.voltampere | VA | | *channels*#pdu.interface.power_channel.power.factor.count | count | @@ -76,20 +82,31 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat -| Métrique | Unité | -|:-----------------------------------------------------------------------|:------| -| pdu.singleport_power_channels.total.count | count | -| *sp*#state | N/A | -| *sp*#status | N/A | -| *sp*#pdu.interface.singleport_power_channel.current.ampere | A | -| *sp*#pdu.interface.singleport_power_channel.energy.active.kilowatthour | kWh | -| *sp*#pdu.interface.singleport_power_channel.frequency.hertz | Hz | -| *sp*#pdu.interface.singleport_power_channel.phase.angle.degree | N/A | -| *sp*#pdu.power_channel.active.watt | W | -| *sp*#pdu.interface.singleport_power_channel.power.apparent.voltampere | VA | -| *sp*#pdu.interface.singleport_power_channel.power.factor.count | count | -| *sp*#pdu.interface.singleport_power_channel.power.reactive.voltampere | Var | -| *sp*#pdu.interface.singleport_power_channel.voltage.volt | V | +| Nom | Unité | +|:------------------------------------------------------------------------|:------| +| pdu.singleport_power_channels.total.count | count | +| state | N/A | +| state | N/A | +| status | N/A | +| status | N/A | +| *sp1*#pdu.interface.singleport_power_channel.current.ampere | A | +| *sp2*#pdu.interface.singleport_power_channel.current.ampere | A | +| *sp1*#pdu.interface.singleport_power_channel.energy.active.kilowatthour | kWh | +| *sp2*#pdu.interface.singleport_power_channel.energy.active.kilowatthour | kWh | +| *sp1*#pdu.interface.singleport_power_channel.frequency.hertz | Hz | +| *sp2*#pdu.interface.singleport_power_channel.frequency.hertz | Hz | +| phase-angle | N/A | +| phase-angle | N/A | +| *sp1*#pdu.power_channel.active.watt | W | +| *sp2*#pdu.power_channel.active.watt | W | +| *sp1*#pdu.interface.singleport_power_channel.power.apparent.voltampere | VA | +| *sp2*#pdu.interface.singleport_power_channel.power.apparent.voltampere | VA | +| *sp1*#pdu.interface.singleport_power_channel.power.factor.count | count | +| *sp2*#pdu.interface.singleport_power_channel.power.factor.count | count | +| *sp1*#pdu.interface.singleport_power_channel.power.reactive.voltampere | Var | +| *sp2*#pdu.interface.singleport_power_channel.power.reactive.voltampere | Var | +| *sp1*#pdu.interface.singleport_power_channel.voltage.volt | V | +| *sp2*#pdu.interface.singleport_power_channel.voltage.volt | V | @@ -97,9 +114,13 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat ## Prérequis ### Configuration SNMP -Le service SNMP doit être activé et configuré sur l'équipement. Veuillez vous référer à la documentation officielle du constructeur/éditeur. + +L'agent SNMP doit être activé et configuré sur l'équipement. Référez vous à la documentation officielle. +Il se peut que votre équipement nécessite qu'une liste d'adresses autorisées à l'interroger soit paramétrée. +Veillez à ce que les adresses des collecteurs Centreon y figurent bien. ### Flux réseau + La communication doit être possible sur le port UDP 161 depuis le collecteur Centreon vers la ressource supervisée. @@ -107,10 +128,8 @@ Centreon vers la ressource supervisée. ### Pack -La procédure d'installation des connecteurs de supervision diffère légèrement [suivant que votre licence est offline ou online](../getting-started/how-to-guides/connectors-licenses.md). - 1. Si la plateforme est configurée avec une licence *online*, l'installation d'un paquet -n'est pas requise pour voir apparaître le connecteur dans le menu **Configuration > Connecteurs > Connecteurs de supervision**. +n'est pas requise pour voir apparaître le connecteur dans le menu **Configuration > Gestionnaire de connecteurs de supervision**. Au contraire, si la plateforme utilise une licence *offline*, installez le paquet sur le **serveur central** via la commande correspondant au gestionnaire de paquets associé à sa distribution : @@ -130,7 +149,7 @@ dnf install centreon-pack-hardware-pdu-gude-epc-snmp ``` - + ```bash apt install centreon-pack-hardware-pdu-gude-epc-snmp @@ -147,7 +166,7 @@ yum install centreon-pack-hardware-pdu-gude-epc-snmp 2. Quel que soit le type de la licence (*online* ou *offline*), installez le connecteur **Gude EPC SNMP** -depuis l'interface web et le menu **Configuration > Connecteurs > Connecteurs de supervision**. +depuis l'interface web et le menu **Configuration > Gestionnaire de connecteurs de supervision**. ### Plugin @@ -175,7 +194,7 @@ dnf install centreon-plugin-Hardware-Pdu-Gude-Epc-Snmp ``` - + ```bash apt install centreon-plugin-hardware-pdu-gude-epc-snmp @@ -200,10 +219,10 @@ yum install centreon-plugin-Hardware-Pdu-Gude-Epc-Snmp 3. Appliquez le modèle d'hôte **HW-Pdu-Gude-Epc-SNMP-custom**. > 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#mapping-des-options-snmpv3). +> Plus d'informations dans la section [Troubleshooting SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#snmpv3-options-mapping). -| Macro | Description | Valeur par défaut | Obligatoire | -|:-----------------|:-----------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| Macro | Description | Valeur par défaut | Obligatoire | +|:-----------------|:---------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| | SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | 4. [Déployez la configuration](/docs/monitoring/monitoring-servers/deploying-a-configuration). L'hôte apparaît dans la liste des hôtes supervisés, et dans la page **Statut des ressources**. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros. @@ -216,67 +235,67 @@ yum install centreon-plugin-Hardware-Pdu-Gude-Epc-Snmp -| Macro | Description | Valeur par défaut | Obligatoire | -|:-----------------------|:---------------------------------------------------------------------------------------------------|:------------------------|:-----------:| -| FILTERNAME | Filter power channel interfaces by name (can be a regexp) | | | -| WARNINGACTIVECHANNELS | Warning threshold | | | -| CRITICALACTIVECHANNELS | Critical threshold | | | -| WARNINGCURRENT | Warning threshold | | | -| CRITICALCURRENT | Critical threshold | | | -| WARNINGENERGY | Warning threshold | | | -| CRITICALENERGY | Critical threshold | | | -| WARNINGFREQUENCY | Warning threshold | | | -| CRITICALFREQUENCY | Critical threshold | | | -| CRITICALOVPSTATUS | Critical threshold for OVP (OverVoltage Protection) status (default: '%\{ovp_status\} !~ /ok/i') | %\{ovp_status\} !~ /ok/i | | -| WARNINGOVPSTATUS | Warning threshold for OVP (OverVoltage Protection) status | | | -| WARNINGPHASEANGLE | Warning threshold | | | -| CRITICALPHASEANGLE | Critical threshold | | | -| WARNINGPOWERACTIVE | Warning threshold | | | -| CRITICALPOWERACTIVE | Critical threshold | | | -| WARNINGPOWERAPPARENT | Warning threshold | | | -| CRITICALPOWERAPPARENT | Critical threshold | | | -| WARNINGPOWERFACTOR | Warning threshold | | | -| CRITICALPOWERFACTOR | Critical threshold | | | -| WARNINGPOWERREACTIVE | Warning threshold | | | -| CRITICALPOWERREACTIVE | Critical threshold | | | -| CRITICALPSSTATUS | Critical threshold for power supply status (default: '%\{ps_status\} !~ /up/i') | %\{ps_status\} !~ /up/i | | -| WARNINGPSSTATUS | Warning threshold for power supply status | | | -| CRITICALSTATUS | Critical threshold for channel status (default: '%\{status\} !~ /valid/i') | %\{status\} !~ /valid/i | | -| WARNINGSTATUS | Warning threshold for channel status | | | -| WARNINGVOLTAGE | Warning threshold | | | -| CRITICALVOLTAGE | Critical threshold | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-----------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------------|:-----------:| +| FILTERNAME | Filter power channel interfaces by name (can be a regexp) | | | +| WARNINGACTIVECHANNELS | Threshold | | | +| CRITICALACTIVECHANNELS | Threshold | | | +| WARNINGCURRENT | Threshold | | | +| CRITICALCURRENT | Threshold | | | +| WARNINGENERGY | Threshold | | | +| CRITICALENERGY | Threshold | | | +| WARNINGFREQUENCY | Threshold | | | +| CRITICALFREQUENCY | Threshold | | | +| CRITICALOVPSTATUS | Critical threshold for OVP (OverVoltage Protection) status | %\{ovp\_status\} !~ /ok/i | | +| WARNINGOVPSTATUS | Warning threshold for OVP (OverVoltage Protection) status | | | +| WARNINGPHASEANGLE | Threshold | | | +| CRITICALPHASEANGLE | Threshold | | | +| WARNINGPOWERACTIVE | Threshold | | | +| CRITICALPOWERACTIVE | Threshold | | | +| WARNINGPOWERAPPARENT | Threshold | | | +| CRITICALPOWERAPPARENT | Threshold | | | +| WARNINGPOWERFACTOR | Threshold | | | +| CRITICALPOWERFACTOR | Threshold | | | +| WARNINGPOWERREACTIVE | Threshold | | | +| CRITICALPOWERREACTIVE | Threshold | | | +| CRITICALPSSTATUS | Critical threshold for power supply status | %\{ps\_status\} !~ /up/i | | +| WARNINGPSSTATUS | Warning threshold for power supply status | | | +| CRITICALSTATUS | Critical threshold for channel status | %\{status\} !~ /valid/i | | +| WARNINGSTATUS | Warning threshold for channel status | | | +| WARNINGVOLTAGE | Threshold | | | +| CRITICALVOLTAGE | 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 | -|:-------------------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| FILTERNAME | Filter single port power channels by name (can be a regexp) | | | -| WARNINGCURRENT | Warning threshold | | | -| CRITICALCURRENT | Critical threshold | | | -| WARNINGENERGY | Warning threshold | | | -| CRITICALENERGY | Critical threshold | | | -| WARNINGFREQUENCY | Warning threshold | | | -| CRITICALFREQUENCY | Critical threshold | | | -| WARNINGPHASEANGLE | Warning threshold | | | -| CRITICALPHASEANGLE | Critical threshold | | | -| WARNINGPOWERACTIVE | Warning threshold | | | -| CRITICALPOWERACTIVE | Critical threshold | | | -| WARNINGPOWERAPPARENT | Warning threshold | | | -| CRITICALPOWERAPPARENT | Critical threshold | | | -| WARNINGPOWERFACTOR | Warning threshold | | | -| CRITICALPOWERFACTOR | Critical threshold | | | -| WARNINGPOWERREACTIVE | Warning threshold | | | -| CRITICALPOWERREACTIVE | Critical threshold | | | -| WARNINGSTATE | Warning threshold single port state | | | -| CRITICALSTATE | Critical threshold single port state | | | -| WARNINGSTATUS | Warning threshold for single port status | | | -| CRITICALSTATUS | Critical threshold for single port status | | | -| WARNINGTOTALSINGLEPORTS | Warning threshold | | | -| CRITICALTOTALSINGLEPORTS | Critical threshold | | | -| WARNINGVOLTAGE | Warning threshold | | | -| CRITICALVOLTAGE | Critical threshold | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| FILTERNAME | Filter single port power channels by name (can be a regexp) | | | +| WARNINGCURRENT | Threshold | | | +| CRITICALCURRENT | Threshold | | | +| WARNINGENERGY | Threshold | | | +| CRITICALENERGY | Threshold | | | +| WARNINGFREQUENCY | Threshold | | | +| CRITICALFREQUENCY | Threshold | | | +| WARNINGPHASEANGLE | Threshold | | | +| CRITICALPHASEANGLE | Threshold | | | +| WARNINGPOWERACTIVE | Threshold | | | +| CRITICALPOWERACTIVE | Threshold | | | +| WARNINGPOWERAPPARENT | Threshold | | | +| CRITICALPOWERAPPARENT | Threshold | | | +| WARNINGPOWERFACTOR | Threshold | | | +| CRITICALPOWERFACTOR | Threshold | | | +| WARNINGPOWERREACTIVE | Threshold | | | +| CRITICALPOWERREACTIVE | Threshold | | | +| WARNINGSTATE | Warning threshold for single port state | | | +| CRITICALSTATE | Critical threshold for single port state | | | +| WARNINGSTATUS | Warning threshold for for single port status | | | +| CRITICALSTATUS | Critical threshold for for single port status | | | +| WARNINGTOTALSINGLEPORTS | Threshold | | | +| CRITICALTOTALSINGLEPORTS | Threshold | | | +| WARNINGVOLTAGE | Threshold | | | +| CRITICALVOLTAGE | 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 | | @@ -330,7 +349,7 @@ telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) : La commande devrait retourner un message de sortie similaire à : ```bash -OK: 35 single port(s) All single port power channel interfaces are ok | 'pdu.singleport_power_channels.total.count'=35;;;0;'*sp*#pdu.interface.singleport_power_channel.current.ampere'=A;;;0;'*sp*#pdu.interface.singleport_power_channel.energy.active.kilowatthour'=kWh;;;0;'*sp*#pdu.interface.singleport_power_channel.frequency.hertz'=Hz;;;0;'*sp*#pdu.interface.singleport_power_channel.phase.angle.degree'=;;;0;'*sp*#pdu.power_channel.active.watt'=W;;;;'*sp*#pdu.interface.singleport_power_channel.power.apparent.voltampere'=VA;;;;'*sp*#pdu.interface.singleport_power_channel.power.factor.count'=;;;0;'*sp*#pdu.interface.singleport_power_channel.power.reactive.voltampere'=Var;;;;'*sp*#pdu.interface.singleport_power_channel.voltage.volt'=V;;;0; +OK: 24395 single port(s) All single port power channel interfaces are ok | 'pdu.singleport_power_channels.total.count'=24395;;;0; 'sp1#pdu.interface.singleport_power_channel.current.ampere'=70611A;;;0; 'sp2#pdu.interface.singleport_power_channel.current.ampere'=3284A;;;0; 'sp1#pdu.interface.singleport_power_channel.energy.active.kilowatthour'=21254kWh;;;0; 'sp2#pdu.interface.singleport_power_channel.energy.active.kilowatthour'=70640kWh;;;0; 'sp1#pdu.interface.singleport_power_channel.frequency.hertz'=22842Hz;;;0; 'sp2#pdu.interface.singleport_power_channel.frequency.hertz'=13504Hz;;;0; 'sp1#pdu.interface.singleport_power_channel.phase.angle.degree'=95850;;;0; 'sp2#pdu.interface.singleport_power_channel.phase.angle.degree'=80038;;;0; 'sp1#pdu.power_channel.active.watt'=36789W;;;; 'sp2#pdu.power_channel.active.watt'=68356W;;;; 'sp1#pdu.interface.singleport_power_channel.power.apparent.voltampere'=53443VA;;;; 'sp2#pdu.interface.singleport_power_channel.power.apparent.voltampere'=43459VA;;;; 'sp1#pdu.interface.singleport_power_channel.power.factor.count'=38564;;;0; 'sp2#pdu.interface.singleport_power_channel.power.factor.count'=93150;;;0; 'sp1#pdu.interface.singleport_power_channel.power.reactive.voltampere'=79853Var;;;; 'sp2#pdu.interface.singleport_power_channel.power.reactive.voltampere'=32397Var;;;; 'sp1#pdu.interface.singleport_power_channel.voltage.volt'=44717V;;;0; 'sp2#pdu.interface.singleport_power_channel.voltage.volt'=33693V;;;0; ``` ### Diagnostic des erreurs communes @@ -340,7 +359,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. @@ -368,61 +387,67 @@ 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\[,\[\\],\[min\],\[max\]\] Common examples: =over 4 Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage free perfdata into used: --change-perfdata='used,free,invert()' Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)' Scale traffic values in Mbps: --change-perfdata='traffic\_in,,scale(Mbps),mbps' Change traffic values in percent: --change-perfdata='traffic\_in,,percent()' =back | +| --change-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[\\],\[min\],\[max\]\] Common examples: =over 4 Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage free perfdata into used: --change-perfdata='used,free,invert()' Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)' Scale traffic values in Mbps: --change-perfdata='traffic\_in,,scale(Mbps),mbps' Change traffic values in percent: --change-perfdata='traffic\_in,,percent()' =back | +| --extend-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[\\],\[min\],\[max\]\] Common examples: =over 4 Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage free perfdata into used: --change-perfdata='used,free,invert()' Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)' Scale traffic values in Mbps: --change-perfdata='traffic\_in,,scale(Mbps),mbps' Change traffic values in percent: --change-perfdata='traffic\_in,,percent()' =back | +| --extend-perfdata-group | Add new aggregated metrics (min, max, average or sum) for groups of metrics defined by a regex match on the metrics' names. Syntax: --extend-perfdata-group=regex,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: how the new metrics' names are composed (can use $1, $2... for groups defined by () in regex). calculation: how the values of the new metrics should be calculated \ (optional): unit of measure for the new metrics min (optional): lowest value the metrics can reach max (optional): highest value the metrics can reach Common examples: =over 4 Sum wrong packets from all interfaces (with interface need --units-errors=absolute): --extend-perfdata-group=',packets\_wrong,sum(packets\_(discard\|error)\_(in\|out))' Sum traffic by interface: --extend-perfdata-group='traffic\_in\_(.*),traffic\_$1,sum(traffic\_(in\|out)\_$1)' =back | +| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-exit | Replace an exit code with one of your choice. Example: adding --change-exit=unknown=critical will result in a CRITICAL state instead of an UNKNOWN state. | +| --change-output-adv | Replace short output and exit code based on a "if" condition using the following variables: short\_output, exit\_code. Variables must be written either %\{variable\} or %(variable). Example: adding --change-output-adv='%(short\_ouput) =~ /UNKNOWN: No daemon/,OK: No daemon,OK' will change the following specific UNKNOWN result to an OK result. | +| --range-perfdata | Rewrite the ranges displayed in the perfdata. Accepted values: 0: nothing is changed. 1: if the lower value of the range is equal to 0, it is removed. 2: remove the thresholds from the perfdata. | +| --filter-uom | Mask the units when they don't match the given regular expression. | +| --opt-exit | Replace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown. | +| --output-ignore-perfdata | Remove all the metrics from the service. The service will still have a status and an output. | +| --output-ignore-label | Remove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Example: 'OK: Ram Total:...' will become 'Ram Total:...' | +| --output-xml | Return the output in XML format (to send to an XML API). | +| --output-json | Return the output in JSON format (to send to a JSON API). | +| --output-openmetrics | Return the output in OpenMetrics format (to send to a tool expecting this format). | +| --output-file | Write output in file (can be combined with JSON, XML and OpenMetrics options). Example: --output-file=/tmp/output.txt will write the output in /tmp/output.txt. | +| --disco-format | Applies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML). | +| --disco-show | Applies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery. | +| --float-precision | Define the float precision for thresholds (default: 8). | +| --source-encoding | Define the character encoding of the response sent by the monitored resource Default: 'UTF-8'. =head1 DESCRIPTION B\. =cut | +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | #### Options des modes @@ -431,31 +456,31 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous -| Option | Description | -|:----------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-name | Filter power channel interfaces by name (can be a regexp). | -| --warning-status | Warning threshold for channel status. | -| --critical-status | Critical threshold for channel status (default: '%\{status\} !~ /valid/i') | -| --warning-ovp-status | Warning threshold for OVP (OverVoltage Protection) status. | -| --critical-ovp-status | Critical threshold for OVP (OverVoltage Protection) status (default: '%\{ovp_status\} !~ /ok/i') | -| --warning-ps-status | Warning threshold for power supply status. | -| --critical-ps-status | Critical threshold for power supply status (default: '%\{ps_status\} !~ /up/i') | -| --warning-* | Warning threshold. Can be: 'active-channels', 'current', 'energy', 'frequency', 'phase-angle', 'power-active', 'power-apparent', 'power-factor', 'power-reactive', 'voltage' | -| --critical-* | Can be: 'active-channels', 'current', 'energy', 'frequency', 'phase-angle', 'power-active', 'power-apparent', 'power-factor', 'power-reactive', 'voltage' | +| Option | Description | +|:----------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-name | Filter power channel interfaces by name (can be a regexp). | +| --warning-status | Warning threshold for channel status. | +| --critical-status | Critical threshold for channel status (default: '%\{status\} !~ /valid/i') | +| --warning-ovp-status | Warning threshold for OVP (OverVoltage Protection) status. | +| --critical-ovp-status | Critical threshold for OVP (OverVoltage Protection) status (default: '%\{ovp\_status\} !~ /ok/i') | +| --warning-ps-status | Warning threshold for power supply status. | +| --critical-ps-status | Critical threshold for power supply status (default: '%\{ps\_status\} !~ /up/i') | +| --warning-* | Warning threshold. Can be: 'active-channels', 'current', 'energy', 'frequency', 'phase-angle', 'power-active', 'power-apparent', 'power-factor', 'power-reactive', 'voltage' | +| --critical-* | Can be: 'active-channels', 'current', 'energy', 'frequency', 'phase-angle', 'power-active', 'power-apparent', 'power-factor', 'power-reactive', 'voltage' | -| Option | Description | -|:------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-name | Filter single port power channels by name (can be a regexp). | -| --skip-poweredoff | Exclude the single ports that have been powered off. | -| --warning-state | Warning threshold for single port state. | -| --critical-state | Critical threshold for single port state. | -| --warning-status | Warning threshold for for single port status. | -| --critical-status | Critical threshold for for single port status. | -| --warning-* | Warning threshold. Can be: 'active-channels', 'current', 'energy', 'frequency', 'phase-angle', 'power-active', 'power-apparent', 'power-factor', 'power-reactive', 'voltage' | -| --critical-* | Can be: 'active-channels', 'current', 'energy', 'frequency', 'phase-angle', 'power-active', 'power-apparent', 'power-factor', 'power-reactive', 'voltage' | +| Option | Description | +|:------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-name | Filter single port power channels by name (can be a regexp). | +| --skip-poweredoff | Exclude the single ports that have been powered off. | +| --warning-state | Warning threshold for single port state. | +| --critical-state | Critical threshold for single port state. | +| --warning-status | Warning threshold for for single port status. | +| --critical-status | Critical threshold for for single port status. | +| --warning-* | Warning threshold. Can be: 'active-channels', 'current', 'energy', 'frequency', 'phase-angle', 'power-active', 'power-apparent', 'power-factor', 'power-reactive', 'voltage' | +| --critical-* | Can be: 'active-channels', 'current', 'energy', 'frequency', 'phase-angle', 'power-active', 'power-apparent', 'power-factor', 'power-reactive', 'voltage' | diff --git a/pp/integrations/plugin-packs/procedures/hardware-pdu-gude-epc-snmp.md b/pp/integrations/plugin-packs/procedures/hardware-pdu-gude-epc-snmp.md index b38f21758dd8..d7261e4a8b67 100644 --- a/pp/integrations/plugin-packs/procedures/hardware-pdu-gude-epc-snmp.md +++ b/pp/integrations/plugin-packs/procedures/hardware-pdu-gude-epc-snmp.md @@ -5,6 +5,12 @@ title: Gude EPC PDU SNMP import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +## Connector dependencies + +The following monitoring connectors will be installed when you install the **Gude EPC SNMP** connector through the +**Configuration > Monitoring Connector Manager** menu: +* [Base Pack](./base-generic.md) + ## Pack assets ### Templates @@ -18,10 +24,10 @@ The connector brings the following service templates (sorted by the host templat -| Service Alias | Service Template | Service Description | Discovery | -|:------------------|:----------------------------------------------|:---------------------------------|:----------:| -| Power-Channels | HW-Pdu-Gude-Epc-Power-Channels-SNMP-custom | Check power channels | | -| Sp-Power-Channels | HW-Pdu-Gude-Epc-Sp-Power-Channels-SNMP-custom | Check single port power channels | X | +| Service Alias | Service Template | Service Description | Discovery | +|:------------------|:----------------------------------------------|:---------------------------------|:---------:| +| Power-Channels | HW-Pdu-Gude-Epc-Power-Channels-SNMP-custom | Check power channels | | +| Sp-Power-Channels | HW-Pdu-Gude-Epc-Sp-Power-Channels-SNMP-custom | Check single port power channels | X | > The services listed above are created automatically when the **HW-Pdu-Gude-Epc-SNMP-custom** host template is used. @@ -34,38 +40,38 @@ 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-Pdu-Gude-Epc-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-Pdu-Gude-Epc-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-Pdu-Gude-Epc-SNMP-Sp-Power-Channel-Name | | +| Rule name | Description | +|:-------------------------------------------|:-----------------------------------------------------| +| HW-Pdu-Gude-Epc-SNMP-Sp-Power-Channel-Name | Discover single port power channels and monitor them | 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 | |:------------------------------------------------------------------|:------| | pdu.power_channels.active.count | count | -| *channels*#status | N/A | -| *channels*#ovp-status | N/A | -| *channels*#ps-status | N/A | +| status | N/A | +| ovp-status | N/A | +| ps-status | N/A | | *channels*#pdu.interface.power_channel.current.ampere | A | | *channels*#pdu.interface.power_channel.energy.active.kilowatthour | kWh | | *channels*#pdu.interface.power_channel.frequency.hertz | Hz | -| *channels*#pdu.interface.power_channel.phase.angle.degree | N/A | +| phase-angle | N/A | | *channels*#pdu.interface.power_channel.active.watt | W | | *channels*#pdu.interface.power_channel.power.apparent.voltampere | VA | | *channels*#pdu.interface.power_channel.power.factor.count | count | @@ -75,20 +81,31 @@ Here is the list of services for this connector, detailing all metrics linked to -| Metric name | Unit | -|:-----------------------------------------------------------------------|:------| -| pdu.singleport_power_channels.total.count | count | -| *sp*#state | N/A | -| *sp*#status | N/A | -| *sp*#pdu.interface.singleport_power_channel.current.ampere | A | -| *sp*#pdu.interface.singleport_power_channel.energy.active.kilowatthour | kWh | -| *sp*#pdu.interface.singleport_power_channel.frequency.hertz | Hz | -| *sp*#pdu.interface.singleport_power_channel.phase.angle.degree | N/A | -| *sp*#pdu.power_channel.active.watt | W | -| *sp*#pdu.interface.singleport_power_channel.power.apparent.voltampere | VA | -| *sp*#pdu.interface.singleport_power_channel.power.factor.count | count | -| *sp*#pdu.interface.singleport_power_channel.power.reactive.voltampere | Var | -| *sp*#pdu.interface.singleport_power_channel.voltage.volt | V | +| Name | Unit | +|:------------------------------------------------------------------------|:------| +| pdu.singleport_power_channels.total.count | count | +| state | N/A | +| state | N/A | +| status | N/A | +| status | N/A | +| *sp1*#pdu.interface.singleport_power_channel.current.ampere | A | +| *sp2*#pdu.interface.singleport_power_channel.current.ampere | A | +| *sp1*#pdu.interface.singleport_power_channel.energy.active.kilowatthour | kWh | +| *sp2*#pdu.interface.singleport_power_channel.energy.active.kilowatthour | kWh | +| *sp1*#pdu.interface.singleport_power_channel.frequency.hertz | Hz | +| *sp2*#pdu.interface.singleport_power_channel.frequency.hertz | Hz | +| phase-angle | N/A | +| phase-angle | N/A | +| *sp1*#pdu.power_channel.active.watt | W | +| *sp2*#pdu.power_channel.active.watt | W | +| *sp1*#pdu.interface.singleport_power_channel.power.apparent.voltampere | VA | +| *sp2*#pdu.interface.singleport_power_channel.power.apparent.voltampere | VA | +| *sp1*#pdu.interface.singleport_power_channel.power.factor.count | count | +| *sp2*#pdu.interface.singleport_power_channel.power.factor.count | count | +| *sp1*#pdu.interface.singleport_power_channel.power.reactive.voltampere | Var | +| *sp2*#pdu.interface.singleport_power_channel.power.reactive.voltampere | Var | +| *sp1*#pdu.interface.singleport_power_channel.voltage.volt | V | +| *sp2*#pdu.interface.singleport_power_channel.voltage.volt | V | @@ -96,9 +113,13 @@ Here is the list of services for this connector, detailing all metrics linked to ## Prerequisites ### SNMP Configuration -The SNMP service must be configured and activated on the host. Please refer to the official documentation from the manufacturer/publisher. + +The SNMP service must be configured and activated on the host. Please refer to the official documentation. +Your resource may require a list of addresses authorized to query it to be set up. +Please ensure that the addresses of the Centreon pollers are included in this list. ### Network flow + The target resource must be reachable from the Centreon poller on the UDP/161 SNMP port. @@ -106,12 +127,9 @@ SNMP port. ### Pack - The installation procedures for monitoring connectors are slightly different depending on [whether your license is offline or online](../getting-started/how-to-guides/connectors-licenses.md). - - 1. If the platform uses an *online* license, you can skip the package installation instruction below as it is not required to have the connector displayed within the -**Configuration > Connectors > Monitoring Connectors** menu. +**Configuration > Monitoring Connector Manager** menu. If the platform uses an *offline* license, install the package on the **central server** with the command corresponding to the operating system's package manager: @@ -130,7 +148,7 @@ dnf install centreon-pack-hardware-pdu-gude-epc-snmp ``` - + ```bash apt install centreon-pack-hardware-pdu-gude-epc-snmp @@ -147,7 +165,7 @@ yum install centreon-pack-hardware-pdu-gude-epc-snmp 2. Whatever the license type (*online* or *offline*), install the **Gude EPC SNMP** connector through -the **Configuration > Connectors > Monitoring Connectors** menu. +the **Configuration > Monitoring Connector Manager** menu. ### Plugin @@ -177,7 +195,7 @@ dnf install centreon-plugin-Hardware-Pdu-Gude-Epc-Snmp ``` - + ```bash apt install centreon-plugin-hardware-pdu-gude-epc-snmp @@ -199,14 +217,14 @@ yum install centreon-plugin-Hardware-Pdu-Gude-Epc-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-Pdu-Gude-Epc-SNMP-custom** template to the host. +3. Apply the **HW-Pdu-Gude-Epc-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 | -|:-----------------|:-----------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:-----------------|:-----------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed [here](#available-options). | | | 4. [Deploy the configuration](/docs/monitoring/monitoring-servers/deploying-a-configuration). The host appears in the list of hosts, and on the **Resources Status** page. The command that is sent by the connector is displayed in the details panel of the host: it shows the values of the macros. @@ -218,68 +236,68 @@ yum install centreon-plugin-Hardware-Pdu-Gude-Epc-Snmp -| Macro | Description | Default value | Mandatory | -|:-----------------------|:---------------------------------------------------------------------------------------------------|:------------------------|:-----------:| -| FILTERNAME | Filter power channel interfaces by name (can be a regexp) | | | -| WARNINGACTIVECHANNELS | Warning threshold | | | -| CRITICALACTIVECHANNELS | Critical threshold | | | -| WARNINGCURRENT | Warning threshold | | | -| CRITICALCURRENT | Critical threshold | | | -| WARNINGENERGY | Warning threshold | | | -| CRITICALENERGY | Critical threshold | | | -| WARNINGFREQUENCY | Warning threshold | | | -| CRITICALFREQUENCY | Critical threshold | | | -| CRITICALOVPSTATUS | Critical threshold for OVP (OverVoltage Protection) status (default: '%\{ovp_status\} !~ /ok/i') | %\{ovp_status\} !~ /ok/i | | -| WARNINGOVPSTATUS | Warning threshold for OVP (OverVoltage Protection) status | | | -| WARNINGPHASEANGLE | Warning threshold | | | -| CRITICALPHASEANGLE | Critical threshold | | | -| WARNINGPOWERACTIVE | Warning threshold | | | -| CRITICALPOWERACTIVE | Critical threshold | | | -| WARNINGPOWERAPPARENT | Warning threshold | | | -| CRITICALPOWERAPPARENT | Critical threshold | | | -| WARNINGPOWERFACTOR | Warning threshold | | | -| CRITICALPOWERFACTOR | Critical threshold | | | -| WARNINGPOWERREACTIVE | Warning threshold | | | -| CRITICALPOWERREACTIVE | Critical threshold | | | -| CRITICALPSSTATUS | Critical threshold for power supply status (default: '%\{ps_status\} !~ /up/i') | %\{ps_status\} !~ /up/i | | -| WARNINGPSSTATUS | Warning threshold for power supply status | | | -| CRITICALSTATUS | Critical threshold for channel status (default: '%\{status\} !~ /valid/i') | %\{status\} !~ /valid/i | | -| WARNINGSTATUS | Warning threshold for channel status | | | -| WARNINGVOLTAGE | Warning threshold | | | -| CRITICALVOLTAGE | Critical threshold | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:-----------------------|:---------------------------------------------------------------------------------------------------------------------------------------|:--------------------------|:---------:| +| FILTERNAME | Filter power channel interfaces by name (can be a regexp) | | | +| WARNINGACTIVECHANNELS | Threshold | | | +| CRITICALACTIVECHANNELS | Threshold | | | +| WARNINGCURRENT | Threshold | | | +| CRITICALCURRENT | Threshold | | | +| WARNINGENERGY | Threshold | | | +| CRITICALENERGY | Threshold | | | +| WARNINGFREQUENCY | Threshold | | | +| CRITICALFREQUENCY | Threshold | | | +| CRITICALOVPSTATUS | Critical threshold for OVP (OverVoltage Protection) status | %\{ovp\_status\} !~ /ok/i | | +| WARNINGOVPSTATUS | Warning threshold for OVP (OverVoltage Protection) status | | | +| WARNINGPHASEANGLE | Threshold | | | +| CRITICALPHASEANGLE | Threshold | | | +| WARNINGPOWERACTIVE | Threshold | | | +| CRITICALPOWERACTIVE | Threshold | | | +| WARNINGPOWERAPPARENT | Threshold | | | +| CRITICALPOWERAPPARENT | Threshold | | | +| WARNINGPOWERFACTOR | Threshold | | | +| CRITICALPOWERFACTOR | Threshold | | | +| WARNINGPOWERREACTIVE | Threshold | | | +| CRITICALPOWERREACTIVE | Threshold | | | +| CRITICALPSSTATUS | Critical threshold for power supply status | %\{ps\_status\} !~ /up/i | | +| WARNINGPSSTATUS | Warning threshold for power supply status | | | +| CRITICALSTATUS | Critical threshold for channel status | %\{status\} !~ /valid/i | | +| WARNINGSTATUS | Warning threshold for channel status | | | +| WARNINGVOLTAGE | Threshold | | | +| CRITICALVOLTAGE | 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 | -|:-------------------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| FILTERNAME | Filter single port power channels by name (can be a regexp) | | | -| WARNINGCURRENT | Warning threshold | | | -| CRITICALCURRENT | Critical threshold | | | -| WARNINGENERGY | Warning threshold | | | -| CRITICALENERGY | Critical threshold | | | -| WARNINGFREQUENCY | Warning threshold | | | -| CRITICALFREQUENCY | Critical threshold | | | -| WARNINGPHASEANGLE | Warning threshold | | | -| CRITICALPHASEANGLE | Critical threshold | | | -| WARNINGPOWERACTIVE | Warning threshold | | | -| CRITICALPOWERACTIVE | Critical threshold | | | -| WARNINGPOWERAPPARENT | Warning threshold | | | -| CRITICALPOWERAPPARENT | Critical threshold | | | -| WARNINGPOWERFACTOR | Warning threshold | | | -| CRITICALPOWERFACTOR | Critical threshold | | | -| WARNINGPOWERREACTIVE | Warning threshold | | | -| CRITICALPOWERREACTIVE | Critical threshold | | | -| WARNINGSTATE | Warning threshold single port state | | | -| CRITICALSTATE | Critical threshold single port state | | | -| WARNINGSTATUS | Warning threshold for single port status | | | -| CRITICALSTATUS | Critical threshold for single port status | | | -| WARNINGTOTALSINGLEPORTS | Warning threshold | | | -| CRITICALTOTALSINGLEPORTS | Critical threshold | | | -| WARNINGVOLTAGE | Warning threshold | | | -| CRITICALVOLTAGE | Critical threshold | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:-------------------------|:---------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| FILTERNAME | Filter single port power channels by name (can be a regexp) | | | +| WARNINGCURRENT | Threshold | | | +| CRITICALCURRENT | Threshold | | | +| WARNINGENERGY | Threshold | | | +| CRITICALENERGY | Threshold | | | +| WARNINGFREQUENCY | Threshold | | | +| CRITICALFREQUENCY | Threshold | | | +| WARNINGPHASEANGLE | Threshold | | | +| CRITICALPHASEANGLE | Threshold | | | +| WARNINGPOWERACTIVE | Threshold | | | +| CRITICALPOWERACTIVE | Threshold | | | +| WARNINGPOWERAPPARENT | Threshold | | | +| CRITICALPOWERAPPARENT | Threshold | | | +| WARNINGPOWERFACTOR | Threshold | | | +| CRITICALPOWERFACTOR | Threshold | | | +| WARNINGPOWERREACTIVE | Threshold | | | +| CRITICALPOWERREACTIVE | Threshold | | | +| WARNINGSTATE | Warning threshold for single port state | | | +| CRITICALSTATE | Critical threshold for single port state | | | +| WARNINGSTATUS | Warning threshold for for single port status | | | +| CRITICALSTATUS | Critical threshold for for single port status | | | +| WARNINGTOTALSINGLEPORTS | Threshold | | | +| CRITICALTOTALSINGLEPORTS | Threshold | | | +| WARNINGVOLTAGE | Threshold | | | +| CRITICALVOLTAGE | 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 | | @@ -289,7 +307,7 @@ yum install centreon-plugin-Hardware-Pdu-Gude-Epc-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 @@ -330,7 +348,7 @@ is able to monitor a resource using a command like this one (replace the sample The expected command output is shown below: ```bash -OK: 35 single port(s) All single port power channel interfaces are ok | 'pdu.singleport_power_channels.total.count'=35;;;0;'*sp*#pdu.interface.singleport_power_channel.current.ampere'=A;;;0;'*sp*#pdu.interface.singleport_power_channel.energy.active.kilowatthour'=kWh;;;0;'*sp*#pdu.interface.singleport_power_channel.frequency.hertz'=Hz;;;0;'*sp*#pdu.interface.singleport_power_channel.phase.angle.degree'=;;;0;'*sp*#pdu.power_channel.active.watt'=W;;;;'*sp*#pdu.interface.singleport_power_channel.power.apparent.voltampere'=VA;;;;'*sp*#pdu.interface.singleport_power_channel.power.factor.count'=;;;0;'*sp*#pdu.interface.singleport_power_channel.power.reactive.voltampere'=Var;;;;'*sp*#pdu.interface.singleport_power_channel.voltage.volt'=V;;;0; +OK: 24395 single port(s) All single port power channel interfaces are ok | 'pdu.singleport_power_channels.total.count'=24395;;;0; 'sp1#pdu.interface.singleport_power_channel.current.ampere'=70611A;;;0; 'sp2#pdu.interface.singleport_power_channel.current.ampere'=3284A;;;0; 'sp1#pdu.interface.singleport_power_channel.energy.active.kilowatthour'=21254kWh;;;0; 'sp2#pdu.interface.singleport_power_channel.energy.active.kilowatthour'=70640kWh;;;0; 'sp1#pdu.interface.singleport_power_channel.frequency.hertz'=22842Hz;;;0; 'sp2#pdu.interface.singleport_power_channel.frequency.hertz'=13504Hz;;;0; 'sp1#pdu.interface.singleport_power_channel.phase.angle.degree'=95850;;;0; 'sp2#pdu.interface.singleport_power_channel.phase.angle.degree'=80038;;;0; 'sp1#pdu.power_channel.active.watt'=36789W;;;; 'sp2#pdu.power_channel.active.watt'=68356W;;;; 'sp1#pdu.interface.singleport_power_channel.power.apparent.voltampere'=53443VA;;;; 'sp2#pdu.interface.singleport_power_channel.power.apparent.voltampere'=43459VA;;;; 'sp1#pdu.interface.singleport_power_channel.power.factor.count'=38564;;;0; 'sp2#pdu.interface.singleport_power_channel.power.factor.count'=93150;;;0; 'sp1#pdu.interface.singleport_power_channel.power.reactive.voltampere'=79853Var;;;; 'sp2#pdu.interface.singleport_power_channel.power.reactive.voltampere'=32397Var;;;; 'sp1#pdu.interface.singleport_power_channel.voltage.volt'=44717V;;;0; 'sp2#pdu.interface.singleport_power_channel.voltage.volt'=33693V;;;0; ``` ### Troubleshooting @@ -342,7 +360,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 @@ -368,61 +386,67 @@ 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\[,\[\\],\[min\],\[max\]\] Common examples: =over 4 Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage free perfdata into used: --change-perfdata='used,free,invert()' Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)' Scale traffic values in Mbps: --change-perfdata='traffic\_in,,scale(Mbps),mbps' Change traffic values in percent: --change-perfdata='traffic\_in,,percent()' =back | +| --change-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[\\],\[min\],\[max\]\] Common examples: =over 4 Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage free perfdata into used: --change-perfdata='used,free,invert()' Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)' Scale traffic values in Mbps: --change-perfdata='traffic\_in,,scale(Mbps),mbps' Change traffic values in percent: --change-perfdata='traffic\_in,,percent()' =back | +| --extend-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[\\],\[min\],\[max\]\] Common examples: =over 4 Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage free perfdata into used: --change-perfdata='used,free,invert()' Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)' Scale traffic values in Mbps: --change-perfdata='traffic\_in,,scale(Mbps),mbps' Change traffic values in percent: --change-perfdata='traffic\_in,,percent()' =back | +| --extend-perfdata-group | Add new aggregated metrics (min, max, average or sum) for groups of metrics defined by a regex match on the metrics' names. Syntax: --extend-perfdata-group=regex,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: how the new metrics' names are composed (can use $1, $2... for groups defined by () in regex). calculation: how the values of the new metrics should be calculated \ (optional): unit of measure for the new metrics min (optional): lowest value the metrics can reach max (optional): highest value the metrics can reach Common examples: =over 4 Sum wrong packets from all interfaces (with interface need --units-errors=absolute): --extend-perfdata-group=',packets\_wrong,sum(packets\_(discard\|error)\_(in\|out))' Sum traffic by interface: --extend-perfdata-group='traffic\_in\_(.*),traffic\_$1,sum(traffic\_(in\|out)\_$1)' =back | +| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-exit | Replace an exit code with one of your choice. Example: adding --change-exit=unknown=critical will result in a CRITICAL state instead of an UNKNOWN state. | +| --change-output-adv | Replace short output and exit code based on a "if" condition using the following variables: short\_output, exit\_code. Variables must be written either %\{variable\} or %(variable). Example: adding --change-output-adv='%(short\_ouput) =~ /UNKNOWN: No daemon/,OK: No daemon,OK' will change the following specific UNKNOWN result to an OK result. | +| --range-perfdata | Rewrite the ranges displayed in the perfdata. Accepted values: 0: nothing is changed. 1: if the lower value of the range is equal to 0, it is removed. 2: remove the thresholds from the perfdata. | +| --filter-uom | Mask the units when they don't match the given regular expression. | +| --opt-exit | Replace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown. | +| --output-ignore-perfdata | Remove all the metrics from the service. The service will still have a status and an output. | +| --output-ignore-label | Remove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Example: 'OK: Ram Total:...' will become 'Ram Total:...' | +| --output-xml | Return the output in XML format (to send to an XML API). | +| --output-json | Return the output in JSON format (to send to a JSON API). | +| --output-openmetrics | Return the output in OpenMetrics format (to send to a tool expecting this format). | +| --output-file | Write output in file (can be combined with JSON, XML and OpenMetrics options). Example: --output-file=/tmp/output.txt will write the output in /tmp/output.txt. | +| --disco-format | Applies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML). | +| --disco-show | Applies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery. | +| --float-precision | Define the float precision for thresholds (default: 8). | +| --source-encoding | Define the character encoding of the response sent by the monitored resource Default: 'UTF-8'. =head1 DESCRIPTION B\. =cut | +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | #### Modes options @@ -431,31 +455,31 @@ All available options for each service template are listed below: -| Option | Description | -|:----------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-name | Filter power channel interfaces by name (can be a regexp). | -| --warning-status | Warning threshold for channel status. | -| --critical-status | Critical threshold for channel status (default: '%\{status\} !~ /valid/i') | -| --warning-ovp-status | Warning threshold for OVP (OverVoltage Protection) status. | -| --critical-ovp-status | Critical threshold for OVP (OverVoltage Protection) status (default: '%\{ovp_status\} !~ /ok/i') | -| --warning-ps-status | Warning threshold for power supply status. | -| --critical-ps-status | Critical threshold for power supply status (default: '%\{ps_status\} !~ /up/i') | -| --warning-* | Warning threshold. Can be: 'active-channels', 'current', 'energy', 'frequency', 'phase-angle', 'power-active', 'power-apparent', 'power-factor', 'power-reactive', 'voltage' | -| --critical-* | Can be: 'active-channels', 'current', 'energy', 'frequency', 'phase-angle', 'power-active', 'power-apparent', 'power-factor', 'power-reactive', 'voltage' | +| Option | Description | +|:----------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-name | Filter power channel interfaces by name (can be a regexp). | +| --warning-status | Warning threshold for channel status. | +| --critical-status | Critical threshold for channel status (default: '%\{status\} !~ /valid/i') | +| --warning-ovp-status | Warning threshold for OVP (OverVoltage Protection) status. | +| --critical-ovp-status | Critical threshold for OVP (OverVoltage Protection) status (default: '%\{ovp\_status\} !~ /ok/i') | +| --warning-ps-status | Warning threshold for power supply status. | +| --critical-ps-status | Critical threshold for power supply status (default: '%\{ps\_status\} !~ /up/i') | +| --warning-* | Warning threshold. Can be: 'active-channels', 'current', 'energy', 'frequency', 'phase-angle', 'power-active', 'power-apparent', 'power-factor', 'power-reactive', 'voltage' | +| --critical-* | Can be: 'active-channels', 'current', 'energy', 'frequency', 'phase-angle', 'power-active', 'power-apparent', 'power-factor', 'power-reactive', 'voltage' | -| Option | Description | -|:------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-name | Filter single port power channels by name (can be a regexp). | -| --skip-poweredoff | Exclude the single ports that have been powered off. | -| --warning-state | Warning threshold for single port state. | -| --critical-state | Critical threshold for single port state. | -| --warning-status | Warning threshold for for single port status. | -| --critical-status | Critical threshold for for single port status. | -| --warning-* | Warning threshold. Can be: 'active-channels', 'current', 'energy', 'frequency', 'phase-angle', 'power-active', 'power-apparent', 'power-factor', 'power-reactive', 'voltage' | -| --critical-* | Can be: 'active-channels', 'current', 'energy', 'frequency', 'phase-angle', 'power-active', 'power-apparent', 'power-factor', 'power-reactive', 'voltage' | +| Option | Description | +|:------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-name | Filter single port power channels by name (can be a regexp). | +| --skip-poweredoff | Exclude the single ports that have been powered off. | +| --warning-state | Warning threshold for single port state. | +| --critical-state | Critical threshold for single port state. | +| --warning-status | Warning threshold for for single port status. | +| --critical-status | Critical threshold for for single port status. | +| --warning-* | Warning threshold. Can be: 'active-channels', 'current', 'energy', 'frequency', 'phase-angle', 'power-active', 'power-apparent', 'power-factor', 'power-reactive', 'voltage' | +| --critical-* | Can be: 'active-channels', 'current', 'energy', 'frequency', 'phase-angle', 'power-active', 'power-apparent', 'power-factor', 'power-reactive', 'voltage' | From a88317fedef62ce5bc7b130fdf41a9da72dc0568 Mon Sep 17 00:00:00 2001 From: cg-tw <83637804+cg-tw@users.noreply.github.com> Date: Mon, 17 Nov 2025 15:27:05 +0100 Subject: [PATCH 2/2] Apply suggestions from code review --- .../plugin-packs/procedures/hardware-pdu-gude-epc-snmp.md | 8 ++++---- .../plugin-packs/procedures/hardware-pdu-gude-epc-snmp.md | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-pdu-gude-epc-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-pdu-gude-epc-snmp.md index c990c381613a..d933b2e4e863 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-pdu-gude-epc-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-pdu-gude-epc-snmp.md @@ -8,7 +8,7 @@ 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 **Gude EPC SNMP** -depuis la page **Configuration > Gestionnaire de connecteurs de supervision** : +depuis la page **Configuration > Connecteurs > Connecteurs de supervision** : * [Base Pack](./base-generic.md) ## Contenu du pack @@ -129,7 +129,7 @@ Centreon vers la ressource supervisée. ### Pack 1. Si la plateforme est configurée avec une licence *online*, l'installation d'un paquet -n'est pas requise pour voir apparaître le connecteur dans le menu **Configuration > Gestionnaire de connecteurs de supervision**. +n'est pas requise pour voir apparaître le connecteur dans le menu **Configuration > Connecteurs > Connecteurs de supervision**. Au contraire, si la plateforme utilise une licence *offline*, installez le paquet sur le **serveur central** via la commande correspondant au gestionnaire de paquets associé à sa distribution : @@ -166,7 +166,7 @@ yum install centreon-pack-hardware-pdu-gude-epc-snmp 2. Quel que soit le type de la licence (*online* ou *offline*), installez le connecteur **Gude EPC SNMP** -depuis l'interface web et le menu **Configuration > Gestionnaire de connecteurs de supervision**. +depuis l'interface web et le menu **Configuration > Connecteurs > Connecteurs de supervision**. ### Plugin @@ -219,7 +219,7 @@ yum install centreon-plugin-Hardware-Pdu-Gude-Epc-Snmp 3. Appliquez le modèle d'hôte **HW-Pdu-Gude-Epc-SNMP-custom**. > 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). +> Plus d'informations dans la section [Troubleshooting SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#mapping-des-options-snmpv3). | Macro | Description | Valeur par défaut | Obligatoire | |:-----------------|:---------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| diff --git a/pp/integrations/plugin-packs/procedures/hardware-pdu-gude-epc-snmp.md b/pp/integrations/plugin-packs/procedures/hardware-pdu-gude-epc-snmp.md index d7261e4a8b67..78f30db49468 100644 --- a/pp/integrations/plugin-packs/procedures/hardware-pdu-gude-epc-snmp.md +++ b/pp/integrations/plugin-packs/procedures/hardware-pdu-gude-epc-snmp.md @@ -129,7 +129,7 @@ SNMP port. 1. If the platform uses an *online* license, you can skip the package installation instruction below as it is not required to have the connector displayed within the -**Configuration > Monitoring Connector Manager** menu. +**Configuration > Connectors > Monitoring Connectors** menu. If the platform uses an *offline* license, install the package on the **central server** with the command corresponding to the operating system's package manager: @@ -165,7 +165,7 @@ yum install centreon-pack-hardware-pdu-gude-epc-snmp 2. Whatever the license type (*online* or *offline*), install the **Gude EPC SNMP** connector through -the **Configuration > Monitoring Connector Manager** menu. +the **Configuration > Connectors > Monitoring Connectors** menu. ### Plugin